WordPress Api

Spring Web immutable Parameter

Posted by wonwoo on 2019-01-27

오늘은 Web immutable Parameter Object에 대해서 알아보도록 하자.
요즘에는 immutable Object를 많이 사용하는 듯 하다. 아마도 가장 좋은점은 스레드 세이프하다는 장점이 있어야 일 것이다.
그래서 오늘 Spring web과 관련해서 immutable 한 Parameter에 대해서 알아보도록 하자.

요즘은 코틀린으로 Spring 개발을 많이 하고 있고 Spring 에서도 코틀린을 거의 완벽히 지원해주고 있다.
또한 java에서는 lombok도 많이 사용하고 있으니 괜찮다면 한번 살펴보는 것도 나쁘지 않다.

@ModelAttribute

Spring5 부터는 @ModelAttribute도 불변의 Object도 사용가능하다. 아마도 코틀린을 지원하면서 고려가 많이 된 것 같다.

@RestController
public class PersonController {

    @PostMapping("/")
    Person person(@ModelAttribute Person person) {
        return person;
    }
}


public class Person {
    private final String name;
    private final String email;

    public Person(String name, String email) {
        this.name = name;
        this.email = email;
    }

    public String getName() {
        return name;
    }

    public String getEmail() {
        return email;
    }

}

만약 위의 코드처럼 작성하고 해당 컨트롤러를 호출해보자.

http POST :8080 name==wonwoo email==wonwoo@test.com

만약 버전이 Spring5 이전버전이라면 아래와 같이 에러가 발생할 것이다.

java.lang.NoSuchMethodException: xxx.xxxxx.xxxxxxx.Person.<init>()
 ...
 ...

기본 생성자가 없다는 뜻으로 Spring5 이전버전에서는 무조건 default 생성자가 존재했어야 했다. 하지만 spring5 부터는 기본생성자 없이도 에러가 발생하지 않는다.
Spring5에서 테스트를 해보자.

http POST :8080 name==wonwoo email==wonwoo@test.com
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
Date: Sun, 27 Jan 2019 10:58:49 GMT
Transfer-Encoding: chunked

{
    "email": "wonwoo@test.com",
    "name": "wonwoo"
}

그럼 에러가 발생하지 않고 우리가 원하던 데이터가 출력이 된다. 아주 괜찮다. lombok을 대부분 많이, 잘 사용하니 lombok을 사용한다면 좀 더 코드가 간결해 질 수 있다.

@Value
public class Person {
    String name;
    String email;
}

lombok 의 @Value
lombok @Value가 하는 역할은 위의 링크를 참고 하자.

만약 해당 모델의 파라미터명과 전달하는 파라미터가 다르다면 어떻게 할까? 이것 역시 Spring 에서 지원해주고 있다.
@ConstructorProperties 어노테이션을 통해 해당 파라미터명을 변경할 수 있다. @ConstructorProperties 어노테이션은 Spring이 제공해주는 것 아니지만 지원은 해주는 java bean 스펙이다.

어쨌든 @ConstructorProperties 어노테이션을 이용해서 파라미터를 변경할 수 있으니 한번 해보자.

public class Person {
    private final String name;
    private final String email;

    @ConstructorProperties({"user_name", "user_email"})
    public Person(String name, String email) {
        this.name = name;
        this.email = email;
    }

    public String getName() {
        return name;
    }

    public String getEmail() {
        return email;
    }

}

위와 같이 생성자에 @ConstructorProperties 어노테이션을 작성하고 해당 컬럼의 명을 순서대로 작성해주면 된다.

http POST :8080 user_name==wonwoo user_email==wonwoo@test.com
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
Date: Sun, 27 Jan 2019 11:03:29 GMT
Transfer-Encoding: chunked

{
    "email": "wonwoo@test.com",
    "name": "wonwoo"
}

아주 간단하다.

만약 lombok을 사용한다면 아래와 같이 작성하면 된다.

