攔截請求的三種方式 Filter、Interceptor、Aspect

在 java web 開發中，咱們能夠經過三種方式攔截請求，分別是：Filter、Interceptor、Aspect，下面咱們來介紹一下這三種方式之間的異同點。

以一個簡單的 spring-boot 項目爲例，記錄 Controller 方法執行的時間。

項目結構

HelloController

@RestController
public class HelloController {

    @GetMapping("/hello")
    public Object sayHello(String name) {
        System.out.println("name: " + name);
        return "hello " + name;
    }

}

單元測試

先寫一個單元測試，驗證 HelloController.sayHello() 方法的正確性。

@RunWith(SpringRunner.class)
@SpringBootTest
public class HelloControllerTest {

    @Autowired
    private WebApplicationContext webApplicationContext;

    private MockMvc mockMvc;

    @Before
    public void setup() {
        mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();
    }

    @Test
    public void sayHello() throws Exception {
        // 模擬 get 請求
        mockMvc.perform(
                get("/hello") // get 請求 url /hello
                        .param("name", "tom") // 參數 name=tom
                        .contentType(MediaType.APPLICATION_JSON_UTF8)) // 設置請求頭 Content-Type = application/json;charset=UTF-8
                .andExpect(status().isOk()) // 指望返回的狀態碼爲200
                .andExpect(content().string("hello tom")); // 指望返回值爲"hello tom"
    }

}

經測試，HelloController.sayHello() 沒有問題。

Filter

新建 TimeFilter

@Component
public class TimeFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("time filter init");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("time filter start");
        long startTime = System.currentTimeMillis();

        filterChain.doFilter(servletRequest, servletResponse);

        long endTime = System.currentTimeMillis();
        System.out.println("time filter consume " + (endTime - startTime) + " ms");
        System.out.println("time filter end");
    }

    @Override
    public void destroy() {
        System.out.println("time filter init");
    }
}

啓動服務器，在瀏覽器輸入：http://localhost:8080/hello?name=tom 能夠在控制檯輸出以下結果：

time filter start
name: tom
time filter consume 3 ms
time filter end

能夠看到，filter 先執行，再到真正執行 HelloController.sayHello() 方法。

經過 TimeFilter.doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) 方法的參數能夠看出，咱們只能獲得原始的 request 和 response 對象，不能獲得這個請求被哪一個 Controller 以及哪一個方法處理了，使用Interceptor 就能夠得到這些信息。

Interceptor

新建 TimeInterceptor

@Component
public class TimeInterceptor extends HandlerInterceptorAdapter {

    private final NamedThreadLocal<Long> startTimeThreadLocal = new NamedThreadLocal<>("startTimeThreadLocal");

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("time interceptor preHandle");

        HandlerMethod handlerMethod = (HandlerMethod) handler;
        // 獲取處理當前請求的 handler 信息
        System.out.println("handler 類：" + handlerMethod.getBeanType().getName());
        System.out.println("handler 方法：" + handlerMethod.getMethod().getName());
        
        MethodParameter[] methodParameters = handlerMethod.getMethodParameters();
        for (MethodParameter methodParameter : methodParameters) {
            String parameterName = methodParameter.getParameterName();
            // 只能獲取參數的名稱，不能獲取到參數的值
            //System.out.println("parameterName: " + parameterName);
        }

        // 把當前時間放入 threadLocal
        startTimeThreadLocal.set(System.currentTimeMillis());

        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("time interceptor postHandle");
    }

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

        // 從 threadLocal 取出剛纔存入的 startTime
        Long startTime = startTimeThreadLocal.get();
        long endTime = System.currentTimeMillis();

        System.out.println("time interceptor consume " + (endTime - startTime) + " ms");

        System.out.println("time interceptor afterCompletion");
    }
}

註冊 TimeInterceptor

把 TimeInterceptor 注入 spring 容器

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {

    @Autowired
    private TimeInterceptor timeInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(timeInterceptor);
    }
}

啓動服務器，在瀏覽器輸入：http://localhost:8080/hello?name=tom 能夠在控制檯輸出以下結果：

time filter start
time interceptor preHandle
handler 類：com.nextyu.demo.web.controller.HelloController
handler 方法：sayHello
name: tom
time interceptor postHandle
time interceptor consume 40 ms
time interceptor afterCompletion
time filter consume 51 ms
time filter end

能夠看到，filter 先於 interceptor 執行，再到真正執行 HelloController.sayHello() 方法。

經過 interceptor 方法上的 handler 參數，咱們就能夠獲得這個請求被哪一個 Controller 以及哪一個方法處理了。可是不能直接獲取到這個方法上的參數值（在這裏就是 HelloController.sayHello(String name) 方法參數 name 的值），經過 Aspect 就能夠獲取到。

Aspcet

新建 TimeAspect

@Aspect
@Component
public class TimeAspect {

    @Around("execution(* com.nextyu.demo.web.controller.*.*(..))")
    public Object handleControllerMethod(ProceedingJoinPoint pjp) throws Throwable {

        System.out.println("time aspect start");

        Object[] args = pjp.getArgs();
        for (Object arg : args) {
            System.out.println("arg is " + arg);
        }

        long startTime = System.currentTimeMillis();

        Object object = pjp.proceed();

        long endTime = System.currentTimeMillis();
        System.out.println("time aspect consume " + (endTime - startTime) + " ms");

        System.out.println("time aspect end");

        return object;
    }

}

啓動服務器，在瀏覽器輸入：http://localhost:8080/hello?name=tom 能夠在控制檯輸出以下結果：

time filter start
time interceptor preHandle
handler 類：com.nextyu.demo.web.controller.HelloController
handler 方法：sayHello
time aspect start
arg is tom
name: tom
time aspect consume 0 ms
time aspect end
time interceptor postHandle
time interceptor consume 2 ms
time interceptor afterCompletion
time filter consume 4 ms
time filter end

能夠看到，filter 先執行，再到 interceptor 執行，再到 aspect 執行，再到真正執行 HelloController.sayHello() 方法。

咱們也獲取到了 HelloController.sayHello(String name) 方法參數 name 的值。

請求攔截過程圖

總結

• Filter 是 java web 裏面的，確定獲取不到 spring 裏面 Controller 的信息。
• Interceptor、Aspect 是和 spring 相關的，因此能獲取到 Controller 的信息。

源碼地址

• https://github.com/nextyu/request-interception-demo