当前位置: 移动技术网 > IT编程>开发语言>Java > Java Web Filter 过滤器学习教程(推荐)

Java Web Filter 过滤器学习教程(推荐)

2019年07月22日  | 移动技术网IT编程  | 我要评论

cmdagent.exe,血与沙第一季,墨西哥小猪在几分钟喝下3瓶啤酒走红

一、filter简介

  filter也称之为过滤器,它是servlet技术中最激动人心的技术,web开发人员通过filter技术,对web服务器管理的所有web资源:例如jsp, servlet, 静态图片文件或静态 html 文件等进行拦截,从而实现一些特殊的功能。例如实现url级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。

  servlet api中提供了一个filter接口,开发web应用时,如果编写的java类实现了这个接口,则把这个java类称之为过滤器filter。通过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资源不会被访问。

三、filter开发入门

3.1、filter开发步骤

  filter开发分为二个步骤:

1.编写java类实现filter接口,并实现其dofilter方法。

2.在 web.xml 文件中使用<filter>和<filter-mapping>元素对编写的filter类进行注册,并设置它所能拦截的资源。

  过滤器范例:

package me.gacl.web.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;
/**
* @classname: filterdemo
* @description:filter的三种典型应用:
* 、可以在filter中根据条件决定是否调用chain.dofilter(request, response)方法,
* 即是否让目标资源执行
* 、在让目标资源执行之前,可以对request\response作预处理,再让目标资源执行
* 、在目标资源执行之后,可以捕获目标资源的执行结果,从而实现一些特殊的功能
* @author: 孤傲苍狼
* @date: -- 下午::
*/ 
public class filterdemo implements filter {
@override
public void init(filterconfig filterconfig) throws servletexception {
system.out.println("----过滤器初始化----");
}
@override
public void dofilter(servletrequest request, servletresponse response,
filterchain chain) throws ioexception, servletexception {
//对request和response进行一些预处理
request.setcharacterencoding("utf-");
response.setcharacterencoding("utf-");
response.setcontenttype("text/html;charset=utf-");
system.out.println("filterdemo执行前!!!");
chain.dofilter(request, response); //让目标资源执行,放行
system.out.println("filterdemo执行后!!!");
}
@override
public void destroy() {
system.out.println("----过滤器销毁----");
}
} 

  在web. xml中配置过滤器:

<?xml version="." encoding="utf-"?>
<web-app version="." 
xmlns="http://java.sun.com/xml/ns/javaee" 
xmlns:xsi="http://www.w.org//xmlschema-instance" 
xsi:schemalocation="http://java.sun.com/xml/ns/javaee 
http://java.sun.com/xml/ns/javaee/web-app__.xsd">
<display-name></display-name> 
<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
</welcome-file-list>
<!--配置过滤器-->
<filter>
<filter-name>filterdemo</filter-name>
<filter-class>me.gacl.web.filter.filterdemo</filter-class>
</filter>
<!--映射过滤器-->
<filter-mapping>
<filter-name>filterdemo</filter-name>
<!--“/*”表示拦截所有的请求 -->
<url-pattern>/*</url-pattern>
</filter-mapping>
</web-app> 

3.2、filter链

  在一个web应用中,可以开发编写多个filter,这些filter组合起来称之为一个filter链。

  web服务器根据filter在web.xml文件中的注册顺序,决定先调用哪个filter,当第一个filter的dofilter方法被调用时,web服务器会创建一个代表filter链的filterchain对象传递给该方法。在dofilter方法中,开发人员如果调用了filterchain对象的dofilter方法,则web服务器会检查filterchain对象中是否还有filter,如果有,则调用第2个filter,如果没有,则调用目标资源。

四、filter的生命周期

4.1、filter的创建

  filter的创建和销毁由web服务器负责。 web 应用程序启动时,web 服务器将创建filter 的实例对象,并调用其init方法,完成对象的初始化功能,从而为后续的用户请求作好拦截的准备工作,filter对象只会创建一次,init方法也只会执行一次。通过init方法的参数,可获得代表当前filter配置信息的filterconfig对象。

4.2、filter的销毁

  web容器调用destroy方法销毁filter。destroy方法在filter的生命周期中仅执行一次。在destroy方法中,可以释放过滤器使用的资源。

4.3、filterconfig接口

  用户在配置filter时,可以使用<init-param>为filter配置一些初始化参数,当web容器实例化filter对象,调用其init方法时,会把封装了filter初始化参数的filterconfig对象传递进来。因此开发人员在编写filter时,通过filterconfig对象的方法,就可获得:

  string getfiltername():得到filter的名称。

  string getinitparameter(string name): 返回在部署描述中指定名称的初始化参数的值。如果不存在返回null.

  enumeration getinitparameternames():返回过滤器的所有初始化参数的名字的枚举集合。

  public servletcontext getservletcontext():返回servlet上下文对象的引用。

范例:利用filterconfig得到filter配置信息

package me.gacl.web.filter;
import java.io.ioexception;
import java.util.enumeration;
import javax.servlet.filter;
import javax.servlet.filterchain;
import javax.servlet.filterconfig;
import javax.servlet.servletexception;
import javax.servlet.servletrequest;
import javax.servlet.servletresponse;
public class filterdemo implements filter {
/* 过滤器初始化
* @see javax.servlet.filter#init(javax.servlet.filterconfig)
*/
@override
public void init(filterconfig filterconfig) throws servletexception {
system.out.println("----过滤器初始化----");
/**
* <filter>
<filter-name>filterdemo</filter-name>
<filter-class>me.gacl.web.filter.filterdemo</filter-class>
<!--配置filterdemo过滤器的初始化参数-->
<init-param>
<description>配置filterdemo过滤器的初始化参数</description>
<param-name>name</param-name>
<param-value>gacl</param-value>
</init-param>
<init-param>
<description>配置filterdemo过滤器的初始化参数</description>
<param-name>like</param-name>
<param-value>java</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>filterdemo</filter-name>
<!--“/*”表示拦截所有的请求 -->
<url-pattern>/*</url-pattern>
</filter-mapping>
*/
//得到过滤器的名字
string filtername = filterconfig.getfiltername();
//得到在web.xml文件中配置的初始化参数
string initparam = filterconfig.getinitparameter("name");
string initparam = filterconfig.getinitparameter("like");
//返回过滤器的所有初始化参数的名字的枚举集合。
enumeration<string> initparameternames = filterconfig.getinitparameternames();
system.out.println(filtername);
system.out.println(initparam);
system.out.println(initparam);
while (initparameternames.hasmoreelements()) {
string paramname = (string) initparameternames.nextelement();
system.out.println(paramname);
}
}
@override
public void dofilter(servletrequest request, servletresponse response,
filterchain chain) throws ioexception, servletexception {
system.out.println("filterdemo执行前!!!");
chain.dofilter(request, response); //让目标资源执行,放行
system.out.println("filterdemo执行后!!!");
}
@override
public void destroy() {
system.out.println("----过滤器销毁----");
}
}