@Value
@RequiredArgsConstructor(onConstructor_ = @ConstructorProperties({"user_name", "user_email"}))
//@RequiredArgsConstructor(onConstructor = @__(@ConstructorProperties({"user_name", "user_email"})))
class Person {
    String name;
    String email;
}

onConstructor 문법은 java 버전과 관련이 있다.

@RequestBody (Jackson)

jackson 기준이기 때문에 다른 라이브러리를 사용한다면 다를 수 있으니 참고하길 바란다.

@RequestBody 어노테이션 또 한 불변의 Object로 만들 수 있다. Spring 지원한다기 보다는 사용하는 해당 라이브러리가 지원하고 있으니 사용하는 라이브러리의 문서를 살펴보면 좋다.

일단 기본적으로는 아무 설정하지 않았다면 jackson의 경우에는 기본생성자가 있어야 한다. 하지만 여러 방법으로 기본생성자 없이 사용할 수 있으니 한번 살펴보도록 하자.

@JsonProperty

@JsonProperty 어노테이션으로 해당 필드를 지정해주면 된다.

public class Person {

    private final String name;
    private final String email;

    public Person(@JsonProperty("name") String name, @JsonProperty("email") String email) {
        this.name = name;
        this.email = email;
    }

    public String getName() {
        return name;
    }

    public String getEmail() {
        return email;
    }
}

위와 같이 작성한다면 기본생성자 없이도 deserialize가 가능하다. 만약 모델의 필드와 요청파라미터가 다르다면 @JsonProperty의 value를 변경하기만 하면 된다.

lombok을 사용한다면 다음과 같다.

@Value
class Person {
    String name;
    String email;

    public Person(@JsonProperty("name") String name, @JsonProperty("email") String email) {
        this.name = name;
        this.email = email;
    }
}

lombok일 경우에는 조금 귀찮다. 생성자 필드에는 어떻게 넣지..?

@ConstructorProperties

jackson 도 @ConstructorProperties 어노테이션을 지원하다. 아마도 jackson2.7 부터 지원한다고 했는데 그 이하버전은 테스트는 해보지 않았다.

public class Person {

    private final String name;
    private final String email;

    @ConstructorProperties({"name", "email"})
    public Person(String name, String email) {
        this.name = name;
        this.email = email;
    }

    public String getName() {
        return name;
    }

    public String getEmail() {
        return email;
    }
}

마찬가지로 해당 필드를 변경하고 싶다면 @ConstructorProperties의 속성을 순서대로 변경하면 된다.

lombok을 사용할 경우는 다음과 같다.

@Value
@RequiredArgsConstructor(onConstructor_ = @ConstructorProperties({"name", "email"}))
class Person {
    String name;
    String email;
}

jackson-module-parameter-names

jackson 해당 모듈을 사용해서도 가능하다. 하지만 ObjectMapper를 조금 설정해줘야 한다.

@Bean
public ObjectMapper objectMapper() {
    ObjectMapper objectMapper = new ObjectMapper();
    objectMapper.registerModule(new ParameterNamesModule());
    return objectMapper;
}

위와 같이 설정한 후에 사용하면 바로 사용할 수 있다. 하지만 위의 모듈은 java8부터 가능하다. 만약 그 이하 버전을 사용한다면 위의 모듈을 사용할 수 없다.

public class Person {

    private final String name;
    private final String email;

    public Person(String name, String email) {
        this.name = name;
        this.email = email;
    }

    public String getName() {
        return name;
    }

    public String getEmail() {
        return email;
    }
}

해당 모듈을 사용한다면 어노테이션을 사용하지 않아도 기본적으로 동작을 한다.

lombok을 사용할 경우는 다음과 같다.

@Value
class Person {
    String name;
    String email;
}

