스프링에서 Argument Resolver 사용하기

컨트롤러에서 쿼리 스트링을 변수에 바인딩하려면 @RequestParam 을, 가변적인 경로를 변수에 바인딩하려면 @PathVariable 을, HTTP Body를 변수에 바인딩하려면 @RequestBody 를 사용해야한다.

하지만 HTTP Header, Session, Cookie 등 직접적이지 않은 방식 혹은 외부 데이터 저장소로부터 데이터를 바인딩해야할 때가 있다. Argument Resolver는 방금과 같은 경우 사용한다. Argument Resolver를 사용하면 컨트롤러 메서드의 파라미터 중 특정 조건에 맞는 파라미터가 있다면, 요청에 들어온 값을 이용해 원하는 객체를 만들어 바인딩해줄 수 있다.

Argument Resolver를 사용하지 않았을 때

우리가 만들 어플리케이션은 요청을 처리할 때 클라이언트 IP와 요청한 유저의 ID가 필요하다고 가정하자. 참고로 유저의 ID는 HTTP Authorization 헤더에 실려오는 JWT의 Payload에서 가져와야한다. 이를 컨트롤러에서 직접 구현하려면 많은 중복이 발생할 것 이다.

@PostMapping("/items")
public ResponseEntity<Void> createItem(HttpServletRequest request) {
    String token = JwtUtil.extract(request);
    JwtUtil.validateToken(token);

    String userId = JwtUtil.getPayload(token);
    String ipAddress = request.getRemoteAddr();

    // userId와 ipAddress를 사용한 요청의 처리

    return ResponseEntity.ok().build();
}

여기서 JwtTokenProvider는 JWT의 유효성 검증, 페이로드 추출 등을 위해 미리 만들어둔 유틸클래스이다.

직접 구현하기

백문이 불여일타. 직접 Argument Resolver를 구현해보며 이해해보자. 우리는 Argument 유저의 접속 IP와 유저 ID를 가져와 UserDto 에 담아줄 것 이다.

@Data
public class UserDto {
    private final String id;
    private final String ipAddress;
}

HandlerMethodArgumentResolver 인터페이스

Argument Resolver를 만들기 위해서는 클래스가 HandlerMethodArgumentResolver 를 구현해야한다. HandlerMethodArgumentResolver 는 두개의 메소드를 가지고 있다.

supportsParameter() : 주어진 메소드의 파라미터가 이 Argument Resolver에서 지원하는 타입인지 검사한다. 지원한다면 true 를, 그렇지 않다면 false 를 반환한다.
resolveArgument() : 이 메소드의 반환값이 대상이 되는 메소드의 파라미터에 바인딩된다.

UserArgumentResolver 구현

나는 아래와 같이 UserArgumentResolver 를 구현했다.

public class UserArgumentResolver implements HandlerMethodArgumentResolver {
    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.getParameterType().equals(UserDto.class);
    }

    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
                                  NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
        HttpServletRequest httpServletRequest = (HttpServletRequest) webRequest.getNativeRequest();

        String token = JwtUtil.extract(httpServletRequest);
        JwtUtil.validateToken(token);

        String userId = JwtUtil.getPayload(token);
        String ipAddress = httpServletRequest.getRemoteAddr();

        return new UserDto(userId, ipAddress);
    }
}

supportsParameter() 에서는 parameter 객체의 getParameterType() 메소드를 통해 컨트롤러 메소드의 파라미터가 UserDto 타입인지 확인한다. 그리고 일치 여부를 boolean 타입으로 반환한다.

resolveArgument() 에서는 컨트롤러에서 반복된 HTTP 헤더로부터 JWT 가져오는 로직, JWT 검증 로직, JWT 페이로드 추출 로직, 클라이언트 IP 가져오기 로직을 넣어준다. 그리고 최종적으로 UserDto 를 생성해서 반환한다.

WebMvcConfigurer에서 Argument Resolver 등록

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
        resolvers.add(new UserArgumentResolver());
    }
}

WebMvcConfigurer 를 구현한 클래스에서 위와 같이 우리가 만든 UserArgumentResolver 를 Argument Resolver로 등록한다.

Controller에 Argument Resolver 구현

@PostMapping("/items")
public ResponseEntity<Void> createItem(UserDto userDto) {
    // UserDto를 사용한 요청의 처리
    return ResponseEntity.ok().build();
}

컨트롤러에 존재했던 복잡한 여러 로직들이 사라지고, 자동으로 컨트롤러 메소드 파라미터인 userDto 에 바인딩되는 것을 확인할 수 있다.

어노테이션으로 제한하기

위와 같이 구현하면 많은 중복 로직이 사라질 수 있다. 하지만, 특정한 부분에서만 자동으로 객체가 Argument Resolver를 통해 바인딩되도록 만들고 싶은 경우가 있을 것 이다. 이를 커스텀 어노테이션을 만들어서 해결할 수 있다. 아래와 같은 User 라는 어노테이션을 만든다.

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface User {
}

그리고 아래와 같이 Argument Resolver에서 hasParameterAnnotaion() 이라는 메소드로 파라미터의 어노테이션으로 Argument Resolver 적용 대상을 제한할 수 있다.

public class UserArgumentResolver implements HandlerMethodArgumentResolver {
    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.getParameterType().equals(UserDto.class) &&
                parameter.hasParameterAnnotation(User.class); // 추가됨
    }

		// ...
}

그렇다면 아래와 같이 @User 가 붙은 파라미터에만 UserDto 가 바인딩될 것 이다.

@PostMapping("/items")
public ResponseEntity<Void> createItem(UserDto userDto) {
    // UserDto(id=null, ipAddress=null)
    return ResponseEntity.ok().build();
}

@PostMapping("/items")
public ResponseEntity<Void> createItem(@User UserDto userDto) {
    // UserDto(id=devHudi, ipAddress=0:0:0:0:0:0:0:1)
    return ResponseEntity.ok().build();
}