JavaWeb三大组件-Filter

文章目录

• Filter
  
• 
  
  
  
  • 1. 概念
    
  • 2. 基本使用
    
  • 3. 生命周期
    
  • 4. FilterConfig类
    
  • 5. FilterChain类
    
  • 6. 拦截路径
    
  • 7. ThreadLocal+Filter管理事务
    
  • 
    
    
    
    • 7.1 ThreadLocal
      
    • 7.2 MySQL事务前提
      
    • 7.3 Filter统一管理
      
    • 7.4 错误信息展示
      
      
    
  
  

Filter

1. 概念

Filter过滤器是JavaWeb的三大组件之一。三大组件：Servlet，Listener，Filter
Filter过滤器是JavaEE的规范，即接口
作用：拦截请求，过滤响应
拦截请求常见的应用场景：

• 权限检查
  
• 日记操作
  
• 事务管理…
  

2. 基本使用

例子：要求在你的web工程下，有一个admin目录，这个目录下的所有资源(html，jpg，jsp等)都必须是用户登录之后才允许访问。

• 根据之前我们学的，用户登陆后我们把用户信息保存到Session域中，所以我们判断Session中是否包含有用户信息即可，但这种方案只能用在jsp页面中
  
• 使用Filter，可以使用在任何资源上（Filter在获取目标资源前执行）
  

使用：

• 写个类去实现Filter接口
  

1. // 先写个类去实现javax.servlet.Filter
2. public class AdminFilter implements Filter {
3.     // 这个方法重要，主要用于拦截请求！！(权限检查)
4.     @Override
5.     public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse,
6.                          FilterChain filterChain) throws IOException, ServletException
7.     {
8.         HttpServletRequest req = (HttpServletRequest) servletRequest; // 要强转一下，才能获取Session
9.         HttpServletResponse resp = (HttpServletResponse) servletResponse;
11.         HttpSession session = req.getSession();  // 获取Session
12.         Object user = session.getAttribute("user");
13.         if (user == null) {
14.             req.getRequestDispatcher("/login.jsp").forward(req, resp); //没登录转发到登陆页面
15.             return;
16.         } else {
17.             // 如果已经登录，如果有下一个Filter则进入，没有则放行，去访问用户请求的资源！(没有这行是不行的)
18.             filterChain.doFilter(req, resp);
19.         }
20.     }
22.     // 下面两个可以空实现
23.     @Override
24.     public void init(FilterConfig filterConfig) throws ServletException { }
25.     @Override
26.     public void destroy() { }
27. }

复制代码

• xml配置过滤器（和Servlet差不多）
  