참고로 Spring boot 2.0 부터는 spring-boot-starter-json 에 jackson-module-parameter-names 모듈이 포함되어 있다. 그래서 spring-boot-starter-web을 디펜더시 받는 다면 기본적으로 spring-boot-starter-json가 포함 되어 있으니 jackson-module-parameter-names를 추가 하지 않아도 된다. 만약 그 이전 버전을 사용한다면 해당 모듈만 디펜더시만 받으면 자동설정이 동작한다.
또 한 jackson-module-parameter-names 과 @ConstructorProperties 어노테이션은 함께 동작하지 않는 것 같다. jackson-module-parameter-names 을 사용한다면 @JsonProperty 어노테이션을 사용해야 한다.

@Value
//@RequiredArgsConstructor(onConstructor_ = @ConstructorProperties({"user_name", "user_email"})) // not working
class Person {
    String name;
    String email;

    public Person(@JsonProperty("user_name") String name, @JsonProperty("user_email") String email) {
        this.name = name;
        this.email = email;
    }
}

위처럼 jackson-module-parameter-names 을 사용하는 경우엔 @JsonProperty 어노테이션을 사용해서 해당 필드를 변경해야 한다.

오늘은 이렇게 Spring Web immutable Parameter 에 대해서 알아봤다.
꼭 Object를 불변으로 만들 필요는 없지만 사용할일이 있다면 참고하면 되겠다. 또 한 프로퍼티들을 변경해야 하는 일이 있다면 사용해도 괜찮을 듯 하다.

Spring boot 2.1 의@WebMvcTest

Posted by wonwoo on 2019-01-06

오늘 이야기할 내용은 Spring boot 2.1의 @WebMvcTest 어노테이션에 대해서 살펴볼텐데 기존의 @WebMvcTest과 조금 다른 부분이 있어 그것에 대해 알아보도록 하자.

만약 Spring boot 2.0 혹은 그 이전 버전에서 Spring boot 2.1로 버전을 올린다면 함께 봐야 할 수도 있다. 물론 그 상황이 라면?
필자도 Spring boot 2.0 에서 2.1로 올렸을 때 발생한 이슈였다. 2.0에서는 문제 없이 잘 실행 되었지만 2.1로 버전을 올렸더니 갑자기 테스트 케이스들이 실패하였다.
그래서 그 이유가 무엇인지 찾아보기 시작했다.

일단 어떤 경우에 이런 현상이 나오는지 코드로 살펴보도록 하자. 이 코드는 단지 예제일 뿐이다.

@Configuration
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS)
            .and()
            .authorizeRequests()
            .antMatchers("/hi").authenticated()
            .anyRequest()
            .permitAll()
            .and()
            .csrf()
            .disable();
    }

    @Bean
    public UserManager userManager(UserRepository userRepository) {
        return new UserManager(userRepository);
    }
}

위는 Security 설정이다. 딱히 문제 될 것은 없어 보인다. 기본적인 Security 설정이며 UserManager 경우에는 Security 와 관련있는 어떤 클래스라고 생각하면 되겠다. 그래서 위와 같이 설정을 했다고 하자.

@RestController
public class HelloController {

    @GetMapping("hi")
    public String hi() {
        return "hi";
    }
}


@RunWith(SpringRunner.class)
@WebMvcTest(HelloController.class)
@WithMockUser
public class HelloControllerTests {

    @Autowired
    private MockMvc mockMvc;

    @Test
    public void hi() throws Exception {
        mockMvc.perform(get("/hi")).andExpect(status().isOk())
            .andExpect(content().string("hi"))
            .andDo(print());
    }
}

그리고 나서 위와 같이 테스트 코드를 작성해보자. 딱히 문제는 없어 보인다. 테스트 코드를 돌려봐도 문제가 없다. 초록색 창이 뜨면서 테스트가 성공한 것을 볼 수 있을 것이다.
하지만 여기에서 버전을 2.1로 올려서 테스트를 한다면 어떻게 될까? 위의 코드가 2.1에서 잘 동작했다면 필자는 이 글을 쓸 이유가 없었을 것이다.

