过滤器

过滤器
        Web应用过滤器，开发一个过滤器，必须实现Filter接口，并实现init(),doFilter(),destroy()三个方法。

        其中doFilter()方法进行过滤操作。尤其要注意的是:过滤有两种含义，一，执行该方法，判断Boolean类型的布尔值，true/false进行过滤，例如isLogin的布尔值来决定继续登录还是重定向到登录login界面;二，执行该方法，通过执行了该方法，将属性进行设置。例如，request.setCharacterEncoding("UTF-8")可以通过servlet编写过滤器对所有页面进行统一编码而不必每一页都这样设置。

        web.xml中对过滤器的配置与servlet的配置相类似。

概念：

Filter也称之为过滤器，它是Servlet技术中比较激动人心的技术，WEB开发人员通过Filter技术，对web服务器管理的所有web资源：例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。

二、Filter简介

Servlet API中提供了一个Filter接口，开发web应用时，如果编写的Java类实现了这个接口，则把这个java类称之为过滤器Filter。通过Filter技术，开发人员可以实现用户在访问某个目标资源之前，对访问的请求和响应进行拦截。简单说，就是可以实现web容器对某资源的访问前截获进行相关的处理，还可以在某资源向web容器返回响应前进行截获进行处理。

三、快速入门

1、新建一个类，实现Filter接口

2、实现doFilter()方法，打印一句话，来证明能够进行拦截

3、在web.xml中进行配置（参照Servlet配置）

4、访问一个页面，看看能不能拦截

1>
```
package com.test.filter;

import java.io.IOException;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
public class Demo1Filter implements Filter {
	private FilterConfig filterConfig;

	public void doFilter(ServletRequest request, ServletResponse response,
			FilterChain chain) throws IOException, ServletException {
		System.out.println("Demo1过滤前");
		System.out.println(filterConfig.getInitParameter("param1"));
		chain.doFilter(request, response);//放行。让其走到下个链或目标资源中
		System.out.println("Demo1过滤后");
	}

	public void init(FilterConfig filterConfig) throws ServletException {
		System.out.println("初始化了");
		this.filterConfig = filterConfig;
	}

	public void destroy() {
		System.out.println("销毁了");
	}
}
```
2>在web.xml中进行配置
```
 <filter>
 	<filter-name>Demo1Filter</filter-name>
 	<filter-class>com.itheima.filter.Demo1Filter</filter-class>
 	<init-param>
 		<param-name>param1</param-name>
 		<param-value>value在这里呢</param-value>
 	</init-param>
 </filter>
 <filter-mapping>
 	<filter-name>Demo1Filter</filter-name>
 	<url-pattern>/*</url-pattern>
 	<dispatcher>REQUEST</dispatcher> 
 	<dispatcher>FORWARD</dispatcher>
 	<dispatcher>ERROR</dispatcher>
 	<dispatcher>INCLUDE</dispatcher>
 </filter-mapping>
```
四、Filter的应用场景

通过对filter过滤器的了解，可以得知在以下三种情况下可以做些处理：

1> 通过控制对chain.doFilter的方法的调用，来决定是否需要访问目标资源。

比如，可以在用户权限验证等等。判断用户是否有访问某些资源的权限，有权限放行，没权限不执行chain.doFilter方法。

2> 通过在调用chain.doFilter方法之前，做些处理来达到某些目的。

比如，解决中文乱码的问题等等。可以在doFilter方法前，执行设置请求编码与响应的编码。甚至可以对request接口进行封装装饰来处理get请求方式的中文乱码问题(重写相应的request.getParameter方法)。

3> 通过在调用chain.doFilter方法之后，做些处理来达到某些目的。

比如对整个web网站进行压缩。在调用chain.doFilter方法之前用类A对response对象进行封装装饰，重写getOutputStream和重写getWriter方法。在类A内部中，将输出内容缓存进ByteArrayOutputStream流中，然后在chain.doFilter方法执行后，获取类A中ByteArrayOutputStream流缓存数据，用GZIPOutputStream流进行压缩下。

