JSP开发之JSP 过滤器简单使用案例了解下

た入场券 2022-05-18 00:44 246阅读 0赞

JSP 和 Servlet 中的过滤器都是 Java 类，并且这个过滤器可以动态地拦截请求和响应，以变换或使用包含在请求或响应中的信息，还可以将一个或多个过滤器附加到一个 Servlet 或一组 Servlet，也可以附加到 JavaServer Pages (JSP) 文件和 HTML 页面。

过滤器还可用于 Servlet 编程的 Java 类，可以实现以下目的：

*  在客户端的请求访问后端资源之前，拦截这些请求。
 *  在服务器的响应发送回客户端之前，处理这些响应。

来看下各种类型的过滤器：

*  身份验证过滤器（Authentication Filters）。
 *  数据压缩过滤器（Data compression Filters）。
 *  加密过滤器（Encryption Filters）。
 *  触发资源访问事件过滤器。
 *  图像转换过滤器（Image Conversion Filters）。
 *  日志记录和审核过滤器（Logging and Auditing Filters）。
 *  MIME-TYPE 链过滤器（MIME-TYPE Chain Filters）。
 *  标记化过滤器（Tokenizing Filters）。
 *  XSL/T 过滤器（XSL/T Filters），转换 XML 内容。

过滤器通过 Web 部署描述符（web.xml）中的 XML 标签来声明，然后映射到我们的应用程序的部署描述符中的 Servlet 名称或 URL 模式。 当 Web 容器启动 Web 应用程序时，它会为我们在部署描述符中声明的每一个过滤器创建一个实例。

Filter 的执行顺序与在 web.xml 配置文件中的配置顺序一致，一般把 Filter 配置在所有的 Servlet 之前。来看张图感受下：

![70][]

过滤器是一个实现了 javax.servlet.Filter 接口的 Java 类，来看下javax.servlet.Filter 接口定义的三个方法：

<table> 
 <tbody> 
  <tr> 
   <th>序号</th> 
   <th>方法 &amp; 描述</th> 
  </tr> 
  <tr> 
   <td>1</td> 
   <td><strong>public void doFilter (ServletRequest, ServletResponse, FilterChain)</strong><br> 该方法完成实际的过滤操作，当客户端请求方法与过滤器设置匹配的URL时，Servlet容器将先调用过滤器的doFilter方法。FilterChain用户访问后续过滤器。</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td><strong>public void init(FilterConfig filterConfig)</strong><br> web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，读取web.xml配置，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作（filter对象只会创建一次，init方法也只会执行一次）。开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td><strong>public void destroy()</strong><br> Servlet容器在销毁过滤器实例前调用该方法，在该方法中释放Servlet过滤器占用的资源。</td> 
  </tr> 
 </tbody> 
</table>

Filter 的 init 方法中提供了一个 FilterConfig 对象，我们来看下web.xml 文件配置：

<filter>
        <filter-name>LoginFilter</filter-name>
        <filter-class>com.luyaran.www.LogFilter</filter-class>
        <init-param>
            <param-name>Site</param-name>
            <param-value>luyaran</param-value>
        </init-param>
    </filter>

我们在 init 方法使用 FilterConfig 对象获取参数：

public void  init(FilterConfig config) throws ServletException {
        // 获取初始化参数
        String site = config.getInitParameter("Site"); 
        // 输出初始化参数
        System.out.println("my lover is: " + site); 
    }

完事我们来看下Servlet 过滤器的实例，先来看LogFilter.java的代码：

package com.luyaran;
    
    import javax.servlet.*;
    import java.util.*;
    
    //实现 Filter 类
    public class LogFilter implements Filter  {
        public void  init(FilterConfig config) throws ServletException {
            // 获取初始化参数
            String site = config.getInitParameter("Site"); 
    
            // 输出初始化参数
            System.out.println("my lover is: " + site); 
        }
        public void  doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws java.io.IOException, ServletException {
    
            // 输出站点名称
            System.out.println("luyaran");
    
            // 把请求传回过滤链
            chain.doFilter(request,response);
        }
        public void destroy( ){
            /* 在 Filter 实例被 Web 容器从服务移除之前调用 */
        }
    }

完事再来看DisplayHeader.java 文件代码：