Spring boot 버전을 2.1로 올리고 테스트를 해보면 다음과 같은 에러가 발생한다.

java.lang.IllegalStateException: Failed to load ApplicationContext

....

Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.example.demosecurity.UserRepository' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {}
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.raiseNoMatchingBeanFound(DefaultListableBeanFactory.java:1644)
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.doResolveDependency(DefaultListableBeanFactory.java:1203)
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.resolveDependency(DefaultListableBeanFactory.java:1164)
    at org.springframework.beans.factory.support.ConstructorResolver.resolveAutowiredArgument(ConstructorResolver.java:857)
    at org.springframework.beans.factory.support.ConstructorResolver.createArgumentArray(ConstructorResolver.java:760)

stack trace 가 길어서 특정부분만 가져왔다.

갑자기 버전을 올리니 위와 같은 에러가 발생한다. 아까 위에서 설정한 UserManager의 디펜더시인 UserRepository타입의 빈을 찾을 수 없다는 내용이다. 그럼 왜 갑자기 이런 에러가 발생하는 걸까?

그 이유는 @WebMvcTest어노테이션으로 테스트할 때 기존에는 Spring boot의 기본 Config를 사용했다면 2.1부터는 WebSecurityConfigurer를 사용한 Config들도 같이 설정되어 실행된다. 그래서 위와 같이 UserRepository 라는 빈을 찾지 못한다고 에러가 발생된 것이다.

기존에는 설정해 놓은 프로젝트의 Security의 설정이 동작하는 것이 아니라 Spring boot 의 기본 설정이 동작해서 이 것이 정말 맞는 테스트인가? 의문도 생길수 있다.

아래의 코드를 살펴보자.

@Configuration
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS)
            .and()
            .authorizeRequests()
            .antMatchers("/admin/**").access("hasRole('ADMIN')")
            .anyRequest()
            .permitAll()
            .and()
            .csrf()
            .disable();
    }
}

기존의 코드를 위의 코드로 변경하고 테스트케이스를 만들어보자.

@RunWith(SpringRunner.class)
@WebMvcTest(AdminController.class)
public class AdminControllerTests {

    @Autowired
    private MockMvc mockMvc;

    @Test
    @WithMockUser(username = "example", roles = {"ANONYMOUS"})
    public void adminTestWithBadAuthentication() throws Exception {
        mockMvc.perform(get("/admin"))
            .andExpect(status().isForbidden());
    }

    @Test
    @WithMockUser(username = "user", roles = {"ADMIN"})
    public void adminTestWithAuthentication() throws Exception {
        mockMvc.perform(get("/admin"))
            .andExpect(status().isOk())
            .andExpect(content().string("admin"));
    }

}

