SpringBoot中使用Filter、Interceptor和Aop拦截REST服务

目录

过滤器（Filter）：

1. 注解方式：

2. 配置文件方式：

拦截器（Interceptor）

切片（Aspect）

---

在SpringBoot中使用REST服务时，往往需要对controller层的请求进行拦截或者获取请求数据和返回数据，就需要过滤器、拦截器或者切片。

过滤器（Filter）：对HttpServletRequest处理，也可以对HttpServletResponse进行后处理，无法获取请求方法的信息。

拦截器（Interceptor）：可以获取HttpServletRequest、HttpServletResponse的数据，也可以获取请求方法的信息，但是无法获取请求的参数和返回参数。

切片（Aspect）：AOP的切片可以获取请求的参数和返回的值，但是无法获HttpServletRequest、HttpServletResponse的数据。

执行请求的处理顺序：过滤器（Filter）> 拦截器（Interceptor）> 切片（Aspect）

过滤器（Filter）：

1. 注解方式：

项目启动类，需要加上 @ServletComponentScan 注解

TestFilter 使用注解的方式过滤，在class上面加上 @Component

import org.springframework.stereotype.Component;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.nio.charset.StandardCharsets;

/**
 * TestFilter过滤器
 */
@Component
@WebFilter(urlPatterns = "/*")
public class TestFilter implements Filter {

    /**
     * 销毁时执行
     */
    @Override
    public void destroy() {
        System.out.println("===== 销毁 TestFilter过滤器 =====");
    }

    /**
     * 逻辑代码执行
     * @param request
     * @param response
     * @param chain
     */
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        System.out.println("===== TestFilter过滤器，开始 =====");
        long start = new Date().getTime();
        chain.doFilter(request, response);
        System.out.println("TestFilter过滤器，耗时:" + (new Date().getTime() - start));
        System.out.println("===== TestFilter过滤器，结束 =====");
    }

    /**
     * 加载前执行
     * @param filterConfig
     */
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("===== 初始化 TestFilter过滤器 =====");
    }

}

属性释义

属性名	类型	释义
filterName	String	指定过滤器的 name 属性，等价于
value	String[]	该属性等价于 urlPatterns 属性。但是两者不应该同时使用。
urlPatterns	String[]	指定一组过滤器的 URL 匹配模式。等价于标签。
servletNames	String[]	指定过滤器将应用于哪些 Servlet。取值是 @WebServlet 中的 name 属性的取值，或者是 web.xml 中的取值。
dispatcherTypes	DispatcherType	指定过滤器的转发模式。具体取值包括：ASYNC、ERROR、FORWARD、INCLUDE、REQUEST。
initParams	WebInitParam[]	指定一组过滤器初始化参数，等价于标签。
asyncSupported	boolean	声明过滤器是否支持异步操作模式，等价于标签。
description	String	该过滤器的描述信息，等价于标签。
displayName	String	该过滤器的显示名，通常配合工具使用，等价于标签。

2. 配置文件方式：

TestFilter 使用配置文件的方式过滤，添加过滤文件WebConfig

使用这种方式，TestFilter不需要加@Component

import org.springframework.stereotype.Component;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.nio.charset.StandardCharsets;

/**
 * TestFilter过滤器
 */
public class TestFilter implements Filter {

    /**
     * 销毁时执行
     */
    @Override
    public void destroy() {
        System.out.println("===== 销毁 TestFilter过滤器 =====");
    }

    /**
     * 逻辑代码执行
     * @param request
     * @param response
     * @param chain
     */
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        System.out.println("===== TestFilter过滤器，开始 =====");
        long start = new Date().getTime();
        chain.doFilter(request, response);
        System.out.println("TestFilter过滤器，耗时:" + (new Date().getTime() - start));
        System.out.println("===== TestFilter过滤器，结束 =====");
    }

    /**
     * 加载前执行
     * @param filterConfig
     */
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("===== 初始化 TestFilter过滤器 =====");
    }

}

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.WebMvcConfigurerAdapter;
import java.util.ArrayList;
import java.util.List;

/**
 * 自定义配置URL拦截器
 */
@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {
    /**
     * 自定义配置URL拦截
     * @return
     */
    @Bean
    public FilterRegistrationBean timeFilter() {
        FilterRegistrationBean registrationBean = new FilterRegistrationBean();
        ResponseFilter filter = new ResponseFilter();
        registrationBean.setFilter(filter);
        List<String> urls = new ArrayList<>();
        // 获取所有请求
        // urls.add("/*");
        // 这里可以配置指定的url
        urls.add("/test/list");
        registrationBean.setUrlPatterns(urls);
        return registrationBean;
    }
}

拦截器（Interceptor）

import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Date;

/**
 * Test 拦截器
 */
@Component
public class TestInterceptor implements HandlerInterceptor {
    /**
     * 在业务处理器处理请求之前被调用
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("在业务处理器处理请求之前被调用的方法");
        System.out.println(((HandlerMethod)handler).getBean().getClass().getName());
        System.out.println(((HandlerMethod)handler).getMethod().getName());
        request.setAttribute("startTime", new Date().getTime());
        return true;
    }

    /**
     * 在业务处理器处理请求完成之后，生成视图之前执行
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("===== 在业务处理器处理请求完成之后，生成视图之前执行的方法 =====");
        Long start = (Long) request.getAttribute("startTime");
        System.out.println("Test拦截器，耗时:" + (new Date().getTime() - start));

    }

    /**
     * 请求完成之后执行
     * @param request
     * @param response
     * @param handler
     * @param exception
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception exception) throws Exception {
        System.out.println("===== 请求完成之后执行的方法 =====");
        Long start = (Long) request.getAttribute("startTime");
        System.out.println("Test拦截器，耗时:" + (new Date().getTime() - start));
        System.out.println("异常："+ exception);
    }
}

切片（Aspect）

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;
import java.util.Date;

/**
 * Test 切面
 */
@Aspect
@Component
public class TestAspect {
    @Around("execution(* com.smart.controller.UserController.*(..))")
    public Object handleControllerMethod(ProceedingJoinPoint pjp) throws Throwable {
        System.out.println("===== Test切面，开始 =====");
        Object[] args = pjp.getArgs();
        for (Object arg : args) {
            //获取请求参数
            System.out.println("请求参数：" + arg);
        }
        long start = new Date().getTime();
        //获取返回值
        Object object = pjp.proceed();
        System.out.println("Test切面，耗时:" + (new Date().getTime() - start));
        System.out.println("===== Test切面，结束 =====");
        return object;
    }
}