Servlet中的过滤器Filter是实现了javax.servlet.filter接口的服务端程序,主要的用途是过滤字符编码,做一些业务逻辑判断等。其原理是只要你在web.xml文件配置好要拦截的客户端请求,他都会帮你拦截到请求,此时你就可以对qing求或相应(Request,Response)统一设置编码,简化操作;同时还可以进行逻辑判断,如用户是否已经登录,有没有权限访问该页面等等工作,他是随你的web应用启动而启动的,只初始化一次,以后就可以拦截相关的请求,只有当你的web应用停止或重新部署的时候才能销毁。
void init(FilterConfig filterConfig) 用于完成过滤器的初始化
void destroy() 用于过滤器销毁前,完成某些资源的回收
void doFilter(ServletRequest request, ServletResponse response,FilterChain chain) 实现过滤功能,该方法对每个请求增加额外的处理
public class FilterUtil implements Filter{
@SuppressWarnings("unused")
private FilterConfig filterConfig;
@Override
public void init(FilterConfig filterConfig) throws ServletException {
this.filterConfig = filterConfig;
System.out.println("过滤器Filter初始化");
}
@Override
public void doFilter(ServletRequest request, ServletResponse response,
FilterChain chain) throws IOException, ServletException {
if (!(request instanceof HttpServletRequest) || !(response instanceof HttpServletResponse)) {
throw new ServletException("FilterUtil just supports HTTP requests");
}
@Override
public void doFilter(ServletRequest request, ServletResponse response,
FilterChain chain) throws IOException, ServletException {
if(!(request instanceof HttpServletRequest) || !(response instanceof HttpservletResponse)){
throw new ServletException("FilterUtil just supports HTTP requests");
}
HttpServletRequest httpRequest = (HttpServletRequest) request;
HttpServletResponse httpResponse = (HttpServletResponse) response;
httpRequest.setCharacterEncoding(this.filterConfig.getInitParameter("encoding"));
httpResponse.setCharacterEncoding(this.filterConfig.getInitParameter("encoding"));
chain.doFilter(httpRequest, httpResponse);
}
@Override
public void destroy() {
System.out.println("过滤器Filter销毁");
}
}
web.xml配置:
encodingFilter com.cn.util.FilterUtil true encoding UTF-8 encodingFilter /*
监听器
Servlet的监听器Listener,它是实现了javax.servlet.ServletContextListener接口的服务器端程序,它也是随web应用的启动而启动,只初始化一次,随web应用的停止而销毁。主要作用是:做一些初始化的内容添加工作、设置一些基本的内容、比如一些参数或者是一些固定的对象等等。
在javax.servlet.ServletContextListener接口中定义了2种方法:
void contextInitialized(ServletContextEvent sce) 监听器的初始化
void contextDestroyed(ServletContextEvent sce) 监听器销毁
package com.cn.util;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
public class ServletContextListenerUtil implements ServletContextListener{
//监听器的初始化
@Override
public void contextInitialized(ServletContextEvent sce) {
System.out.println("监听器ServletContextListenerUtil初始化");
}
//监听器销毁
@Override
public void contextDestroyed(ServletContextEvent sce) {
System.out.println("监听器ServletContextListenerUtil销毁");
}
}
项目启动时,先启动监听器,再启动过滤器。
拦截器
拦截器是在面向切面编程中应用的,就是在你的service或者一个方法前调用一个方法,或者在方法后调用一个方法比如动态代理就是拦截器的简单实现,在你调用方法前打印出字符串(或者做其它业务逻辑的操作),也可以在你调用方法后打印出字符串,甚至在你抛出异常的时候做业务逻辑的操作。拦截器不是在web.xml配置的,比如struts在struts.xml配置,在springMVC在spring与springMVC整合的配置文件中配置。
在springmvc中,定义拦截器要实现HandlerInterceptor接口,并实现该接口中提供的三个方法
package com.cn.util;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
public class InterceptorUtil implements HandlerInterceptor{
//进入Handler方法之前执行
//可以用于身份认证、身份授权。如果认证没有通过表示用户没有登陆,需要此方法拦截不再往下执行,否则就放行
@Override
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response, Object handler) throws Exception {
// TODO Auto-generated method stub
System.out.println("InterceptorUtil...........preHandle");
String user= (String) request.getSession().getAttribute("user");
if(user != null){
return true;
}
request.getRequestDispatcher("/WEB-INF/jsp/index.jsp").forward(request, response);
//true表示放行,false表示不放行
return false;
}
@Override
public void postHandle(HttpServletRequest request,
HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
// TODO Auto-generated method stub
System.out.println("InterceptorUtil...........postHandle");
}
@Override
public void afterCompletion(HttpServletRequest request,
HttpServletResponse response, Object handler, Exception ex)
throws Exception {
// TODO Auto-generated method stub
System.out.println("InterceptorUtil...........afterCompletion");
}
}
preHandle方法:进入Handler方法之前执行。可以用于身份认证、身份授权。比如如果认证没有通过表示用户没有登陆,需要此方法拦截不再往下执行(return false),否则就放行(return true)。
postHandle方法:进入Handler方法之后,返回ModelAndView之前执行。可以看到该方法中有个modelAndView的形参。应用场景:从modelAndView出发:将公用的模型数据(比如菜单导航之类的)在这里传到视图,也可以在这里同一指定视图。
afterCompletion方法:执行Handler完成之后执行。应用场景:统一异常处理,统一日志处理等。
在springmvc中,拦截器是针对具体的HandlerMapping进行配置的,也就是说如果在某个HandlerMapping中配置拦截,经过该 HandlerMapping映射成功的handler最终使用该拦截器。
spring-mvc.xml配置文件中:
在网上查询的过滤器和拦截器的区别,基本都是以下一模一样的5行话。
1、拦截器是基于Java的反射机制的,而过滤器是基于函数回调
2、过滤器依赖与servlet容器,而拦截器不依赖与servlet容器
3、拦截器只能对action请求起作用,而过滤器则可以对几乎所有的请求起作用
4、拦截器可以访问action上下文、值栈里的对象,而过滤器不能
5、在action的生命周期中,拦截器可以多次被调用,而过滤器只能在容器初始化时被调用一次
执行顺序:过滤前 - 拦截前 - Action处理 - 拦截后 -过滤后。个人认为过滤是一个横向的过程,首先把客户端提交的内容进行过滤(例如未登录用户不能访问内部页面的处理);过滤通过后,拦截器将检查用户提交数据的验证,做一些前期的数据处理,接着把处理后的数据发给对应的Action;Action处理完成返回后,拦截器还可以做其他过程,再向上返回到过滤器的后续操作。
过滤器(Filter):当你有一堆东西的时候,你只希望选择符合你要求的某一些东西。定义这些要求的工具,就是过滤器。
拦截器(Interceptor):在一个流程正在进行的时候,你希望干预它的进展,甚至终止它进行,这是拦截器做的事情。
监听器(Listener):当一个事件发生的时候,你希望获得这个事件发生的详细信息,而并不想干预这个事件本身的进程,这就要用到监听器。
context-param:就是一些需要初始化的配置,放入context-param中,从而被监听器(这里特指org.springframework.web.context.ContextLoaderListener)监听,然后加载;
监听器(listener):就是对项目起到监听的作用,它能感知到包括request(请求域),session(会话域)和applicaiton(应用程序)的初始化和属性的变化;
过滤器(filter):就是对请求起到过滤的作用,它在监听器之后,作用在servlet之前,对请求进行过滤;
servlet:就是对request和response进行处理的容器,它在filter之后执行,servlet其中的一部分就是controller层(标记为servlet_2),还包括渲染视图层(标记为servlet_3)和进入controller之前系统的一些处理部分(servlet_1),另外我们把servlet开始的时刻标记为servlet_0,servlet结束的时刻标记为servlet_4。
拦截器(interceptor):就是对请求和返回进行拦截,它作用在servlet的内部,具体来说有三个地方:
1)servlet_1和servlet_2之间,即请求还没有到controller层
2)servlet_2和servlet_3之间,即请求走出controller层次,还没有到渲染时图层
3)servlet_3和servlet_4之间,即结束视图渲染,但是还没有到servlet的结束
它们之间的关系,可以用一张图来表示:
3.使用原则
对整个流程清楚之后,然后就是各自的使用,在使用之前应该有一个使用规则,为什么这个说,因为有些功能比如判断用户是否登录,既可以用过滤器,也可以用拦截器,用哪一个才是合理的呢?那么如果有一个原则,使用起来就会更加合理。实际上这个原则是有的:
把整个项目的流程比作一条河,那么监听器的作用就是能够听到河流里的所有声音,过滤器就是能够过滤出其中的鱼,而拦截器则是拦截其中的部分鱼,并且作标记。所以当需要监听到项目中的一些信息,并且不需要对流程做更改时,用监听器;当需要过滤掉其中的部分信息,只留一部分时,就用过滤器;当需要对其流程进行更改,做相关的记录时用拦截器。下面是具体的使用案例
本文涉及到的jsp页面:
index.jsp:
<%@ page language="java" import="com.mycompany.mvc.listener.*" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
this is index jsp
login
测试servletcontext:
<%
application.setAttribute("app","app");
application.getAttribute("app");
application.removeAttribute("app");
%>
测试httpsession:
<%
session.setAttribute("app3","app3");
session.getAttribute("app3");
session.removeAttribute("app3");
%>
测试servletrequest:
<%
request.setAttribute("app3","app3");
request.getAttribute("app3");
request.removeAttribute("app3");
%>
当前在线人数:
<%=session.getAttribute("peopleOnLine")%>
HttpSessionBindingListener测试:
<%
session.setAttribute("bean",new myHttpSessionBindingListener());
session.removeAttribute("bean");
%>
login.jsp:
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
This is has login jsp
view
view.jsp:
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
用户已经登陆,欢迎来到登陆后系统主界面
4.监听器
4.1listener具体分为八种,能够监听包括request域,session域,application域的产生,销毁和属性的变化;
具体使用,可以看之前转载一篇文章(再次感谢"孤傲苍狼",他的主页 http://www.cnblogs.com/xdp-gacl/): http://blog.csdn.net/Jintao_Ma/article/details/51464124
在配置完然后我们在web.xml中诸如下面的配置即可:
com.mycompany.mvc.listener.myServletContextListener
com.mycompany.mvc.listener.myServletContextAttributeListener
4.2 listener实际应用
4.2.1 获取当前在线人数
package com.mycompany.mvc.listener;
import javax.servlet.http.HttpSessionEvent;
import javax.servlet.http.HttpSessionListener;
public class myHttpSessionListener implements HttpSessionListener{
public static int peopleOnLine = 0;
@Override
public void sessionCreated(HttpSessionEvent arg0) {
System.out.println("myHttpSessionListener.sessionCreated():"+arg0);
peopleOnLine++;
arg0.getSession().setAttribute("peopleOnLine",peopleOnLine);
}
@Override
public void sessionDestroyed(HttpSessionEvent arg0) {
System.out.println("myHttpSessionListener.sessionDestroyed():"+arg0);
peopleOnLine--;
arg0.getSession().setAttribute("peopleOnLine",peopleOnLine);
}
}
在页面中就可以获取:
当前在线人数:
<%=session.getAttribute("peopleOnLine")%>
其实也可以获得历史所有在线人数,只需要把历史所有在线人数保存在文件中,然后每次项目启动读取这个文件,当前人数增加时,把历史所有人数也相应增加,项目关闭时,再保存起来。
4.2.2 在系统初始化时,获取项目绝对路径
如下,获得绝对路径后保存到系统变量System中:
@Override
public void contextInitialized(ServletContextEvent servletContext) {
System.out.println("myServletContextListener.contextInitialized()");
System.setProperty("realPath", servletContext.getServletContext().getRealPath("/"));
System.out.println("myServletContextListener.contextInitialized()");
}
5.过滤器(filter)
5.1过滤器只需要继承javax.servlet.filter即可,一般来说我们只要添加tomcat运行时环境就能够包含javax.servlet的jar包,但是eclipse在tomcat8中没有找到,实际上tomcat8中确实没有,只有通过maven来添加了:
5.2 filter的实际应用
5.2.1 请求编码转换
package com.mycompany.mvc.filter;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
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 org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class urlEncodeFilter implements Filter{
Logger logger = LoggerFactory.getLogger(urlEncodeFilter.class);
Map paramMap = new HashMap();
@Override
public void destroy() {
}
@Override
public void doFilter(ServletRequest arg0, ServletResponse arg1,
FilterChain arg2) throws IOException, ServletException {
System.out.println("urlEncodeFilter doFilter..."+paramMap.get("urlEncode").toString());
arg0.setCharacterEncoding(paramMap.get("urlEncode").toString());
arg2.doFilter(arg0, arg1);
}
@Override
public void init(FilterConfig arg0) throws ServletException {
String urlEncode = arg0.getInitParameter("urlEncode");
paramMap.put("urlEncode",urlEncode);
}
}
web.xml配置:
5.2.2 日志记录,比如记录所有对网站发起请求的地址
package com.mycompany.mvc.filter;
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.http.HttpServletRequest;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class logFilter implements Filter{
Logger logger = LoggerFactory.getLogger(logFilter.class);
@Override
public void destroy() {
}
@Override
public void doFilter(ServletRequest arg0, ServletResponse arg1,
FilterChain arg2) throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest)arg0;
System.out.println("logFilter doFilter servletPath:"+request.getRemoteHost());
arg2.doFilter(arg0, arg1);
}
@Override
public void init(FilterConfig arg0) throws ServletException {
}
}
web.xml:
5.2.3 对未登陆用户的判断
package com.mycompany.mvc.filter;
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.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import org.apache.commons.lang.StringUtils;
import com.mycompany.mvc.utils.Constant;
public class loginFilter implements Filter{
private String dispatchUrl = "";
private String excludeUrl = "";
@Override
public void destroy() {
}
@Override
public void doFilter(ServletRequest arg0, ServletResponse arg1, FilterChain arg2)
throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest)arg0;
String servletPath = request.getServletPath();
HttpSession session = request.getSession();
String sessionKey = (String) session.getAttribute(Constant.SESSIONKEY);
/*就是登陆界面不进行过滤*/
if(servletPath.equals(dispatchUrl) || servletPath.equals(excludeUrl)){
arg2.doFilter(arg0, arg1);
}else{
if(!StringUtils.isEmpty(sessionKey)){
arg2.doFilter(arg0, arg1);
}else{
request.getRequestDispatcher(dispatchUrl).forward(arg0, arg1);
}
}
}
@Override
public void init(FilterConfig arg0) throws ServletException {
dispatchUrl = arg0.getInitParameter("dispatchUrl");
excludeUrl = arg0.getInitParameter("excludeUrl");
}
}
web.xml:
之所以上面的/main能够直接跳转到index这个登陆界面,是因为SpringMvc中配置了这个(上篇文章有讲述到):
它的意思就是不经过controller层,直接把index放入ModelAndView,然后由渲染层进行渲染。 讲到这里,再结合上面说到的拦截器,我们发现,这个时候拦截器还是能够拦截2次的,就是视图渲染前和渲染后,但是进入controller层之前肯定拦截不到了,因为请求根本就没有进入controller。
systemAction:
package com.mycompany.system.controller;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
@Controller
@RequestMapping("/system")
public class systemAction {
@RequestMapping("/login")
public ModelAndView login(HttpServletRequest request){
ModelAndView mv = new ModelAndView();
HttpSession session = request.getSession();
/*假设用户输入的用户名密码正确,则放入sessionKey中,对应的value可以
* 是User对象,这里以字符串"test"代替*/
session.setAttribute("sessionKey","test");
mv.setViewName("login");
return mv;
}
@RequestMapping("/view")
public ModelAndView view(HttpServletRequest request){
ModelAndView mv = new ModelAndView();
mv.setViewName("view");
return mv;
}
}
Constant.java:
package com.mycompany.mvc.utils;
public class Constant {
public static final String SESSIONKEY = "sessionKey";
}
6.拦截器(interceptor)
6.1 拦截器这个要详细讲述一下了,上一篇文章说到,Spring的配置文件应该扫描service层及以下,SpringMvc的配置文件应该扫描controller层; 我们在service层如果想做日志的话,可以使用spring aop特性,在spring.xml中配置aspect即可,那么如果想在controller层做日志,相应地,在SpringMvc.xml中应该怎么配置呢?
这个时候就需要拦截器,它其实也是一种aop的实现(aop本身是一种思想),而且这种实现本质上和aspect是一样的,只是做了更多的事情,我们当然可以在SpringMvc.xml中也配置aspect,不过现在有一个更好的实现,为什么不用呢。
关于拦截器细节,可以参考这篇文章:http://elim.iteye.com/blog/1750680
6.2 拦截器的实际应用
6.2.1 可以全局做日志
package com.mycompany.mvc.interceptor;
import java.lang.reflect.Method;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
/**@Description
-
logInterceptor公共拦截器,做日志记录
*/
public class logInterceptor implements HandlerInterceptor{@Override
public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)
throws Exception {
/做一些清理工作/
}@Override
public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)
throws Exception {
System.out.println("logInterceptor.postHandle()---view Name:"+arg3.getViewName());
}@Override
public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2) throws Exception {
/取得调用的controller方法等/
if(arg2 instanceof HandlerMethod){
HandlerMethod hMethod = (HandlerMethod)arg2;
Method method = hMethod.getMethod();
System.out.println("logInterceptor.preHandle()--method Name:"+method.getName());
}
return true;
}
}
6.2.2 记录部分调用的时间
package com.mycompany.mvc.interceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
/**@Description
登陆时间拦截器,记录用户登录时间
-
*/
public class timeInterceptor implements HandlerInterceptor{@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
return true;
}@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
System.out.println("timeInterceptor.postHandle()--time:"+System.currentTimeMillis());
}@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
throws Exception {
}
}
上述两个拦截器功能的配置如下,SpringMvc.xml: