JavaWeb学习|Filter与ThreadLocal

学习材料声明

所有知识点都来自互联网，进行总结和梳理，侵权必删。
引用来源：尚硅谷最新版JavaWeb全套教程,java web零基础入门完整版

Filter

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

1.情景实践（要求未登录情况，浏览器不能访问admin目录下的所有文件）

设置filter类，继承Filter，编写doFilter
在web.xml里面配置filter的url。

Filter：

public class AdminFilter implements Filter {
	/**
	* doFilter 方法，专门用于拦截请求。可以做权限检查
	*/
	@Override
	public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChainfilterChain) 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-name>AdminFilterfilter-name>
	
	<filter-class>com.atguigu.filter.AdminFilterfilter-class>
filter>

<filter-mapping>
	
	<filter-name>AdminFilterfilter-name>
	
	<url-pattern>/admin/*url-pattern>
filter-mapping>

2.Filter过滤的整个生命周期

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

3.Filter的一些配置

和servlet一样，filter也可以配置一些东西。

FilterConfig 类见名知义，它是 Filter 过滤器的配置文件类。
Tomcat 每次创建 Filter 的时候，也会同时创建一个 FilterConfig 类，这里包含了 Filter 配置文件的配置信息。
FilterConfig 类的作用是获取 filter 过滤器的配置内容
1、获取 Filter 的名称 filter-name 的内容
2、获取在 Filter 中配置的 init-param 初始化参数
3、获取 ServletContext 对象

web.xml里面配置初始化参数

<filter>
	
	<filter-name>AdminFilterfilter-name>
	
	<filter-class>com.atguigu.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类里面获取：

@Override
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());
}

4.FilterChain 过滤器链

整个过滤器流程，同时，在web.xml里面的配置顺序代表了整个过滤流程的顺序。

5.拦截路径

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

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

后缀名匹配
.html
以上配置的路径，表示请求地址必须以.html 结尾才会拦截到
.do
以上配置的路径，表示请求地址必须以.do 结尾才会拦截到
*.action
以上配置的路径，表示请求地址必须以.action 结尾才会拦截到
Filter 过滤器它只关心请求的地址是否匹配，不关心请求的资源是否存在！！！
请记住，可以同时配置多个。

ThreadLocal

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

1.一个小实践

//创建
public static ThreadLocal threadLocal = new ThreadLocal();
//绑定
threadLocal.set(i);
//获取
Object o = threadLocal.get();

public class ThreadLocalTest {
	// public static Map data = new Hashtable();
	//创建
	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();
	}
	}
}

2.书城项目是要求利用Filter和ThreadLocal是组合管理事务。

这里涉及线程的知识，啊啊啊，忘得差不多了。
使用 ThreadLocal 来确保所有 dao 操作都在同一个 Connection 连接对象中完成。
主要的改动在JDBC，然后设置Filter来统一处理提交和回滚。同时要记得千万要抛出异常，才能实现回滚。

JDBC里改动，要创建ThreadLocal绑定conn。然后设置提交和回滚。

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();
		}
	}
	/**
	* 获取数据库连接池中的连接
	* @return 如果返回 null,说明获取连接失败
有值就是获取连接成功
	*/
	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(){
		Connection connection = conns.get();
		if (connection != null) { // 如果不等于 null，说明 之前使用过连接，操作过数据库
			try {
				connection.commit(); // 提交 事务
			} catch (SQLException e) {
				e.printStackTrace();
			} finally {
				try {
					connection.close(); // 关闭连接，资源资源
				} catch (SQLException e) {
					e.printStackTrace();
				}
			}
		}
		// 一定要执行 remove 操作，否则就会出错。（因为 Tomcat 服务器底层使用了线程池技术）
		conns.remove();
	}
	/**
	* 回滚事务，并关闭释放连接
	*/
	public static void rollbackAndClose(){
		Connection connection = conns.get();
		if (connection != null) { // 如果不等于 null，说明 之前使用过连接，操作过数据库
			try {
				connection.rollback();//回滚事务
			} catch (SQLException e) {
				e.printStackTrace();
			} finally {
				try {
					connection.close(); // 关闭连接，资源资源
				} catch (SQLException e) {
					e.printStackTrace();
				}
			}
		}
		// 一定要执行 remove 操作，否则就会出错。（因为 Tomcat 服务器底层使用了线程池技术）
		conns.remove();
	}
}

其他部分Dao

catch (SQLException e) {
	e.printStackTrace();
	throw new RuntimeException(e);
}

利用FIlter：给所有的 Service 方法都加上 try-catch。来进行实现的管理。

public class TransactionFilter implements Filter {
	@Override
	public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
		try {
			filterChain.doFilter(servletRequest,servletResponse);
			JdbcUtils.commitAndClose();// 提交事务
		} catch (Exception e) {
		JdbcUtils.rollbackAndClose();//回滚事务
			e.printStackTrace();
		}
	}
}

在 web.xml 中的配置：
<filter>
	<filter-name>TransactionFilterfilter-name>
	<filter-class>com.atguigu.filter.TransactionFilterfilter-class>
filter>
<filter-mapping>
	<filter-name>TransactionFilterfilter-name>
	
	<url-pattern>/*url-pattern>
filter-mapping> 

BaseServlet 中的异常往外抛给 Filter 过滤器

public abstract class BaseServlet extends HttpServlet {
	@Override
	protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException,
	IOException {
		doPost(req, resp);
	}
	protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException,IOException {
		// 解决 post 请求中文乱码问题
		// 一定要在获取请求参数之前调用才有效
		req.setCharacterEncoding("UTF-8");
		String action = req.getParameter("action");
		try {
			// 获取 action 业务鉴别字符串，获取相应的业务 方法反射对象
			Method method = this.getClass().getDeclaredMethod(action, HttpServletRequest.class,
			HttpServletResponse.class);
			// System.out.println(method);
			// 调用目标业务 方法
			method.invoke(this, req, resp);
		} catch (Exception e) {
			e.printStackTrace();
			throw new RuntimeException(e);// 把异常抛给 Filter 过滤器
		}
	}
}

友好的错误代码展示

也是在xml文件中配置。

<error-page>
	
	<error-code>500error-code>
	
	<location>/pages/error/error500.jsplocation>
error-page>

<error-page>
	
	<error-code>404error-code>
	
	<location>/pages/error/error404.jsplocation>
error-page>