1.过滤器简介
Filter也称之为过滤器，它是Servlet技术中最激动人心的技术，WEB开发人员通过Filter技术，对web服务器管理的所有web资源：例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。
Servlet API中提供了一个Filter接口，开发WEB应用时，如果编写的Java类实现了这个接口，则把这个java类称之为过滤器Filter。通过Filter技术，开发人员可以实现用户在访问某个目标资源之前，对访问的请求和响应进行拦截。
过滤器链，正常流程
过滤失败，返回
比较复杂的形式
- 用户提交个人信息的请求。
- 请求将被发送到服务器。
- 它通过过滤器,记录日志信息。
- 它去过滤检查用户已登陆,这个过滤器发现用户没有登录,它将用户的请求重定向到登录页面。
2. 过滤器 API
由容器实现的接口
– javax.servlet.Filter
– javax.servlet.FilterChain
– javax.servlet.FilterConfig
四个包装器类
– javax.servlet.ServletRequestWrapper
– javax.servlet.ServletResponseWrapper
– javax.servlet.http.HttpServletRequestWrapper
– javax.servlet.http.HttpServletResponseWrapper
3.Filter是如何实现拦截的？
Filter接口中有一个doFilter方法，当我们编写好Filter，并配置对哪个web资源进行拦截后，WEB服务器每次在调用web资源的service方法之前，都会先调用一下filter的doFilter方法，因此，在该方法内编写代码可达到如下目的：
- 调用目标资源之前，让一段代码执行。
- 是否调用目标资源（即是否让用户访问web资源）。
- 调用目标资源之后，让一段代码执行。
web服务器在调用doFilter方法时，会传递一个filterChain对象进来，filterChain对象是filter接口中最重要的一个对 象，它也提供了一个doFilter方法，开发人员可以根据需求决定是否调用此方法，调用该方法，则web服务器就会调用web资源的service方 法，即web资源就会被访问，否则web资源不会被访问。
4. Filter 开发使用
4.1 过滤器开发步骤
- 编写java类实现Filter接口，并实现其doFilter方法。
- 在 web.xml 文件中使用<filter>和<filter-mapping>元素对编写的filter类进行注册，并设置它所能拦截的资源。
Servlet 3.0 里面对过滤器也提供了注解方式，但是大部分我们还是习惯使用XML方式
编码过滤器
/**
* @ClassName: FilterDemo01
* @Description:filter的三种典型应用：
* 1、可以在filter中根据条件决定是否调用chain.doFilter(request, response)方法，即是否让目标资源执行
* 2、在让目标资源执行之前，可以对request\response作预处理，再让目标资源执行
* 3、在目标资源执行之后，可以捕获目标资源的执行结果，从而实现一些特殊的功能
* @author: 胖先森
*/
public class FilterDemo01 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("----过滤器初始化----");
}
@Override
public void doFilter(ServletRequest request, ServletResponse response,
FilterChain chain) throws IOException, ServletException {
//对request和response进行一些预处理
request.setCharacterEncoding("UTF-8");
response.setCharacterEncoding("UTF-8");
response.setContentType("text/html;charset=UTF-8");
System.out.println("FilterDemo01执行前！！！");
chain.doFilter(request, response); //让目标资源执行，放行
System.out.println("FilterDemo01执行后！！！");
}
@Override
public void destroy() {
System.out.println("----过滤器销毁----");
}
}
建立过滤器规则：
<!--配置过滤器-->
<filter>
<filter-name>FilterDemo01</filter-name>
<filter-class>com.hapang.web.filter.FilterDemo01</filter-class>
</filter>
<!--映射过滤器-->
<filter-mapping>
<filter-name>FilterDemo01</filter-name>
<!--“/*”表示拦截所有的请求 -->
<url-pattern>/*</url-pattern>
</filter-mapping>
4.2 过滤器链
在一个web应用中，可以开发编写多个Filter，这些Filter组合起来称之为一个Filter链。
web服务器根据Filter在web.xml文件中的注册顺序，决定先调用哪个Filter，当第一个Filter的doFilter方法被调用时，web服务器会创建一个代表Filter链的FilterChain对象传递给该方法。在doFilter方法中，开发人员如果调用了FilterChain对象的doFilter方法，则web服务器会检查FilterChain对象中是否还有filter，如果有，则调用第2个filter，如果没有，则调用目标资源。
5.过滤器的生命周期
目前我们已经学过
- JSP的生命周期
- Servlet的生命周期
下面我们来学学过滤器的生命周期
5.1 Filter的创建
Filter的创建和销毁由WEB服务器负责。 web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作，filter对象只会创建一次，init方法也只会执行一次。通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。
5.2 Filter的销毁
Web容器调用destroy方法销毁Filter。destroy方法在Filter的生命周期中仅执行一次。在destroy方法中，可以释放过滤器使用的资源。
5.3 FilterConfig接口
用户在配置filter时，可以使用<init-param>为filter配置一些初始化参数，当web容器实例化Filter对象，调用其init方法时，会把封装了filter初始化参数的filterConfig对象传递进来。因此开发人员在编写filter时，通过filterConfig对象的方法，就可获得：
- String getFilterName()：得到filter的名称。
- String getInitParameter(String name)： 返回在部署描述中指定名称的初始化参数的值。如果不存在返回null.
- Enumeration getInitParameterNames()：返回过滤器的所有初始化参数的名字的枚举集合。
- public ServletContext getServletContext()：返回Servlet上下文对象的引用。
public class FilterDemo02 implements Filter {
/* 过滤器初始化
* @see javax.servlet.Filter#init(javax.servlet.FilterConfig)
*/
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("----过滤器初始化----");
/**
* <filter>
<filter-name>FilterDemo02</filter-name>
<filter-class>com.hanpang.web.filter.FilterDemo02</filter-class>
<!--配置FilterDemo02过滤器的初始化参数-->
<init-param>
<description>配置FilterDemo02过滤器的初始化参数</description>
<param-name>name</param-name>
<param-value>胖哥</param-value>
</init-param>
<init-param>
<description>配置FilterDemo02过滤器的初始化参数</description>
<param-name>like</param-name>
<param-value>撸串</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>FilterDemo02</filter-name>
<!--“/*”表示拦截所有的请求 -->
<url-pattern>/*</url-pattern>
</filter-mapping>
*/
//得到过滤器的名字
String filterName = filterConfig.getFilterName();
//得到在web.xml文件中配置的初始化参数
String initParam1 = filterConfig.getInitParameter("name");
String initParam2 = filterConfig.getInitParameter("like");
//返回过滤器的所有初始化参数的名字的枚举集合。
Enumeration<String> initParameterNames = filterConfig.getInitParameterNames();
System.out.println(filterName);
System.out.println(initParam1);
System.out.println(initParam2);
while (initParameterNames.hasMoreElements()) {
String paramName = (String) initParameterNames.nextElement();
System.out.println(paramName);
}
}
@Override
public void doFilter(ServletRequest request, ServletResponse response,
FilterChain chain) throws IOException, ServletException {
System.out.println("FilterDemo02执行前！！！");
chain.doFilter(request, response); //让目标资源执行，放行
System.out.println("FilterDemo02执行后！！！");
}
@Override
public void destroy() {
System.out.println("----过滤器销毁----");
}
}
6.Filter的部署
Filter的部署分为两个步骤：
- 1、注册Filter
- 2、映射Filter
6.1 注册Filter
开发好Filter之后，需要在web.xml文件中进行注册，这样才能够被web服务器调用
在web.xml文件中注册Filter范例：
<filter>
<description>FilterDemo02过滤器</description>
<filter-name>FilterDemo02</filter-name>
<filter-class>com.hanpang.web.filter.FilterDemo02</filter-class>
<!--配置FilterDemo02过滤器的初始化参数-->
<init-param>
<description>配置FilterDemo02过滤器的初始化参数</description>
<param-name>name</param-name>
<param-value>胖先森</param-value>
</init-param>
<init-param>
<description>配置FilterDemo02过滤器的初始化参数</description>
<param-name>like</param-name>
<param-value>小宁</param-value>
</init-param>
</filter>
- <description> ：用于添加描述信息，该元素的内容可为空，<description>可以不配置。
- <filter-name> ：用于为过滤器指定一个名字，该元素的内容不能为空。
- <filter-class> ：元素用于指定过滤器的完整的限定类名。
- <init-param> ：元素用于为过滤器指定初始化参数，它的子元素<param-name>指定参数的名字，<param-value>指定参数的值。在过滤器中，可以使用FilterConfig接口对象来访问初始化参数。如果过滤器不需要指定初始化参数，那么<init-param>元素可以不配置。
6.2 映射Filter
在web.xml文件中注册了Filter之后，还要在web.xml文件中映射Filter
<!--映射过滤器-->
<filter-mapping>
<filter-name>FilterDemo02</filter-name>
<!--“/*”表示拦截所有的请求 -->
<url-pattern>/*</url-pattern>
</filter-mapping>
- <filter-mapping> ：元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径
- <filter-name> ：子元素用于设置filter的注册名称。该值必须是在<filter>元素中声明过的过滤器的名字
- <url-pattern> ：设置 filter 所拦截的请求路径(过滤器关联的URL样式)
- <servlet-name> ：指定过滤器所拦截的Servlet名称。
- <dispatcher> ：指定过滤器所拦截的资源被 Servlet 容器调用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，默认REQUEST。用户可以设置多个<dispatcher> 子元素用来指定 Filter 对资源的多种调用方式进行拦截。如下：
<filter-mapping>
<filter-name>testFilter</filter-name>
<url-pattern>/index.jsp</url-pattern>
<dispatcher>REQUEST</dispatcher>
<dispatcher>FORWARD</dispatcher>
</filter-mapping>
<dispatcher> 子元素可以设置的值及其意义：
- REQUEST：当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时，那么该过滤器就不会被调用。
- INCLUDE：如果目标资源是通过RequestDispatcher的include()方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。
- FORWARD：如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。
- ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用。
7.常用应用
7.1 不允许直接访问JSP
public class JspFilter implements Filter {
@Override
public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain)
throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) req;
HttpServletResponse response = (HttpServletResponse) resp;
String path = request.getRequestURI();
if (path.endsWith(".jsp")) {
response.setContentType("text/html;charset=UTF-8");
PrintWriter out = response.getWriter();
out.write("<h1>不允许直接访问JSP页面</h1>");
out.flush();
out.close();
}else{
chain.doFilter(req, resp);
}
}
}
7.2 登录过滤器
public class SessionFilter implements Filter {
private final static String LOGIN_JSP = "/login.jsp";
private final static String LOGIN_URL = "sys/login";
private final static String SESSION_KEY = "session_user";
private static List<String> excludePath = new ArrayList<String>();
@Override
public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain)
throws IOException, ServletException {
//1.获取HttpSession
HttpServletRequest request = (HttpServletRequest)req;
HttpServletResponse response = (HttpServletResponse)resp;
HttpSession session = request.getSession();
//排除的资源
String path = request.getRequestURI();
String ext = path.substring(path.lastIndexOf("."));
if(/*path.endsWith("login.jsp")||path.endsWith("sys/login")
||path.endsWith(".css")||path.endsWith(".js")||path.endsWith(".png")
||path.endsWith(".jpg")||path.endsWith(".gif")||path.endsWith(".html") */
path.endsWith(LOGIN_URL)||excludePath.contains(ext)
){
//放行
chain.doFilter(req, resp);
}else{
if(session.getAttribute(SESSION_KEY)!=null){
//已经登录
chain.doFilter(req, resp);
}else{
response.sendRedirect(request.getContextPath()+LOGIN_JSP);
}
}
}
@Override
public void init(FilterConfig arg0) throws ServletException {
excludePath.add(".css");
excludePath.add(".js");
excludePath.add(".png");
excludePath.add(".jpg");
excludePath.add(".gif");
excludePath.add(".html");
}
@Override
public void destroy() {
}
}
7.3 排除JSP的空格
来自于别人已经写好的过滤器
参考配置网站：
http://www.servletsuite.com/servlets/trimflt.htm
7.4 编码过滤器
因为我们设置了GET的URIEncoding="UTF-8"，其实只是需要过滤器POST请求的中文乱码问题就好
public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain)
throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest)req;
HttpServletResponse response = (HttpServletResponse)resp;
if("POST".equals(request.getMethod())){
request.setCharacterEncoding("UTF-8");
}
response.setContentType("text/html;charset=UTF-8");
chain.doFilter(req, resp);
}
胖先森的学生，请参考一下，谢谢大家支持！！！
