Dto Validation 예외 처리에 AOP를 적용해보자!

기존 방식

implementation 'org.springframework.boot:spring-boot-starter-validation'

위 validation 라이브러리를 사용하면

Controller 에서 @RequestBody 어노테이션으로 매핑하는 Request Dto 의 필드 유효성을 검사할 수 있다.

public class UserCreateRequest {

    @Email(message = "올바른 이메일 형식이 아닙니다. '@' 를 포함시켜주세요.")
    private String email;

    @Length(min = 8,message = "비밀번호는 최소 8자 이상입니다.")
    private String password;

}

위와 같이 매핑되는 필드에 validation에서 제공하는 어노테이션을 사용하면 된다.

@RestController
@RequiredArgsConstructor
@RequestMapping("/api/v1/users")
public class UserApiController {
    private final UserService userService;

    @PostMapping
    public ResponseEntity<Response<UserCreateResponse>> create(@RequestBody @Validated UserCreateRequest requestDto, BindingResult br) {

        if (br.hasErrors()) {
            throw new BindingException(br.getFieldError().getDefaultMessage());
        }

        UserCreateResponse response = userService.createUser(requestDto);

        return ResponseEntity.ok(Response.success(response));
    }
}

Controller의 메서드에서 @Validated 를 유효성을 검증할 객체 앞에 붙이고

바로 뒤에 BindingResult 객체를 파라미터로 추가해주면 예외처리를 할 수 있다.

🚨 꼭, 바로 뒤 파라미터에 BindingResult 객체를 추가해주어야 한다.

이렇게 적용하고 나니, 더 개선하고 싶은 부분이 보였다.

if (br.hasErrors()) {
        throw new BindingException(br.getFieldError().getDefaultMessage());
}

💡 validation을 통해 예외처리를 하다보면, 이 부분이 공통적으로 사용될 것이 예상되었다.

AOP 를 활용해 커스텀 어노테이션을 만들어 바인딩 체크를 한다는 것을 명시하고

메서드 안에는 핵심 로직으로만 구성해 가독성을 높이는 방식으로 개선해야겠다 생각했다.

AOP 를 활용해 개선해보자

// 자바 17버전, 스프링 부트 3.1.2 기준
implementation group: 'org.springframework.boot', name: 'spring-boot-starter-aop', version: '3.1.2'
testImplementation group: 'org.springframework.boot', name: 'spring-boot-starter-aop', version: '3.1.2'

AOP를 사용하기 위해서 위 라이브러리를 추가해준다.

그러면 스프링 부트 자동 설정으로 AnnotationAwareAspectJAutoProxyCreator 라는 빈 후처리기가 스프링 빈에 등록된다.

그러면 이 빈 후처리기가 스프링 빈으로 등록된 Advisor를 자동으로 찾아서 필요한 곳에 프록시를 적용하고

Advisor : 부가기능과 부가기능을 적용할 대상을 알고 있는 오브젝트

프록시 객체에서 원하는 부가기능을 실행시키고 원본 메서드를 호출하거나, 원본 메서드를 호출하고 부가기능을 실행시키도록 할 수 있다.

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface BindingCheck {

}

위와 같은 커스텀 어노테이션을 정의한다.

@Aspect
@Component
public class BindingCheckAop {

    @Before(value = "@annotation(com.wanted.global.annotation.BindingCheck)")
    public void before(JoinPoint joinPoint) {
        for (Object arg : joinPoint.getArgs()) {
            if (arg instanceof BindingResult) {
                BindingResult br = (BindingResult) arg;
                if (br.hasErrors()) {
                    throw new BindingException(br.getFieldError().getDefaultMessage());
                }
            }
        }
    }
}

위와 같이 @Aspect 와 @Component 어노테이션을 사용하면 빈 후처리기가 내가 정의한 Advisor를 찾을 수 있다.

@Before 와 value 옵션값에 커스텀 어노테이션의 경로 정보를 입력했다.

이 어노테이션이 적용된 메서드가 실행하기 전, before() 에 정의한 로직이 실행되도록 설정하였다.

JoinPoint 객체를 통해서 커스텀 어노테이션이 적용된 메서드의 파라미터에 접근할 수 있고

BindingResult 객체에 접근해 에러가 있는지 확인하는 메서드이다.

개선 후

@RestController
@RequiredArgsConstructor
@RequestMapping("/api/v1/users")
public class UserApiController {
    private final UserService userService;

    @PostMapping
    @BindingCheck
    public ResponseEntity<Response<UserCreateResponse>> create(@RequestBody @Validated UserCreateRequest requestDto, BindingResult br) {

        UserCreateResponse response = userService.createUser(requestDto);

        return ResponseEntity.ok(Response.success(response));
    }
}

Controller 코드가 깔끔해졌다.

테스트 코드

먼저, Controller 테스트를 WebMvcTest와 직접 설정한 Spring Security를 import 해서 사용하고 있었다.

테스트 코드에서도 AOP 적용을 위해서는, 추가 어노테이션이 필요하다.

@WebMvcTest(value = UserApiController.class)
@EnableAspectJAutoProxy
@Import({SecurityConfig.class, BindingCheckAop.class})
class UserApiControllerTest {
    
   .....
   
}

@EnableAspectJAutoProxy 와 정의한 Advisor 클래스인 BindingCheckAop.class 를 추가해주었다.

        private static Stream<Arguments> createUserFailScenarios() {
            return Stream.of(
                    Arguments.of(EMAIL_BINDING_ERROR_MESSAGE, UserCreateRequest.builder().email("email").password("12345678").build()),
                    Arguments.of(PASSWORD_BINDING_ERROR_MESSAGE, UserCreateRequest.builder().email("email@email.com").password("1234567").build())
            );
        }

        @DisplayName("Request Dto 유효성 검증 실패")
        @ParameterizedTest
        @MethodSource("createUserFailScenarios")
        void createUser_error_bindingError(String errorMessage, UserCreateRequest request) throws Exception {

            mockMvc.perform(post("/api/v1/users")
                            .contentType(APPLICATION_JSON)
                            .content(objectMapper.writeValueAsString(request)))
                    .andDo(print())
                    .andExpect(status().isBadRequest())
                    .andExpect(jsonPath("$.message").exists())
                    .andExpect(jsonPath("$.message").value("ERROR"))
                    .andExpect(jsonPath("$.result").exists())
                    .andExpect(jsonPath("$.result").value(errorMessage));

        }

위와 같이 Controller 테스트 코드를 작성해보았다.

첫번째 시나리오는 @가 포함되어있지 않은 email을 담아 요청했고

두번째 시나리오는 8자리보다 짧은 비밀번호를 담아 요청했다.

원하는 테스트 결과가 나왔다.

기존 방식

AOP 를 활용해 개선해보자

개선 후

테스트 코드

티스토리툴바