io-uty
commented
1 month ago [Chapter 15] 간단한 웹 어플리케이션의 구조
1 간단한 웹 어플리케이션의 구성요소
- 전형적 구조
- 프론트 서블릿
- 웹 브라우저의 모든 요청을 받는 창구역할
- 요청을 분석해 컨트롤러에 전달
- 스프링 MVC에서는 DispatcherServlet이 해당
- 컨트롤러+뷰
- 컨트롤러 : 실제 웹 브라우저의 요청 처리
- 클라이언트의 요청을 처리하기 위해 기능 실행 후 결과를 뷰에 전달
- 컨트롤러 역할
- 클라이언트가 요구한 기능 실행
- 응답 결과 생성하는데 필요한 모델 생성
- 응답 결과 생성할 뷰 선택
- 어플 제공 기능과 사용자 요청 기능 매개체로서의 기능 제공 로직을 직접 수행하는 것은 x, 서비스에 처리를 위임
- 서비스
- 기능의 로직 구현
- DAO
- DB 연동이 필요할 때 사용
- 웹 어플리게이션 간 데이터 이동해주는 역할
- 데이터 조회 기능 외 다른 로직이 없는 경우 컨트롤러에서 DAO 사용하기도 함
- 프론트 서블릿
2 서비스의 구현
-
핵심이 되는 기능의 로직 제공
-
Example) 비밀번호 변경 기능에서 필요한 로직
- DB에서 비밀번호 변경할 회원 데이터 구하기
- 존재하지 않으면 예외 발생
- 데이터의 비밀번호 변경
- 변경 내역을 DB 에 반영
@Transactional public void changePassword(String email, String oldPwd, String newPwd){ Member member = memberDao.selectByEmail(email); //1 if(member==null) throw new MemberNetFoundException(); //2 member.changePassword(oldPwd, newPwd); //3 memberDao.update(member);//4 } -
서비스 메서드를 @Transactional 애노테이션을 이용해 트랜잭션 범위에서 실행
-
서비스 클래스가 제공할 기능의 개수는 몇 개가 적당할까?
- 이 책에서는 각 서비스 클래스 내 한 개의 기능만 제공
- 같은 데이터를 사용하는 기능들을 한 개의 서비스 클래스에 모아서 구현해도 o (선호하지는 x)
-
서비스 메서드의 parameter
- 세 개의 파라미터를 이용해 기능 실행에 필요한 값 전달
public void changePAssword(String email, String oldPwd, String newPwd)- 필요한 데이터를 담고 있는 별도의 클래스를 파라미터로 사용
public void regist(RegisterRequest req)- 웹 요청 파라미터를 커맨드 객체로 받고 커맨드 객케의 프로퍼티를 서비스 메서드에 인자로 전달
- 커맨드 클래스를 작성하여 스프링 MVC가 제공하는 폼 값 바인딩과 검증, 스프링 폼 태그와의 연동 기능 사용
@RequestMapping(method = RequestMethod.POST) public String submit( @ModelAttibute("command") ChangePwdCommand pwdCmd, Errors errors, HttpSession session){ ... changePAsswordService.changePassword( authInfo.getEmail(), pwdCmd.getCurrentPassword(), pwdCmd.getNewPassword(); ... } -
서비스 메서드 기능 실행 후 결과
- 리턴 값을 이용한 정상 결과
- 익셉션을 이용한 비정상 결과
public class AuthService { ... 생략 public Authinfo authenticate(String email, String password) { Member member = memberDao.selectByEmail(email); if (member == null) { throw new WrongldPasswordException); } if (!member.matchPassword(password)) { throw new WrongldPasswordException(); } return new AuthInfo(member.getld(), member.getEmail), member.getName()); } } //성공할 경우 AuthInfo객체 리턴@RequestMapping(method = RequestMethod.POST) public String submit( LoginCommand loginCommand, Errors errors, HttpSession session, HttpServletResponse response) { ... try { AuthInfo authInfo = authService.authenticate( loginCommand.getEmail), loginCommand.getPassword()); session.setAttribute("authinfo", authinfo); ... return "login/loginSuccess"; } catch (WrongldPasswordException e) { // 서비스는 기능 실행에 실패할 경우 익셉션을 발생시킨다. errors.reject("idPasswordNotMatching"); return "login/loginForm"; } }
3 컨트롤러에서의 DAO 접근
- 서비스 메서드에서 로직 수행하지 않고 DAO 메서드만 호출하고 끝나기도 함
public class MemberService{
...
public Member getMember(Long id){
return memberDao.selectById(id);
}
}4 패키지 구성
- 웹 요청 처리 영역 : 컨트롤러 클래스 관련 클래스
- RegisterController
- ChangePwdController
- ChangePwdCommand
- 회원 기능 제공 영역 : 모델 클래스
- service
- MemberRegisterService
- RegisterRequest
- ChangePAsswordService
- dao
- MemberDao
- model
- Member
- service
- 패키지 구성에 정답은 없지만 팀 구성원끼리 동일 규칙을 따르는 것이 중요
[Chapter 16] JSON 응답과 요청 처리
- Ajax를 이용해 서버 API 호출하는 사이트가 다수임 -> API는 웹 요청 응답으로 JSON 등 사용
1 JSON 개요
- JSON이란 ?
- 간단한 형식을 갖는 문자열로, 데이터 교환에 주로 사용
- { “name1”:”key1” , “name2”:”key2”, … } 형식
- key 값으로는 문자열, 숫자, 불리언, null, 배열, 다른 객체 등이 올수 있다
2 Jackson 의존 설정
- Jackson이란?
- JSON 형식 문자열과 자바 객체 간 변환을 처리하는 라이브러리
- 스프링에서 Jackson 라이브러리 추가함으로써 자바 객체를 JSON으로 변환 가능
- maven에서는 pom.xml파일에 관련 의존 추가
public class Person { <=> { "name":"이름",
private String name; "age":10
private int age; }
..get/set 메서드
}3 @RestController로 JSON 형식 응답
-
스프링 MVC에서 JSON 형식으로 데이터 응답하는 방법
→ @Controller 애노테이션 대신 @RestController 애노테이션 사용
→ 매핑 애노테이션을 붙인 메서드가 리턴한 객체를 알맞게 변환해 응답 데이터로 전송
: 이 때 클래스 패스에 Jackson이 존재하면 JSON 형식 문자열로 변환하여 응답
3.1 @JsonIgnore를 이용한 제외 처리
- 암호과 같은 데이터는 응답 결과에 포함하면 안되기 때문에 응답 결과에서 데이터를 제외
- @JsonIgnore 애노테이션을 사용해 처리
import com.fasterxml.jackson.annotation.JsonIgnore;
public class Member{
private Long id;
private String email;
@JsonIgnore;
private String password;
private String name;
private LocalDateTime registerDateTime;
}3.2 날짜 형식 변환 처리: @JsonFormat 사용
- 3.1 코드의 결과에서 registerDateTime 값은 [2018, 3, 1, 11, 7, 49]이다.
- 날짜나 시간 값을 특정 형식으로 전환하기 위해 @JsonFormat 애노테이션 사용
import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonFormat.Shape;
public class Member{
private Long id;
private String email;
private String name;
@JsonFormat(shape = Shape.STRING)
private LocalDateTime registerDateTime;
}//형식을 원하는 형식으로 변환하고싶다면
@JsonFormat(pattern = "yyyyMMddHHmmss"3.3 날짜 형식 변환 처리 : 기본 적용 설정
-
매번 @JsonFormat 애노테이션 사용한다면 번거로움
→ 스프링 MVC 설정을 변경하여 Jackson 변환규칙을 모든 날짜타입에 적용
-
원래 HttpMessageConverter 사용하여 자바객체를 HTTP응답으로 변환
⇒ MappingJackson2HttpMessageConverter 새롭게 등록
//MvcConfig클래스 ... public class MvcConfig implements VecMvcConfigurer{ ... @Override public void extendMessageConverters( List<HttpMessageConverter<?>> converters){ ObjectMapper objectMapper = Jackson2ObjectMapperBuilder .json() *.featuresToDisable( SerializationFeature.WRITE_DATES_AS_TIMESTAMPS)* .build(); converters.add(0, new MappingJackson2HttpMessageConverter(objectMapper)); } }원하는 타입의 형식으로 출력하고싶다면 Jackson2ObjectMapperBuilder#simpleDateFormat() 메서드 사용
//위에서 .featuresToDisable(...)을 변경 .simpleDateFormat("yyyyMMddHHmmss") //ISO-8601 형식 대신 원하는 패턴을 원한다면 .serializerByType(LocalDateTime.class, new LocalDateTimeSerializer(formatter))
3.4 응답 데이터의 컨텐츠 형식
-
개발자도구 실행 후 JSON이 제공하는 API를 호출하면 헤더의 Content-Type 확인 가능
→ application/json
자바객체 ⇒ JSON
JSON ⇒ 자바객체
4 @RequestBody로 JSON 요청 처리
- POST / PUT 방식을 이용해 JSON 형식 데이터를 요청 데이터로 전송
- @RequestBody 애노테이션을 붙여 요청 데이터를 커맨드 객체로 전달
- 커맨드 객체 앞에 @RequestBody 애노테이션 붙이면 됨
**import org.springframework.web.bind.annotation.RequestBody;**
...
@RestController
public class RestMemberController{
...
@PostMapping("/api/members")
public void newMember(
**@RequestBody** @valid RegisterRequest regReq,
HttpServletResponse response) throws IOException{
...
}
}
}4.1 JSON 데이터의 날짜 형식 다루기
- default ⇒ yyyy-MM-ddTHH:mm:ss 패턴 문자열을 LocalDateTime과 Date로 변환
- 특정 패턴을 가진 문자열을 변환하고자 할 때 : @JsonFormat 애노테이션의 pattern 속성사용
//특정 패턴을 가진 문자열을 변환하고자 할 때
@JsonFormat(pattern = "yyyyMMddHHmmss")
private LocalDateTime birthDateTime;
@JsonFormat(pattern = "yyyyMMdd HHmmss")
private Date birthDate;- 특정 속성이 아니라 해당 타입을 갖는 모든 속정에 적용하고싶다면 스프링 MVC설정 추가
...
public class MvcConfig implements VecMvcConfigurer{
...
@Override
public void extendMessageConverters(
List<HttpMessageConverter<?>> converters){
ObjectMapper objectMapper = Jackson2ObjectMapperBuilder
.json()
**.featuresToDisable(SerializationFeature.INDENT_OUTPUT)
.deserailizerByType(LocalDateTime.class,
new LocalDateTimeeserializer(formatter))
.simpleDateFormat("yyyyMMdd HHmmss")
.build();
converters.add(0,
new MappingJackson2HttpMessageConverter(objectMapper));
}
}- simpleDateFormat()은 Date 타입을 JSON 데이터로 변환할 때에도 사용된다는 점 유의
4.2 요청 객체 검증하기
- @Valid 애노테이션 또는 별도 Validator 이용해 검증
PostMapping("/api/members")
public void newMember(
@RequestBody RegisterRequest regRea, Errors errors,
HttpServletResponse response) throws IOException {
try {
new RegisterRequestValidator) validate(regRea, errors);
if (errors.hasErrors()) {
response.sendError(HttpServletResponse.SC_BAD_REQUEST);
return;
} ...
} catch (DuplicateMemberException dupEx) {
response.sendError(HttpServletResponse.SC_CONFLICT);
}
}5 ResponseEntiry로 객체 리턴하고 응답 코드 지정하기
- 지금까지와 같이 HttpServletResponse 이용해 404 응답을 하면 JSON이 아닌 HTML을 응답 결과로 제공 ⇒ JSON으로 전송해야 API 호출 프로그램이 일관되게 응답 처리할 수 o
5.1 ResponseEntity를 이용한 응답 데이터 처리
- ResponseEntity : 정상인 경우 + 비정상인 경우 둘 다 JSON 응답 전송하는 방법
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
@RestController
public class RestMemberController {
private MemberDao memberDao;
.. 생략
@GetMapping("/api/members/{id}")
public ResponseEntity<Object> member @PathVariable Long id) {
Member member = memberDao.selectByld (id);
if (member == null) {
return ResponseEntity.status(HttpStatus.NOT_FOUND)
.body(new ErrorResponse("no member"));
｝
return ResponseEntity.status(HttpStatus.OK).body(member);
}-
리턴타입이 ResponseEntity면 ResponseEntity의 body로 지정한 객체를 사용해 변환
→ 이 경우 member객체, ErrorResponse를 JSON으로 변환
-
생성하는 기본 방법 : ResponseEntity.status(상태코드).body(객체)
-
200(OK) 응답 코드와 몸체 데이터를 생성할 경우 : ResponseEntity.ok(member)
-
몸체가 없다면
: ResponseEntity.status(HttpStatus.NOT_FOUND).build()
: ReponseEntity.notFound().build()
5.2 @ExceptionHandler 적용 메서드에서 ResponseEntity로 응답하기
- 한 메서드에서 정상 응답과 에러 응답을 ResponseBody로 생성하면 코드 중복 위험
⇒ @ExceptionHandler 애노테이션을 적용한 메서드에서 에러 응답을 처리
@GetMapping("/api/members/{id}")
public ResponseEntity<Object> member @PathVariable Long id) {
Member member = memberDao.selectByld (id);
if (member == null) {
throw new MemberNotFoundException();
｝
return member;
}
@ExceptionHandler(MemberNotFoundException.class)
public ResponseEntity<ErrorResponse> handleNoData() {
return ResponseEntity
.status(HttpStatus.NOT_FOUND)
.body(new ErrorResponse("no member"));
}-
Member 자체를 리턴
⇒ 회원 데이터가 존재하면 JSON으로 변환한 결과 응답
⇒ 존재하지 않으면 MemberNotFoundException 발생
→ @ExceptionHandler 애노테이션 사용한 handleNoData() 메서드가 에러 처리
→ 404이고 몸체가 JSON인 형식의 응답 전송
-
@RestControllerAdvice 애노테이션을 이용해 에러코드 처리할수도 o
-
@ControllerAdvice 애노테이션과 동일,
차이는 @RestController 애노테이션과 같이 응답을 JSON 이나 XML같은 형식으로 변환
-
5.3 @Valid 에러 결과를 JSON으로 응답하기
-
@Valid 애노테이션을 붙인 커맨드 객체가 값 검증에 실패하면 400 상태 코드 응답
→ 문제는 HttpServletResponse 이용했을 때와 같이 HTML 응답을 전송한다는 것
⇒ Errors 타입 파라미터를 추가해 직접 에러 응답 생성!
@PostMapping("/api/members") public ResponseEntity<Object> newMember( @RequestBody @Valid RegisterRequest regReq, Errors errors) { if (errors.hasErrors()) { String errorCodes = errors.getAllErrors) // List<ObjectError> .stream() .map (error → error.getCodes) [0]) // error= ObjectError .collect(Collectors.joining(",")); return ResponseEntity .status (HttpStatus.BAD_REQUEST) body(new ErrorResponse("errorCodes = " + errorCodes)); } ...생략 }-
hasErrors()메서드를 이용해 검증 에러가 존재하는지 확인
→ 존재하면 getAllErrors() 메서드로 모든 에러 정보 구하고,
각 에러 코드값 연결한 문자열을 errorCodes 변수에 할당
-
[Chapter 17] 프로필과 프로퍼티 파일
1 프로필
- 개발 완료한 어플을 배포하려면 서비스 환경에 맞는 JDBC 연결 정보를 사용해야 하나, 실수하기 쉬우며 원시적이기 때문에 프로필을 사용
- 처음부터 개발 목적 설정과 실 서비스 목적의 설정을 구분해 작성하기 위한 기능
1.1 @Configuration 설정에서 프로필 사용하기
- @Configuration 이용한 설정에서 프로필 지정하려면 @Profile 애노테이션 이용
//DsDevConfig 클래스를 설정으로 사용
@Configuration
@Profile("dev")
public class DsDevConfig{
@Bean(destroyMethod="close")
public DataSource dataSource(){
...
}
}
//"dev"가 아닌 "real" 프로필 활성화 했을 대
@Configuration
@Profile("real")
public class DsRealConfig{
@Bean(destroyMethod="close")
public DataSource dataSource(){
...
}
}-
“dev”프로필을 활성화 → @Profile(”dev”) 애노테이션 붙인 설정 클래스의 빈 사용
-
“real”프로필을 활성화 → @Profile(”real”) 애노테이션 붙인 설정 클래스의 빈 사용
-
특정 프로필을 선택하는 법
-
1 초기화 전 setActiveProfiles() 메서드 사용
context.getEnvironment().setActiveProfiles(”dev”); ...-
getEnvironment() : 스프링 실행 환경을 설정하는 데 사용하는 Environment 리턴
→ 이 메서드를 사용해 사용할 프로필 선택 가능 (이 경우엔 dev)
⇒ 따라서 DsDevConfig 클래스와 DsRealConfig 클래스에 정의된 “dataSource” 중 DsDevConfig에 정의된 “dataSource” 빈 사용
-
주의할 점 : 설정 정보 전달 전에 사용할 프로필을 지정해야 함
⇒ 프로필 선택 전 선택정보를 먼저 전달하면 빈을 찾지 못해 익셉션 발생
-
두 개 이상 프로필을 활성화 하고싶다면 파라미터로 전달
-
-
2 spring.profiles.active 시스템 프로퍼티에 사용할 프로필 값 지정
-
명령행에서 -D 옵션 이용
java -Dspring.profiles.active=dev main.Main -
System.setProperty() 이용
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext( MemberConfig.class, DsDevConfig.class, DsRealConfig.class);
-
-
-
프로필 우선순위
→ setActiveProfiles() - 자바 시스템 프로퍼티 - OS 환경변수
1.2 @Configuration을 이용한 프로필 설정
- 중첩 클래스 이용해 프로필 설정을 한 곳으로 모을 수 있다
주의) 중첩된 @Configuration 설정 사용할 때 중첩 클래스는 static이어야 함
@Configuration
public class MemberConfigWithProfile{
@Autowired
private DataSource dataSource;
@Bean
public MemberDao memberDao(){
return new MemberDao(dataSource);
}
@Configuration
@Profile("dev")
public class DsDevConfig{
@Bean(destroyMethod="close")
public DataSource dataSource(){
...
}
}
@Configuration
@Profile("real")
public class DsRealConfig{
@Bean(destroyMethod="close")
public DataSource dataSource(){
...
}
}
}1.3 다수 프로필 설정
- 두 개 이상의 프로필 이름을 가질 수 있음
//real, test 프로필 모두 사용
@Configuration
@Profile(”real,test”)
public class DataSourceJndiConfig{ ... )
//real 프로필 비활성화
@Configuration
@Profile(”!real”)
public class DataSourceJndiConfig{ ... )1.4 어플리케이션에서 프로필 설정하기
- spring.profiles.active 시스템 프로퍼티나 환경 변수를 사용해 선택할 수 o
- web.xml에서 spring.profiles.active 초기화 파라미터 이용
<servlet>
...
<init-param>
<param-name>spring.profiles.active</param-name>
<param-value>dev</param-value>
</init-param>
...
</servlet>2 프로퍼티 파일을 이용한 프로퍼티 설정
- 외부의 프로퍼티 파일을 이용해 스프링 빈 설정 가능
2.1 @Configuration 애노테이션 이용 자바 설정에서의 프로퍼티 사용
-
프로퍼티 사용을 위한 설정
-
1 PropertySourcesPlaceholderConfigurer 빈 설정
package config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.support.PropertySoucesPlaceholderConfigurer; import org.springframework.core.io.ClassPathResource; @Configuration public class PropertyConfig{ @Bean public static PropertySourcesPlaceholderConfigurer properties(){ PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer(); configurer.setLocations( new ClassPathResource("db.properties"), new ClassPathResource("info.properties")); return configurer; } }-
위 setLocations() 메서드는 프로퍼티 파일 목록을 인자로 전달받는다
→ Resource 타입을 이용해 파일 경로 전달
-
PropertySourcesPlaceholderConfigurer 빈 설정 메서드는 항상 정적 메서드
→ 정적 메서드로 지정하지 않으면 원하는 방식으로 동작 x
-
-
2 @Value 애노테이션
- setLocation 메서드로 전달받은 프로퍼티 파일 목록 정보를 읽어와 사용하기 위함
package config; ... @Congifuration public class DsConfigWithProp{ Value("${db.driver}") private String driver; ... }- 플레이스 홀더의 값을 일치하는 프로퍼티 값으로 치환
- 위의 경우 db.driver 프로퍼티 값으로 치환
-
2.2 빈 클래스에서 사용하기
- 빈으로 사용하는 클래스에도 @Value 애노테이션 사용 가능
package spring;
import ...;
public class Info{
@Value("${Info.version}")
private String version;
...
}- set 메서드에도 사용 가능
public class Info{
private String version;
...
@Value("${info.version}")
public void setVersion(String version){
this.version=version;
}
}
jgw1202
wldnd7145
스프링 프로그래밍 입문 5 남은 부분 정독