ArgumentResolver 직접 어노테이션 만들기

공통으로 쓰는 코드일 경우, 특히나 로그인 같은 경우에는 컨트롤러 호출 전에 인터셉터에서 처리 하기보다 어노테이션을 만들어

필요한 컨트롤러에 삽입하는 것이 효과적이다.

 

    @GetMapping("/")
    public String homeLoginV3ArgumentResolver(
            @Login Member member, Model model, HttpServletRequest request){

        //아래 코드는 파라미터로 대체 될 수 있다.
        /*
        HttpSession session = request.getSession(false);
        if(session != null){
            return "home";
        }

        Member member = (Member)session.getAttribute(SessionConst.LOGIN_MEMBER);
        */
        if(member == null){
            return "home";
        }

        model.addAttribute("member",member);

        return "homelogin";
    }

 

위와 같은 코드에서 파라미터에 @Login 이라는 어노테이션을 만드려 한다.

 

package hello.login.web.argumentresolver;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.PARAMETER) //필수로 넣어줘야함 파라미터에 넣을 것이다.라는 뜻
@Retention(RetentionPolicy.RUNTIME) //어플리케이션이 기동되어 있을때 계속 유지, 리플렉션 등을 활용할 수 있도록 런타임까지 에노테이션 정보가 남아있음
public @interface Login {

}

 

먼저 어노테이션 자체를 만들어 준다.

 

package hello.login.web.argumentresolver;

import hello.login.domain.member.Member;
import hello.login.web.session.SessionConst;
import lombok.extern.slf4j.Slf4j;
import org.springframework.core.MethodParameter;
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;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

@Slf4j
public class LoginMemberArgumentResolver implements HandlerMethodArgumentResolver {

    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        log.info("supportsParameter 실행");

        // 요청한 컨트롤러 메소드에 @Login 어노테이션이 붙어 있는가 물어본는 것
        boolean hasLoginAnnotation = parameter.hasParameterAnnotation(Login.class);

        // parameter.getParameterType() 에서는 사용한 파라미터의 타입인 즉 현재로써는 Member가 된다.
        //public String homeLoginV3ArgumentResolver(
        // @Login Member member, Model model, HttpServletRequest request){
        boolean hasMemberType = Member.class.isAssignableFrom(parameter.getParameterType());


        return hasLoginAnnotation && hasMemberType; //두개가 만족 할 시에 아래의 resolveArgument가 작동한다.
    }

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

        log.info("resolveArgument 실행");

        HttpServletRequest request = (HttpServletRequest) webRequest.getNativeRequest();
        HttpSession session = request.getSession(false); //세션을 없으면 만들지 않음

        if(session == null){
            return null;
        }

        return session.getAttribute(SessionConst.LOGIN_MEMBER);
    }
}

 

HandlerMethodArgumentResolver

라는 인터페이스를 상속해 준 뒤에 오버라이드 해준다.

 

먼저 sopportsParameter가 먼저 실행 되며 요청에서 넘어오는 파라미터를 확인 할 수 있다.

1. 요청에 대한 것이 @Login 어노테이션이 붙어 있는지 확인한다.  
2. 파라미터에 Member에 대한 필드값이 있는지 확인한다.

값이 true 라면

 

resolveArgument 메소드를 실행한다.

 

그 전에 해줄 것이 남아있다.

 

package hello.login;

import hello.login.web.Interceptor.LogInterceptor;
import hello.login.web.Interceptor.LoginCheckInterceptor;
import hello.login.web.argumentresolver.LoginMemberArgumentResolver;
import hello.login.web.filter.LogFilter;
import hello.login.web.filter.LoginCheckFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import javax.servlet.Filter;
import java.util.List;

@Configuration
public class WebConfig implements WebMvcConfigurer {//WebMvcConfigurer은 인터셉터 등록 시 필요


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

    // 오버라이드 단축키 command + N 혹은 control + o
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LogInterceptor())
                .order(1)
                .addPathPatterns("/**")//허용 패턴
                .excludePathPatterns("/css/**","/*.ico","/error"); //미허용 패턴
        registry.addInterceptor(new LoginCheckInterceptor())
                .order(2)
                .addPathPatterns("/**")
                .excludePathPatterns("/","/members/add","/login","/logout",
                        "/css/**","/*.ico","/error");


    }

    //@Bean
    public FilterRegistrationBean logFilter(){
        FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
        filterRegistrationBean.setFilter(new LogFilter()); //만든 필터를 넣는다.
        filterRegistrationBean.setOrder(1); //작동 순서를 정한다.
        filterRegistrationBean.addUrlPatterns("/*"); //어떤 url일 때에 작동할지를 적는다.

        return filterRegistrationBean;

    }

    //@Bean
    public FilterRegistrationBean loginFilter(){
        FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
        filterRegistrationBean.setFilter(new LoginCheckFilter()); //만든 필터를 넣는다.
        filterRegistrationBean.setOrder(2); //작동 순서를 정한다.
        filterRegistrationBean.addUrlPatterns("/*"); //어떤 url일 때에 작동할지를 적는다.

        return filterRegistrationBean;

    }

}

 

WebConfig에 addArgumentResolvers를 오버라이드 해 사용해준다.

resolver에 만들었던 argumentResolver를 추가한다. (등록하는 것에 가깝다)

 

그럼 이제 해당 @Login 어노테이션을 사용한 컨트롤러를 호출하기 전에 LoginMemberArgumentResolver가 작동한다a