springboot配置过滤器、监听器、拦截器

springboot配置过滤器监听器

在SpringBootApplication上使用**@ServletComponentScan**注解后，Servlet、Filter、Listener可以直接通过@WebServlet、@WebFilter、@WebListener注解自动注册，无需其他代码。

过滤器

@WebFilter("/*")//拦截那些请求路径
public class LoginFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        //乱码设置
        servletRequest.setCharacterEncoding("UTF-8");//请求
        servletResponse.setCharacterEncoding("UTF-8");//响应

        HttpServletRequest request = (HttpServletRequest) servletRequest;
        HttpServletResponse response = (HttpServletResponse) servletResponse;
        //处理调试时json中文乱码
        response.setContentType("text/json");
//        response.setHeader("Access-Control-Allow-Origin", "*");
        response.setHeader("Access-Control-Allow-Origin", "http://localhost:8080");
        response.setHeader("Access-Control-Allow-Credentials", "true");
        filterChain.doFilter(servletRequest, servletResponse);

        //处理多个
        /*String []  allowDomain= {"http://127.0.0.1:8080","http://192.168.1.178"};
        Set<String> allowedOrigins= new HashSet<>(Arrays.asList(allowDomain));
        String originHeader=(request.getHeader("Origin");
        if (allowedOrigins.contains(originHeader)) {
            response.setHeader("Access-Control-Allow-Origin", originHeader);
            response.setHeader("Access-Control-Allow-Methods", "POST, GET, OPTIONS, DELETE");
            response.setHeader("Access-Control-Max-Age", "3600");
            response.setHeader("Access-Control-Allow-Headers", "content-type, x-requested-with");
            response.setHeader("Access-Control-Allow-Credentials", "true");
        }*/
    }

    @Override
    public void destroy() {

    }
}

监听器

@WebListener
public class MyListener implements ServletContextListener {

    @Autowired
    private RedisService redisService;

    @Override
    public void contextInitialized(ServletContextEvent servletContextEvent) {
        System.out.println("监听器的初始化方法执行！");
        redisService.flushAll();
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        System.out.println("监听器的销毁方法执行！");

        //想在服务关闭时，清除redis缓存，目前方法都失败。问题暂时不知道
        System.out.println("监听器的销毁方法执行完成！");

    }
}

springboot配置拦截器

自定义拦截器类

public class LoginInterceptor implements HandlerInterceptor {

    @Autowired
    private RedisService redisService;

    //处理器方法映射之前执行
    //返回true，放行；false，不放行
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String path = request.getServletPath();
        /*System.out.println(path);
        String[] paths = {"/code", "/login", "/register", "/before/"};
        for (String s : paths) {
            if (path.contains(s)) {
                return true;
            }
        }*/


        String token = request.getParameter("token");
        if (path.contains("/formData/")) {
            MultipartHttpServletRequest req = (MultipartHttpServletRequest) request;
            token = req.getParameter("token");
        }
        System.out.println("token-----的值为-----" + token);

        //判断token为空，就是为登录
        if (token == null) {
            Result<String> result = new Result<>("403", "未登录，请先登录！");
            ObjectMapper objectMapper = new ObjectMapper();
            String json = objectMapper.writeValueAsString(result);
            response.getWriter().println(json);

            return false;
        } else if (!redisService.exists(token)) { //判断jedis中是否存在此token，不存在就是登录失效
            System.out.println(redisService.get(token));
            Result<String> result = new Result<>("403", "登录失效，请重新登录！");

            ObjectMapper objectMapper = new ObjectMapper();
            String json = objectMapper.writeValueAsString(result);
            response.getWriter().println(json);

            return false;
        } else {
            return true;
        }
    }

    //处理器方法映射执行之后会自动调用
    @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 {

    }
}

配置拦截器

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    /*
     * 拦截器配置
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注册自定义拦截器，添加拦截路径和排除拦截路径
        registry.addInterceptor(new LoginInterceptor()) // 添加拦截器
                .addPathPatterns("/**") // 添加拦截路径
                .excludePathPatterns(// 添加排除拦截路径
                        "/code", "/login", "/register", "/before/").order(0);//执行顺序
    }
}

如果拦截器中使用@Autowired注解，拦截器需要如下改造

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    //在此处将拦截器注册为一个bean，这样拦截器就可以使用@Autowired注入其他bean了。
    @Bean
    public LoginInterceptor getLoginInterceptor() {
        return new LoginInterceptor();
    }

    /*
     * 拦截器配置
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注册自定义拦截器，添加拦截路径和排除拦截路径
        //registry.addInterceptor(new LoginInterceptor()) // 添加拦截器
        registry.addInterceptor(getLoginInterceptor())
                .addPathPatterns("/**") // 添加拦截路径
                .excludePathPatterns(// 添加排除拦截路径
                        "/code", "/login", "/register", "/before/").order(0);//执行顺序
    }
}