Filter过滤器和ThreadLocal和 Filter 和 ThreadLocal 组合管理事务

1、Filter 什么是过滤器

1、Filter 过滤器它是 JavaWeb 的三大组件之一。三大组件分别是：Servlet 程序、Listener 监听器、Filter 过滤器

2、Filter 过滤器它是 JavaEE 的规范。也就是接口

3、Filter 过滤器它的作用是：拦截请求，过滤响应。 拦截请求常见的应用场景有：

1、权限检查

2、日记操作

3、事务管理 ……等等

2、Filter 的初体验

要求：在你的 web 工程下，有一个 admin 目录。这个 admin 目录下的所有资源（html 页面、jpg 图片、jsp 文件、等等）都必 须是用户登录之后才允许访问。

思考：根据之前我们学过内容。我们知道，用户登录之后都会把用户登录的信息保存到 Session 域中。所以要检查用户是否 登录，可以判断 Session 中否包含有用户登录的信息即可！！！

  public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest servlet = (HttpServletRequest) servletRequest;
        Object user = servlet.getSession().getAttribute("user");
        System.out.println(user);
        if (user != null) {
            //若登录则放行
            filterChain.doFilter(servletRequest, servletResponse);
        } else {
            servletRequest.getRequestDispatcher("/login.jsp").forward(servletRequest, servletResponse);
        }
    }

Filter的工作流程：