五、Filter实现拦截的原理

Filter接口中有一个doFilter方法，当开发人员编写好Filter类实现doFilter方法，并配置对哪个web资源进行拦截后，WEB服务器每次在调用web资源的service方法之前(服务器内部对资源的访问机制决定的)，都会先调用一下filter的doFilter方法。

六、Filter生命周期

和Servlet一样Filter的创建和销毁也是由WEB服务器负责。不过与Servlet区别的是，它是1>在应用启动的时候就进行装载Filter类(与Servlet的load-on-startup配置效果相同)。2>容器创建好Filter对象实例后，调用init()方法。接着被Web容器保存进应用级的集合容器中去了等待着，用户访问资源。3>当用户访问的资源正好被Filter的url-pattern拦截时，容器会取出Filter类调用doFilter方法，下次或多次访问被拦截的资源时，Web容器会直接取出指定Filter对象实例调用doFilter方法(Filter对象常驻留Web容器了)。4>当应用服务被停止或重新装载了，则会执行Filter的destroy方法，Filter对象销毁。

注意：init方法与destroy方法只会直接一次。

七、Filter部署应用注意事项

1> filter-mapping标签中servlet-name与url-pattern。

Filter不仅可以通过url-pattern来指定拦截哪些url匹配的资源。而且还可以通过servlet-name来指定拦截哪个指定的servlet(专门为某个servlet服务了,servlet-name对应Servlet的相关配置)。

2> filter-mapping标签中dispatcher。

指定过滤器所拦截的资源被 Servlet 容器调用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，默认REQUEST。用户可以设置多个<dispatcher> 子元素用来指定 Filter 对资源的多种调用方式进行拦截。

REQUEST：

当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问或ERROR情况时，那么该过滤器就不会被调用。

INCLUDE：

如果目标资源是通过RequestDispatcher的include()方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。

FORWARD：

如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。

ERROR：

如若在A.jsp页面page指令中指定了error属性=examError.jsp，那么A.jsp中若出现了异常，会跳转到examError.jsp中处理。而在跳转到examError.jsp时，若过滤器配置了ERROR的dispather那么则会拦截，否则不会拦截。

JavaWeb学习篇之----Servlet过滤器Filter和监听器
首先来看一下Servlet的过滤器内容:

一、Servlet过滤器的概念：

***************************************************************************************
Servlet过滤器是在Java Servlet规范2.3中定义的，它能够对Servlet容器的请求和响应对象进行检查和修改。　　　
Servlet过滤器本身并不产生请求和响应对象，它只能提供过滤作用。Servlet过期能够在Servlet被调用之前检查Request对象，修改Request Header和Request内容；在Servlet被调用之后检查Response对象，修改Response Header和Response内容。
Servlet过期负责过滤的Web组件可以是Servlet、JSP或者HTML文件。　
***************************************************************************************

二、Servlet过滤器的特点：
***************************************************************************************
A．Servlet过滤器可以检查和修改ServletRequest和ServletResponse对象
B．Servlet过滤器可以被指定和特定的URL关联，只有当客户请求访问该URL时，才会触发过滤器
C．Servlet过滤器可以被串联在一起，形成管道效应，协同修改请求和响应对象
***************************************************************************************

三、Servlet过滤器的作用：
***************************************************************************************
A．查询请求并作出相应的行动。
B．阻塞请求-响应对，使其不能进一步传递。
C．修改请求的头部和数据。用户可以提供自定义的请求。
D．修改响应的头部和数据。用户可以通过提供定制的响应版本实现。
E．与外部资源进行交互。
***************************************************************************************

四、Servlet过滤器的适用场合：
***************************************************************************************
A．认证过滤
B．登录和审核过滤
C．图像转换过滤
D．数据压缩过滤
E．加密过滤
F．令牌过滤
G．资源访问触发事件过滤
H．XSL/T过滤
I．Mime-type过滤
***************************************************************************************

