JavaWeb三大组件之Filter和Listener

Filter过滤器

• Filter 过滤器它是 JavaWeb 的三大组件之一。三大组件分别是：Servlet 程序、Listener 监听器、Filter 过滤器
• Filter 过滤器它是 JavaEE 的规范。也就是接口
• Filter 过滤器它的作用是：拦截请求，过滤响应。
• 拦截请求常见的应用场景有： 1、权限检查 2、日记操作 3、事务管理 ……等等

主要用于对用户请求进行预处理，也可以对HttpServletResponse进行后处理。使用Filter的完整流程：Filter对用户请求进行预处理，接着将请求交给Servlet进行处理并生成响应，最后Filter再对服务器响应进行后处理。

（在HttpServletRequest到达 Servlet 之前，拦截客户的HttpServletRequest 。根据需要检查HttpServletRequest，也可以修改HttpServletRequest 头和数据。HttpServletResponse到达客户端之前，拦截HttpServletResponse 。根据需要检查HttpServletResponse，也可以修改HttpServletResponse头和数据。）

Filter 过滤器的使用步骤：

• 编写一个类去实现 Filter 接口
• 实现过滤方法 doFilter()
• 到web.xml 中去配置 Filter 的拦截路径

public class AdminFilter implements Filter {
     
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
     
    }
    
    //doFilter方法，专门用于拦截请求。可以做权限检查
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
            throws IOException, ServletException {
     
        HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
        HttpSession session = httpServletRequest.getSession();
        Object user = session.getAttribute("user"); // 如果等于null，说明还没有登录
        if (user == null) {
     
            servletRequest.getRequestDispatcher("/login.jsp").forward(servletRequest, servletResponse);
            return;
        } else {
      // 让程序继续往下访问用户的目标资源 
            filterChain.doFilter(servletRequest, servletResponse);
        }
    }

    @Override
    public void destroy() {
     
    }
}

<filter>
    
    <filter-name>AdminFilterfilter-name>
    
    <filter-class>com.xingyu.filter.AdminFilterfilter-class>