public class AdminFilter implements Filter {
/**
* 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);
}
}
}

<!--filter 标签用于配置一个 Filter 过滤器-->
<filter>
<!--给 filter 起一个别名-->
<filter-name>AdminFilter</filter-name>
<!--配置 filter 的全类名-->
<filter-class>com.atguigu.filter.AdminFilter</filter-class>
</filter>
<!--filter-mapping 配置 Filter 过滤器的拦截路径-->
<filter-mapping>
<!--filter-name 表示当前的拦截路径给哪个 filter 使用-->
<filter-name>AdminFilter</filter-name>
<!--url-pattern 配置拦截路径
/ 表示请求地址为：http://ip:port/工程路径/ 映射到 IDEA 的 web 目录
/admin/* 表示请求地址为：http://ip:port/工程路径/admin/*
-->
<url-pattern>/admin/*</url-pattern>
</filter-mapping>

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

1、构造器方法

2、init 初始化方法 第 1，2 步，在 web 工程启动的时候执行（Filter 已经创建）

3、doFilter 过滤方法 第 3 步，每次拦截到请求，就会执行

4、destroy 销毁 第 4 步，停止 web 工程的时候，就会执行（停止 web 工程，也会销毁 Filter 过滤器

4、FilterConfig 类

FilterConfig 类见名知义，它是 Filter 过滤器的配置文件类。

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

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

1、获取 Filter 的名称 filter-name 的内容

2、获取在 Filter 中配置的 init-param 初始化参数

3、获取 ServletContext 对象

*     FilterConfig类
*     他是filter过滤器的配置文件类
*     Tomcat每次创建Filter的时候也会创建又给FilterConfigl类，这里包含了Filter配置文件的配置信息
*     作用：获取Filter过滤器的配置内容
*           1.获取Filter的名称的Filter-name的内容
*           2.获取Filter中配置的init-param初始化参数        //通过名字获取
*           3.获取ServletContext对象

public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("2.Filter 的 init(FilterConfig filterConfig)初始化");
// 1、获取 Filter 的名称 filter-name 的内容
System.out.println("filter-name 的值是：" + filterConfig.getFilterName());
// 2、获取在 web.xml 中配置的 init-param 初始化参数
System.out.println("初始化参数 username 的值是：" + filterConfig.getInitParameter("username"));
System.out.println("初始化参数 url 的值是：" + filterConfig.getInitParameter("url"));
// 3、获取 ServletContext 对象
System.out.println(filterConfig.getServletContext());
}

<!--filter 标签用于配置一个 Filter 过滤器-->
<filter>
<!--给 filter 起一个别名-->
<filter-name>AdminFilter</filter-name>
<!--配置 filter 的全类名-->
<filter-class>com.atguigu.filter.AdminFilter</filter-class>
<init-param>
<param-name>username</param-name>
<param-value>root</param-value>
</init-param>
<init-param>
<param-name>url</param-name>
<param-value>jdbc:mysql://localhost3306/test</param-value>
</init-param>
</filter>

5、FilterChain 过滤器链

Filter 过滤器 Chain 链，链条 FilterChain 就是过滤器链（多个过滤器如何一起工作）

*        FilterChain 过滤器链
*        Filter 过滤器
*        Chain 链，链条
*        FilterChain多个过滤器一起使用
*
*        特点：
*         1.默认在同一个线程中执行
*         2.共享同一个requset域

 6、Filter 的拦截路径

  FilterChain.doFilter()方法的作用：
*         1.执行完前一个之后，执行后面的Filter过滤器(如果有);
*         2.执行目标资源(如果前面没有Filter过滤器)
*
*         如果有多个过滤器一起使用，他们是按照在xml中的配置文件的先后顺序来运行的
*
*         Filter拦截配置的三种配置方式:
*         精准匹配:Http://ip:port/工程名/目录/target.jsp
*         目录匹配:/目录名/*
*         后缀名匹配：*.html  只拦截后缀名为html的文件
*                    *.abc   只拦截后缀名为abc的文件
*                    这种方式它不关你文件存不存在，只要你是这个后缀名就会拦截

-精确匹配 /target.jsp

以上配置的路径，表示请求地址必须为：http://ip:port/工程路径/target.jsp

--目录匹配 /admin/* 以上配置的路径，表示请求地址必须为：http://ip:port/工程路径/admin/*

--后缀名匹配 *.html 以上配置的路径，表示请求地址必须以.html 结尾才会拦截到

*.do 以上配置的路径，表示请求地址必须以.do 结尾才会拦截到

*.action 以上配置的路径，表示请求地址必须以.action 结尾才会拦截到 Filter

过滤器它只关心请求的地址是否匹配，不关心请求的资源是否存在！！！

7、书城第八阶段：

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

    <filter>
        <filter-name>Filter1</filter-name>
        <filter-class>web.Filter1</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>Filter1</filter-name>
        <url-pattern>/pages/manager/*</url-pattern>
        <url-pattern>/client/OrderServlet</url-pattern>
        <url-pattern>/manager/bookServlet</url-pattern>
    </filter-mapping>

2、ThreadLocal 的使用

ThreadLocal 的作用，它可以解决多线程的数据安全问题。

ThreadLocal 它可以给当前线程关联一个数据（可以是普通变量，可以是对象，也可以是数组，集合）

ThreadLocal 的特点： 1、ThreadLocal 可以为当前线程关联一个数据。（它可以像 Map 一样存取数据，key 为当前线程）

2、每一个 ThreadLocal 对象，只能为当前线程关联一个数据，如果要为当前线程关联多个数据，就需要使用多个 ThreadLocal 对象实例。

3、每个 ThreadLocal 对象实例定义的时候，一般都是 static 类型 4、ThreadLocal 中保存数据，在线程销毁后。会由 JVM 虚拟自动释放。

public class OrderService {
public void createOrder(){
String name = Thread.currentThread().getName();
System.out.println("OrderService 当前线程[" + name + "]中保存的数据是：" +
ThreadLocalTest.threadLocal.get());
new OrderDao().saveOrder();
}
}
public class OrderDao {
public void saveOrder(){
String name = Thread.currentThread().getName();
System.out.println("OrderDao 当前线程[" + name + "]中保存的数据是：" +
ThreadLocalTest.threadLocal.get());
}
}
public class ThreadLocalTest {
// public static Map<String,Object> data = new Hashtable<String,Object>();
public static ThreadLocal<Object> threadLocal = new ThreadLocal<Object>();
private static Random random = new Random();
public static class Task implements Runnable {
@Override
public void run() {
// 在 Run 方法中，随机生成一个变量（线程要关联的数据），然后以当前线程名为 key 保存到 map 中
Integer i = random.nextInt(1000);
// 获取当前线程名
String name = Thread.currentThread().getName();
System.out.println("线程["+name+"]生成的随机数是：" + i);
// data.put(name,i);
threadLocal.set(i);
try {
Thread.sleep(3000);
} catch (InterruptedException e) {
e.printStackTrace();
}
new OrderService().createOrder();
// 在 Run 方法结束之前，以当前线程名获取出数据并打印。查看是否可以取出操作
// Object o = data.get(name);
Object o = threadLocal.get();
System.out.println("在线程["+name+"]快结束时取出关联的数据是：" + o);
}
}
public static void main(String[] args) {
for (int i = 0; i < 3; i++){
new Thread(new Task()).start();
}
}

3、使用 Filter 和 ThreadLocal 组合管理事务

3.1、使用 ThreadLocal 来确保所有 dao 操作都在同一个 Connection 连接对象中完成

工具类的改变

package utils;

import com.alibaba.druid.pool.DruidDataSource;
import com.alibaba.druid.pool.DruidDataSourceFactory;
import com.alibaba.druid.util.JdbcUtils;

import java.io.InputStream;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.Properties;

public class JDBCutils {
    private static DruidDataSource dataSource;
    private static ThreadLocal<Connection>threadLocal = new ThreadLocal<Connection>();
    static {
        try {
//          之前写InputStream is =ClassLoader.getSystemClassLoader().getResourceAsStream("jdbc.properties");
            InputStream is = JdbcUtils.class.getClassLoader().getResourceAsStream("jdbc.properties");
            Properties pro = new Properties();
            pro.load(is);
            dataSource = (DruidDataSource) DruidDataSourceFactory.createDataSource(pro);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
    public static Connection getConn(){
      Connection conn = threadLocal.get();
      if(conn==null){
          try {
              conn = dataSource.getConnection();
              threadLocal.set(conn);
              conn.setAutoCommit(false);
          } catch (Exception e) {
              e.printStackTrace();
          }
      }
      return conn;
    }

//    @Test
//    public void test(){
//        Connection conn = getConn();
//        System.out.println(conn);
//    }
    public static  void  closeAndCommit(){
        Connection conn=threadLocal.get();
        if(conn!=null){
            try {
                conn.commit();
            } catch (SQLException e) {
                e.printStackTrace();
            }finally {
                try {
                    conn.close();
                } catch (SQLException e) {
                    e.printStackTrace();
                }
            }
        }
        //因为tomcat底层使用了数据库连接池，所以要Remove(),否则会报错
        threadLocal.remove();
    }
    public static void rollBack(){
        Connection conn=threadLocal.get();
        if(conn!=null){
            try {
                conn.rollback();
            } catch (SQLException e) {
                e.printStackTrace();
            }finally {
                try {
                    conn.close();
                } catch (SQLException e) {
                    e.printStackTrace();
                }
            }
        }
        threadLocal.remove();
    }
}

BaseDao的改变

package Dao;

import org.apache.commons.dbutils.QueryRunner;
import org.apache.commons.dbutils.handlers.BeanHandler;
import org.apache.commons.dbutils.handlers.BeanListHandler;
import utils.JDBCutils;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.List;

public abstract class BaseDao {
    private QueryRunner queryRunner = new QueryRunner();

    public int updateForOne(String sql, Object... args) {
        Connection conn = null;
        try {
            conn = JDBCutils.getConn();
            return queryRunner.update(conn, sql, args);
        } catch (Exception e) {
            e.printStackTrace();
            throw new RuntimeException(e);
        }
    }

    public <T> T queryForOne(Class<T> clazz, String sql, Object... args) {
        Connection conn = null;
        try {
            conn = JDBCutils.getConn();
            return queryRunner.query(conn, sql, new BeanHandler<T>(clazz), args);
        } catch (Exception e) {
            e.printStackTrace();
            throw new RuntimeException(e);
        }
    }

    public <T> List<T> queryMore(Class<T> clazz, String sql, Object... args) {
        Connection conn = null;
        try {
            conn = JDBCutils.getConn();
            return queryRunner.query(conn, sql, new BeanListHandler<T>(clazz), args);
        } catch (Exception e) {
            e.printStackTrace();
            throw new RuntimeException(e);
        }
    }

    public <E> E getValue(String sql, Object... args) {
        Connection conn = JDBCutils.getConn();
        PreparedStatement ps = null;
        ResultSet rs = null;
        try {
            ps = conn.prepareStatement(sql);
            for (int i = 0; i < args.length; i++) {
                ps.setObject(i + 1, args[i]);
            }
            rs = ps.executeQuery();
            if (rs.next()) {
                Object object = rs.getObject(1);
                return (E) object;
            }
        } catch (SQLException e) {
            e.printStackTrace();
            throw new RuntimeException(e);
        }
        return null;
    }
}

3.2、使用 Filter 过滤器统一给所有的 Service 方法都加上 try-catch。来进行实现的 管理。

Filter 类代码

package web;

import utils.JDBCutils;

import javax.servlet.*;
import java.io.IOException;

public class TransationFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {


        try {
            filterChain.doFilter(servletRequest,servletResponse);
            JDBCutils.closeAndCommit();
            System.out.println("我提交了事务");
        } catch (Exception e) {
            JDBCutils.rollBack();
            System.out.println("我回滚了事务");
            e.printStackTrace();
            //将所有异常都统一交给Tomcat，让Tomcat展示友好的错误信息页面
            /*
            * 在web.xml中我们可以通过错误页面配置来进行管理
            * */
            throw new RuntimeException(e);
        }


    }
}

