Servlet 编写过滤器

àì夳堔傛蜴生んèń 2021-09-30 16:02 349阅读 0赞

## 前言 ##

Servlet 过滤器可以动态地拦截请求和响应，以变换或使用包含在请求或响应中的信息。

可以将一个或多个 Servlet 过滤器附加到一个 Servlet 或一组 Servlet。Servlet 过滤器也可以附加到 JavaServer Pages (JSP) 文件和 HTML 页面。调用 Servlet 前调用所有附加的 Servlet 过滤器。

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

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

**Javaweb项目目录结构**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI1Nzc0NzQ_size_16_color_FFFFFF_t_70]  
一、LogFilter.java 源码

实现 Filter 类 （过滤器实现）

//实现 Filter 类
    public class LogFilter implements Filter  { 
        public void  init(FilterConfig config) throws ServletException { 
            // 获取初始化参数
            String site = config.getInitParameter("Site"); 
    
            // 输出初始化参数
            System.out.println("网站名称: " + site); 
        }
        public void  doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws java.io.IOException, ServletException { 
    
        	//获取请求信息(测试时可以通过get方式在URL中添加name)
            //http://localhost:8080/servlet_demo/helloword?name=123
            String name = request.getParameter("name");
    
            // 过滤器核心代码逻辑
            System.out.println("过滤器获取请求参数:"+name);
            System.out.println("第二个过滤器执行--网站名称：www.runoob.com");
    
            if("123".equals(name)){ 
                // 把请求传回过滤链
                chain.doFilter(request, response);
            }else{ 
                //设置返回内容类型
            	response.setContentType("text/html;charset=GBK");
    
                //在页面输出响应信息
                PrintWriter out = response.getWriter();
                out.print("<b>name不正确，请求被拦截，不能访问web资源</b>");
                System.out.println("name不正确，请求被拦截，不能访问web资源");
            }
        }
        public void destroy( ){ 
            /* 在 Filter 实例被 Web 容器从服务移除之前调用 */
        }
    }

二、DisplayHeader.java 源码 （一个测试web，当被访问成功后向用户输出HTTP Header信息）

//导入必需的 java 库
    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 源码

web.xml 中配置 Servlet 过滤器映射，以及servlet配置

<?xml version="1.0" encoding="UTF-8"?>
    <web-app>
    <filter>
      <filter-name>LogFilter</filter-name>
      <filter-class>LogFilter</filter-class>
      <init-param>
        <param-name>Site</param-name>
        <param-value>servlet过滤器</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>DisplayHeader</servlet-class>  
    </servlet>  
    <servlet-mapping>  
      <servlet-name>DisplayHeader</servlet-name>  
        
      <url-pattern>/TomcatTest/DisplayHeader</url-pattern>  
    </servlet-mapping>  
    
    
    </web-app>

四、运行项目

请求DisplayHeader页面：[http://localhost/test/TomcatTest/DisplayHeader][http_localhost_test_TomcatTest_DisplayHeader]  
如下图所示请求被拦截了。因为我们设置了过滤器用于所有的 Servlet，请求参数必须要有name=123。  
**过滤器拦截部分代码：**

if("123".equals(name)){ 
                // 把请求传回过滤链
                chain.doFilter(request, response);
            }else{ 
                //设置返回内容类型
            	response.setContentType("text/html;charset=GBK");
    
                //在页面输出响应信息
                PrintWriter out = response.getWriter();
                out.print("<b>name不正确，请求被拦截，不能访问web资源</b>");
                System.out.println("name不正确，请求被拦截，不能访问web资源");
            }

![在这里插入图片描述][2019080716440674.png]  
发起带 name=123 的请求，[http://localhost/test/TomcatTest/DisplayHeader?name=123][http_localhost_test_TomcatTest_DisplayHeader_name_123] ，  
因为过滤器匹配到了name=123，所以DisplayHeader页面被正常访问了。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI1Nzc0NzQ_size_16_color_FFFFFF_t_70 1]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI1Nzc0NzQ_size_16_color_FFFFFF_t_70]: /images/20210726/6721cf7f9ea04e03aef600197e0c4243.png
[http_localhost_test_TomcatTest_DisplayHeader]: http://localhost/test/TomcatTest/DisplayHeader
[2019080716440674.png]: /images/20210726/fb3c5fcb919b447db80699c5ae4ac244.png
[http_localhost_test_TomcatTest_DisplayHeader_name_123]: http://localhost/test/TomcatTest/DisplayHeader?name=123
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI1Nzc0NzQ_size_16_color_FFFFFF_t_70 1]: /images/20210726/6fced98a1a2e4d00b18f32ce26db7664.png