java 监听器过滤器_JavaWeb中监听器+过滤器+拦截器区别、配置和实际应用

最新推荐文章于 2021-12-30 17:46:34 发布

李萱Yo

最新推荐文章于 2021-12-30 17:46:34 发布

阅读量146

点赞数

文章标签： java 监听器过滤器

本文链接：https://blog.csdn.net/weixin_35147832/article/details/114116363

版权

1.前沿上一篇文章提到在web.xml中各个元素的执行顺序是这样的，context-param-->listener-->filter-->servlet；而拦截器是在Spring MVC中配置的，如果从整个项目中看，一个servlet请求的执行过程就变成了这样context-param-->listener-->filter-->servlet-->interceptor(指的是拦截器)，为什么拦截器是在servlet执行之后，因为拦截器本身就是在servlet内部的，下面把所学和所总结的用自己的描述整理出来~。另外本文的项目框架是基于上篇文章http://blog.csdn.net/Jintao_Ma/article/details/52892625讲述的框架，下载路径：http://download.csdn.net/download/jintao_ma/9661038。

2.概念

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:

pageEncoding="UTF-8"%>

html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

index.jsp

this is index jsp

测试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");

当前在线人数：

HttpSessionBindingListener测试：

session.setAttribute("bean",new myHttpSessionBindingListener());

session.removeAttribute("bean");

html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

main.jsp

This is has login jsp

view

view.jsp:

pageEncoding="UTF-8"%>

html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

view jsp

用户已经登陆，欢迎来到登陆后系统主界面

4.监听器

4.1listener具体分为八种，能够监听包括request域，session域，application域的产生，销毁和属性的变化；

在配置完然后我们在web.xml中诸如下面的配置即可：

com.mycompany.mvc.listener.myServletContextListener

com.mycompany.mvc.listener.myServletContextAttributeListener

4.2listener实际应用

4.2.1 获取当前在线人数

packagecom.mycompany.mvc.listener;

importjavax.servlet.http.HttpSessionEvent;

importjavax.servlet.http.HttpSessionListener;

