1、简介

UrlRewriteFilter是一个用于改写URL的Web过滤器，类似于Apache的mod_rewrite。适用于任何Web应用服务器（如Resin，Orion，Tomcat等）。其典型应用就把动态URL静态化，便于搜索引擎爬虫抓取你的动态网页。

其主页：http://tuckey.org/urlrewrite/

2、安装

在其主页下载该包文件，把其jar 包放在lib 目录下，在web.xml 中添加下面内容

在 WEB-INF目录下放置urlrewrite.xml 其配置文件。重启应用即可完成安装。

3、参数介绍

（1）web.xml 下的filter 参数设置介绍

(2)urlrewrite.xml 配置文件参数

配置文件规则：

urlrewirte 配置文件必须有一个urlrewrite根元素和包含至少一个rule元素。

一个rule元素必须包含一个from 和一个to 元素，也可以包含0个以上的condition 元素和0个以上set 元素。

一个rule元素拦截用户的请求，from元素 是请求的url，to元素是经过重写后的url 输出，下面是类似java 的重写内部实现。

（4）元素参数说明

<urlrewrite>元素

参数	取值	描述
default-match-type	regex(默认)、wildcard	所有的rule和condition 元素都会用到该匹配方法
decode-using	header,utf8(默认)、null、iso-8859-1 等	当url 需要解码时request.getCharacterEncoding()将被用到，如果为空，则为utf-8
use-query-string	false(默认)、true	语句是否加到url的后面
use-context	false(默认)、true	上下午路径是否要加到url 中

<rule>元素

参数	取值	描述
enable	true(默认)、false	是否应用该rule
match-type	regex（默认）、wildcard	应用那种匹配规则

实例代码：

<outbound-rule>元素

参数	取值	描述
enabled	true（默认）、false	是否应该该规则
encodefirst	false（默认）、false	是否在执行<outbound-rule>之前执行encodeURL()，ture为之后，false为之前

实例：

<name>元素

<note>元素

<condition>元素

可以用来为rule元素选择条件，所有条件将在规则执行时执行（除非显式的把“next” 设为“or”）

参数	取值	描述
type	header（默认）、method、port、time等	设置一些条件的类型
name	可为任何值	如果type 取值为header，这个名称将是http header 的值
next	and（默认）、or	and：下一个rule 元素和这个rule 必须匹配。or：下一个rule元素或者这个condition 将被匹配
operator	equal（默认）、notequal、greater、less等	ie请求的值和condition 值比较

实例：

<from> 元素

rule 或者outbound-rule 必须至有一个from 元素，该值为url 相对于上下文的值

参数	取值	描述
casesensitive	false（默认）、true	是否要求该值的大小写，false为大小写匹配，true为忽略大小写

<to>元素

重写后的输出值

参数	取值	描述
type	forward（默认）、passthrough、redirect等	url 的跳转问题
last	false（默认）、true	false：余下的rule 元素将被执行，如果该规则符合的话 true：剩下的rule 元素不被执行，如果该规则符合的话
encode	false（默认）、true	response.encodeURL([to]) 是否被调用。 false：将在url重写前调用。 true：将不被调用
context		如果应用服务器配置允许 cross context（跨越上下文），这个属性将被forward（只有forward可以，redirct 或者其他to元素的类型都不可以） 比如在tomcat 的配置文件中设有： <Context docBase="app" path="/app" reloadable="true" crossContext="true"/> <Context docBase="forum" path="/forum" reloadable="true" crossContext="true"/>

<to>null</to>表示当这个规则匹配时，将不会有任何的反应。

to元素可以包含后引用（backreferences）和变量

Backreferences

比如：%N
Provides access to the grouped parts (parentheses) of the pattern from the last matched Condition in the current rule. N must be less than 10 and greater than 0 (i.e. %1,%2,%3 etc).

（上面不理解，未翻译）

变量

%{varName}

任何变量的 condition type 可以被用来作为varName。比如：%{port}将被翻译为80,%{year}将被翻译成2009等

函数

%{function:params}

函数可以用在set元素或者to元素中。

名称	实例	输入结果
replace	${replace:my cat is a blue cat:cat:dog}	my dog is a blue dog
replaceFirst	${replace:my cat is a blue cat:cat:dog}	my cat is a blue dog
escape	${escape:a b c}	a+b+c
unescape	${unescape:a+b+c}	a b c
lower	${lower:Hello World}	hello world
upper	${upper:hello}	HELLO
trim	${trim: abc def }	abc def

set元素

如果rule 匹配的话，允许你设置一些变量。

参数	取值	描述
type	request、session、cookie、charset等	设置域的类型
name	任何数	在request、session、response-header、cookie，有特殊的作用

实例：

<run> 元素

当rule和它的condition匹配时，你可以运行Object中的一个方法

参数	取值	描述
class		你所要调用的方法的Object
method	run(默认)	你所要调用的方法，该方法必须带有(HttpServletRequest,HttpServletResponse)参数。例如：run(HttpServletRequest request,HttpServletResponse response) 如果init(ServletConfig)或者destroy() 方法，将会被执行，当创建或销毁该Object时
neweachtime	false(默认)、true	该Oject 是否为单例执行。false为单例，true为每次都new 新的Object

实例：

才此方法中出现的异常将会被包装成ServletException 后抛出。

<class-rule>元素

每次请求都执行这个方法在rule 元素中，具体的例子在org.tuckey.web.filters.urlrewrite.sample可以查看。

参数	取值	描述
class		运行的Object，必须带有包的全名
method	matches（默认）	运行的方法，和run元素中的方法类似
last	true（默认）	当为false时更多的rule将被执行，即使寂静匹配

实例：

4、小知识点

(1)xml 的一些字符必须要进行转义，如& 要转成 $amp;

(2)正则表达式里 在from 元素中，是以 ^ 开始 $结束的。例如请求：/my/url/path将不能匹配<from>^/url/$</from>但能匹配<from>/url/</from>

(3)如果你用了<outbound-rule> 元素，记得在页面输出的时候进行重写。即 jstl 表达式或者Java脚本输出

（4）如果你发现正则表达式比较难表达，可以用wildcards 表达式来写。

5、wildcard 表达式匹配方法

用wildcard 可以取代正则表达式，要使用该表达式的时候记得要在rule 元素中 把match-type 设为 wildcard ，因为默认是使用正则表达式的。

实例：

/big/url/* 匹配/big/url/abc.html不匹配/big/url/abc/dir/or/big/url/abc/

/big/url/** 匹配/big/url/abc.html,/big/url/abc/dir/和 /big/url/abc/

实例：

/my/big/url/*匹配/my/big/url/abc.html和$1将被设为abc.html