五、Servlet过滤器接口的构成：
***************************************************************************************
所有的Servlet过滤器类都必须实现javax.servlet.Filter接口。这个接口含有3个过滤器类必须实现的方法：
A.init(FilterConfig)：
这是Servlet过滤器的初始化方法，Servlet容器创建Servlet过滤器实例后将调用这个方法。在这个方法中可以读取web.xml文件中Servlet过滤器的初始化参数
B.doFilter(ServletRequest,ServletResponse,FilterChain)：
这个方法完成实际的过滤操作，当客户请求访问于过滤器关联的URL时，Servlet容器将先调用过滤器的doFilter方法。FilterChain参数用于访问后续过滤器
C.destroy()：
Servlet容器在销毁过滤器实例前调用该方法，这个方法中可以释放Servlet过滤器占用的资源
***************************************************************************************

六、Servlet过滤器的创建步骤：
***************************************************************************************
A．实现javax.servlet.Filter接口
B．实现init方法，读取过滤器的初始化函数
C．实现doFilter方法，完成对请求或过滤的响应
D．调用FilterChain接口对象的doFilter方法，向后续的过滤器传递请求或响应
E．销毁过滤器
***************************************************************************************

七、Servlet过滤器对请求的过滤：
***************************************************************************************
A．Servlet容器创建一个过滤器实例
B．过滤器实例调用init方法，读取过滤器的初始化参数
C．过滤器实例调用doFilter方法，根据初始化参数的值判断该请求是否合法
D．如果该请求不合法则阻塞该请求
E．如果该请求合法则调用chain.doFilter方法将该请求向后续传递
***************************************************************************************

八、Servlet过滤器对响应的过滤：
***************************************************************************************
A．过滤器截获客户端的请求
B．重新封装ServletResponse，在封装后的ServletResponse中提供用户自定义的输出流
C．将请求向后续传递
D．Web组件产生响应
E．从封装后的ServletResponse中获取用户自定义的输出流
F．将响应内容通过用户自定义的输出流写入到缓冲流中
G．在缓冲流中修改响应的内容后清空缓冲流，输出响应内容
***************************************************************************************