publicclassmyHttpSessionListenerimplementsHttpSessionListener{

publicstaticintpeopleOnLine =0;

@Override

publicvoidsessionCreated(HttpSessionEvent arg0) {

System.out.println("myHttpSessionListener.sessionCreated():"+arg0);

peopleOnLine++;

arg0.getSession().setAttribute("peopleOnLine",peopleOnLine);

}

@Override

publicvoidsessionDestroyed(HttpSessionEvent arg0) {

System.out.println("myHttpSessionListener.sessionDestroyed():"+arg0);

peopleOnLine--;

arg0.getSession().setAttribute("peopleOnLine",peopleOnLine);

}

在页面中就可以获取：

当前在线人数：

其实也可以获得历史所有在线人数，只需要把历史所有在线人数保存在文件中，然后每次项目启动读取这个文件，当前人数增加时，把历史所有人数也相应增加，项目关闭时，再保存起来。

4.2.2 在系统初始化时，获取项目绝对路径

如下，获得绝对路径后保存到系统变量System中：

@Override

publicvoidcontextInitialized(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来添加了：

javax.servlet

servlet-api

2.5

javax.servlet

jsp-api

2.0

5.2filter的实际应用

5.2.1 请求编码转换

packagecom.mycompany.mvc.filter;

importjava.io.IOException;

importjava.util.HashMap;

importjava.util.Map;

importjavax.servlet.Filter;

importjavax.servlet.FilterChain;

importjavax.servlet.FilterConfig;

importjavax.servlet.ServletException;

importjavax.servlet.ServletRequest;

importjavax.servlet.ServletResponse;

importorg.slf4j.Logger;

importorg.slf4j.LoggerFactory;

publicclassurlEncodeFilterimplementsFilter{

Logger logger = LoggerFactory.getLogger(urlEncodeFilter.class);

Map paramMap = newHashMap();

@Override

publicvoiddestroy() {

}

@Override

publicvoiddoFilter(ServletRequest arg0, ServletResponse arg1,

FilterChain arg2) throwsIOException, ServletException {

System.out.println("urlEncodeFilter doFilter..."+paramMap.get("urlEncode").toString());

arg0.setCharacterEncoding(paramMap.get("urlEncode").toString());

arg2.doFilter(arg0, arg1);

}

@Override

publicvoidinit(FilterConfig arg0)throwsServletException {

String urlEncode = arg0.getInitParameter("urlEncode");

paramMap.put("urlEncode",urlEncode);

}

web.xml配置：

urlEncodeFilter

com.mycompany.mvc.filter.urlEncodeFilter

urlEncode

UTF-8

urlEncodeFilter

5.2.2 日志记录，比如记录所有对网站发起请求的地址

packagecom.mycompany.mvc.filter;

importjava.io.IOException;

importjavax.servlet.Filter;

importjavax.servlet.FilterChain;

importjavax.servlet.FilterConfig;

importjavax.servlet.ServletException;

importjavax.servlet.ServletRequest;

importjavax.servlet.ServletResponse;

importjavax.servlet.http.HttpServletRequest;

importorg.slf4j.Logger;

importorg.slf4j.LoggerFactory;

publicclasslogFilterimplementsFilter{

Logger logger = LoggerFactory.getLogger(logFilter.class);

@Override

publicvoiddestroy() {

}

@Override

publicvoiddoFilter(ServletRequest arg0, ServletResponse arg1,

FilterChain arg2) throwsIOException, ServletException {

HttpServletRequest request = (HttpServletRequest)arg0;

System.out.println("logFilter doFilter servletPath:"+request.getRemoteHost());

arg2.doFilter(arg0, arg1);

}

@Override

publicvoidinit(FilterConfig arg0)throwsServletException {

}

web.xml:

logFilter

com.mycompany.mvc.filter.logFilter

logFilter

5.2.3 对未登陆用户的判断

packagecom.mycompany.mvc.filter;

importjava.io.IOException;

importjavax.servlet.Filter;

importjavax.servlet.FilterChain;

importjavax.servlet.FilterConfig;

importjavax.servlet.ServletException;

importjavax.servlet.ServletRequest;

importjavax.servlet.ServletResponse;

importjavax.servlet.http.HttpServletRequest;

importjavax.servlet.http.HttpSession;

importorg.apache.commons.lang.StringUtils;

importcom.mycompany.mvc.utils.Constant;

publicclassloginFilterimplementsFilter{

privateString dispatchUrl ="";

privateString excludeUrl ="";

@Override

publicvoiddestroy() {

}

@Override

publicvoiddoFilter(ServletRequest arg0, ServletResponse arg1, FilterChain arg2)

throwsIOException, 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

publicvoidinit(FilterConfig arg0)throwsServletException {

dispatchUrl = arg0.getInitParameter("dispatchUrl");

excludeUrl = arg0.getInitParameter("excludeUrl");

}

web.xml:

loginFilter

com.mycompany.mvc.filter.loginFilter

excludeUrl

/main

dispatchUrl

/system/login

loginFilter

之所以上面的/main能够直接跳转到index这个登陆界面，是因为SpringMvc中配置了这个(上篇文章有讲述到)：

它的意思就是不经过controller层，直接把index放入ModelAndView，然后由渲染层进行渲染。讲到这里，再结合上面说到的拦截器，我们发现，这个时候拦截器还是能够拦截2次的，就是视图渲染前和渲染后，但是进入controller层之前肯定拦截不到了，因为请求根本就没有进入controller。

systemAction:

packagecom.mycompany.system.controller;

importjavax.servlet.http.HttpServletRequest;

importjavax.servlet.http.HttpSession;

importorg.springframework.stereotype.Controller;

importorg.springframework.web.bind.annotation.RequestMapping;

importorg.springframework.web.servlet.ModelAndView;

@Controller

@RequestMapping("/system")

publicclasssystemAction {

@RequestMapping("/login")

publicModelAndView login(HttpServletRequest request){

ModelAndView mv = newModelAndView();

HttpSession session = request.getSession();

/*假设用户输入的用户名密码正确，则放入sessionKey中，对应的value可以

* 是User对象，这里以字符串"test"代替*/

session.setAttribute("sessionKey","test");

mv.setViewName("login");

returnmv;

}

@RequestMapping("/view")

publicModelAndView view(HttpServletRequest request){

ModelAndView mv = newModelAndView();

mv.setViewName("view");

returnmv;

}

Constant.java:

packagecom.mycompany.mvc.utils;

publicclassConstant {

publicstaticfinalString 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，不过现在有一个更好的实现，为什么不用呢。

6.2 拦截器的实际应用

6.2.1 可以全局做日志

packagecom.mycompany.mvc.interceptor;

importjava.lang.reflect.Method;

importjavax.servlet.http.HttpServletRequest;

importjavax.servlet.http.HttpServletResponse;

importorg.springframework.web.method.HandlerMethod;

importorg.springframework.web.servlet.HandlerInterceptor;

importorg.springframework.web.servlet.ModelAndView;

/**@Description

* logInterceptor公共拦截器，做日志记录

publicclasslogInterceptorimplementsHandlerInterceptor{

@Override

publicvoidafterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)

throwsException {

/*做一些清理工作*/

}

@Override

publicvoidpostHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)

throwsException {

System.out.println("logInterceptor.postHandle()---view Name:"+arg3.getViewName());

}

@Override

publicbooleanpreHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2)throwsException {

/*取得调用的controller方法等*/

if(arg2instanceofHandlerMethod){

HandlerMethod hMethod = (HandlerMethod)arg2;

Method method = hMethod.getMethod();

System.out.println("logInterceptor.preHandle()--method Name:"+method.getName());

}

returntrue;

}

6.2.2 记录部分调用的时间

packagecom.mycompany.mvc.interceptor;

importjavax.servlet.http.HttpServletRequest;

importjavax.servlet.http.HttpServletResponse;

importorg.springframework.web.servlet.HandlerInterceptor;

importorg.springframework.web.servlet.ModelAndView;

/**@Description

* 登陆时间拦截器，记录用户登录时间

* */

publicclasstimeInterceptorimplementsHandlerInterceptor{

@Override

publicbooleanpreHandle(HttpServletRequest request, HttpServletResponse response, Object handler)

throwsException {

returntrue;

}

@Override

publicvoidpostHandle(HttpServletRequest request, HttpServletResponse response, Object handler,

ModelAndView modelAndView) throwsException {

System.out.println("timeInterceptor.postHandle()--time:"+System.currentTimeMillis());

}

@Override

publicvoidafterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)

throwsException {

}

上述两个拦截器功能的配置如下，SpringMvc.xml:

更详细的web.xml解释，请参考：

李萱Yo

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
java 监听器过滤器_JavaWeb中监听器+过滤器+拦截器区别、配置和实际应用

1.前沿上一篇文章提到在web.xml中各个元素的执行顺序是这样的，context-param-->listener-->filter-->servlet；而拦截器是在Spring MVC中配置的，如果从整个项目中看，一个servlet请求的执行过程就变成了这样context-param-->listener-->filter-->servlet-->i...
复制链接

扫一扫