Java进阶学习第二十一天——Filter学习
| 文档版本 | 开发工具 | 测试平台 | 工程名字 | 日期 | 作者 | 备注 |
|---|---|---|---|---|---|---|
| V1.0 | 2016.06.03 | lutianfei | none |
javaWeb之过滤器
Fileter介绍
Filter也称之为过滤器，它是Servlet技术中最实用的技术，WEB开发人员通过Filter技术，对web服务器管理的所有web资源：例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。
Servlet API中提供了一个Filter接口，开发web应用时，如果编写的Java类实现了这个接口，则把这个java类称之为
过滤器Filter。通过Filter技术，开发人员可以实现用户在访问某个目标资源之前，对访问的请求和响应进行拦截。
Filter如何实现拦截
- Filter接口中有一个
doFilter方法，当开发人员编写好Filter，并配置对哪个web资源(拦截url)进行拦截后，WEB服务器每次在调用web资源之前，都会先调用一下filter的doFilter方法，因此，在该方法内编写代码可达到如下目的：
- 调用目标资源之前，让一段代码执行
- 是否调用目标资源（即是否让用户访问web资源）。
- web服务器在调用doFilter方法时，会传递一个
filterChain对象进来，filterChain对象是filter接口中最重要的一个对象，它也提供了一个doFilter方法，开发人员可以根据需求决定是否调用此方法，调用该方法，则web服务器就会调用web资源的service方法，即web资源就会被访问，否则web资源不会被访问。
- web服务器在调用doFilter方法时，会传递一个
- 调用目标资源之后，让一段代码执行
开发Fileter步骤
- Filter开发分为三个步骤：
- 编写java类实现Filter接口，
- 实现(三个方法)其doFilter方法。
- 在 web.xml 文件中使用
注册，并设置它所能拦截的资源。
Filter链 — FilterChain
在一个web应用中，可以开发编写多个Filter，这些Filter组合起来称之为一个
Filter链。web服务器根据Filter在web.xml文件中的注册顺序
Filter链实验（查看filterChain API文档）
Filter的生命周期
init(FilterConfig filterConfig)throws ServletException- 和我们编写的Servlet程序一样，Filter的创建和销毁由WEB服务器负责。 web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法进行初始化（注：filter对象只会创建一次，init方法也只会执行一次。示例 ）
- 开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。(filterConfig对象见下页PPT)
doFilter(ServletRequest,ServletResponse,FilterChain)- 每次filter进行拦截都会执行
- 在实际开发中方法中参数request和response通常转换为HttpServletRequest和HttpServletResponse类型进行操作
destroy()- 在Web容器卸载 Filter 对象之前被调用。
FilterConfig接口
- 用户在配置filter时，可以使用
- String
getFilterName()：得到filter的名称。 - String
getInitParameter(String name)： 返回在部署描述中指定名称的初始化参数的值。如果不存在返回null。 - Enumeration
getInitParameterNames()：返回过滤器的所有初始化参数的名字的枚举集合。 - public ServletContext
getServletContext()：返回Servlet**上下文对象**的引用。
- String
注册与映射Filter
注册
<filter>
<filter-name>testFitlerfilter-name>
<filter-class>org.test.TestFiterfilter-class>
param>
<param-name>word_fileparam-name>
<param-value>/WEB-INF/word.txtparam-value>
param>
filter>
映射Filter
- 映射Filter示例
<filter-mapping>
<filter-name>testFilterfilter-name>
<url-pattern>/index.jspurl-pattern>
<dispatcher>REQUESTdispatcher>
<dispatcher>FORWARDdispatcher>
filter-mapping>- 1 . 完全匹配 必须以
/开始。 - 2 . 可以使用
*通配符。
- 目录匹配
/a/*,/*要求必须以/开始。 - 扩展名匹配
*.do,*.action要求，不能以/开始，以*.xxx结束。
- 目录匹配
- 1 . 完全匹配 必须以
REQUEST,INCLUDE,FORWARD和ERROR之一，默认REQUEST。用户可以设置多个REQUEST：当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过 RequestDispatcher 的 include()或 forward()方法访问时，那么该过滤器就不会被调用。INCLUDE：如果目标资源是通过 RequestDispatcher 的 include() 方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。FORWARD：如果目标资源是通过 RequestDispatcher 的 forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用。
Filter示例
示例1：全站统一字符编码过滤器
通过配置参数encoding指明使用何种字符编码,以处理Html Form请求参数的中文问题
编写jsp 输入用户名，在Servlet中获取用户名，将用户名输出到浏览器上
处理请求post乱码代码
- request.setCharacterEncoding(“utf-8”);
设置响应编码集代码
- response.setContentType(“text/html;charset=utf-8”);
经常会使用，而过滤器可以在目标资源之前执行，将很多程序中处理乱码公共代码，提取到过滤器中，以后程序中不需要处理编码问题了
public class EncodingFilter implements Filter {
private String encode;
public void destroy() {
}
public void doFilter(ServletRequest arg0, ServletResponse arg1,
FilterChain chain) throws IOException, ServletException {
// 1.强制转换
HttpServletRequest request = (HttpServletRequest) arg0;
HttpServletResponse response = (HttpServletResponse) arg1;
// 2.操作
request.setCharacterEncoding(encode);
// 3.放行
chain.doFilter(request, response);
}
public void init(FilterConfig config) throws ServletException {
this.encode = config.getInitParameter("encode");
}
}
<filter>
<filter-name>encodingFilterfilter-name>
<filter-class>cn.itcast.filter.demo1.EncodingFilterfilter-class>
<init-param>
<param-name>encodeparam-name>
<param-value>utf-8param-value>
init-param>
filter>
<filter-mapping>
<filter-name>encodingFilterfilter-name>
<url-pattern>/*url-pattern>
filter-mapping>
示例2禁用所有JSP页面缓存
因为动态页面数据，是由程序生成的，所以如果有缓存，就会发生，客户端查看数据不是最新数据情况 ，对于动态程序生成页面，设置浏览器端禁止缓存页面内容
有 3 个 HTTP 响应头字段都可以禁止浏览器缓存当前页面，它们在 Servlet 中的示例代码如下：
- response.setDateHeader(“Expires”,-1);
- response.setHeader(“Cache-Control”,”no-cache”);
- response.setHeader(“Pragma”,”no-cache”);
并不是所有的浏览器都能完全支持上面的三个响应头，因此最好是同时使用上面的三个响应头。
- Expires数据头：值为GMT时间值，为-1指浏览器不要缓存页面
Cache-Control响应头有两个常用值：
- no-cache指浏览器不要缓存当前页面。
- max-age:xxx指浏览器缓存页面xxx秒。
将禁用缓存代码，提起到过滤器中，通过url配置，禁用所有JSP页面的缓存
public class CacheFilter implements Filter{
public void destroy() {
}
public void doFilter(ServletRequest req, ServletResponse resp,
FilterChain chain) throws IOException, ServletException {
// 1.强制转换
HttpServletRequest request = (HttpServletRequest) req;
HttpServletResponse response = (HttpServletResponse) resp;
// 2.操作
response.setHeader("pragma", "no-cache");
response.setHeader("cache-control", "no-cache");
response.setDateHeader("expires", 0);
// 3.放行
chain.doFilter(request, response);
}
public void init(FilterConfig filterConfig) throws ServletException {
}
}
cacheFilter
class>cn.itcast.filter.demo2.CacheFilterfilter-class>
filter>
<filter-mapping>
<filter-name>cacheFilterfilter-name>
<url-pattern>*.jspurl-pattern>
filter-mapping> 示例3设置图片过期时间
- 控制浏览器缓存页面中的静态资源的过滤器：
场景：有些动态页面中引用了一些图片或css文件以修饰页面效果，这些图片和css文件经常是不变化的，所以为减轻服务器的压力，可以使用filter控制浏览器缓存这些文件，以提升服务器的性能。
Tomcat缓存策略
对于服务器端经常不变化文件，设置客户端缓存时间，在客户端资源缓存时间到期之前，就不会去访问服务器获取该资源 ——– 比tomcat内置缓存策略更优手段
减少服务器请求次数，提升性能
设置静态资源缓存时间，需要设置 Expires 过期时间 ，在客户端资源没有过期之前，不会产生对该资源的请求的
设置Expires 通常使用 response.setDateHeader 进行设置 设置毫秒值
public class ImageCacheFilter implements Filter {
public void destroy() {
}
public void doFilter(ServletRequest req, ServletResponse resp,
FilterChain chain) throws IOException, ServletException {
// 1.强制转换
HttpServletRequest request = (HttpServletRequest) req;
HttpServletResponse response = (HttpServletResponse) resp;
// 2.操作
response.setDateHeader("expires", System.currentTimeMillis()+60*60*24*10*1000);//缓存10天
// 3.放行
chain.doFilter(request, response);
}
public void init(FilterConfig filterConfig) throws ServletException {
}
}
cacheFilter
class>cn.itcast.filter.demo2.CacheFilterfilter-class>
filter>
<filter-mapping>
<filter-name>imageFilterfilter-name>
<url-pattern>*.bmpurl-pattern>
filter-mapping> 示例4自动登录案例（MD5加密）
- 说明：在访问一个站点，登陆时勾选自动登陆（三个月内不用登陆），操作系统后，关闭浏览器；过几天再次访问该站点时，直接进行登陆后状态。
要求：实现用户自动登陆的过滤器
- 在用户登陆成功后，以cookis形式发送用户名、密码给客户端
- 编写一个过滤器，filter方法中检查cookie中是否带有用户名、密码信息，如果存在则调用业务层登陆方法，登陆成功后则向session中存入user对象（即用户登陆标记），以实现程序完成自动登陆。
在数据库中创建 user表
create table user (
id int primary key auto_increment,
username varchar(20),
password varchar(40),
role varchar(10)
);
insert into user values(null,'admin','123','admin');
insert into user values(null,'aaa','123','user');
insert into user values(null,'bbb','123','user');- 完成自动登录原理：
在用户完成登陆后，勾选自动登陆复选框，服务器端将用户名和密码 以Cookie形式，保存在客户端 。当用户下次访问该站点，AutoLoginFilter 过滤器从Cookie中获取 自动登陆信息
- 1、登录成功后，判断是否勾选了自动登录。
- 2、如果勾线了自动登录，将用户名与密码储存到cookie中。
- 3、做一个Filter，它拦截所有请求，当访问资源时，我们从cookie中获取用户名与密码，进行登录操作。
在LoginServlet中主要工作
- 如果登录成功后，判断是否勾选了自动登录，如果勾选了，将用户名与密码存储到cookie中。
if("ok".equals(autologin)){
Cookie cookie = new Cookie("autologin",URLEncoder.encode(username,"utf-8")+"::"+password);
cookie.setMaxAge(60*60*24*10);
cookie.setPath("/");
response.addCookie(cookie);
}- 创建一个AutoLoginFilter进行自动登录操作
- 得到autologin这个cookie
Cookie cookie = CookieUtils.findCookieByName(request.getCookies(),"autologin");
- 得到username与password进行登录操作
- 得到autologin这个cookie
if(cookie != null){
String username = URLDecoder.decode(cookie.getValue().split("::")[0],"utf-8");
String password = cookie.getValue().split("::")[1];
UserService service = new UserService();
User user;
try {
user = service.login(username, password);
if(user != null){
request.getSession().setAttribute("user", user);
response.sendRedirect(request.getContextPath()
+ "/demo4/success.jsp");
return;
}
} catch (SQLException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}如果将用户密码保存在cookie文件中，非常不安全的 ，通常情况下密码需要加密后才能保存到客户端
- 使用md5算法对密码进行加密
- md5 加密算法是一个单向加密算法 ，支持明文—密文 不支持密文解密
MySQL数据库中提供md5 函数，可以完成md5 加密
- mysql> select md5(‘123’);
- 将数据表中所有密码 变为密文 update user set password = md5(password) ;
Java中提供类 MessageDigest 完成MD5加密
- MD5加密算法
/**
* 使用md5的算法进行加密
*/
public static String md5(String plainText) {
byte[] secretBytes = null;
try {
secretBytes = MessageDigest.getInstance("md5").digest(
plainText.getBytes());
} catch (NoSuchAlgorithmException e) {
throw new RuntimeException("没有md5这个算法！");
}
String md5code = new BigInteger(1, secretBytes).toString(16);
for (int i = 0; i < 32 - md5code.length(); i++) {
md5code = "0" + md5code;
}
return md5code;示例5 URL级别的权限控制
使用Filter实现URL级别的权限认证
情景：在实际开发中我们经常把一些执行敏感操作的servlet映射到一些特殊目录中，并用filter把这些特殊目录保护起来，限制只能拥有相应访问权限的用户才能访问这些目录下的资源。从而在我们系统中实现一种URL级别的权限功能。
要求：为使Filter具有通用性，Filter保护的资源和相应的访问权限通过filter参数的形式予以配置。
问题1：怎样判断哪些资源需要权限，哪些资源不需要权限？
//admin.properites
url=/book_add,/book_delete,/book_update,/book_search
//user.properites
url=/book_search
String uri = request.getRequestURI();
String contextPath = request.getContextPath();
String path = uri .substring(contextPath.length());
if(admins.contains(path) || users.contains(path)){
User user = (User) request.getSession().getAttribute("user");
if(user == null){
throw new PrivilegeException();
}
public void init(FilterConfig arg0) throws ServletException {
this.admins = new ArrayList<String>();
this.users = new ArrayList<String>();
fillPath("user",users);
fillPath("admin",admins);
}
private void fillPath(String baseName,List<String>list){
ResourceBundle bundle = ResourceBundle.getBundle(baseName);
String path = bundle.getString("url");
String[] paths = path.split(",");
for(String p : paths){
list.add(p);
}
} - 问题2：我们的用户是有role的，如果是admin角色，如何限制权限，如果是user角色如何限制权限？
if("admin".equals(user.getRole())){
if(!(admins.contains(path))){
throw new PrivilegeException();
}
}
else {
if(!(users.contains(path))){
throw new PrivilegeException();
}
}示例6 通用get和post乱码过滤器
- 由于开发人员在filter中可以得到代表用户请求和响应的request、response对象，因此在编程中可以使用Decorator(装饰器)模式对request、response对象进行包装，再把包装对象传给目标资源，从而实现一些特殊需求。
- Decorator模式
- 1、包装类需要和被包装对象 实现相同接口，或者继承相同父类
- 2、包装类需要持有 被包装对象的引用
- 在包装类中定义成员变量，通过包装类构造方法，传入被包装对象
- 3、在包装类中，可以控制原来那些方法需要加强不需要加强 ，调用被包装对象的方法需要加强，编写增强代码逻辑
- Decorator设计模式的实现
- 1.首先看需要被增强对象继承了什么接口或父类，编写一个类也去继承这些接口或父类。
- 2.在类中定义一个变量，变量类型即需增强对象的类型。
- 3.在类中定义一个构造函数，接收需增强的对象。
- 4.覆盖需增强的方法，编写增强的代码。
request对象的增强
Servlet API 中提供了一个request对象的Decorator设计模式的默认实现类
HttpServletRequestWrapper- HttpServletRequestWrapper 类实现了request 接口中的所有方法，但这些方法的内部实现都是仅仅调用了一下所包装的的 request 对象的对应方法,以避免用户在对request对象进行增强时需要实现request接口中的所有方法。
使用Decorator模式包装request对象，完全解决get、post请求方式下的乱码问题
ServletRequestWrapper和HttpServletRequestWrapper提供对request对象进行包装的方法，但是默认情况下每个方法都是调用原来request对象的方法，也就是说包装类并没有对request进行增强在这两个包装类基础上，继承
HttpServletRequestWrapper，覆盖需要增强的方法即可系统中存在很多资源，将需要进行权限控制的资源，放入特殊路径中，编写过滤器管理访问特殊路径的请求，如果没有相应身份和权限，控制无法访问
在Filter中，对request对象进行包装，增强获得参数的方法
- getParameter
- getParameterValues
- getParameterMap
public class EncodingFilter implements Filter{
@Override
public void destroy() {
// TODO Auto-generated method stub
}
@Override
public void doFilter(ServletRequest req, ServletResponse resp,
FilterChain chain) throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) req;
HttpServletResponse response = (HttpServletResponse) resp;
HttpServletRequest myrequest = new MyRequest(request);
response.setContentType("text/html;charset=utf-8");
chain.doFilter(myrequest, response);
}
@Override
public void init(FilterConfig arg0) throws ServletException {
// TODO Auto-generated method stub
}
}
class MyRequest extends HttpServletRequestWrapper{
private HttpServletRequest request;
public MyRequest(HttpServletRequest request){
super(request);
this.request=request;
}
public String getParameter(String name){
Map map = getParameterMap();
if(name == null){
return null;
}
String[] st = map.get(name);
if(st ==null || st.length==0){
return null;
}
return st[0];
}
private boolean flag = true;
public Map getParaMap(){
Map map = request.getParameterMap();
if(flag){
for(String key : map.keySet()){
String[] values = map.get(key);
for(int i = 0;itry {
values[i] = new String(values[i].getBytes("iso8859-1"),"utf-8");
} catch (UnsupportedEncodingException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
flag = false;
}
return map;
}
} response对象的增强
Servlet API 中提供了response对象的Decorator设计模式的默认实现类HttpServletResponseWrapper ， （HttpServletResponseWrapper类实现了response接口中的所有方法，但这些方法的内部实现都是仅仅调用了一下所包装的的 response对象的对应方法）以避免用户在对response对象进行增强时需要实现response接口中的所有方法。
ServletResponseWrapper和HttpServletResponseWrapper提供了对response 对象包装，继承 HttpServletResponseWrapper ，覆盖需要增强response的方法response增强案例—压缩响应
- 应用HttpServletResponseWrapper对象，压缩响应正文内容。
- 思路:
- 通过filter向目标页面传递一个自定义的response对象。
- 在自定义的response对象中，重写getOutputStream方法和getWriter方法，使目标资源调用此方法输出页面内容时，获得的是我们自定义的ServletOutputStream对象。
- 在我们自定义的ServletOuputStream对象中，重写write方法，使写出的数据写出到一个buffer中。
- 当页面完成输出后，在filter中就可得到页面写出的数据，从而我们可以调用GzipOuputStream对数据进行压缩后再写出给浏览器，以此完成响应正文件压缩功能。
- 通过filter向目标页面传递一个自定义的response对象。