[스프링] ArgumentResolver 사용하기. 어노테이션은 필요한가?

오늘은 스프링 mvc 에서 제공하는 ArgumentResolver를 직접 구현하는 방법을 설명하려고 합니다.

컨트롤러 메서드 파라미터에 Model, ServletRequest 등등 정의만 하면 쉽게 가져다 쓸 수 있는 이유는 이 ArgumentResolver 덕분인데요, 커스텀하게 만들어서 자주 사용하기도 합니다.

 

자료를 찾다 보니 어노테이션을 붙이는 경우도 있고 안붙이기도 하는데

제 생각은 String, Integer 등 범용적인 클래스가 사용되는 경우는 식별을 위해 어노테이션을 붙이고

클래스가 명확하게 구분된다면 어노테이션을 붙이는 것은 불필요하다고 생각합니다.

 

예제를 만들기 위해 몇가지 추가 의존성을 추가했습니다.

// build.gradle
// apache lang3와 user-agent-parser를 함께 추가했습니다.

plugins {
    id 'org.springframework.boot' version '2.2.6.RELEASE'
    id 'io.spring.dependency-management' version '1.0.9.RELEASE'
    id 'java'
}

group = 'com.larry.blog'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'

configurations {
    compileOnly {
        extendsFrom annotationProcessor
    }
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-web'
    compileOnly 'org.projectlombok:lombok'
    annotationProcessor 'org.projectlombok:lombok'
    testImplementation('org.springframework.boot:spring-boot-starter-test') {
        exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
    }
    // https://mvnrepository.com/artifact/com.github.ua-parser/uap-java
    compile group: 'com.github.ua-parser', name: 'uap-java', version: '1.4.3'
    // https://mvnrepository.com/artifact/org.apache.commons/commons-lang3
    compile group: 'org.apache.commons', name: 'commons-lang3', version: '3.9'
}

test {
    useJUnitPlatform()
}

 

Ip를 파싱하는 기능과 User-Agent 정보를 파싱한 정보 두 가지를 각각 가져오기 위해서 아래와 같이 두 개의 ArgumentResolver를 만들었습니다. 

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

    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
        Parser parser = new Parser();
        return parser.parse(webRequest.getHeader("User-Agent"));
    }
}


public class ParsedIpArgumentResolver implements HandlerMethodArgumentResolver {

    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.hasParameterAnnotation(ParsedIp.class);
    }

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

        String ipAddress = request.getHeader("X-Forwarded-For");

        return StringUtils.defaultString(ipAddress,
                parameter.getParameterAnnotation(ParsedIp.class).defaultValue());
    }
}

 

 

보통 웹서버를 프록시로 이용하는 경우 X-Forwarded-For로 Ip를 가져오므로 (아닌 경우도 많습니다! IP를 파싱하는 방법에 대해서는 추가 포스팅 하겠습니다.^^)

헤더를 가져오고 만약 없다면 기본 값을 주도록 만들었습니다.

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
public @interface ParsedIp {

    String defaultValue() default "UNKNOWN";

}

 

스프링 MVC Configuration 에 등록해 줍니다.

@Configuration
public class WebConfig extends WebMvcConfigurationSupport {

    @Override
    protected void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
        super.addArgumentResolvers(argumentResolvers);
        argumentResolvers.add(new ParsedIpArgumentResolver());
        argumentResolvers.add(new ClientArgumentResolver());
    }

}

 

여기까지 했다면 사용하는 일만 남았습니다!

@RestController
@Slf4j
public class MyController {

    @GetMapping
    public ResponseEntity<Void> ipTest(@ParsedIp(defaultValue = "Hello ip") String ip,
                                       Client client) {
      log.info("ip address: {}", ip);
      log.info("client: {}", client.toString());
      return ResponseEntity.ok().build();
    }

}

컨트롤러 메서드에 위와 같이 필요한 파라미터를 선택적으로 등록하여 사용하면 됩니다.

 

간단히 테스트를 위해 요청을 해보면 (디바이스는 아이패드로 했습니다.)

아무것도 한게 없으니 백지죠

 

파싱된 결과물을 확인할 수 있습니다.

 

이렇게 해서 각자의 프로젝트에 유용하게 적용하시길 바랍니다~👍👍