九、Servlet过滤器的发布：
***************************************************************************************
A．发布Servlet过滤器时，必须在web.xml文件中加入<filter>元素和<filter-mapping>元素。
B．<filter>元素用来定义一个过滤器：
属性含义
filter-name 指定过滤器的名字
filter-class 指定过滤器的类名
init-param 为过滤器实例提供初始化参数，可以有多个
C．<filter-mapping>元素用于将过滤器和URL关联：
属性含义
filter-name 指定过滤器的名字
url-pattern 指定和过滤器关联的URL，为”/*”表示所有URL
***************************************************************************************

十一、Servlet过滤器使用的注意事项
***************************************************************************************
A．由于Filter、FilterConfig、FilterChain都是位于javax.servlet包下，并非HTTP包所特有的，所以其中所用到的请求、响应对象ServletRequest、ServletResponse在使用前都必须先转换成HttpServletRequest、HttpServletResponse再进行下一步操作。
B．在web.xml中配置Servlet和Servlet过滤器，应该先声明过滤器元素，再声明Servlet元素
C．如果要在Servlet中观察过滤器生成的日志，应该确保在server.xml的localhost对应的<host>元素中配置如下<logger>元素：
<Logger className = “org.apache.catalina.logger.FileLogger”
directory = “logs”prefix = “localhost_log.”suffix=”.txt”
timestamp = “true”/>

***************************************************************************************

十二、一个实例

首先来看一下web.xml的配置：
[html] view plain copy
1. 
2. <filter>
3. <filter-name>logfilter</filter-name>
4. <filter-class>com.weijia.filterservlet.LogFilter</filter-class>
5. </filter>
6. <filter-mapping>
7. <filter-name>logfilter</filter-name>
8. <url-pattern>/*</url-pattern>
9. </filter-mapping>
11. 
12. <filter>
13. <filter-name>setCharacterEncoding</filter-name>
14. <filter-class>com.weijia.filterservlet.EncodingFilter</filter-class>
15. <init-param>
16. <param-name>encoding</param-name>
17. <param-value>utf-8</param-value>
18. </init-param>
19. </filter>
20. <filter-mapping>
21. <filter-name>setCharacterEncoding</filter-name>
22. <url-pattern>/*</url-pattern>
23. </filter-mapping>
然后看一下编码过滤器：
[java] view plain copy
1. package com.weijia.filterservlet;
3. import java.io.IOException;
4. import java.util.Enumeration;
5. import java.util.HashMap;
7. import javax.servlet.Filter;
8. import javax.servlet.FilterChain;
9. import javax.servlet.FilterConfig;
10. import javax.servlet.ServletException;
11. import javax.servlet.ServletRequest;
12. import javax.servlet.ServletResponse;
14. public class EncodingFilter implements Filter {
15. private String encoding;
16. private HashMap<String,String> params = new HashMap<String,String>();
17. // 项目结束时就已经进行销毁
18. public void destroy() {
19. System.out.println("end do the encoding filter!");
20. params=null;
21. encoding=null;
22. }
23. public void doFilter(ServletRequest req, ServletResponse resp,FilterChain chain) throws IOException, ServletException {
24. System.out.println("before encoding " + encoding + " filter！");
25. req.setCharacterEncoding(encoding);
26. chain.doFilter(req, resp);
27. System.out.println("after encoding " + encoding + " filter！");
28. System.err.println("----------------------------------------");
29. }
31. // 项目启动时就已经进行读取
32. public void init(FilterConfig config) throws ServletException {
33. System.out.println("begin do the encoding filter!");
34. encoding = config.getInitParameter("encoding");
35. for (Enumeration<?> e = config.getInitParameterNames(); e.hasMoreElements();) {
36. String name = (String) e.nextElement();
37. String value = config.getInitParameter(name);
38. params.put(name, value);
39. }
40. }
41. }
日志过滤器：
[java] view plain copy
1. package com.weijia.filterservlet;
3. import java.io.IOException;
5. import javax.servlet.Filter;
6. import javax.servlet.FilterChain;
7. import javax.servlet.FilterConfig;
8. import javax.servlet.ServletException;
9. import javax.servlet.ServletRequest;
10. import javax.servlet.ServletResponse;
11. import javax.servlet.http.HttpServletRequest;
13. public class LogFilter implements Filter {
15. public FilterConfig config;
17. public void destroy() {
18. this.config = null;
19. System.out.println("end do the logging filter!");
20. }
22. public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {
23. System.out.println("before the log filter!");
24. // 将请求转换成HttpServletRequest 请求
25. HttpServletRequest hreq = (HttpServletRequest) req;
26. // 记录日志
27. System.out.println("Log Filter已经截获到用户的请求的地址:"+hreq.getServletPath() );
28. try {
29. // Filter 只是链式处理，请求依然转发到目的地址。
30. chain.doFilter(req, res);
31. } catch (Exception e) {
32. e.printStackTrace();
33. }
34. System.out.println("after the log filter!");
35. }
37. public void init(FilterConfig config) throws ServletException {
38. System.out.println("begin do the log filter!");
39. this.config = config;
40. }
42. }
测试Servlet:
[java] view plain copy
1. package com.weijia.filterservlet;
3. import java.io.IOException;
5. import javax.servlet.ServletException;
6. import javax.servlet.http.HttpServlet;
7. import javax.servlet.http.HttpServletRequest;
8. import javax.servlet.http.HttpServletResponse;
10. public class FilterServlet extends HttpServlet {
12. private static final long serialVersionUID = 1L;
14. public void doGet(HttpServletRequest request, HttpServletResponse response)
15. throws ServletException, IOException {
16. response.setDateHeader("expires", -1);
17. }
19. public void doPost(HttpServletRequest request, HttpServletResponse response)
20. throws ServletException, IOException {
21. }
23. }
访问FilterServlet

运行结果：

before the log filter!
Log Filter已经截获到用户的请求的地址:/FilterServlet
before encoding utf-8 filter！
after encoding utf-8 filter！
----------------------------------------
after the log filter!

我们从运行结果可以看到这个过滤器的调用关系：

类似于C++中的构造函数和析构函数的调用顺序，

这里我们在web.xml中注册的是先注册日志过滤器的，然后再注册

当我们重新部署应用的时候发现：

会先销毁上次的过滤器，然后再重新注册一下

下面在来看一下Servlet的监听器

Servlet监听器用于监听一些重要事件的发生，监听器对象可以在事情发生前、发生后可以做一些必要的处理。下面将介绍几种常用的监听器，以及它们都适合运用于那些环境。

分类及介绍：
1． ServletContextListener：用于监听WEB 应用启动和销毁的事件，监听器类需要实现javax.servlet.ServletContextListener 接口。
Java代码
1. public class QuartzListener implements ServletContextListener {
3. private Logger logger = LoggerFactory.getLogger(QuartzListener.class);
5. public void contextInitialized(ServletContextEvent sce) {
7. }
9. /**
10. *在服务器停止运行的时候停止所有的定时任务
11. */
12. @SuppressWarnings("unchecked")
13. public void contextDestroyed(ServletContextEvent arg0) {
14. try {
15. Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
16. List<JobExecutionContext> jobList = scheduler.getCurrentlyExecutingJobs();
17. for (JobExecutionContext jobContext : jobList) {
18. Job job = jobContext.getJobInstance();
19. if (job instanceof InterruptableJob) {
20. ((InterruptableJob) job).interrupt();
21. }
22. }
23. scheduler.shutdown();
24. } catch (SchedulerException e) {
25. logger.error("shut down scheduler happened error", e);
26. }
27. }
28. }
2． ServletContextAttributeListener：用于监听WEB应用属性改变的事件，包括：增加属性、删除属性、修改属性，监听器类需要实现javax.servlet.ServletContextAttributeListener接口。