在 web.xml 中的配置：

    <filter>
        <filter-name>TransationFilter</filter-name>
        <filter-class>web.TransationFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>TransationFilter</filter-name>
<!--        表示当前工程下所有请求-->
        <url-pattern>/*</url-pattern>
    </filter-mapping>

一定要记得把 BaseServlet 中的异常往外抛给Filter过滤器

package web;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.lang.reflect.Method;

//优化baseServlet 在多个模块需要运用到这个代码的时候 可以不用重复写
public class BaseServlet extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        req.setCharacterEncoding("utf-8");
        doPost(req,resp);
    }

    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        req.setCharacterEncoding("utf-8");
        String action = req.getParameter("action");
        System.out.println(action);
        try {
            Method method = this.getClass().getDeclaredMethod(action, HttpServletRequest.class, HttpServletResponse.class);
            method.invoke(this,req,resp);
        } catch (Exception e) {
            e.printStackTrace();
            //将异常抛给Tomcat服务器
            throw new RuntimeException(e);
        }
    }
}

3.3、将所有异常都统一交给 Tomcat，让 Tomcat 展示友好的错误信息页面。

<!--    error-page标签配置，服务器出错之后，自动跳转的页面-->
    <error-page>
<!--        error-code是错误类型 -->
        <error-code>500</error-code>
<!--        location标签表示。要跳转去的页面路径-->
        <location>/pages/Error/Error500.jsp</location>
    </error-page>

    <error-page>
        <error-code>404</error-code>
        <location>/pages/Error/Error404.jsp</location>
    </error-page>

页面：

<%--
  Created by IntelliJ IDEA.
  User: Distance
  Date: 2021/10/31
  Time: 21:01
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Error404</title>
</head>
<body>
您访问的页面不存在，或已经被删除。<br>
<a href="index.jsp">返回首页</a>
</body>
</html>

<%--
  Created by IntelliJ IDEA.
  User: Distance
  Date: 2021/10/31
  Time: 21:02
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Error500</title>
</head>
您访问的页面出现了错误，程序员小哥正在努力抢修<br>
<a href="index.jsp">返回首页</a>
</body>
</html>