乐趣区

关于java:原创Spring-Boot-过滤器监听器拦截器的使用

jiezi

关注“Java 后端技术全栈”**

回复“面试”获取全套大厂面试材料

在开发中用到过滤器、监听器、拦截器的场景十分多，明天就来聊聊这三者在日常开发中是如何应用的。

概念和应用场景

监听器

listener 是 servlet 标准中定义的一种非凡类。用于监听 servletContext、HttpSession 和 servletRequest 等域对象的创立和销毁事件。

实现形式：实现接口javax.servlet.http.HttpSessionListener

其次要可用于以下方面：

  • 统计在线人数和在线用户
  • 系统启动时加载初始化信息
  • 统计网站访问量
  • 记录用户拜访门路
过滤器

Filter 是 Servlet 技术中最实用的技术，Web 开发人员通过 Filter 技术，对 web 服务器治理的所有 web 资源。过滤器是在申请进入 tomcat 容器后，但申请进入 servlet 之前进行预处理的。申请完结返回也是，是在 servlet 解决完后，返回给前端之前。

  • 例如 Jsp, Servlet, 动态图片文件或动态 html 文件等进行拦挡，从而实现一些非凡的性能
  • 例如实现 URL 级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级性能

它次要用于对用户申请进行预处理，也能够对 HttpServletResponse 进行后处理。应用 Filter 的残缺流程：Filter 对用户申请进行预处理，接着将申请交给 Servlet 进行解决并生成响应，最初 Filter 再对服务器响应进行后处理。过滤器只在 servlet 前后起作用，所以它既不能捕捉异样，取得 bean 对象等

实现形式：实现接口javax.servlet.Filter

拦截器

拦截器中用于在某个办法或字段被拜访之前，进行拦挡而后，在之前或之后退出某些操作。比方日志，平安等。个别拦截器办法都是通过动静代理的形式实现。能够通过它来进行权限验证，或者判断用户是否登陆，或者是像 12306 判断以后工夫是否是购票工夫。通常在我的项目开发中基本上都会做一个异样对立拦挡解决的中央。比照一下其实咱们能够发现，过滤器能做的事拦截器都能做，二拦截器做的事过滤器不肯定做的了。

实现形式：实现org.springframework.web.servlet.HandlerInterceptor

三者比照

拦截器和过滤器：过滤前 -> 拦挡前 ->action/controller 执行 -> 拦挡后 -> 过滤后

为了让大家更好的了解，这里借用网上几张图：

实战

我的项目持续应用之前文章中用到的我的项目。

增加过滤器
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 javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;
public class UserFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {System.out.println(servletRequest.getParameter("name"));
        HttpServletRequest hrequest = (HttpServletRequest) servletRequest;
        HttpServletResponseWrapper wrapper = new HttpServletResponseWrapper((HttpServletResponse) servletResponse);
        // 过滤 URI 存在局部关键字的
        if (hrequest.getRequestURI().indexOf("/index") != -1 ||
                hrequest.getRequestURI().indexOf("/online") != -1 ||
                hrequest.getRequestURI().indexOf("/login") != -1
                ) {filterChain.doFilter(servletRequest, servletResponse);
        } else {wrapper.sendRedirect("/login");
        }
    }
    @Override
    public void destroy() {}
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {}}

自定义 Filter 还能够 应用 Servlet3.0 的注解进行配置第三步的 @WebFilter 就是 3.0 的注解

1）启动类外面减少 @ServletComponentScan，进行扫描

2）新建一个 Filter 类，implements Filter，并实现对应的接口

3) @WebFilter 标记一个类为 filter，被 spring 进行扫描

urlPatterns：拦挡规定，反对正则

4）管制 chain.doFilter 的办法的调用，来实现是否通过放行不放行，web 利用 resp.sendRedirect(“/index.html”); 场景：权限管制、用户登录 (非前端后端拆散场景) 等

增加监听器

