[WEB] Interceptor, Sevlet, Filter, Resource Handler 알아보기

안녕하세요? 주니하랑 입니다.

오늘은 제목에 열거한 것들에 대해 한번 알아보는 것이에요.

우리가 WEB을 만들 때, 인증이나, 파일 업로드 등을 할 때 필요한 개념으로 어떤 식으로 요청을 받아드리는지 알아야 하는 부분이라 정리를 해 보았습니다.

 

그럼 바로 시작 해 볼게요!

 

 

---

 

🚀 Interceptor, Servlet Filter

Spring Filter와 Intercptor는 어떤 차이점이 있을까요?
Filter는 Servlet Container에 이 전에 공통적으로 처리해야 되는 부분을 처리할 수 있는 것이고, Interceptor는 AOP처럼 특정 시점에 가로채기 하여 어떤 행위를 할 수 있도록 하는 것이에요.

Spring 또는 Spring Boot 프레임워크로 Web Application을 개발하다 보면 아래와 같은 요구사항이 생기기 마련인 것이에요.

1. 특정 URL 진입 시 Login(인가)된 이용자만 접근 가능
2. 특정 URL 진입 시 JWT와 같은 Token값 검사
3. 특정 URL 진입 시 계정에 권한에 따라 접근 허용 및 차단(인가)
    이 부분은 View(Front End)에서도 처리가 가능합니다.

 

인터셉터는 무언가를 진행하기 전 특정 작업을 수행할 때 사용하는 것이에요.

JAVA WEB Programming에서는 이런 작업을 하는 기술로 Servlet Filter, Interceptor, AOP등을 사용할 수 있는 것이에요.

 

 

위의 사진은 Spring Request Life Cycle을 도식화한 자료인 것이에요.
사진을 보면 이용자의 요청 뒤에 Filter와 DispatcherServlet이 보이는 것이에요.

Interceptor는 Dispatcher Servlet 뒤의 Handler 영역에서 요청 정보를 처리하는 친구 인 것이에요.

Servlet Filter의 경우 J2EE의 표준 스펙에 정의되어 있지만, Interceptor는 Spring 프레임워크에서 자체 제공하는 기능 이랍니다.

 

1. Contoller에 들어오는 HttpRequest와 응답하는 HttpResponse 값을 가로채어 처리를 하는 역할
2. 관리자만 접근할 수 있는 관리자 인증의 용도로 많이 활용
3. Filter는 DispatcherServlet이 실행되기 전에 호출되나, Interceptor는 DispatcherServlet이 실행된 뒤 호출
4. Filter는 web.xml에서 관리하고, Interceptor는 spring-servlet.xml에서 관리

 

Servlet Filter는 Dispatcher Servlet 앞단에서 들어오는 요청 정보를 처리하고, Dispatcher Servle 전에 호출되기 때문에 Spring과 무관한 작업들을 처리 할 수 있는 것이에요.

 

이용자 요청(Request) -> Servlet Filter -> Dispatcher Servlet -> Interceptor -> Controller

 

 

 

 

    🔽  Filter, Interceptor, AOP

        📦 기능별 위치

