首页 > 应用开发 > Java > servlet和JSP过滤器
本章内容如下:
l 设计基本过滤器
l 读取请求数据
l 访问serlvet环境
l 初始化过滤器
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
<!-- ... -->
2.filter-mapping元素
filter-mapping元素位于web.xml文件中filter元素之后serlvet元素之前。它包含如下三个可能的子元素::
l filter-name 这个必需的元素必须与用filter元素声明时给予过滤器的名称相匹配。
l url-pattern 此元素声明一个以斜杠(/)开始的模式,它指定过滤器应用的URL。所有filter-mapping元素中必须提供url-pattern或servlet-name。但不能对单个filter-mapping元素提供多个url-pattern元素项。如果希望过滤器适用于多个模式,可重复整个filter-mapping元素。
l servlet-name 此元素给出一个名称,此名称必须与利用servlet元素给予servlet或JSP页面的名称相匹配。不能给单个filter-mapping元素提供多个servlet-name元素项。如果希望过滤器适合于多个servlet名,可重复这个filter-mapping元素。
下面举一个例子:
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
<!-- ... -->
1.5 禁用激活器servlet
在对资源应用过滤器时,可通过指定要应用过滤器的URL模式或servlet名来完成。如果提供servlet名,则此名称必须与web.xml的servlet元素中给出的名称相匹配。如果使用应用到一个serlvet的URL模式,则此模式必须与利用web.xml的元素servlet-mapping指定的模式相匹配。但是,多数服务器使用“激活器servlet”为servlet体统一个缺省的URL:http://host/WebAppPrefix/servlet/ServletName。需要保证用户不利用这个URL访问servlet(这样会绕过过滤器设置)。
例如,假如利用filter和filter-mapping指示名为SomeFilter的过滤器应用到名为SomeServlet的servlet,则如下:
<!-- ... -->
接着,用servlet和servlet-mapping规定URL http://host/webAppPrefix/Blah 应该调用SomeSerlvet,如下所示:
<!-- ... -->
现在,在客户机使用URL http://host/webAppPrefix/Blah 时就会调用过滤器。过滤器不应用到
http://host/webAppPrefix/servlet/SomePackage.SomeServletClass。
尽管有关闭激活器的服务器专用方法。但是,可移植最强的方法时重新映射Web应用钟的/servlet模式,这样使所有包含此模式的请求被送到相同的servlet中。为了重新映射此模式,首先应该建立一个简单的servlet,它打印一条错误消息,或重定向用户到顶层页。然后,使用servlet和servlet-mapping元素发送包含/servlet模式的请求到该servlet。程序清单9-1给出了一个简短的例子。
程序清单9-1 web.xml(重定向缺省servlet URL的摘录)
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
<!-- ... -->
<!-- ... -->
<!-- ... -->
2. 样例:报告过滤器
趁热打铁,我们来试验一个简单的过滤器,只要调用相关的servlet或JSP页面,它就打印一条消息到标准输出。为了完成此任务,相应的过滤器必须具有下面的内容:
1)实现Filter接口的一个类。这个类名为ReportFilter,如程序清单9-2所示。这个类对init和destroy方法提供空体。
2)在doFilter方法中过滤行为。每当调用与这个过滤器相关的servlet或JSP页面时,doFilter方法就生成一个打印输出,此输出列出请求主机和调用的URL。因为getRequestURL方法位于HttpServletRequest而不是ServletRequest中,所以把ServletRequest对象构造为HttpServletRequest类型。
3)调用FilterChain的doFilter方法。在打印输出报告后,过滤器调用FilterChain的doFilter方法激活servlet或JSP页面(如果有的话,调用下一个过滤器)
4)对Web应用主页和显示TodaysSpecialservlet进行注册。首先,filter元素将名称Reporter与类moreservlets.filters.ReportFilter相关联。然后,filter-mapping元素使用/index.jsp的url-pattern将过滤器与主页相关联。最后,filter-mapping元素使用TodaysSpecial的servlet-name将过滤器与TodaysSpecialservlet(名称TodaysSpecial是在servlet元素中声明的)相关联。参见程序清单9-3。
5)禁用激活器servlet。首先,建立一个RedirectorServlet(见程序清单9-6),它把接收到的所有请求重定向到此Web应用的主页。接着,利用servlet和servlet-mapping元素(参见程序清单9-3)指定所有以http://host/webAppPrefix/servlet/ 开始的URL都应该激活RedirectorServlet。
给出这些设置后,每当客户机请求此Web应用主页(程序清单9-4)或TodaysSpecialservlet(程序清单9-5)时,都调用此过滤器。
程序清单9-2 ReportFilter.java
package moreservlets.filters;
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*; // For Date class
/** Simple filter that prints a report on the standard output
* each time an associated servlet or JSP page is accessed.
*/
public class ReportFilter implements Filter {
public void doFilter(ServletRequest request,
ServletResponse response,
FilterChain chain)
throws ServletException, IOException {
HttpServletRequest req = (HttpServletRequest)request;
System.out.println(req.getRemoteHost() +
" tried to access " +
req.getRequestURL() +
" on " + new Date() + ".");
chain.doFilter(request,response);
}
public void init(FilterConfig config)
throws ServletException {
}
public void destroy() {}
}
程序清单9-3 web.xml(针对报告过滤器的摘录)
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
<!-- Register the name "Reporter" for ReportFilter. -->
moreservlets.filters.ReportFilter
<!-- ... -->
<!-- Apply the Reporter filter to home page. -->
<!-- Also apply the Reporter filter to the servlet named
"TodaysSpecial".
-->
<!-- ... -->
<!-- Give a name to the Today's Special servlet so that filters
can be applied to it.
-->
moreservlets.TodaysSpecialServlet
<!-- ... -->
<!-- Make /TodaysSpecial invoke the servlet
named TodaysSpecial (i.e., moreservlets.TodaysSpecial).
-->
<!-- Turn off invoker. Send requests to index.jsp. -->
<!-- ... -->
程序清单9-4 index.jsp
| Filters 'R' Us |
|---|
![]() | ![]() | ![]() |
|---|
程序清单9-5 TodaysSpecialServlet.java
package moreservlets;
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
/** Sample servlet used to test the simple filters. */
public class TodaysSpecialServlet extends HttpServlet {
private String title, picture;
public void doGet(HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException {
updateSpecials();
response.setContentType("text/html");
PrintWriter out = response.getWriter();
String docType =
" "Transitional//EN">n";
out.println
(docType +
"n" +
"
// Rotate among the three available filter images.
private void updateSpecials() {
double num = Math.random();
if (num < 0.333) {
title = "Air Filter";
picture = "air-filter.jpg";
} else if (num < 0.666) {
title = "Coffee Filter";
picture = "coffee-filter.gif";
} else {
title = "Pump Filter";
picture = "pump-filter.jpg";
}
}
}
程序清单9-6 RedirectorServlet.java
package moreservlets;
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
/** Servlet that simply redirects users to the
* Web application home page. Registered with the
* default servlet URL to prevent clients from
* using http://host/webAppPrefix/servlet/ServletName
* to bypass filters or security settings that
* are associated with custom URLs.
*/
public class RedirectorServlet extends HttpServlet {
public void doGet(HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException {
response.sendRedirect(request.getContextPath());
}
public void doPost(HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException {
doGet(request, response);
}
}
3. 从过滤器中访问servlet环境
前一节的ReportFilter只要调用指定的servlet或JSP页面,就在标准输出上打印一个报告。当你在自己的桌面系统上运行一个服务器时,一般会用一个显示标准输出的窗口,在开发过程中,标准输出上的报告很好用。但在部署过程中,不可能访问这个窗口。因此,一种自然的改进是将报告写入servlet日志文件写到标准输出。
Servlet API提供了两个log方法:一个取一个简单的String而另一个取一个String和一个Throwable。这两个方法都可以从GenericServlet或ServletContext类中使用。关于这两个方法所用的日志文件的准确位置,请查看相关服务器的帮助文档。问题是doFilter方法在与其相关的serlvet或JSP页面之前执行。因此,你不能访问该servlet的实例,从而不能调用从GenericServlet继承的log方法。此外,API没有体统从doFilter方法中访问ServletContext的简单方法。可以访问ServletContext的方法并且与过滤器相关的唯一类是FilterConfig,访问ServletContext的方法为getServletContext。FilterConfig对象被传输给init方法,但不会自动存放到doFilter可使用的某个位置。
因此,你必须自己存放FilterConfig。可建立一个FilterConfig类型的字段,然后重载init,将它的参数分配给该字段。因为一般只使用FilterConfig对象来访问ServletContext和过滤器名,所以可以存放该ServletContext和名称在字段中。相面举一个例子:
public class SomeFilter implements Filter {
protected FilterConfig config;
private ServletContext context;
private String filterName;
public void init(FilterConfig config)
throws ServletException {
this.config = config; // In case it is needed by subclass.
context = config.getServletContext();
filterName = config.getFilterName();
}
// doFilter and destroy methods...
}
4. 例子:日志记录过滤器
我们来更新ReportFilter(程序清单9-2),以便消息进入日志文件而不是标准输出。为了完成这个任务,过滤器应该具有下列内容:
1)实现Filter接口的一个类。这个类名为LogFilter,如程序清单9-7所示。这个类的init方法在过滤器的字段中存放FilterConfig、ServletContext和过滤器名。它对destory方法提供一个空体。
2)在doFilter方法中过滤行为。这个行为和ReportFilter的行为之间有两点不同:报告放于日志文件中而不是标准输出中,报告包括过滤器的名称。
3)调用FilterChain的doFilter方法。在打印出报告后,此过滤器调用FilterChain的doFilter方法激活链中的下一个过滤器(如果没有更多的过滤器,则激活servlet或JSP页面)。
4)对所有URL进行注册。首先,filter元素将名称LogFilter与类moreservlets.filters.LogFilter相关联。接着,filter-mapping元素使用值为/*的url-pattern将此过滤器与Web应用中所有URL相关联。参看程序清单9-8。
5)禁用激活servlet。这个操作已经在第2节介绍过,这里就不再重复了。
当这个Web应用部署在一个外部服务器上且附加了日志记录过滤器后,客户机对此Web应用主页的请求将在日志文件中产生一个项,如:“audits.irs.gov tired to acces http://www.filtersrus.com/filters/index.jsp on Fri Oct 26 15:16:15 EDT 2001.(Reported by Logger.)”。
程序清单9-7 LogFilter.java
package moreservlets.filters;
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*; // For Date class
/** Simple filter that prints a report in the log file
* whenever the associated servlets or JSP pages
* are accessed.
*/
public class LogFilter implements Filter {
protected FilterConfig config;
private ServletContext context;
private String filterName;
public void doFilter(ServletRequest request,
ServletResponse response,
FilterChain chain)
throws ServletException, IOException {
HttpServletRequest req = (HttpServletRequest)request;
context.log(req.getRemoteHost() +
" tried to access " +
req.getRequestURL() +
" on " + new Date() + ". " +
"(Reported by " + filterName + ".)");
chain.doFilter(request,response);
}
public void init(FilterConfig config)
throws ServletException {
this.config = config; // In case it is needed by subclass.
context = config.getServletContext();
filterName = config.getFilterName();
}
public void destroy() {}
}
程序清单9-8 web.xml(针对日志记录过滤器的摘录)
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
<!-- ... -->
<!-- Register the name "Logger" for LogFilter. -->
moreservlets.filters.LogFilter
<!-- ... -->
<!-- Apply the Logger filter to all servlets and
JSP pages.
-->
<!-- ... -->
5. 利用过滤器的初始化参数
对于servlet和JSP页面,可通过提供初始化参数定制初始化行为。这个功能之所以游泳的原因在于有三组不同的人员可能希望定制servlet或JSP页面的行为,这三组人员分别为:
1)开发人员——他们通过更改serlvet或JSP页面的代码定制相应的行为。
2)最终用户——他们通过在HTML表单中输入值来定制相应的行为。
3)部署人员——这是提供初始化参数服务的一组人员。这组人员是那些获得现存Web应用(或个别的servlet或JSP页面)并在一个定制环境环境中部署它们的人员。他们不一定是开发人员,因此期望他们修改servlet和JSP代码是不现实的。但由于过滤器在它们所附加的servlet或JSP页面之前执行,最终用户一般不能定制过滤器的行为,这种能力仍然很有用。定制过滤器的行为用如下步骤完成:
1)定义初始化参数。使用web.xml中的filter的init-param子元素以及param-nam和param-value子元素,如下所示。
2)读初始化参数。从过滤器的inti方法中调用FilterConfig的getInitParameter方法。如下所示。
public void init(FilterConfig config)
throws ServletException {
String val1 = config.getInitParameter("param1");
String val2 = config.getInitParameter("param2");
...
}
3)分析初始化参数。就像servlet和JSP的初始化参数一样,每个过滤器的初始化都是String类型的。因此,如果想要其他类型的值,必须对它进行转换。例如,可用Integer.parseInt将String“7”转换为int 7。在分析时,别忘了检查缺少的和不良的数据。缺少初始化参数将导致从getInitParameter返回null。即使这些参数存在,也一个来考虑到部署人员不正确地对其值进行格式化的可能性。例如,在转换String类型的值为int类型的值时,应该将Integer.parseInt调用封在try/catch中,这个块捕捉NumberFormatException。这种办法彻底地处理了null和格式化不正确的值。
6. 例子:访问时的过滤器
第4节的LogFilter,每当相关的servlet或JSP页面被访问时,就在日志文件中打印一个项。假如想修改它,使它只注意不寻常时刻出现的访问。因为“不寻常”要视具体情况而定,servlet应该提供不寻常时间范围的缺省值,并允许部署人员通过初始化参数来重载这些值。为了完成这种功能,相应的过滤器应该具有下面的内容:
1)实现Filter接口的一个类。这个类名为LateAccessFilter,如程序清单9-9所示。这个类的init方法读取startTime和endTime初始化参数。它尝试作为init分析这些值,如果这些参数为null或未格式化为整数,这使用缺省值。然后,它将开始和结束事件、FilterConfig、ServletContext以及过滤器名存入过滤器的字段。最后,LateAccessFilter对destroy方法提供一个空体。
2)在doFilter方法中过滤行为。这个方法查找当前事件,看它问是否在开始时间和结束事件给出的范围内,如果是,打印一个日志项。
3)调用FilterChain的doFilter方法。在打印出报告后,此过滤器调用FilterChain的doFilter方法激活链中的下一个过滤器(如果没有更多的过滤器,则激活servlet或JSP页面)。
4)对Web应用主页进行注册;定义初始化参数。首先,filter元素将名称LateAccessFilter与类moreservlets.filters.LateAccessFilter相关联。filter元素还包含两个init-param子元素:一个定义startTime参数,另一个定义endTime参数。因为将要访问filterRus主页的人是程序员,考虑反常的时间范围为上午2:00到10:00之间。最后,filter-mapping元素使用值为/index.jsp的ulr-pattern子元素,将此过滤器与Web应用主页相关联。参看程序清单9-10。
5)己用激活器serlvet。这个已经在第2节介绍过,不再重复。
当这个Web应用部署在一个外部服务器上且附加了日志记录过滤器后,客户机对此Web应用主页的请求将在日志文件中产生一个项,如:“WARNING: hacker6.filtersrus.com accessed http://www.filtersrus.com/filters/index.jsp on Oct 30,2001 9:22:09 AM.”。
程序清单9-9 LateAccessFilter.java
package moreservlets.filters;
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*;
import java.text.*;
/** Filter that keeps track of accesses that occur
* at unusual hours.
*/
public class LateAccessFilter implements Filter {
private FilterConfig config;
private ServletContext context;
private int startTime, endTime;
private DateFormat formatter;
public void doFilter(ServletRequest request,
ServletResponse response,
FilterChain chain)
throws ServletException, IOException {
HttpServletRequest req = (HttpServletRequest)request;
GregorianCalendar calendar = new GregorianCalendar();
int currentTime = calendar.get(calendar.HOUR_OF_DAY);
if (isUnusualTime(currentTime, startTime, endTime)) {
context.log("WARNING: " +
req.getRemoteHost() +
" accessed " +
req.getRequestURL() +
" on " +
formatter.format(calendar.getTime()));
}
chain.doFilter(request,response);
}
public void init(FilterConfig config)
throws ServletException {
this.config = config;
context = config.getServletContext();
formatter =
DateFormat.getDateTimeInstance(DateFormat.MEDIUM,
DateFormat.MEDIUM);
try {
startTime =
Integer.parseInt(config.getInitParameter("startTime"));
endTime =
Integer.parseInt(config.getInitParameter("endTime"));
} catch(NumberFormatException nfe) { // Malformed or null
// Default: access at or after 10 p.m. but before 6 a.m.
// is considered unusual.
startTime = 22; // 10:00 p.m.
endTime = 6; // 6:00 a.m.
}
}
public void destroy() {}
// Is the current time between the start and end
// times that are marked as abnormal access times?
private boolean isUnusualTime(int currentTime,
int startTime,
int endTime) {
// If the start time is less than the end time (i.e.,
// they are two times on the same day), then the
// current time is considered unusual if it is
// between the start and end times.
if (startTime < endTime) {
return((currentTime >= startTime) &&
(currentTime < endTime));
}
// If the start time is greater than or equal to the
// end time (i.e., the start time is on one day and
// the end time is on the next day), then the current
// time is considered unusual if it is NOT between
// the end and start times.
else {
return(!isUnusualTime(currentTime, endTime, startTime));
}
}
}
程序清单9-10 web.xml(针对访问时过滤器的摘录)
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
<!-- ... -->
<!-- Register the name "LateAccessFilter" for
moreservlets.filter.LateAccessFilter.
Supply two initialization parameters:
startTime and endTime.
-->
moreservlets.filters.LateAccessFilter
<!-- ... -->
<!-- Apply LateAccessFilter to the home page. -->
<!-- ... -->
来自 “ ITPUB博客 ” ,链接:https://blog.itpub.net/8042616/viewspace-892896/ ,如需转载,请注明出处,否则将追究法律责任。