监听器就会联想到监听器设计模式。就相当于于考试的时候，考官始终盯着你们，一旦有人有动静，考官就始终监督者你们，一旦有人舞弊，考官马上将其拿下。

import javax.servlet.http.HttpSessionEvent;
import javax.servlet.http.HttpSessionListener;
public class UserHttpSessionListener implements HttpSessionListener {
    // 监控在线人数
    public static int online = 0;
    @Override
    public void sessionCreated(HttpSessionEvent se) {System.out.println("创立 session");
        online++;
    }
    @Override
    public void sessionDestroyed(HttpSessionEvent se) {System.out.println("销毁 session");
    }
}
增加拦截器
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.PrintWriter;
public class UserInterceptor implements HandlerInterceptor {
    // 进入 controller 办法之前
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {System.out.println("preHandle 被调用");
        System.out.println(httpServletRequest.getParameter("username"));
        if(httpServletRequest.getParameter("username").equals("zhangsan")) {return true;}else {
            // 如果 false，进行流程，api 被拦挡
            // 通常验证是都登录，如果没有登录则进行登录操作
            PrintWriter printWriter = httpServletResponse.getWriter();
            printWriter.write("please login again!");
            return false;
        }
    }
    // 调用完 controller 之后，视图渲染之前
    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {System.out.println("postHandle 被调用");
    }
   // 整个实现之后，通常用于资源清理
    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {System.out.println("afterCompletion 被调用");
    }
}

preHandle 办法是在咱们的 controller 办法执行之前调用的。

增加配置类
package com.example.demo.config;
import com.example.demo.filter.UserFilter;
import com.example.demo.listener.UserHttpSessionListener;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.boot.web.servlet.ServletListenerRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
// 主拦截器，依据拦挡不同门路跳转不同自定义拦截器 
@Configuration
public class UserWebConfig implements WebMvcConfigurer {
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {registry.addViewController("/index").setViewName("login");
    }
    @SuppressWarnings({"rawtypes", "unchecked"})
    @Bean
    public FilterRegistrationBean filterRegist() {FilterRegistrationBean frBean = new FilterRegistrationBean();
        frBean.setFilter(new UserFilter());
        frBean.addUrlPatterns("/*");
        System.out.println("filter");
        return frBean;
    }
    @SuppressWarnings({"rawtypes", "unchecked"})
    @Bean
    public ServletListenerRegistrationBean listenerRegistry() {ServletListenerRegistrationBean srb = new ServletListenerRegistrationBean();
        srb.setListener(new UserHttpSessionListener());
        System.out.println("listener");
        return srb;
    }
}

测试类，写个 controller 来测试

package com.example.demo;
import java.util.Date;
import java.util.Map;
import java.util.UUID;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import com.example.demo.listener.UserHttpSessionListener;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class UserController {private final Logger logger = LoggerFactory.getLogger(UserController.class);
    @GetMapping("/welcome")
    public String welcome(Map<String, Object> model) {model.put("time", new Date());
        model.put("message", "hello world");
        return "welcome";
    }
    @RequestMapping("/login")
    @ResponseBody
    public Object login() {logger.info("-----login---");
        return "login";
    }
    @RequestMapping("/index/{name}")
    @ResponseBody
    public Object index(@PathVariable String name, HttpServletRequest request) {HttpSession session = request.getSession(true);
        session.setAttribute(UUID.randomUUID().toString(), name);
        return "index";
    }
    @RequestMapping("/online")
    @ResponseBody
    public Object online() {return "以后在线人数：" + UserHttpSessionListener.online + "人";}
}

以上便是明天分享的监听器、过滤器、拦截器的相干常识。倡议大家手动试试~

纸上得来终觉浅，绝知此事要躬行。

举荐浏览

必须要分明 Exception 和 Error 有什么区别

一条 SQL 语句在 MySQL 中是如何执行的？

面试被问：5 亿整数的大文件，排个序？

退出移动版