Filter & Interceptor 위치 (출처: https://justforchangesake.wordpress.com/2014/05/07/spring-mvc-request-life-cycle/)

Filter와 Interceptor는 위의 그림에서 나오는 위치에 있어요.

AOP 위치 (출처: https://programming.vip/docs/spring-aop-basic-use.html)

AOP는 위의 위치에 있다고 볼 수 있어요.

        📦 Filter

Filter는 Web Application(웹 애플리케이션)에 등록해요. 즉, Request Thread가 Servlet Container에 도착하기 전에 수행 된답니다. Filter는 이용자의 요청 정보에 대한 검증을 할 수 있고, 필요에 따라 Data를 추가하거나, 변조할 수 있도록 해 주는 역할을 해요.

응답 정보에 대한 변경도 당연히 가능하답니다.

주로 전역적으로 처리해야 하는 인코딩, 보안 관련된 일을 이것을 통해 수행한다고 볼 수 있어요.

Filter 사용 예시

∙ 오류 처리 기능
∙ 인코딩 처리 기능
∙ 웹 보안 관련 기능
∙ Data 압축 및 변환 기능
∙ 요청, 응답에 대한 Loging
∙ Login 여부 확인 및 권한 검사와 같은 인증, 인가 기능



Filter Method

∙ init() : Filter 인스턴스 초기화
∙ doFilter() - 전/후 처리
∙ destroy() : Filter 인스턴스 종료


Filet 구현 예제

∙ Filter 구현
∙ doFilter() 재정의
∙ init(), destroy()는 Default Method이기 때문에 필요에 따라 구현 즉, 필수 사항 아님

import java.io.IOException;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import lombok.extern.log4j.Log4j2;

@Slf4j
public class JunyHarangFilter implements Filter {

    private final String value;

    public JunyHarangFilter(String value) {
        this.value = value;
    }


    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("==========\t" + value + " init filter");
    }

    @Override
    public void destroy() {
        log.info("==========\t" + value + " destroy filter");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        log.info("==========\t" + value + " before doFilter");
        chain.doFilter(request, response);
        log.info("==========\t" + value + " after doFilter");
    }
}

WebMvcConfiguration Class

∙ Spring Boot에서는 web.xml이 없기 때문에 FilterRegistrationBean을 정의하여 Filter를 등록
∙ Filter가 처리할 Path 지정
∙ WebMvcConfigurer 인터페이스 상속과는 무관

import junyhararang.in.action.filters.BlogFilter;
import junyhararang.in.action.interceptor.BlogHandlerInterceptor;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebMvcConfiguration implements WebMvcConfigurer {

    @Bean
    public FilterRegistrationBean filterRegistrationBean() {
        FilterRegistrationBean registrationBean = new FilterRegistrationBean(new BlogFilter(BlogFilter.class.getSimpleName()));
        registrationBean.addUrlPatterns("/*");
        registrationBean.setOrder(1);
        return registrationBean;
    }

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

        📦 Interceptor

인터셉터는 Spring Context에 등록해요.
Servlet Container를 지난 뒤 Controller에 요청이 전달되기 직전과 직후에 대한 처리를 담당하는 친구에요.
Spring Context 안에 존재하기 때문에 모든 Bean 객체에 접근할 수 있답니다.

여러 개의 인터셉터를 사용할 수 있고, Session 처리, Login 처리, 권한 처리, Program 실행 시간 계산등을 수행할 수 있어요.

Filter와 다르게 handlerMethod Parameter를 이용하여 AOP와 같은 기능 수행도 가능하답니다.


인터셉터 Method

∙ preHandler() - Controller 실행되기 전 작업 처리
∙ postHandler() - Controller 실행 뒤 View Page Randering 전 작업 처리
∙ afterCompletion() - View Page Randering 뒤 작업 처리



인터셉터 구현 예제

∙ HandlerInterceptor Interface 구현체

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import lombok.extern.log4j.Log4j2;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

@Slf4j
public class JunyHarangHandlerInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        log.info("==========\tinterceptor preHandle");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("==========\tinterceptor postHandle");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("==========\tinterceptor afterCompletion");
    }
}

WebMvcConfiguration Class

∙ WebMvcConfigurer Interface 구현
∙ addInterceptors() 재 구현을 통해 개발자가 직접 구현한 Interceptor 등록
∙ Interceptor 처리 Path 지정

import junyharang.in.action.filters.JunyHarangFilter;
import junyharang.in.action.interceptor.BlogHandlerInterceptor;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebMvcConfiguration implements WebMvcConfigurer {

    @Bean
    public FilterRegistrationBean filterRegistrationBean() {
        FilterRegistrationBean registrationBean = new FilterRegistrationBean(new BlogFilter(BlogFilter.class.getSimpleName()));
        registrationBean.addUrlPatterns("/*");
        registrationBean.setOrder(1);
        return registrationBean;
    }

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

        📦 AOP(Aspect Oriented Programming)

비즈니스 로직 수행에 있어 중복되는 Code를 줄이기 위한 프로그래밍 기법이에요.
비즈니스 로직의 특정 시점을 바라보고, 해당 시점이 수행되는 순간을 가로채어 전, 후 기능을 처리 한답니다.
주로 Loging, 트랜잭션 처리, Exception 처리 같은 기능을 담당하게 되요.

AOP 기능은 다양한 방법으로 처리가 가능하다는 점을 잊으면 안되요.


AOP 구현 예제

∙ Service Bean이 수행하는 Method 동작 시작 시점을 가로채어 전, 후 동작 수행
∙ Controller Bean이 수행하는 Method 동작 시작 시점을 가로채어 전, 후 동작 수행

import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;

@Slf4j
@Aspect
@Component
public class JunyHarangAop {

    @Around("execution(* blog.in.action.service.BlogService.*(..))")
    public Object aroundServiceFoo(ProceedingJoinPoint pjp) throws Throwable {
        log.info("==========\taround service before foo");
        Object result = pjp.proceed();
        log.info("==========\taround service after foo");
        return result;
    }

    @Around("execution(* blog.in.action.controller.BlogController.*(..))")
    public Object aroundControllerFoo(ProceedingJoinPoint pjp) throws Throwable {
        log.info("==========\taround controller before foo");
        Object result = pjp.proceed();
        log.info("==========\taround controller after foo");
        return result;
    }
}

 

🚀 Resource Handler

 

반응형

 

1. Servlet Container가 제공하는 DefaultServlet으로 Resource 영역에 존재하는 파일(/Images, /css, /js, /html 등)을 처리
2. 모든 톰켓에 등록
3. $CATALINA_BASE/conf/web.xml에 전역적으로 등록
4. DefaultServlet에 요청을 '위임'하여 Resource 요청 처리