1.过滤器概念

过滤器JavaWeb三大组件之一,过滤器是用来拦截请求的.

当用户请求某个Servlet时,会先执行部署在这个请求上的Filter,如果Filter“放行”,那么会继承执行用户请求的Servlet;如果Filter不“放行”,那么就不会执行用户请求的Servlet。

2.过滤器详解

2.1过滤器生命周期

  • init(FilterConfig):在创建完Filter实例后,会马上调用init()方法完成初始化工作,这个方法只会被执行一次;
  • doFilter(ServletRequest req,ServletResponse res,FilterChain chain):这个方法会在用户每次访问“目标资源(<url-pattern>index.jsp</url-pattern>)”时执行,如果需要“放行”,那么需要调用FilterChain的doFilter(ServletRequest,ServletResponse)方法,如果不调用FilterChain的doFilter()方法,那么目标资源将无法执行;
  • destroy():在关闭服务器时会调用该方法来销毁Filter。

2.2FilterConfig

  • ServletContext getServletContext():获取ServletContext的方法;
  • String getFilterName():获取Filter的配置名称;与<filter-name>元素对应;
  • String getInitParameter(String name):获取Filter的初始化配置,与<init-param>元素对应;

Enumeration getInitParameterNames():获取所有初始化参数的名称。

Web.xml配置:

<filter>
    <filter-name>firstFilter</filter-name>
    <filter-class>cn.tx.filter.MyFilter</filter-class>
    <init-param>
        <param-name>encode</param-name>
        <param-value>UTF-8</param-value>
    </init-param>
    <init-param>
        <param-name>company</param-name>
        <param-value>txjava</param-value>
    </init-param>
</filter>

Filter读取:

String filterName = filterConfig.getFilterName();
String company = filterConfig.getInitParameter("company");
Enumeration<String> names = filterConfig.getInitParameterNames();
while (names.hasMoreElements()){
    String name = names.nextElement();
    String value = filterConfig.getInitParameter(name);
}

2.3FilterChain

doFilter()方法的参数中有一个类型为FilterChain的参数,它只有一个方法:doFilter(ServletRequest,ServletResponse)。

在一个目标资源中可能有多个过滤器,该方法的作用是通过该过滤器,去执行下一个过滤器。

2.4过滤器执行顺序

一个目标资源可以指定多个过滤器,过滤器的执行顺序是在web.xml文件中的部署顺序

<filter>
    <filter-name>filterA</filter-name>
    <filter-class>cn.tx.filter.FilterA</filter-class>
</filter>
<filter-mapping>
    <filter-name>filterA</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

<filter>
    <filter-name>filterB</filter-name>
    <filter-class>cn.tx.filter.FilterB</filter-class>
</filter>
<filter-mapping>
    <filter-name>filterB</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

FilterA:

public class FilterA implements Filter{
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("filter A 被执行了!");
        filterChain.doFilter(servletRequest,servletResponse);
        System.out.println("filter A 执行完毕了!");
    }
    @Override
    public void destroy() {
    }
}

FilterB:

public class FilterB implements Filter{
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("filter B 被执行了!");
        filterChain.doFilter(servletRequest,servletResponse);
        System.out.println("filter B 执行完毕了!");
    }
    @Override
    public void destroy() {
    }
}

执行结果:

filter A 被执行了!

filter B 被执行了!

servlet 被执行了!!!

filter B 执行完毕了!

filter A 执行完毕了!

2.5过滤器设置目标资源

在web.xml文件中部署Filter时,可以通过“*”来执行目标资源:

<filter-mapping>
    <filter-name>myfilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

这一特性与Servlet完全相同!通过这一特性,我们可以在用户访问敏感资源时,执行过滤器,例如:<url-pattern>/admin/*<url-pattern>,可以把所有管理员才能访问的资源放到/admin路径下,这时可以通过过滤器来校验用户身份。

还可以为<filter-mapping>指定目标资源为某个Servlet,例如:

<servlet>
    <servlet-name>myservlet</servlet-name>
    <servlet-class>cn.tx.servlet.TestServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>myservlet</servlet-name>
    <url-pattern>/abc</url-pattern>
</servlet-mapping>
<filter>
    <filter-name>myfilter</filter-name>
    <filter-class>cn.tx.filter.MyFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>myfilter</filter-name>
    <servlet-name>myservlet</servlet-name>
</filter-mapping>

当用户访问http://localhost:8080/filtertest/abc时,会执行名字为myservlet的Servlet,这时会执行过滤器。

2.6过滤器总结

  • Filter的三个方法:
  • void init(FilterConfig):在Tomcat启动时被调用;
  • void destroy():在Tomcat关闭时被调用;
  • void doFilter(ServletRequest,ServletResponse,FilterChain):每次有请求时都调用该方法;

  • FilterConfig类:与ServletConfig相似,用来获取Filter的初始化参数
  • ServletContext getServletContext():获取ServletContext的方法;
  • String getFilterName():获取Filter的配置名称;
  • String getInitParameter(String name):获取Filter的初始化配置,与<init-param>元素对应;
  • Enumeration getInitParameterNames():获取所有初始化参数的名称。

  • FilterChain类:
  • void doFilter(ServletRequest,ServletResponse):放行!表示执行下一个过滤器,或者执行目标资源。可以在调用FilterChain的doFilter()方法的前后添加语句,在FilterChain的doFilter()方法之前的语句会在目标资源执行之前执行,在FilterChain的doFilter()方法之后的语句会在目标资源执行之后执行。

3.过滤器应用

过滤器解决POST中文乱码

前台页面:

<form action="/hello8" method="post">
    用户名:<input type="text" name="name" id="name">
    密&nbsp;&nbsp;码<input type="password" name="password" id="password">
    <input type="submit">
  </form>

Web.xml配置

<filter>
        <filter-name>myFilter</filter-name>
        <filter-class>com.qcby.servlet.MyFilter</filter-class>
        <init-param>
            <param-name>encode</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>myFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

Filter代码:

public class MyFilter implements Filter {
    private String encode;
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        this.encode = filterConfig.getInitParameter("encode");
    }

    @Override
    public void destroy() {

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        servletRequest.setCharacterEncoding(encode);
        servletResponse.setContentType("text/html;charSet="+this.encode);
        servletResponse.setCharacterEncoding(this.encode);
        filterChain.doFilter(servletRequest,servletResponse);
    }
}

Servlet代码:

protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        String name = request.getParameter("name");
        String password = request.getParameter("password");
        System.out.println(name);
        System.out.println(password);
    }

Logo

AtomGit 是由开放原子开源基金会联合 CSDN 等生态伙伴共同推出的新一代开源与人工智能协作平台。平台坚持“开放、中立、公益”的理念,把代码托管、模型共享、数据集托管、智能体开发体验和算力服务整合在一起,为开发者提供从开发、训练到部署的一站式体验。

更多推荐