JavaWeb之Filter过滤器的使用

程序员小徐同学
188 阅读6分钟

一起养成写作习惯！这是我参与「掘金日新计划 · 4 月更文挑战」的第3天，点击查看活动详情。

一、由来

客户端发起请求，那服务器不能什么请求都做出响应,做拦截处理，不仅能减轻服务器的压力，还能保护数据的安全，同样服务端做出响应给客户端时有时也需要进行过滤，比如我们常见的图片添加水印。为了处理这些问题，于是过滤器出现了。有时不仅仅对请求与响应进行一层的过滤，可能会过滤多层，所以提出了滤镜链(FilterChain)的概念.

二、使用

在使用它之前先熟悉下它的作用的地方。过滤器作用在请求Request到达Servlet之前以及响应Response到达浏览器之前会依次经过过虑链。有些类似asp.net中的httpmodule.使用Filter主要是实现javax.servlet.filter接口。查看API可看到有3个方法。

1.public void init(FilterConfig filterConfig) throws ServletException

由 Web 容器调用，指示将放入服务中的过滤器。servlet 容器只在实例化过滤器之后调用一次 init 方法。在要求过滤器做任何过滤工作之前，init 方法必须成功完成。如果 init 方法抛出 ServletException或没有在 Web 容器定义的时间段内返回，则 Web 容器无法将过滤器放入服务中。这个和Servlet的生命周期有点类似，也是只初始化一次，destroy()也是执行一次。

2.public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws java.io.IOException, ServletException

每次由于对链末尾的某个资源的客户端请求而通过链传递请求/响应对时，容器都会调用 Filter 的 doFilter 方法。传入此方法的 FilterChain 允许 Filter 将请求和响应传递到链中的下一个实体。 此方法的典型实现遵循以下模式：

  1. 检查请求\

  2. 有选择地将带有自定义实现的请求对象包装到用于输入过滤的过滤器内容或头中

  3. 有选择地将带有自定义实现的响应对象包装到用于输出过滤的过滤器内容或头中

  4. a) 既可以使用 FilterChain 对象 (chain.doFilter()) 调用链中的下一个实体，

  5. b) 也可以不将请求/响应对传递给过滤器链中的下一个实体，从而阻塞请求处理

  6. 在调用过滤器链中的下一个实体之后直接设置响应上的头。

3.public void destroy()

由 Web 容器调用，指示将从服务中取出的过滤器。此方法仅在过滤器的 doFilter 方法中的所有线程都已退出之后调用一次，或者在过了超时期之后调用。在调用此方法之后，Web 容器不会再对此过滤器实例调用 doFilter 方法。此方法为过滤器提供了一个清除持有的所有资源（比如内存、文件句柄和线程）的机会，并确保任何持久状态都与内存中该过滤器的当前状态保持同步。

Filter过滤器

一.Filter什么是过滤器

Filter过滤器它是JavaWeb的三大组件之一，三大组件分别是：Servlet程序、Listener监听器、Filter过滤器 Filter过滤器它是JavaEE的规划，也是接口 Filter过滤器它的作用是：请求拦截

  • 拦截请求常见的有：权限检查、日记操作、事物管理等等

二.Filter过滤器拦截

在WEB-INF的目录下，有很多资源，如html、jsp、txt、jpg等，都必须是用户登录之后才允许访问 简单的实现不用Filter过滤器就是可以看Session中是否包含用户登录信息即可 先从jsp文件里面进行Session的判断，是否有用户的Cookie信息，但这种只能在jsp文件里面而html是不能写Java代码的 这就需要到Filter过滤器

<%--
  Created by IntelliJ IDEA.
  User: 程序员小徐同学
  Date: 2022-01-12
  Time: 16:41
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
  <head>
    <title>Cookie</title>
    <base href="http://localhost:8888/day2/">
    <style type="text/css">
      ul li {
        list-style: none;
      }
    </style>
  </head>
  <body>
  <h3>开始了新的测试</h3>
  <%
    Object user = session.getAttribute("user");
    if (user == null) {
      request.getRequestDispatcher("/loGin.jsp").forward(request,response);
      return;
    }
  %>
这是index.jsp页面
  </body>
</html>


<%--
  Created by IntelliJ IDEA.
  User: 86176
  Date: 2022-01-12
  Time: 16:50
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
<h4>这是登录页面</h4>
<form>
    用户名: <input type="text" name="username"> <br>
    密 码: <input type="password" name="password" value=""><br>
    <input type="submit" value="登录">
</form>
</body>
</html>

Filter过滤器执行的方式

图片.png

获取用户Cookie

<%--
  Created by IntelliJ IDEA.
  User: 86176
  Date: 2022-01-12
  Time: 16:50
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
<h4>这是登录页面</h4>
<form action="http://localhost:8888/day2/loginServlet" method="get">
    用户名: <input type="text" name="username"> <br>
    密 码: <input type="password" name="password" value=""><br>
    <input type="submit" value="登录">
</form>
</body>
</html>

配置下的Servlet响应