3． HttpSessionListener：用于监听Session对象的创建和销毁，监听器类需要实现javax.servlet.http.HttpSessionListener接口或者javax.servlet.http.HttpSessionActivationListener接口，或者两个都实现。
Java代码
1. /**
2. *
3. * 会话监听器
4. * <p />
5. *
6. */
7. public class SessionListener implements HttpSessionListener {
9. @Override
10. public void sessionCreated(HttpSessionEvent arg0) {
12. }
14. @Override
15. public void sessionDestroyed(HttpSessionEvent event) {
16. HttpSession session = event.getSession();
17. User user = (BrsSession) session.getAttribute("currUser");
18. if (user != null) {
19. //TODO something
20. }
21. }
23. }
4． HttpSessionActivationListener：用于监听Session对象的钝化/活化事件，监听器类需要实现javax.servlet.http.HttpSessionListener接口或者javax.servlet.http.HttpSessionActivationListener接口，或者两个都实现。

5． HttpSessionAttributeListener：用于监听Session对象属性的改变事件，监听器类需要实现javax.servlet.http.HttpSessionAttributeListener接口。

部署：
监听器的部署在web.xml文件中配置，在配置文件中，它的位置应该在过滤器的后面Servlet的前面

web.xml配置文件：

Java代码
相关阅读:
linux shell习题
 The logback manual #02# Architecture
The logback manual #01# Introduction
算法导论（第三版）练习 10.1-1 ~ 10.1-7
算法笔记 #006# 快速排序 × 算法导论（第三版）练习 7.1-1 ~ 7.1-4
Linux笔记 #08# shell编程从零开始到低配学生管理系统
 Maven笔记 #01# 入门
 Java日志学习资料收集
 jsp中用EL读取了数据库里面的时间,怎么设置格式显示的格式
 ajax异步处理时，如何在JS中获取从Servlet或者Action中session，request
原文地址：https://www.cnblogs.com/fqwsndc1314-5207788/p/7396733.html

概念：

JavaWeb学习篇之----Servlet过滤器Filter和监听器