filter>
<filter-mapping> 
     
    <filter-name>AdminFilterfilter-name> 
     
    <url-pattern>/admin/*url-pattern>
filter-mapping>

Filter 的生命周期包含几个方法：

• 构造器方法
• init 初始化方法
  • 第 1，2 步，在 web 工程启动的时候执行（Filter 已经创建）
• doFilter 过滤方法
  • 第 3 步，每次拦截到请求，就会执行
• destroy 销毁
  • 第 4 步，停止 web 工程的时候，就会执行（停止 web 工程，也会销毁 Filter 过滤器）

---

FilterConfig 类

是Filter 过滤器的配置文件类。 Tomcat 每次创建 Filter 的时候，也会同时创建一个 FilterConfig 类，这里包含了 Filter 配置文件的配置信息。

FilterConfig 类的作用是获取 filter 过滤器的配置内容：

• 获取 Filter 的名称 filter-name 的内容
• 获取在 Filter 中配置的 init-param初始化参数
• 获取 ServletContext 对象

	private FilterConfig filterConfig;
	@Override
	public void init(FilterConfig filterConfig) throws ServletException {
     
    	this.filterConfig = filterConfig;
	}
  	@Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) 																throws IOException, ServletException {
     
        System.out.println("Filter 的 init(FilterConfig filterConfig)初始化");
        System.out.println("filter-name 的值是：" + filterConfig.getFilterName());
        //获取在web.xml中配置的init-param初始化参数
        System.out.println("初始化参数 username 的值是：" + filterConfig.getInitParameter("username"));
        System.out.println("初始化参数 url 的值是：" + filterConfig.getInitParameter("url"));
        //获取ServletContext对象
        System.out.println(filterConfig.getServletContext());
    }

<filter>
    
    <filter-name>AdminFilterfilter-name>
    
    <filter-class>com.xingyu.filter.AdminFilterfilter-class>
    <init-param> 
        <param-name>usernameparam-name> 
        <param-value>rootparam-value>
    init-param>
    <init-param> 
        <param-name>urlparam-name> 
        <param-value>jdbc:mysql://localhost3306/testparam-value>
    init-param>
filter>
<filter-mapping>
        
    <filter-name>AdminFilterfilter-name>
        
    <url-pattern>/admin/*url-pattern>
filter-mapping>

---

Filter拦截路径

• 精确匹配：
  • /target.jsp
  • 该路径配置表示请求地址必须为：http://ip:port/工程路径/target.jsp
• 目录匹配
  • /admin/*
  • 该路径配置表示请求地址必须为：http://ip:port/工程路径/admin/*
• 后缀名匹配
  • *.html
  • 该路径配置表示请求地址必须以.html 结尾才会拦截到
  • *.do
  • 该路径配置表示请求地址必须以.do 结尾才会拦截到
  • *.action
  • 该路径配置表示请求地址必须以.action 结尾才会拦截到

注意：Filter 过滤器它只关心请求的地址是否匹配，不关心请求的资源是否存在。

---

FilterChain 过滤器链

方法： filterChain.doFilter(servletRequest,servletResponse);

作用：1.执行下一个Filter过滤器（如果有的话）；2.执行目标资源；

特点：1.所有Filter和目标资源默认都执行在同一个线程中；2.多个Filter共同执行时，使用同一个Request请求对象；

注意：如果web.xml中配置了多个Filter过滤器，那么执行顺序按照在文件中的排列顺序由上往下依次执行。

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
     
        HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
        Object user = httpServletRequest.getSession().getAttribute("user");
        if (user == null) {
            		httpServletRequest.getRequestDispatcher("/pages/user/login.jsp").forward(servletRequest,servletResponse);
        } else {
      
            filterChain.doFilter(servletRequest,servletResponse);
        }
    }

---

ThreadLocal

• ThreadLocal 的作用，它可以解决多线程的数据安全问题。
• ThreadLocal 可以给当前线程关联一个数据。（可以是普通变量，可以是对象，也可以是数组，集合）
• ThreadLocal 的特点：
  • ThreadLocal 可以为当前线程关联一个数据。（它可以像Map 一样存取数据，key 为当前线程）
  • 每一个 ThreadLocal 对象，只能为当前线程关联一个数据，如果要为当前线程关联多个数据，就需要使用多个 ThreadLocal 对象实例。
  • 每个 ThreadLocal 对象实例定义的时候，一般都是 static 类型。
  • ThreadLocal 中保存数据，在线程销毁后，会由 JVM虚拟自动释放。

---

使用 Filter 和 ThreadLocal 组合管理事务

使用 ThreadLocal 可以确保所有 dao 操作都在同一个 Connection 连接对象中完成。常用于需要事务操作的情况，比如支付订单、清空购物车等。

ThreadLocal 结合单例模式获取数据库连接：

public class JdbcUtils {
     
    private static DruidDataSource dataSource;
    private static ThreadLocal<Connection> conns = new ThreadLocal<Connection>();
    static {
      
        try {
      
            Properties properties = new Properties(); // 读取jdbc.properties属性配置文件 
            InputStream inputStream = JdbcUtils.class.getClassLoader().
                getResourceAsStream("jdbc.properties"); 
            // 从流中加载数据
            properties.load(inputStream); 
            // 创建数据库连接池 
            dataSource = (DruidDataSource) DruidDataSourceFactory.createDataSource(properties);
        } catch (Exception e) {
      
            e.printStackTrace();
        } 
    }
    
    public static Connection getConnection(){
      
        Connection conn = conns.get();
        if (conn == null) {
      
            try {
      
                conn = dataSource.getConnection();//从数据库连接池中获取连接 
                conns.set(conn); // 保存到ThreadLocal对象中，供后面的jdbc操作使用
                conn.setAutoCommit(false); // 设置为手动管理事务
            } catch (SQLException e) {
      
                e.printStackTrace();
            }
        } return conn;
    }
    
    public static void commitAndClose(){
     
        ...
        ...
        //没有异常，则提交事务，并且关闭连接
        //最后一定要执行remove操作，否则就会出错。（因为Tomcat服务器底层使用了线程池技术） 
        conns.remove();
    }
    public static void rollbackAndClose(){
     
        ...
        ...
        //捕获到异常，则回滚事务，且关闭连接
        conns.remove();
    }
}
    

---

Listener监听器

• Listener 监听器它是 JavaWeb 的三大组件之一。JavaWeb 的三大组件分别是：Servlet 程序、Filter 过滤器、Listener 监听器。
• Listener 它是 JavaEE 的规范，就是接口
• 监听器的作用是，监听某种事物的变化。然后通过回调函数，反馈给客户（程序）去做一些相应的处理

ServletContextListener 它可以监听 ServletContext 对象的创建和销毁。 ServletContext 对象在 web 工程启动的时候创建，在 web 工程停止的时候销毁。 监听到创建和销毁之后都会分别调用 ServletContextListener 监听器的方法反馈。

使用 ServletContextListener 监听器监听 ServletContext 对象的使用步骤如下：

• 编写一个类去实现 ServletContextListener
• 实现其两个回调方法
• 到web.xml 中去配置监听器

public class MyServletContextListenerImpl implements ServletContextListener {
     
    @Override
    public void contextInitialized(ServletContextEvent sce) {
     
        System.out.println("ServletContext 对象被创建了");
    }
    
    @Override
    public void contextDestroyed(ServletContextEvent sce) {
     
        System.out.println("ServletContext 对象被销毁了");
    }
}

<listener>
    <listener-class>com.xingyu.listener.MyServletContextListenerImpllistener-class>
listener>