叩丁狼分享—培训实战教程之浅谈过滤器Filter
一、过滤器的基本概念Java中的Filter 并不是一个标准的Servlet ，它不能处理用户请求，也不能对客户端生成响应。 主要用于对HttpServletRequest 进行预处理，也可以对HttpServletResponse 进行后处理，是个典型的处理链。过滤链的好处是，执行过程中任何时候都可以打断，只要不执行chain.doFilter()就不会再执行后面的过滤器和请求的内容。而在实际使用时，就要特别注意过滤链的执行顺序问题.。
二、过滤器的运行原理过滤器(Filter)接口中有一个doFilter方法，当开发人员编写好Filter，并配置对哪个web资源进行拦截后，WEB服务器每次在调用web资源的service方法之前，都会先调用一下filter的doFilter方法.web服务器在调用doFilter方法时，会传递request,reponse,filterChain对象进来，filterChain对象是filter接口中最重要的一个对象，它也提供了一个doFilter方法，开发人员可以根据需求决定是否调用此方法，调用该方法，则web服务器就会调用web资源的service方法，即web资源就会被访问,而且我们能够在调用doFilter方法之前先对request、response进行预处理，否则web资源不会被访问。
原理图：
1. 编写java类实现Filter接口，并实现其doFilter方法。
2. 在 web.xml 文件中使用 filter 和 filter-mapping 元素对编写的filter类进行注册，并设置它所能拦截的资源。
Java代码：
public class FilterDemo01 implements Filter {
public void doFilter(ServletRequest request, ServletResponse response,FilterChain chain) throws IOException, ServletException {
System.out.println( 进入FilterDemo01过滤器
}
@Override
public void destroy() {
}
@Override
public void init(FilterConfig filterConfig) throws ServletException {}
Web.xml配置文件
filter
!-- 为Filter取一个唯一的名字 --
filter-name FilterDemo01 /filter-name
!-- Filter的全路径类名，必须提供无参构造器 --
filter-class cn.itcast.javaee.filter.base.FilterDemo01 /filter-class
/filter
filter-mapping
filter-name FilterDemo01 /filter-name
!-- Filter能过滤的URL路径 --
url-pattern /DynaServlet /url-pattern
/filter-mapping
叩丁狼分享—培训实战教程之浅谈过滤器Filter
四、过滤器详解4.1过滤器的生命周期1. init(FilterConfig)：在服务器启动时会创建Filter实例，并且每个类型的Filter只创建一个实例，从此不再创建!在创建完Filter实例后，会马上调用init()方法完成初始化工作，这个方法只会被执行一次;
2. doFilter(ServletRequest req,ServletResponse res,FilterChain chain)：这个方法会在用户每次访问 目标资源( url- pattern index.jsp /url-pattern ) 时执行，如果需要 放行 ，那么需要调用FilterChain的doFilter(ServletRequest,ServletResponse)方法，如果不调用FilterChain的doFilter()方法，那么目标资源将无法执行;
3. destroy()：服务器会在创建Filter对象之后，把Filter放到缓存中一直使用，通常不会销毁它。一般会在服务器关闭时销毁Filter对象，在销毁Filter对象之前，服务器会调用Filter对象的destory()方法。
4.2 FilterConfig对象 Filter接口中的init()方法的参数类型为FilterConfig类型。它的功能与ServletConfig相似，与web.xml文件中的配置信息对应。下面是FilterConfig的功能介绍：
l ServletContext getServletContext()：获取ServletContext的方法;
l String getFilterName()：获取Filter的配置名称;与 filter-name 元素对应;
l String getInitParameter(String name)：获取Filter的初始化配置，与 init-param 元素对应;
l Enumeration getInitParameterNames()：获取所有初始化参数的名称。
4.3 FilterChain过滤器
doFilter()方法的参数中有一个类型为FilterChain的参数，它只有一个方法：doFilter(ServletRequest,ServletResponse)。前面我们说doFilter()方法的放行，让请求流访问目标资源!但这么说不严密，其实调用该方法的意思是， 我(当前Filter) 放行了，但不代表其他人(其他过滤器)也放行。因为一个目标资源上，可能部署了多个过滤器，就好比孙悟空去取经要经过九九八十一难一样，消灭了第一个妖怪还不是成功。然后我们过滤器也是一样，如果当前过滤器是最后一个过滤器，那么调用chain.doFilter()方法表示执行目标资源，而不是最后一个过滤器，那么chain.doFilter()表示执行下一个过滤器的doFilter()方法。
代码：
filter-name filter1 /filter-name
filter-class cn.itcast.filter.MyFilter1 /filter-class
/filter
filter-mapping
filter-name filter1 /filter-name
url-pattern /index.jsp /url-pattern
/filter-mapping
filter
filter-name filter2 /filter-name
filter-class cn.itcast.filter.MyFilter2 /filter-class
/filter
filter-mapping
filter-name myFilter2 /filter-name
url-pattern /index.jsp /url-pattern
/filter-mapping
public class MyFilter1 extends HttpFilter {
public void doFilter(HttpServletRequest request, HttpServletResponse response,
FilterChain chain) throws IOException, ServletException {
System.out.println( filter1 start...
chain.doFilter(request, response);//放行，执行MyFilter2的doFilter()方法
System.out.println( filter1 end...
}
public class MyFilter2 extends HttpFilter {
public void doFilter(HttpServletRequest request, HttpServletResponse response,
FilterChain chain) throws IOException, ServletException {
System.out.println( filter2 start...
chain.doFilter(request, response);//放行，执行目标资源
System.out.println( filter2 end...
}
4.3过滤器的四种拦截方式我们来做个测试，写一个过滤器，指定过滤的资源为b.jsp，然后我们在浏览器中直接访问b.jsp，你会发现过滤器执行了!但是，当我们在a.jsp中request.getRequestDispathcer( /b.jsp ).forward(request,response)时，就不会再执行过滤器了!也就是说，默认情况下，只能直接访问目标资源才会执行过滤器，而forward执行目标资源，不会执行过滤器!
其实过滤器有四种拦截方式!分别是：REQUEST、FORWARD、INCLUDE、ERROR。
l REQUEST：直接访问目标资源时执行过滤器。包括：在地址栏中直接访问、表单提交、超链接、重定向，只要在地址栏中可以看到目标资源的路径，就是REQUEST;
l FORWARD：转发访问执行过滤器。包括RequestDispatcher#forward()方法、 jsp:forward 标签都是转发访问;
l INCLUDE：包含访问执行过滤器。包括RequestDispatcher#include()方法、 jsp:include 标签都是包含访问;
l ERROR：当目标资源在web.xml中配置为 error-page 中时，并且真的出现了异常，转发到目标资源时，会执行过滤器。
可以在 filter-mapping 中添加0~n个 dispatcher 子元素，来说明当前访问的拦截方式。
filter-name myfilter /filter-name
url-pattern /b.jsp /url-pattern
dispatcher REQUEST /dispatcher
dispatcher FORWARD /dispatcher
/filter-mapping
filter-name myfilter /filter-name
url-pattern /b.jsp /url-pattern
/filter-mapping
filter-name myfilter /filter-name
url-pattern /b.jsp /url-pattern
dispatcher FORWARD /dispatcher
/filter-mapping
其实最为常用的就是REQUEST和FORWARD两种拦截方式，而INCLUDE和ERROR都比较少用!ERROR方式如下:
filter-name myfilter /filter-name
url-pattern /b.jsp /url-pattern
dispatcher ERROR /dispatcher
/filter-mapping
error-page
error-code 500 /error-code
location /b.jsp /location
/error-page
public class EncodingRequest extends HttpServletRequestWrapper {
private String charset;
public EncodingRequest(HttpServletRequest request, String charset) {
super(request);
this.charset = charset;
}
public String getParameter(String name) {
HttpServletRequest request = (HttpServletRequest) getRequest();
String method = request.getMethod();
if(method.equalsIgnoreCase( post )) {
try {
request.setCharacterEncoding(charset);
} catch (UnsupportedEncodingException e) {}
} else if(method.equalsIgnoreCase( get )) {
String value = request.getParameter(name);
try {
value = new String(name.getBytes( ISO-8859-1 ), charset);
} catch (UnsupportedEncodingException e) {
}
return value;
}
return request.getParameter(name);
}
public class EncodingFilter extends HttpFilter {
public void doFilter(HttpServletRequest request,
HttpServletResponse response, FilterChain chain)
throws IOException, ServletException {
String charset = this.getInitParameter( charset
if(charset == null || charset.isEmpty()) {
charset = UTF-8
}
response.setCharacterEncoding(charset);
response.setContentType( text/html;charset= + charset);
EncodingRequest res = new EncodingRequest(request, charset);
chain.doFilter(res, response);
}
}
public void init(FilterConfig filterConfig) throws ServletException {
}
public void doFilter(ServletRequest req, ServletResponse res,FilterChain chain) throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) req;
HttpServletResponse response = (HttpServletResponse) res;
//读取浏览器中的cookie
Cookie[] cookies = request.getCookies();
//如果有cookie
if(cookies!=null cookies.length 0){
Cookie usernameCookie = null;
//迭代
for(Cookie c : cookies){
//询找指定的cookie
if( usernameCookie .equals(c.getName())){
//记录已找到的cookie
usernameCookie = c;
//退出
break;
}
}
//如果找到了指定的cookie
if(usernameCookie!=null){
//获取该cookie的值，但此时的值是经过编码后的
String username = usernameCookie.getValue();
//解码
username = URLDecoder.decode(username, UTF-8
//将用户名绑定HttpSession域对象中
request.getSession().setAttribute( username ,username);
//放行请求
chain.doFilter(request,response);
//如果没找到了指定的cookie
}else{
//放行请求
chain.doFilter(request,response);
}
//如果没cookie
}else{
//放行请求
chain.doFilter(request,response);
}
}
5.3 数据压缩public class CharGzipFilter implements Filter {
public void destroy() {
}
public void init(FilterConfig filterConfig) throws ServletException {
}
public void doFilter(ServletRequest req, ServletResponse res,FilterChain chain) throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) req;
HttpServletResponse response = (HttpServletResponse) res;
//创建MyResponse对象
MyResponse myResponse = new MyResponse(response);
//放行请求，即进入charGzip.jsp
chain.doFilter(request,myResponse);
//取出缓存中的数据
byte[] data = myResponse.getData();
//显示
System.out.println( 压缩前： +data.length);
//进行字符压缩，该类只能用于字符流压缩
ByteArrayOutputStream baos = new ByteArrayOutputStream();
GZIPOutputStream gzip = new GZIPOutputStream(baos);
gzip.write(data);
gzip.flush();
gzip.close();
//从缓存中取出压缩后的字节
data = baos.toByteArray();
//显示
System.out.println( 压缩后： +data.length);
//通知浏览器需要接收GZIP压缩格式的数据
response.setHeader( content-encoding , gzip
//将压强后的数据输出到浏览器
response.getOutputStream().write(data);
}
}
/**
* 1)写一个普通类继承HttpServletResponseWrapper类
*/
class MyResponse extends HttpServletResponseWrapper{
private PrintWriter pw;
private ByteArrayOutputStream baos = new ByteArrayOutputStream();
private HttpServletResponse response;
public MyResponse(HttpServletResponse response) {
super(response);
this.response = response;
}
/**
* 4)重写父类的getWriter()方法，返回带有缓存的PrintWriter对象
*/
@Override
public PrintWriter getWriter() throws IOException {
pw = new PrintWriter(new OutputStreamWriter(baos, UTF-8 ));
return pw;
}
public byte[] getData(){
if(pw!=null){
pw.flush();
}
return baos.toByteArray();
}
过滤器除了以上的应用之外，还可以做用户权限的检查、静态资源的缓存优化、拦截器的代理、
等应用操作，在这里就不一一列举了。