package com.luyaran;
    
    import java.io.IOException;
    import java.io.PrintWriter;
    import java.util.Enumeration;
    
    import javax.servlet.ServletException;
    import javax.servlet.annotation.WebServlet;
    import javax.servlet.http.HttpServlet;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    
    @WebServlet("/DisplayHeader")
    
    //扩展 HttpServlet 类
    public class DisplayHeader extends HttpServlet {
    
        // 处理 GET 方法请求的方法
        public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
        {
            // 设置响应内容类型
            response.setContentType("text/html;charset=UTF-8");
    
            PrintWriter out = response.getWriter();
            String title = "HTTP Header 请求实例-过滤器";
            String docType =
                "<!DOCTYPE html> \n";
                out.println(docType +
                "<html>\n" +
                "<head><meta charset=\"utf-8\"><title>" + title + "</title></head>\n"+
                "<body bgcolor=\"#f0f0f0\">\n" +
                "<h1 align=\"center\">" + title + "</h1>\n" +
                "<table width=\"100%\" border=\"1\" align=\"center\">\n" +
                "<tr bgcolor=\"#949494\">\n" +
                "<th>Header 名称</th><th>Header 值</th>\n"+
                "</tr>\n");
    
            Enumeration headerNames = request.getHeaderNames();
    
            while(headerNames.hasMoreElements()) {
                String paramName = (String)headerNames.nextElement();
                out.print("<tr><td>" + paramName + "</td>\n");
                String paramValue = request.getHeader(paramName);
                out.println("<td> " + paramValue + "</td></tr>\n");
            }
            out.println("</table>\n</body></html>");
        }
        // 处理 POST 方法请求的方法
        public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
            doGet(request, response);
        }
    }

然后我们再来搞一个web.xml文件：

<?xml version="1.0" encoding="UTF-8"?>  
    <web-app>  
    <filter>
      <filter-name>LogFilter</filter-name>
      <filter-class>com.luyaran.LogFilter</filter-class>
      <init-param>
        <param-name>Site</param-name>
        <param-value>luyaran</param-value>
      </init-param>
    </filter>
    <filter-mapping>
      <filter-name>LogFilter</filter-name>
      <url-pattern>/*</url-pattern>
    </filter-mapping>
    <servlet>  
        
      <servlet-name>DisplayHeader</servlet-name>  
        
      <servlet-class>com.luyaran.DisplayHeader</servlet-class>  
    </servlet>  
    <servlet-mapping>  
      <servlet-name>DisplayHeader</servlet-name>  
        
      <url-pattern>/*</url-pattern>  
    </servlet-mapping>  
    </web-app>

然后我们来定义一个index.jsp文件，输出内容随便写：

<%@ page language="java" contentType="text/html; charset=UTF-8"
        pageEncoding="UTF-8"%>
    <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    <html>
    <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>luyaran</title>
    </head>
    <body>
    <%
        out.println("Hellos");
    %>
    </body>
    </html>

好，到这里呢，这四个文件算是定义好啦。接下来咱们来看下这些文件具体是放在哪里呢，说实话，我第一次搞这个的时候就被这个文件所安放的位置愁了好长时间，真的是啊，废话不多说，咱们一张图片搞定：

![70 1][]

不存在的就新建，照着上图咱们建立完毕文件之后就来运行这个index.jsp的文件，结果如图：

![70 2][]

上图中标有1的是log那个java过滤器显示的结果，完事另一个就不用说了，之后咱们再次刷新的话，就会有如下展示：

![70 3][]

每刷新一次，就会打印一个这个‘luyaran’。具体的效果就是这个了，我们可以应用这个过滤器功能做很多事情，在下就不做废话了。

上述代码每一步是干啥的，咱已经标注了，不太明白的童鞋可以私信哥，完事咱们这次记录就到这里了哈。

如果感觉不错的话，请多多点赞支持哦。。。

[70]: /images/20220518/69cb171cfe54428daac908f22708c12f.png
[70 1]: /images/20220518/8c5a4fa3901d445783f9babd9d9d8c9c.png
[70 2]: /images/20220518/bc4755a5dff044ecad45d7936d731e32.png
[70 3]: /images/20220518/70cb9adcf5434bdeb98887f20ce1e9b7.png