1. <filter>
2.     <filter-name>AdminFilter</filter-name>  
3.     <filter-class>com.sutong.filter.AdminFilter</filter-class>  
4. </filter>
5. <filter-mapping>
6.     <filter-name>AdminFilter</filter-name>
7.    
8.     <url-pattern>/admin/*</url-pattern>
9. </filter-mapping>

复制代码

3. 生命周期

Filter 的方法执行顺序：

• 构造器 方法
  
• init() 初始化方法， 第一二步在web工程启动的时候已经执行（即Filter已经创建）
  
• doFilter()，每次拦截到请求就会执行
  
• destroy()，停止web的时候执行
  

4. FilterConfig类

FIlterConfig，Filter过滤器的配置文件类，Tomcat每次创建的Filter的时候，会同时创建一个FilterConfig类。
作用：获取Filter过滤器的配置内容

• 获取Filter的名称，即配置文件中filter-name标签里面的内容
  
• 获取Filter在web.xml中配置的init-param初始化参数 （在filter标签里面配置初始化参数，和Servlet一样）
  
• 获取ServletContext对象
  

1. @Override
2. public void init(FilterConfig filterConfig) throws ServletException {
3.     String filterName = filterConfig.getFilterName(); // 1
4.     String value = filterConfig.getInitParameter("key1"); // 2
5.     ServletContext servletContext = filterConfig.getServletContext(); // 3
6. }

复制代码

5. FilterChain类

FilterChain 是过滤器链（多个过滤器一起工作）
filterChain.doFilter(req, resp) 该方法是作用：

• 执行下一个Filter（如果有）
  
• 执行目标资源（没有了Filter了）
  

如果验证通过，执行完目标资源后会返回 doFilter 方法调用的地方，继续执行下面的代码。
当多个过滤器时，拦截同一个文件/目录时，Filter 配置文件的顺序（即web.xml中的配置顺序）决定了每 Filter 的执行顺序，配置在前先执行。
当多个过滤器的特点：⭐

• 所有的 Filter 和目标资源默认都执行在同一个线程中
  
• 多个 Filter 共同执行的时候他们都使用一个 Request 对象
  

6. 拦截路径

• 精确匹配
  /target.jsp --> http://ip:port/工程路径/target.jsp
  
• 目录匹配
  /admin/* -> http://ip:port/工程路径/admin/*
  
• 后缀名匹配
  *.html -> 表示要拦截的地址必须以 .html结尾
  这个后缀名不一定是现有文件的后缀名，是个字符串就行 *.abc 也行。注意不是以斜杠开头
  

   Filter只关系请求的地址是否匹配，不关心资源是否存在。
  
7. ThreadLocal+Filter管理事务

7.1 ThreadLocal

ThreadLocal是jdk1.2开始的，作用：可以解决多线程的数据安全问题
ThreadLocal可以给当前线程关联一个数据（可以是普通变量，对象，集合等）
（可以简单理解为，像Map一样，当前线程名为key，关联的数据为value）
如果想要给当前线程关联多个数据则需要多个ThreadLocal实例，ThreadLocal实例一般都是 static 类型，其中保存的数据在线程销毁后由JVM虚拟机自动释放。

1. // Hashtable线程安全
2. public static Map<String, Object> map = new Hashtable<>();
4. // ThreadLocal泛型就是关联数据的类型，类似：Map中V的类型，K是当前线程
5. // 只能关联一个数据，多个则需new多个
6. public static ThreadLocal<Object> threadLocal = new ThreadLocal<>();
8. // 使用
9. public void test() {
10.     map.put(Thread.currentThread().getName(), "Map存数据");
11.     threadLocal.set("ThreadLocal存数据");
13.     // 取数据
14.     Object obj1 = map.get(Thread.currentThread().getName());
15.     Object obj2 = threadLocal.get();
16. }

复制代码

7.2 MySQL事务前提

   我们在book项目的时候，如果生成订单后发生错误，则生成订单成功而订单详情生成失败，这是严重错误的，所以我们要使用事务确保这些操作在一个事务内。
  而确保在一个事务的前期是 使用同一个 Connection 连接对象！ 这里就可以用 ThreadLocal 了，把Connection 存到ThreadLocal 中，确保多个Service使用的是同一个连接对象。
而使用 ThreadLocal 关联数据要确保上面这些操作在一个线程中执行！ （经过验证我们book中生成订单操作都是在一个线程下的）

1. String orderId = null;
2. try {
3.     orderId = orderService.createOrder(cart, loginUser.getId());
4.     JdbcUtils.commitAndClose();    // 生成订单，没异常提交事务关闭连接
5. } catch (Exception e) {
6.         JdbcUtils.rollbackAndClose();  // 有异常回滚，关闭连接 ！！
7. }
8. // 但这样做每个xxxService.xxx() 都要进行try catch，太麻烦了，可以使用Filter，看下面

复制代码

7.3 Filter统一管理

使用Filter统一给所有的 Service 方法都加上 try-catch，来实现管理！！
所有的异常都要抛给 Filter，不要私自处理异常
TransactionFilter.java ：

1. public class TransactionFilter implements Filter {
2.     @Override
3.     public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse,
4.                          FilterChain filterChain) {
5.         try {
6.             // 下面这行相当于调用xxxService.xxx()方法，
7.             // 所以我们对这行进行try-catch就行了(即给所有的Servlet中的所以方法进行了try-catch)
8.             filterChain.doFilter(servletRequest, servletResponse);
9.             JdbcUtils.commitAndClose();   // 没异常提交事务，关闭连接
10.         } catch (Exception e) {
11.             JdbcUtils.rollbackAndClose();  // 有异常回滚，关闭连接
12.             e.printStackTrace();           // 可以不打印，打印可以让我们开到什么错误
13.             throw new RuntimeException(e); // 再把错误抛给Tomcat去显示我们准备的错误页面！！！！！！
14.             // (如果有异常了，用户页面则会一页空白，我们要给用户一点友好的提示！可以交给Tomcat展示友好的错误页面信息)
15.         }
16.     }
18.     @Override
19.     public void init(FilterConfig filterConfig) throws ServletException { }
20.     @Override
21.     public void destroy() { }
22. }

复制代码

web.xml

1. <filter>
2.     <filter-name>TransactionFilter</filter-name>
3.     <filter-class>com.sutong.filter.TransactionFilter</filter-class>
4. </filter>
5. <filter-mapping>
6.     <filter-name>TransactionFilter</filter-name>
7.     <url-pattern>/*</url-pattern>  
8. </filter-mapping>

复制代码

7.4 错误信息展示

TransactionFilter.java

1. try {
2.     filterChain.doFilter(servletRequest, servletResponse);
3.     JdbcUtils.commitAndClose();
4. } catch (Exception e) {
5.     JdbcUtils.rollbackAndClose();      
6.     throw new RuntimeException(e); // 再把错误抛给Tomcat去显示我们准备的错误页面！！！！！！
7.     // (如果有异常了，用户页面则会一页空白，我们要给用户一点友好的提示！可以交给Tomcat展示友好的错误页面信息)
8. }

复制代码

web.xml配置

1. <error-page>
2.     <error-code>500</error-code>
3.     <location>/pages/error/error500.jsp</location>
4. </error-page>
6. <error-page>
7.     <error-code>404</error-code>
8.     <location>/pages/error/error404.jsp</location>
9. </error-page>

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！