一、介绍
Filter可以管理web服务器中所有的web资源,
开发人员通过Filter技术，对web服务器管理的所有web资源：例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。
Servlet API中提供了一个Filter接口，开发web应用时，如果编写的Java类实现了这个接口，则把这个java类称之为过滤器Filter。通过Filter技术，开发人员可以实现用户在访问某个目标资源之前，对访问的请求和响应进行拦截，
二、实现原理
Filter接口中有一个doFilter方法，当我们编写好Filter，并配置对哪个web资源进行拦截后，WEB服务器每次在调用web资源的service方法之前，都会先调用一下filter的doFilter方法，因此，在该方法内编写代码可达到如下目的：
1. 调用目标资源之前，让一段代码执行。
2. 是否调用目标资源（即是否让用户访问web资源）。
3. 调用目标资源之后，让一段代码执行。
web服务器在调用doFilter方法时，会传递一个filterChain对象进来，filterChain对象是filter接口中最重要的一个对 象，它也提供了一个doFilter方法，开发人员可以根据需求决定是否调用此方法，调用该方法，则web服务器就会调用web资源的service方 法，即web资源就会被访问，否则web资源不会被访问。
三、开发步骤
- 编写java类实现Filter接口，并实现其doFilter方法。
- 在 web.xml 文件中使用<filter>和<filter-mapping>元素对编写的filter类进行注册，并设置它所能拦截的资源。
//继承javax.servlet.Filter;
public class FilterTest implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("init方法被调用");
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
System.out.println("执行过滤了");
chain.doFilter(request, response);//放行，如果没有这句，将不去调用浏览器请求的web资源
}
@Override
public void destroy() {
System.out.println("被销毁了");
}
}
jsp界面
<body>
<h1>过滤器 </h1>
</body>
当不执行
chain.doFilter(request, response)发现浏览器不会显示内容
当执行放行
四、过滤链
在一个web应用中，可以开发编写多个Filter，这些Filter组合起来称之为一个Filter链。
web服务器根据Filter在web.xml文件中的注册顺序，决定先调用哪个Filter，当第一个Filter的doFilter方法被调用时，web服务器会创建一个代表Filter链的FilterChain对象传递给该方法。在doFilter方法中，开发人员如果调用了FilterChain对象的doFilter方法，则web服务器会检查FilterChain对象中是否还有filter，如果有，则调用第2个filter，如果没有，则调用目标资源。
五、生命周期
1、Filter的创建
Filter的创建和销毁由WEB服务器负责。 web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作，filter对象只会创建一次，init方法也只会执行一次。通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。
2、当访问web资源时调用
doFilter
3、Filter的销毁
当web服务器关闭时、Web容器调用destroy方法销毁Filter。destroy方法在Filter的生命周期中仅执行一次。在destroy方法中，可以释放过滤器使用的资源。
六、初始化参数
1、web.xml配置
<filter>
<filter-name>InitParameter</filter-name>
<filter-class>com.web.filter.InitParameter</filter-class>
<init-param>
<description>第一个初始化参数</description>
<param-name>name</param-name>
<param-value>jia</param-value>
</init-param>
<init-param>
<description>第二个初始化参数</description>
<param-name>age</param-name>
<param-value>20</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>InitParameter</filter-name>
<url-pattern>/Demo</url-pattern>
</filter-mapping>
public class InitParameter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("init方法");
Enumeration<String> init = filterConfig.getInitParameterNames();
while (init.hasMoreElements()) {
String name = (String) init.nextElement();
String value = filterConfig.getInitParameter(name);
System.out.println(name);
System.out.println(value);
}
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
System.out.println("过滤");
}
@Override
public void destroy() {
System.out.println("销毁");
}
}
结果当web服务器启动时就获得了初始化参数
七、案例统一乱码问题
过滤器
public class EncodingFilter implements Filter {
private FilterConfig fConfig = null;
//设置默认编码为utf-8
String defaultEncoding="utf-8";
public void doFilter(ServletRequest request1, ServletResponse response1, FilterChain chain)
throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) request1;
HttpServletResponse response = (HttpServletResponse) response1;
// 得到web.xml里的初始编码
String initParameter = fConfig.getInitParameter("charset");
//判断是否为空，为null说明没有初始编码，将默认编码赋值给初始编码
if (initParameter==null) {
initParameter=defaultEncoding;
}
//设置请求编码
request.setCharacterEncoding(initParameter);
System.out.println("initParameter:"+initParameter);
//设置响应编码
response.setContentType("text/html;charset="+initParameter);
MyRequest r=new MyRequest(request);
//放行的时候将过滤后的编码传递给Myrequest
chain.doFilter(r, response);
}
public void init(FilterConfig fConfig) throws ServletException {
this.fConfig = fConfig;
System.out.println("init()执行");
}
public void destroy() {
}
}
包装增强类
包装类一般实现步骤
1、实现与被包装类相同的接口
2、定义一个变量记住被增强对象
3、定义一个构造器，接受被增强对象
4、覆盖要增强的方法
5】对不想增强的方法直接调用被增强对象（目标对象）的方法
public class MyRequest extends HttpServletRequestWrapper {
HttpServletRequest request;
public MyRequest(HttpServletRequest request) {
super(request);
this.request = request;
}
@Override
public String getParameter(String name) {
//获取表单参数
String value = request.getParameter(name);
if (value == null) {
return null;
}
//当方法为get时进行编码处理
if (request.getMethod().equalsIgnoreCase("get")) {
try {
//将参数转成原来的编码的字节数组，在重新进行编码
value = new String(value.getBytes("ISO-8859-1"), request.getCharacterEncoding());
return value;
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
} else {
return value;
}
return value;
}
}
测试Servlet类
public class EncodingTest extends HttpServlet {
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
PrintWriter writer = response.getWriter();
writer.write("中文");
writer.write("英文");
//这句会乱码
System.out.println(request.getParameter("name"));
}
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
doGet(request, response);
}
}
web.xml
<filter>
<filter-name>EncodingFilter</filter-name>
<filter-class>com.encode.EncodingFilter</filter-class>
<init-param>
<param-name>charset</param-name>
<param-value>UTF-8</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>EncodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<servlet>
<servlet-name>EncodingTest</servlet-name>
<servlet-class>com.encode.EncodingTest</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>EncodingTest</servlet-name>
<url-pattern>/EncodingTest</url-pattern>
</servlet-mapping>
</web-app>
jsp
<form action="${pageContext.request.contextPath}/EncodingTest" method="get">
姓名：<input type="text" name="name"/>
密码：<input type="password" name="pwd">
<input type="submit" value="确定">
</form>
八、案例禁止浏览器缓存
在doFilterfa方法上进行如下处理
//禁止浏览器缓存，因为并不是所有浏览器都支持所以都写上
response.setDateHeader("Expires", -1);
response.setHeader("Cache-Control", "no-cache");
response.setHeader("Pragma", "no-cache");
九、缓存
有些动态页面中引用了一些图片或css文件以修饰页面效果，这些图片和css文件经常是不变化的，所以为减轻服务器的压力，可以使用filter控制浏览器缓存这些文件，以提升服务器的性能。
public class Cache implements Filter {
FilterConfig filterConfig;
public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain)
throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) req;
HttpServletResponse response = (HttpServletResponse) resp;
// 1.获取用户想访问的资源
String uri = request.getRequestURI();
// 2.得到用户想访问的资源的后缀名
String ext = uri.substring(uri.lastIndexOf(".") + 1);
// 得到资源需要缓存的时间
String time = filterConfig.getInitParameter(ext);
if (time != null) {
long t = Long.parseLong(time) * 3600 * 1000;
// 设置缓存
response.setDateHeader("expires", System.currentTimeMillis() + t);
}
chain.doFilter(request, response);
}
public void init(FilterConfig fConfig) throws ServletException {
this.filterConfig=fConfig;
}
@Override
public void destroy() {
}
web.xml
<filter>
<filter-name>Cache</filter-name>
<filter-class>com.web.filter.Cache</filter-class>
<init-param>
<param-name>css</param-name>
<param-value>4</param-value>
</init-param>
<init-param>
<param-name>jpg</param-name>
<param-value>1</param-value>
</init-param>
<init-param>
<param-name>js</param-name>
<param-value>4</param-value>
</init-param>
<init-param>
<param-name>png</param-name>
<param-value>4</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>Cache</filter-name>
<url-pattern>*.jpg</url-pattern>
</filter-mapping>
<filter-mapping>
<filter-name>Cache</filter-name>
<url-pattern>*.css</url-pattern>
</filter-mapping>
<filter-mapping>
<filter-name>Cache</filter-name>
<url-pattern>*.js</url-pattern>
</filter-mapping>
<filter-mapping>
<filter-name>Cache</filter-name>
<url-pattern>*.png</url-pattern>
</filter-mapping>
<servlet>
<description></description>
<display-name>Test</display-name>
<servlet-name>Test</servlet-name>
<servlet-class>com.web.filter.Test</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>Test</servlet-name>
<url-pattern>/Test</url-pattern>
</servlet-mapping>
十、判断是否登录及未登录不允许访问相关文件
1、jsp主页
<body>
<h1>首页</h1>
<hr />
<c:choose>
<c:when test="${user != null}">
欢迎${user.username}登陆！
<a href="${pageContext.request.contextPath}/Logout">注销</a>
</c:when>
<c:otherwise>
<a href="${pageContext.request.contextPath}/form.jsp">登陆</a>
</c:otherwise>
</c:choose>
<a href="${pageContext.request.contextPath}/importFile/1.html">重要的WEB资源</a>
</body>
2、点击登陆跳转到注册界面
body>
<form action="${pageContext.request.contextPath}/Test" method="post">
姓名：<input type="text" name="name"/><br/>
密码：<input type="password" name="pwd"><br/>
<input type="submit" value="确定">
</form>
3、提交到servlet处理
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
String name = request.getParameter("name");
String pwd = request.getParameter("pwd");
User u=new User(name, pwd);
System.out.println(name+""+pwd);
boolean isContain = Dao.getList().contains(u);
if (isContain) {
//request.getRequestDispatcher("FilterUser/login.jsp").forward(request, response);
response.getWriter().write("登陆成功，即将跳转");
request.getSession().setAttribute("user", u);
response.setHeader("refresh", "3;URL=/FilterUser/login.jsp");
}else {
//request.getRequestDispatcher("FilterUser/form.jsp").forward(request, response);
response.getWriter().write("用户不存在或密码错误请重新登陆");
response.setHeader("refresh", "3;URL=/FilterUser/form.jsp");
}
}
4、注销功能的servlet
HttpSession session = request.getSession();
if (session.getAttribute("user")!=null) {
session.invalidate();
response.getWriter().write("注销成功即将退出");
response.setHeader("refresh", "3,URL=/FilterUser/form.jsp");
}else {
response.setHeader("refresh", "3,URL=/FilterUser/");
}
5、设置文件访问权限的过滤器
public void doFilter(ServletRequest request1, ServletResponse response1, FilterChain chain) throws IOException, ServletException {
HttpServletRequest request=(HttpServletRequest) request1;
HttpServletResponse response=(HttpServletResponse) response1;
//设置不缓存
response.setDateHeader("Expires", -1);
response.setHeader("Cache-Control", "no-cache");
response.setHeader("Pragma", "no-cache");
if (request.getSession().getAttribute("user")!=null) {
System.out.println("登陆");
chain.doFilter(request, response);
}else {
response.getWriter().write("查阅请登陆");
response.setHeader("refresh", "3;URL=/FilterUser/form.jsp");
}
}
6、web.xml
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaeehttp://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5">
<filter>
<filter-name>EncodingFilter</filter-name>
<filter-class>com.web.fileter.EncodingFilter</filter-class>
<init-param>
<param-name>charset</param-name>
<param-value>utf-8</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>EncodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<servlet>
<servlet-name>Test</servlet-name>
<servlet-class>com.web.fileter.Test</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>Test</servlet-name>
<url-pattern>/Test</url-pattern>
</servlet-mapping>
<servlet>
<description></description>
<display-name>Logout</display-name>
<servlet-name>Logout</servlet-name>
<servlet-class>com.web.fileter.Logout</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>Logout</servlet-name>
<url-pattern>/Logout</url-pattern>
</servlet-mapping>
<filter>
<display-name>Accece</display-name>
<filter-name>Accece</filter-name>
<filter-class>com.web.fileter.Accece</filter-class>
</filter>
<filter-mapping>
<filter-name>Accece</filter-name>
<url-pattern>/importFile/*</url-pattern>
</filter-mapping>
</web-app>
7、Dao
public class Dao {
private static ArrayList<User> list;
public static ArrayList<User> getList() {
list =new ArrayList<>();
list.add(new User("root", "root"));
return list;
}
}
8、User
有name，password两个成员变量，实现equels方法
9、演示
10、思路
1、当用户登录时把对象存在session域对象中
2、点击注销时：判断当前用户是否存在session，有的话调用session.invalidate();
3、访问权限用filter判断用户的session是否存在存在放行，不存在拦截