[Spring] HandlerMethodArgumentResolver

• 안녕하세요~ 이전에 운영하던 블로그와 소스코드를 관리하는 GitHub가 따로 있습니다.

• 네이버 블로그

• GitHub

🐔

---

✔ HandlerMethodArgumentResolver 설명

 

 

안녕하세요~ 이번에 정리할 내용은 Spring의 HandlerMethodArgumentResolver 인터페이스 입니다.

HandlerMethodArgumentResolver 인터페이스는 Controller에서 특정 조건에 맞는 파라미터가 있을때 해당 값을 바인딩하는 인터페이스입니다.

 

보통 스프링의 Controller에서 @RequestBody 어노테이션을 통해 request의 Body 값을 받아올때

HandlerMethodArgumentResolver 를 사용해서 값을 바인딩 시켜 받아옵니다.

 

HandlerMethodArgumentResolver 인터페이스는 위와 같이 두 개의 메서드가 존재합니다.

따라서 HandlerMethodArgumentResolver 인터페이스를 구현하는 클래스는 아래 두 가지 메서드를 모두 구현해야 합니다.

 

• boolean supportsParameter(MethodParameter var1)

 

• Object resolveArgument(

        MethodParameter var1,

        @Nullable ModelAndViewContainer var2,

        NativeWebRequest var3, 

        @Nullable WebDataBinderFactory var4)

 

 

각 메서드와 파라미터가 의미하는바는 다음과 같습니다.

 

• supportsParameter 

    • 현재 resolver가 파라미터를 지원하면 true를, 그렇지 않으면 false를 리턴합니다

 

• resolveArgument

    • 실제 바인딩 할 객체를 리턴합니다.

    • 바인딩 할 객체에 대한 정보를 입력하고, 수정할 수 있는 메서드

    • 각 매개변수가 나타내는 의미는 다음과 같습니다.

    • MethodParameter var1

        • 확인할 메서드의 매개변수

        • 이 매개 변수는 위 supportsParameter에 의해 true가 반환되어야 함

    • ModelAndViewContainer var2

        • 현재 request에 대한 ModelAndViewContainer

    • NativeWebRequest var3

        • 현재 request

    • WebDataBinderFactory var4

        • WebDataBinder 인스턴스 생성을 위한 Factory

---

 

✔ HandlerMethodArgumentResolver 예제

 

 

이제 간단한 예제를 통해 알아보겠습니다.

 

 

 

1) Person 객체 생성

package com.github.prgrms.social.model.person;

import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;

public class Person {

    private final String name;
    private final int age;

    public String getName() {
        return name;
    }

    public int getAge() {
        return age;
    }

    public Person(String name, int age) {
        checkNotNull(name, "name must be provided.");
        checkArgument(age >= 0, "age must be greater than zero");

        this.name = name;
        this.age = age;
    }
}

 

 

 

2) resolver 작성

package com.github.prgrms.social.model.person;

import org.springframework.core.MethodParameter;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.support.WebDataBinderFactory;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.ModelAndViewContainer;

@Component
public class CustomHandlerMethodArgumentResolver implements HandlerMethodArgumentResolver {

    private static final String DEFAULT_PERSON_NAME = "JuHyun";
    private static final int DEFAULT_PERSON_AGE = 29;

    @Override
    public boolean supportsParameter(MethodParameter methodParameter) {
        return Person.class.isAssignableFrom(methodParameter.getParameterType());
    }

    @Override
    public Object resolveArgument(MethodParameter methodParameter, ModelAndViewContainer modelAndViewContainer, NativeWebRequest nativeWebRequest, WebDataBinderFactory webDataBinderFactory) throws Exception {
        return new Person(DEFAULT_PERSON_NAME, DEFAULT_PERSON_AGE);
    }
}

 

 

 

3) resolver 등록

package com.github.prgrms.social.configure;

import com.github.prgrms.social.model.person.CustomHandlerMethodArgumentResolver;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import java.util.List;

@Configuration
public class WebMvcConfigure implements WebMvcConfigurer {

    private final CustomHandlerMethodArgumentResolver customHandlerMethodArgumentResolver;

    public WebMvcConfigure(CustomHandlerMethodArgumentResolver customHandlerMethodArgumentResolver) {
        this.customHandlerMethodArgumentResolver = customHandlerMethodArgumentResolver;
    }

    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
        argumentResolvers.add(customHandlerMethodArgumentResolver);
    }
}

 

 

 

4) Controller 작성

package com.github.prgrms.social.controller;

import com.github.prgrms.social.model.person.Person;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class PersonController {

    @GetMapping("/person")
    public Person test(Person person) {
        return person;
    }
}

 

HandlerMethodArgumentResolver 인터페이스를 적용하기 위한 단계를 간단히 정리하면 다음과 같습니다.

 

 

1) 파라미터로 받을 클래스 생성

2) HandlerMethodArgumentResolver 인터페이스 구현체 생성

3) HandlerMethodArgumentResolver 구현체 resolver 등록

4) Controller 작성

 

 

위 과정을 통해 서버를 실행 한 후 localhost:8080/person 의 URL로 접속하면

resolver에 등록한 초기 Person 객체의 정보가 출력됩니다.

 

---

 

✔ References

velog.io/@kingcjy/Spring-HandlerMethodArgumentResolver%EC%9D%98-%EC%82%AC%EC%9A%A9%EB%B2%95%EA%B3%BC-%EB%8F%99%EC%9E%91%EC%9B%90%EB%A6%AC

 

docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/method/support/HandlerMethodArgumentResolver.html