[Spring] Spring MVC에서 WebConfig 다루기

WebConfig

 

_WebConfig_는 웹 구성에 대해 지정하는 내용이 담겨있는 설정 파일을 말한다.

_WebConfig_는 구현체이고 _WebMvcConfigure_ 인터페이스를 구현하여 작성할 수 있다. 이 _WebConfig_를 다루면 좋은 점은 Controller 단으로 오기 전이나 오고난 후, 혹은 그 사이에 인터셉터를 두는 등 다양한 방식으로 커스텀하는 것이 가능하다.

 

 

주로 자주 사용하는 것은 _View Controller_, _interceptors_, _ArgumentResolvers_인데, 어떤 방식으로 내 입맛에 맞도록 다룰 수 있는 지 한번 살펴보자.

 

 

 

 

 

 

View Controller

 

_View Controller_는 URL 매핑을 간단하게 처리할 수 있도록 한다. 사용함으로써 얻을 수 있는 이점은 개발 시간을 단축 시킬 수 있으며 URL과 뷰 이름을 매핑하는 것이 가능하다.

 

 

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/").setViewName("home");
    }
}

 

 

 

 

 

 

• _@Configuration_ 
  • 스프링 IoC 컨테이너가 초기화 될 때 실행된다.
  • Bean으로 등록한다.
• _@EnableWebMvc_
  • 스프링 MVC를 사용할 때 설정을 자동으로 활성화 해준다.
  • 사용 목적은 컨트롤러를 안쓰고 뷰를 매핑해주기 위함이다.

 

 

 

registry.addViewController("/login").setViewName("login").setStatusCode(HttpStatus.OK);

 

 

사용 방법은 위처럼, 경로와 뷰 이름, 그리고 상태 코드를 설정해 주면 된다.

 

 

 

 

 

 

Interceptor

 

_Intercepter_는 클라이언트의 요청과 서버의 응답 사이, 혹은 그 전 후에 위치하여 요청과 응답에 대한 처리를 한다. 일반적으로는 헤더 정보를 수정하거나 로그를 남기는 일을 한다.

 

 

사용되는 메서드는 _preHandle_, _postHandle_, _afterCompletion_이 있다. 말그대로 요청이 Controller로 도달하기 이전, Controller가 실행된 후이지만, View가 렌더링 되기 이전, View가 렌더링 된 후이다.

 

 

 

커스텀 Interceptor를 작성하기 위해서는 _HandlerInterceptor_에 정의된 해당 함수들을 구현하면 된다.

 

```java
@Component
public class CustomInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        ...
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        ...
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        ...
    }
}

 

 

 

 

정의한 Interceptor는 _WebConfig_에서 등록할 수 있다.

 

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {

    @Autowired
    private CustomInterceptor customInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(customInterceptor).addPathPatterns("/**");
    }
}

 

 

 

 

 

 

Argument Resolver

 

_ArgumentResolver_란 HTTP 요청 파라미터를 컨트롤러 메서드의 파라미터로 변환시키도록 도와주는 스페셜 빈이다.

커스텀으로 사용하기 위해서는 _HanlderMethodArgumentResolver_를 상속받아서 특정 메서드들을 오버라이드 해야 한다.

 

 

실제로 JWT와 같은 토큰 기반 인증 방식을 사용할 때 특히나 사용하면 좋다. 왜냐하면 어노테이션으로 인가 과정을 등록한다면, 반복적으로 토큰을 검사하여 ID 값을 꺼내오는 과정을 하지 않아도 되기 때문이다.

 

 

 

public class CustomArgumentResolver implements HandlerMethodArgumentResolver {

    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.getParameterType().equals(User.class);
    }

    @Override
    public Object resolveArgument(
                MethodParameter parameter, 
                ModelAndViewContainer mavContainer,
                NativeWebRequest webRequest, 
                WebDataBinderFactory binderFactory) throws Exception {

        HttpServletRequest request = (HttpServletRequest) webRequest.getNativeRequest();
        String name = request.getParameter("name");
        String email = request.getParameter("email");

        User user = new User(name, email);

        return user;
    }

}

 

 

• _supportsParameter_
  • true를 반환한다면 ResolveArgument를 통해 바인딩 된다.
  • false를 반환한다면, ResolveArgument도 실행되지 않는다.
  • 즉, Controller 메서드의 인자가 Argument Resolver에서 처리가능한 지 판단한다.
• _MethodParameter_
  • Controller 메서드의 파라미터 정보를 담는다.
  • 이걸 통해 파라미터의 타입이나 어노테이션을 가져올 수 있다.

 

다음은 JWT 토큰 기반 인증과정에 있어 _@Auth_라는 어노테이션 하나로 토큰 추출을 쉽게 가능하게 하도록 커스텀하는 코드이다.

 

@RequiredArgsConstructor
@Component
public class AuthArgumentResolver implements HandlerMethodArgumentResolver {

    private final JwtService jwtService;

    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.hasParameterAnnotation(Auth.class) && parameter.getParameterType().equals(Long.class);
    }

    @Override
    public Object resolveArgument(
            MethodParameter parameter,
            ModelAndViewContainer mavContainer,
            NativeWebRequest webRequest,
            WebDataBinderFactory binderFactory
    ) {
        Auth authAt = parameter.getParameterAnnotation(Auth.class);
        requireNonNull(authAt);
        String accessToken = extractAccessToken(webRequest);
        return jwtService.extractMemberId(accessToken);
    }

    private static String extractAccessToken(NativeWebRequest request) {
        String bearerToken = request.getHeader("Authorization");

        if (StringUtils.hasText(bearerToken) && bearerToken.startsWith("Bearer ")) {
            return bearerToken.substring(7);
        }

        throw new UnAuthorizedException("로그인 후 접근할 수 있습니다.");
    }
}

 

 

이제 만들어진 커스텀 _ArgumentResolver_를 등록시켜보자.

 

@RequiredArgsConstructor
@Configuration
public class AuthConfig implements WebMvcConfigurer {

    @Autowired
    private final AuthArgumentResolver authArgumentResolver;

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

 

 

_WebMvcConfigure_를 살펴보면, _addArgumentResolvers()_ 를 구현할 수 있도록 해두었다.

 

마지막으로 어노테이션으로 사용할 수 있겠끔 _@Auth_를 만들면 된다.

 

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

 

 

 

 

 

References

• https://engineerinsight.tistory.com/80
• https://hudi.blog/spring-argument-resolver/
• https://blog.advenoh.pe.kr/spring/HandlerMethodArgumentResolver-%EC%9D%B4%EB%9E%80/#google_vignette
• https://engineerinsight.tistory.com/79#google_vignette