Java Servlet Filter的两种映射方式

àì夳堔傛蜴生んèń 2024-03-29 15:50 16阅读 0赞

使用 MyEclipse 创建 Filter 后，在 web.xml 中的对应配置信息就是 Filter 映射。Filter 的映射方式可分为两种。

1）使用通配符\*拦截用户的所有请求

Filter 的 \\ 元素用于配置过滤器拦截的资源信息，如果想让过滤器拦截所有的请求，那么可以使用通配符`*`实现，具体实现方式如下：

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

2）拦截不同方式的访问请求

在 web.xml 文件中，每一个 `<filter-mapping>` 元素都可以配置一个 Filter 所负责拦截的资源。在 `<filter-mapping>` 元素中有一个特殊的子元素 `<dispatcher>`，该元素用于指定过滤器所拦截的资源被 Servlet 容器调用的方式。`<dispatcher>` 元素的值共有四个，如表 1 所示。

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>功能描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>REQUEST</td> 
   <td>当用户直接访问页面时，Web 容器将会调用过滤器。如果目标资源通过 RequestDispatcher 的 include() 或 forward() 方法访问，那么该过滤器将不会被调用</td> 
  </tr> 
  <tr> 
   <td>INCLUDE</td> 
   <td>如果目标资源通过 RequestDispatcher 的 include() 方法访问，那么该过滤器将会被调用。除此之外，该过滤器不会被调用</td> 
  </tr> 
  <tr> 
   <td>FORWARD</td> 
   <td>如果目标资源通过 RequestDispatcher 的 forward() 方法访问，那么该过滤器将会被调用。除此之外，该过滤器不会被调用</td> 
  </tr> 
  <tr> 
   <td>ERROR</td> 
   <td>如果目标资源通过声明式异常处理机制调用，那么该过滤器将会被调用。除此之外，该过滤器不会被调用</td> 
  </tr> 
 </tbody> 
</table>

为了让读者更好地理解表 1 中的四个值的作用，下面以 FORWARD 为例，分步骤演示 Filter 对转发请求的拦截效果。

1）创建ForwardServlet

在 filterDemo01 项目的 com.mengma.filter 包中创建一个名为 ForwardServlet 的 Servlet 类，该类用于将请求转发给 first.jsp 页面，如下所示。

> 1.  `package com.mengma.filter;`
> 2.  
> 3.  `import java.io.IOException;`
> 4.  
> 5.  `import javax.servlet.ServletException;`
> 6.  `import javax.servlet.http.HttpServlet;`
> 7.  `import javax.servlet.http.HttpServletRequest;`
> 8.  `import javax.servlet.http.HttpServletResponse;`
> 9.  
> 10. `public class ForwardServlet extends HttpServlet {`
> 11. 
> 12. `public void doGet(HttpServletRequest request, HttpServletResponse response)`
> 13. `throws ServletException, IOException {`
> 14. `request.getRequestDispatcher("/first.jsp").forward(request, response);`
> 15. `}`
> 16. 
> 17. `public void doPost(HttpServletRequest request, HttpServletResponse response)`
> 18. `throws ServletException, IOException {`
> 19. `doGet(request, response);`
> 20. `}`
> 21. `}`

2）创建 first.jsp

在项目的 WebContent 目录中创建一个名称为 first.jsp 的页面，该页面用于输出内容，编辑代码如下所示。

> 1.  `<%@ page language="java" contentType="text/html; charset=utf-8"`
> 2.  `pageEncoding="utf-8"%>`
> 3.  `<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"`
> 4.  `"http://www.w3.org/TR/html4/loose.dtd">`
> 5.  `<html>`
> 6.  `<head>`
> 7.  `<meta http-equiv="Content-Type" content="text/html; charset=utf-8">`
> 8.  `<title>Insert title here</title>`
> 9.  `</head>`
> 10. `<body>`
> 11. `first.jsp`
> 12. `</body>`
> 13. `</html>`

3）创建并编辑过滤器 ForwardFilter

在 com.mengma.filter 包中创建一个名称为 ForwardFilter 的过滤器，该过滤器专门用于对 first.jsp 页面进行拦截。需要注意的是，在填写配置信息时，需要将 Edit Filter Mapping 窗口中 Select dispatchers 下的 Forward 复选框选中，如图 1 所示。

![8d1ab04798e95b712c51343e8bf42a2e.png][]

图 1 配置拦截信息

创建完成后，编辑 ForwardFilter 类。编辑后的实现代码如下所示。

> 1.  `package com.mengma.filter;`
> 2.  
> 3.  `import java.io.IOException;`
> 4.  `import java.io.PrintWriter;`
> 5.  
> 6.  `import javax.servlet.Filter;`
> 7.  `import javax.servlet.FilterChain;`
> 8.  `import javax.servlet.FilterConfig;`
> 9.  `import javax.servlet.ServletException;`
> 10. `import javax.servlet.ServletRequest;`
> 11. `import javax.servlet.ServletResponse;`
> 12. 
> 13. `public class ForwardFilter implements Filter {`
> 14. 
> 15. `public void init(FilterConfig fConfig) throws ServletException {`
> 16. `// 过滤对象在初始化时调用，可以配置一些初始化参数`
> 17. `}`
> 18. 
> 19. `public void doFilter(ServletRequest request, ServletResponse response,`
> 20. `FilterChain chain) throws IOException, ServletException {`
> 21. `// 用于拦截用户的请求，如果和当前过滤器的拦截路径匹配，该方法会被调用`
> 22. `PrintWriter out = response.getWriter();`
> 23. `out.write("Hello FilterTest");`
> 24. `}`
> 25. 
> 26. `public void destroy() {`
> 27. `// 过滤器对象在销毁时自动调用，释放资源`
> 28. `}`
> 29. `}`

此时需在 web.xml 文件中添加 ForwardFilter 的映射信息。代码中增加了一个 子元素，并且该元素的值为 FORWARD，如下所示：

> 1.  `<filter>`
> 2.  `<filter-name>ForwardFilter</filter-name>`
> 3.  `<filter-class>com.mengma.filter.ForwardFilter</filter-class>`
> 4.  `</filter>`
> 5.  `<filter-mapping>`
> 6.  `<filter-name>ForwardFilter</filter-name>`
> 7.  `<url-pattern>/first.jsp</url-pattern>`
> 8.  `<dispatcher>FORWARD</dispatcher>`
> 9.  `</filter-mapping>`

4）运行项目并查看结果

启动 Tomcat 服务器，在浏览器的地址栏中输入地址 http://localhost:8080/filterDemo01/ForwardServlet 访问 ForwardServlet，浏览器显示的结果如图 2 所示。

![aa4bc56c39ee46b810e301bdfe5e0f9d.png][]

图 2 运行结果

从图 2 中可以看出，浏览器窗口显示的是 ForwardFilter 类中的内容，而 first.jsp 页面的输出内容没有显示。由此可见，ForwardServlet 中通过 forward() 方法转发的 first.jsp 页面被成功拦截。

[8d1ab04798e95b712c51343e8bf42a2e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/8376400705b8406db13e5a832018bfcc.png
[aa4bc56c39ee46b810e301bdfe5e0f9d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/99a45e84661543fb92c89090c8c9eef8.png