public class LoginServlet  extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        req.setCharacterEncoding("UTF-8");
        resp.setContentType("text/html;character=UTF-8");
        String username = req.getParameter("username");
        String password = req.getParameter("password");
        if ("root".equals(username) && "root".equals(password)){
            req.getSession().setAttribute("user",username);
            resp.getWriter().write("登录成功");
        } else {
            req.getRequestDispatcher("/loGin.jsp").forward(req,resp);
        }
    }
}

给Servlet程序配置和Filter过滤器也进行配置，配置Filter就是要拦截的目标路径

 <!--Filter标签用于配置一个Filter过滤器-->
   <filter>
       <!--给Filter起一个别名-->
       <filter-name>imFilter</filter-name>
       <!--配置Filter的全类名-->
       <filter-class>com.Demo.Filter.imFilter</filter-class>
   </filter>
    <!--Filter-mapping 配置Filter过滤器的拦截路径-->
    <filter-mapping>
        <!--Filter-name表示当前拦截那个路径给Filter过滤使用-->
        <filter-name>imFilter</filter-name>
        <!--urlpattern配置拦截路径
        斜杠就是表示http://ip:port/工程路径/  映射到web目录下
        -->
        <url-pattern>/admin/*</url-pattern>
    </filter-mapping>
    <servlet>
        <servlet-name>LoginServlet</servlet-name>
        <servlet-class>com.Demo.Filter.LoginServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>LoginServlet</servlet-name>
        <url-pattern>/loginServlet</url-pattern>
    </servlet-mapping>

Filter过滤器代码段


public class imFilter  implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    }
    @Override
    public void destroy() {
    }
    @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过滤器包含几个方法

  • 构造器方法
  • init初始化方法
  • doFilter过滤器方法
  • destory销毁
public class imFilter  implements Filter {
    public imFilter() {
        System.out.println("Filter构造器方法");
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("Filter初始化方法");
    }
    @Override
    public void destroy() {
    }
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("doFilter拦截方法");
    }
     @Override
    public void destory() {
        System.out.println("Filter的destory方法");
    }
}

四.FilterConfig类

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

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

  • 获取Filter的名称Filter-name内容
  • 获取在Filter中配置的init-param初始化参数
  • 获取ServletContext对象
public class imFilter  implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("Filter-name的值是" + filterConfig.getFilterName());
        //获取在web.xml中的init-param初始化参数
        System.out.println("初始化参数username" + filterConfig.getInitParameter("username"));
        //获取ServletContext对象
        System.out.println(filterConfig.getServletContext());
    }
    }

图片.png

五.FilterChain过滤链

FilterChain过滤链就是多个过滤器进行

FilterChain.doFilter（）方法作用

  • 执行下一个Filter过滤器（如果有Filter）

  • 执行目录资源（没有Filter）

  • 所有Filter和目标资源默认都执行在同一个线程中 、多个Filter在执行时他们的顺序是由web.xml的配置顺序决定

  • 多个Filter共同执行的时候，他们都使用同一个Request对象

图片.png

Filter的java代码

public class Filter1 implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("Filter2前置代码");
        filterChain.doFilter(servletRequest,servletResponse);
        System.out.println("Filter2后置代码");
    }
}

在一个web应用中，可以开发编写多个Filter，这些Filter组合起来称之为一个Filter链。

web服务器根据Filter在web.xml文件中的注册顺序，决定先调用哪个Filter，当第一个Filter的doFilter方法被调用时，web服务器会创建一个代表Filter链的FilterChain对象传递给该方法。在doFilter方法中，开发人员如果调用了FilterChain对象的doFilter方法，则web服务器会检查FilterChain对象中是否还有filter，如果有，则调用第2个filter，如果没有，则调用目标资源。

public class imFilter  implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    }
    @Override
    public void destroy() {
    }
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("Filter1前置代码");
        filterChain.doFilter(servletRequest,servletResponse);
        System.out.println("Filter1后置代码");
    }
    public void destory() {
        System.out.println("Filter的destory方法");
    }
}

两个Filter‘在web.xml的配置

<!--Filter标签用于配置一个Filter过滤器-->
   <filter>
       <!--给Filter起一个别名-->
       <filter-name>imFilter</filter-name>
       <!--配置Filter的全类名-->
       <filter-class>com.Demo.Filter.imFilter</filter-class>
   </filter>
    <!--Filter-mapping 配置Filter过滤器的拦截路径-->
    <filter-mapping>
        <!--Filter-name表示当前拦截那个路径给Filter过滤使用-->
        <filter-name>imFilter</filter-name>
        <!--urlpattern配置拦截路径
        斜杠就是表示http://ip:port/工程路径/  映射到web目录下
        -->
        <url-pattern>/loGin.jsp</url-pattern>
    </filter-mapping>
    <filter>
        <filter-name>Filter1</filter-name>
        <filter-class>com.Demo.Filter.Filter1</filter-class>
    </filter>
   <filter-mapping>
       <filter-name>Filter1</filter-name>
       <url-pattern>/loGin.jsp</url-pattern>
   </filter-mapping>

图片.png

六.还有什么问题可以留言给我，会尽心解答的，觉得文章不错的话点个赞把

avatar
文章
阅读
粉丝