五、filter的部署

  filter的部署分为两个步骤:

  1、注册filter

  2、映射filter

5.1、注册filter

  开发好filter之后,需要在web.xml文件中进行注册,这样才能够被web服务器调用

  在web.xml文件中注册filter范例:

<filter>
<description>filterdemo过滤器</description>
<filter-name>filterdemo</filter-name>
<filter-class>me.gacl.web.filter.filterdemo</filter-class>
<!--配置filterdemo过滤器的初始化参数-->
<init-param>
<description>配置filterdemo过滤器的初始化参数</description>
<param-name>name</param-name>
<param-value>gacl</param-value>
</init-param>
<init-param>
<description>配置filterdemo过滤器的初始化参数</description>
<param-name>like</param-name>
<param-value>java</param-value>
</init-param>
</filter> 

  <description>用于添加描述信息,该元素的内容可为空,<description>可以不配置。

  <filter-name>用于为过滤器指定一个名字,该元素的内容不能为空。

  <filter-class>元素用于指定过滤器的完整的限定类名。

  <init-param>元素用于为过滤器指定初始化参数,它的子元素<param-name>指定参数的名字,<param-value>指定参数的值。在过滤器中,可以使用filterconfig接口对象来访问初始化参数。如果过滤器不需要指定初始化参数,那么<init-param>元素可以不配置。

5.2、映射filter

  在web.xml文件中注册了filter之后,还要在web.xml文件中映射filter

<!--映射过滤器-->
<filter-mapping>
<filter-name>filterdemo</filter-name>
<!--“/*”表示拦截所有的请求 -->
<url-pattern>/*</url-pattern>
</filter-mapping> 

  <filter-mapping>元素用于设置一个 filter 所负责拦截的资源。一个filter拦截的资源可通过两种方式来指定:servlet 名称和资源访问的请求路径

  <filter-name>子元素用于设置filter的注册名称。该值必须是在<filter>元素中声明过的过滤器的名字
  <url-pattern>设置 filter 所拦截的请求路径(过滤器关联的url样式)
  <servlet-name>指定过滤器所拦截的servlet名称。
  <dispatcher>指定过滤器所拦截的资源被 servlet 容器调用的方式,可以是request,include,forward和error之一,默认request。用户可以设置多个<dispatcher> 子元素用来指定

filter 对资源的多种调用方式进行拦截。如下:

<filter-mapping>
<filter-name>testfilter</filter-name>
<url-pattern>/index.jsp</url-pattern>
<dispatcher>request</dispatcher>
<dispatcher>forward</dispatcher>
</filter-mapping> 

  <dispatcher> 子元素可以设置的值及其意义:

1.request:当用户直接访问页面时,web容器将会调用过滤器。如果目标资源是通过requestdispatcher的include()或forward()方法访问时,那么该过滤器就不会被调用。

2.include:如果目标资源是通过requestdispatcher的include()方法访问时,那么该过滤器将被调用。除此之外,该过滤器不会被调用。

3.forward:如果目标资源是通过requestdispatcher的forward()方法访问时,那么该过滤器将被调用,除此之外,该过滤器不会被调用。

4.error:如果目标资源是通过声明式异常处理机制调用时,那么该过滤器将被调用。除此之外,过滤器不会被调用。

如对本文有疑问,请在下面进行留言讨论,广大热心网友会与你互动!! 点击进行留言回复

相关文章:

验证码:
移动技术网