J2EE学习笔记(五)之Servlet中的Filter过滤器
一、Filter简介
上一话提到了Servlet原理,当运行一个JSP页面的时候,其实JSP页面会被编译成Servlet文件,Servlet文件来处理和响应用户的请求。
Filter过滤器可以认为是Servlet的一种“加强版”,可以对用户的请求进行预处理,也可以对HttpServletResponse进行后处理。
二、案例一——字符编码
什么时候需要用到Filter呢?
来举一个小栗子~~~
在web项目中应该经常在配置文件web.xml中看到这一段
<filter>
<filter-name>encodingFilter</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<init-param>
<param-name>encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
<init-param>
<param-name>forceEncoding</param-name>
<param-value>true</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>encodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
这一段的意思就是拦截所有的请求,对其进行编码处理以后,再将请求交给Servlet进行处理和响应。
可以看下org.springframework.web.filter.CharacterEncodingFilter的源码中的解释
看下这个类是干什么用的,简单翻译一下上面的英文,Servlet 2.3/2.4 的Filter允许我们为用户的请求指定字符编码,这点是很有用的,英文现在大多数浏览器通常都没有设置字符编码,即使在HTML页面或者表单中指定了。
后面就说啦怎么用了,forceEncoding字段默认是false,强制编码的话就指定为true,encoding字段就指定了一种编码,就是上面filter标签初始化的那样。url-pattern标签指定了/*,就是对所有的url都有效。
从这个栗子就可以看出filter的用处,批量处理了所有的请求。
三、案例二——用户登录验证
还有一种很常见的用途,就是用户登录验证,不知道大家有木有过这样的经历,在一个安全性比较高的网站,比如我们公司项目部署在堡垒机上,当我们登录了一段时间后,会自动的掉出来,返回到登录界面,这就可以利用这个原理来做,当session过期了以后,filter校验到用户没有登录,于是自动跳转到登录界面。
这是怎么做的呢?来自定义一个Filter~~~
1.创建一个Filter类
创建Filter类必须实现javax.servlet.Filter接口,上面举了一个CharacterEncodingFilter类的小栗子,顺着这个栗子来看下Filter接口的源码中的说明
再来简单的翻译一下,过滤器就是一个可以执行过滤任务的对象,对谁执行呢?对资源的请求(一个Servlet或者静态内容),或者一个资源的响应,或者两者都有。用的就是doFilter()这个方法。
在接口里有三个方法,
void init(FilterConfig filterConfig):filter的初始化函数
void destroy():用于Filter销毁前对资源的回收
void doFilter(ServletRequest request, ServletResponse response, FilterChain chain):实现过滤功能,对每个请求及响应进行额外的处理。
Tips:
FilterChain也是一个接口,里面只有
void doFilter(ServletRequest request, ServletResponse response)这一个方法,只要知道这是一个链式处理就好啦
AuthorityFilter.java代码
package com.yolanda.fun.servlet;
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;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
@WebFilter(filterName="authorityFilter", urlPatterns={"/test.jsp"})
public class AuthorityFilter implements Filter{
public void init(FilterConfig config) throws ServletException {
}
public void destroy() {
}
public void doFilter(ServletRequest request, ServletResponse response,
FilterChain chain) throws IOException, ServletException {
System.out.println("到过滤器方法里来啦");
HttpServletRequest httpRequest = (HttpServletRequest) request;
HttpServletResponse httpResponse = (HttpServletResponse) response;
HttpSession session = httpRequest.getSession();
// 获取请求页面
String requestPath = httpRequest.getServletPath();
System.out.println("requestPath:" + requestPath);
if (session.getAttribute("name") == null) {
httpResponse.sendRedirect("http://"+httpRequest.getHeader("Host")+"/servletDemo/login.jsp");
}else {
chain.doFilter(request, response);
}
}
}
这个
chain.doFilter(request, response);
是继续往下运行的意思
Tips:filter配置方式
除了上面注解的方式
@WebFilter(filterName="authorityFilter", urlPatterns={"/test.jsp"})
这里的urlPatterns是一个数组,可以放多个url,用大括号连接,表示要进行拦截处理的url
也可以在web.xml文件里配置
<filter>
<filter-name>authorityFilter</filter-name>
<filter-class>com.yolanda.fun.servlet.AuthorityFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>authorityFilter</filter-name>
<url-pattern>/test.jsp</url-pattern>
</filter-mapping>
2.JSP页面
(1)改下上一话栗子中的welcome.jsp
<%@ page language="java" pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>欢迎界面</title>
</head>
<body>
亲爱的
<%=session.getAttribute("name") %>:你好!
欢迎登录!
<form action="test.jsp" method="post">
<input type="submit" value="测试"></input>
</form>
</body>
</html>
(2)新建一个测试页面test.jsp
<%@ page language="java" pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>测试界面</title>
</head>
<body>
测试页面
</body>
</html>
(3)贴一下登录界面login.jsp
<%@ page language="java" pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>登录界面</title>
</head>
<body>
<form id="login" method="post" action="login">
用户名:<input type="text" name="username" value="Annie"/><br />
密码:<input type="password" name="pwd" value="123"/><br />
<input type="submit" value="登录"></input>
</form>
</body>
</html>
3.贴一下Servlet类
package com.yolanda.fun.servlet;
import java.io.IOException;
import javax.servlet.RequestDispatcher;
import javax.servlet.Servlet;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import javax.servlet.annotation.WebServlet;
@WebServlet(name="loginServlet", urlPatterns="/login")
public class LoginServlet extends HttpServlet implements Servlet{
/**
*
*/
private static final long serialVersionUID = 1L;
public void doPost(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
String username = request.getParameter("username");
String pwd = request.getParameter("pwd");
HttpSession session = request.getSession();
session.setAttribute("name", username);
// 设置过期时间,秒为单位
//session.setMaxInactiveInterval(60);
// Servlet本身并不输出响应到客户端,因此必须将请求转发
RequestDispatcher rd = request.getRequestDispatcher("/welcome.jsp");
// 转发请求
rd.forward(request, response);
}
public void doGet(HttpServletRequest req, HttpServletResponse resp)
throws ServletException, IOException {
doPost(req, resp);
}
}
4.配置文件加入超时设置
web.xml里配置一下session的过期时间1分钟
<session-config>
<session-timeout>1</session-timeout>
</session-config>
结果就是如果时间超过一分钟,欢迎界面跳到测试页面的时候,就会回到登录界面,否则就是测试界面
对啦~~~
web.xml里配置了filter以后报错啦
因为我把filter配置放在Servlet配置的后面啦,从这个报错信息可以看出,在web.xml的web-app标签下,这些标签的放置是有顺序的,
web.xml里这么写就对啦~~~
<!DOCTYPE web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd" >
<web-app>
<display-name>ServletDemo</display-name>
<filter>
<filter-name>authorityFilter</filter-name>
<filter-class>com.yolanda.fun.servlet.AuthorityFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>authorityFilter</filter-name>
<url-pattern>/test.jsp</url-pattern>
</filter-mapping>
<servlet>
<servlet-name>loginServlet</servlet-name>
<servlet-class>com.yolanda.fun.servlet.LoginServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>loginServlet</servlet-name>
<url-pattern>/login</url-pattern>
</servlet-mapping>
<session-config>
<session-timeout>1</session-timeout>
</session-config>
</web-app>