위의 테스트 코드는 전혀 문제가 없어 보인다. adminTestWithBadAuthentication 메서드를 테스트 할 경우 role 이 ANONYMOUS 이니 403 에러가 떨어져야 정상이다. 왜냐하면 /admin/** 으로 들어올경우 role이 ADMIN 이어야 한다고 설정했으니 말이다.

.antMatchers("/admin/**").access("hasRole('ADMIN')")

하지만 Spring boot 2.0 혹은 그 이전버전에서는 위의 테스트 코드가 정상적으로 성공하지 않는다. adminTestWithAuthentication 메서드는 성공하나 adminTestWithBadAuthentication 메서드는 실패로 돌아간다.

java.lang.AssertionError: Status 
Expected :403
Actual   :200

우리는 http status code가 403을 기대 했는데 뜬금없이 정상적인 코드 200이 떨어졌다. 우리가 원하는 테스트가 아니다.

만약 2.1 이전 버전에서 위의 테스트 코드를 성공시키고 싶다면 아래와 같이 코드를 조금 변경해야 한다.

@RunWith(SpringRunner.class)
@WebMvcTest(AdminController.class)
@Import(WebSecurityConfig.class)
public class AdminControllerTests {
  //...
}

그러면 아무 문제 없이 테스트를 통과 할 수 있다. 하지만 Spring boot 2.1 부터는 위와 같이 설정하지 않아도 기본적으로 프로젝트의 Security 설정을 등록하므로 위와 같은 설정은 필요 없다.

오늘은 이렇게 Spring boot 2.1의 @WebMvcTest 변화에 대해서 알아봤다.
만약 Spring boot 2.1로 올리면서 테스트가 깨진다면 해당 이유일 수도 있으니 참고하면 되겠다.

해당 이슈의 토론은 여기에서 확인 할 수 있다.
원래 해당이슈는 2.0 때 개발되었다가 revert 되었다. 아마도 2.0이 나오기 바로 직전에 개발되어서 리스크가 크다고 판단되어 revert를 하고 2.1에 다시 개발되었다.

Spring 의 @ControllerAdvice

Posted by wonwoo on 2018-12-16

오늘은 Spring의 @ControllerAdvice 어노테이션에 대해서 알아보도록 하자. 많은 내용은 아니지만 이런기능도 있으니 한번 살펴보도록 하자.
대부분이 Spring 을 사용할 때 @ControllerAdvice를 글로벌 예외처리기로 사용한다. 하지만 @ControllerAdvice 어노테이션은 예외처리기만을 위한 것은 아니다.

아마도 예외처리기로 사용할 때가 많아서 대부분이 예외처리로 사용할 뿐이다.
구글에 @ControllerAdvice을 검색을 해보면 Exception 처리만 수두룩하다. 뭐 틀린말은 아니다. 예외처리로만 사용해도 문제는 없다.
하지만 예외처리뿐만 아니라 다용도로 사용할 수 있으니 알면 좋을 것 같아서 포스팅을 해본다.

흔히 사용하는 예외처리 @ExceptionHandler

대부분이 @ControllerAdvice를 예외처리기로만 사용한다. 필자도 일반적으로 여러분과 비슷하게 @ControllerAdvice를 사용할 때 99%를 예외처리기로 사용한다.

@ControllerAdvice
public class GlobalControllerAdvice {

    @ExceptionHandler(NullPointerException.class)
    public void nullPointerException(NullPointerException e) {
        //blabla
    }

    //...
}

우리는 위와 같이 특정한 exception을 잡아서 처리한다. 아주 좋은 방법이다. exception을 비지니스 로직에 넣지 않고 분리함으로써 비지니스 로직에 좀 더 집중할 수 있게 한다.
아마도 예외처리기로 대다수가 작성하다보니까 @RestControllerAdvice 어노테이션도 추가 된 듯 싶다. @RestControllerAdvice 은 @ControllerAdvice 어노테이션과 @ResponseBody 어노테이션을 합쳐놓은 어노테이션이다. 만약 예외처리를 body로 전달하고 싶다면 @RestControllerAdvice 이용하면 된다.

ModelAttribute

@ControllerAdvice 어노테이션에 사용할 수 있는 어노테이션은 @ModelAttribute 어노테이션이다.
이것 역시 글로벌 하게 사용할 수 있다. @ModelAttribute를 모든 Controller에 사용한다면 @ControllerAdvice에 선언하면 된다.

@RestControllerAdvice
public class GlobalControllerAdvice {

    @ModelAttribute
    public User user() {
        return new User("wonwoo");
    }
}

위와 같이 사용할 경우 ModelAttribute를 글로벌하게 사용한다는 의미이다. 예를들어 Spring security를 사용해서 사용자 정보를 얻고 싶다면 아래처럼 작성하면 좀 더 편리하다.

@ControllerAdvice
public class GlobalControllerAdvice {

    @ModelAttribute
    public User user(@AuthenticationPrincipal User user) {
        return user;
    }
}

매번 Controller에 작성하지 않고 @ControllerAdvice 이용해서 한번만 작성하면 된다. 매번 작성하는 것보다 나은 방법이다.

InitBinder

@ControllerAdvice에 사용할 수 있는 어노테이션이 한가지 더 있다. 바로 @InitBinder 어노테이션이다. @InitBinder 어노테이션은 아주 다양한 설정을 지원한다.
예를들어 Validator, Formatter, Converter, PropertyEditor 등, 뿐만 아니라 여러가지를 설정을 할 수 있는 어노테이션이다. 여기서는 주 목적이 이것들을 설명하는 것이 아니라 생략하겠다.

이런것들 역시 우리는 글로벌하게 설정할 수 있다. 바로 @ControllerAdvice 를 이용하면 된다.

@ControllerAdvice
public class GlobalControllerAdvice {

    @InitBinder
    public void initBinder(DataBinder dataBinder){
       //...
    }
}

위와 같이 사용할 경우에도 역시 글로벌 하게 @InitBinder를 사용할 수 있다. 근데 사실 글로벌하게 사용할 일이 있나 싶기도 하다. Validator, Formatter, Converter 는 해당 컨트롤러만 사용할 일이 많아 해당 컨트롤러에 있는게 더 나은 방법인 것 같다. 또한 Formatter, Converter 경우에는 WebMvcConfigurer 상속받아 설정하는 것이 더 편리해서 굳이 이 방법으로 글로벌하게 설정 할일은 드물 것 같다. 그렇지만 만약 사용할 일이 있다면 이 방법도 존재하니 참고하면 되겠다.

ResponseBodyAdvice, RequestBodyAdvice

이번엔 어노테이션이 아닌 인터페이스이다. @ControllerAdvice를 사용할 수 있는 마지막 인터페이스이다. 해당 인터페이스를 구현하고 @ControllerAdvice 어노테이션을 설정하면 Spring이 자동으로 감지해 해당 인터페이스의 역할에 맞게 실행해 준다.

@ControllerAdvice
public class FooResponseBodyAdvice implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return false;
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
        Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        return null;
    }
}


@ControllerAdvice
public class FooRequestBodyAdvice implements RequestBodyAdvice {

    @Override
    public boolean supports(MethodParameter methodParameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {
        return false;
    }

    @Override
    public HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter parameter, Type targetType,
        Class<? extends HttpMessageConverter<?>> converterType) throws IOException {
        return null;
    }

    @Override
    public Object afterBodyRead(Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType,
        Class<? extends HttpMessageConverter<?>> converterType) {
        return null;
    }

    @Override
    public Object handleEmptyBody(Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType,
        Class<? extends HttpMessageConverter<?>> converterType) {
        return null;
    }
}

위 처럼 ResponseBodyAdvice, RequestBodyAdvice 인터페이스만 구현해주면 된다. 정확한 사용법은 해당 Spring 문서를 보면 될 것 같다.
간단하게 말하자면 ResponseBodyAdvice 는 body에 쓰기전에 커스텀하게 변경가능하고 RequestBodyAdvice 경우에는 바디를 읽기전, 읽은 후 등에 커스텀하게 Body를 변경가능하다.

간단한 예제로 Jackson 의 @JsonView 어노테이션들이 Spring이 사용하게끔 ResponseBodyAdvice, RequestBodyAdvice 인터페이스를 이용해서 구현되었다.


@PostMapping("/") @JsonView(View.Users.class) public User hello(@JsonView(View.Users.class) @RequestBody User user) { return user; }

@JsonView 사용법은 어렵지 않으니 다른 블로그들을 참고 하면 되겠다. 예전에 쓴 글이 있으나 영 빈약해서..

오늘은 이렇게 Spring 의 @ControllerAdvice 에 대해서 알아봤다.
@ControllerAdvice는 예외처리기 말고도 위와 같이 많은 기능을 제공해주고 있으니 필요하다면 사용해도 괜찮다.