java UrlRewrite中文文档

安装


1. 下载jar包， 并参加到WEB-INF/lib下

2. 在WEB-INF/web.xml中增长下面的设备

<filter>

<filter-name>UrlRewriteFilter</filter-name>

<filter-class>

org.tuckey.web.filters.urlrewrite.UrlRewriteFilter

</filter-class>

</filter>

<filter-mapping>

<filter-name>UrlRewriteFilter</filter-name>

<!-- 阻碍所有的url -->

<url-pattern>/*</url-pattern>

<dispatcher>REQUEST</dispatcher>

<dispatcher>FORWARD</dispatcher>

</filter-mapping>

3. 在WEB-INF/下增长设备文件urlrewrite.xml

4. 重启高低文景象

过滤器的参数


1. confReloadCheckInterval: 设备文件重加载间隔. 0默示随时加载， -1默示不重加载， 默认-1

2. confPath: 设备文件路径. 是相对context的路径， 默认/WEB-INF/urlrewrite.xml

3. logLevel: 设置日记级别， 可所以: TRACE， DEBUG， INFO（默认）， WARN， ERROR， FATAL， log4j， commons， slf4j， sysout:{level}（比如 sysout:DEBUG）， 若是你应用通俗的日记级别有必然艰苦， 可以调为: sysout:DEBUG（注解是应用把握台输出的调试级别）

4. statusPath: 设置改变状况路径， 不克不及和已经安装的应用冲突（重视， 默认是/rewrite-status）， 重视， 必须以/开端

5. statusEnabled: 设置status是否开启， 期望获得的值是true， false， 默认true

6. statusEnabledOnHosts: 设置容许status的主机， *可以被用作通配符， 默认是”localhost， local， 127.0.0.1”

7. modRewriteConf: 设置rewrite模式， 默认是false， 应用mod-rewrite（可以参照apache办事器的mod_rewrite相干材料）体式格式的设备文件， 若是设置为true并且confPath没有设置则设备文件路径将会被默认为/WEB-INF/.htaccess

8. modRewriteConfText: 从这些参数的值加从载mod_rewrite样式的设备， 设置这些参数则其他所有的参数都邑被忽视. 比如:

<init-param>

<param-name>modRewriteConfText</param-name>

<param-value>

RewriteRule ^/~（[^/]+）/？（.*） /u/￥1/￥2 [R]

RewriteRule ^/（[uge]）/（[^/]+）￥ /￥1/￥2/ [R]

</param-value>

</init-param>

9. allowConfSwapViaHttp: 设置是否容许经由过程HTTP体式格式交互设置参数， 比如， 经由过程调用/rewrite-status/？conf=WEB-INF/urlrewrite2.xml

设备文件WEB-INF/urlrewrite.xml


1. DTD束缚

<!DOCTYPE urlrewrite

        PUBLIC "-//tuckey.org//DTD UrlRewrite 3.0//EN"

        "http://tuckey.org/res/dtds/urlrewrite3.0.dtd">

2. <urlrewrite />

2.1. default-match-type（可选）:

2.1.1. regex， 默认. 所有未指定match-type属性的rule都应用java正则表达式进行匹配

2.1.2. wildcard: 所有未指定match-type属性的rule都应用通配符匹配引擎匹配

2.2. decode-using（可选）:

2.2.1. header， utf8: 默认. 应用request.getCharacterEncoding（）获得的编码对URL解码， 若是是空， 应用utf8.

2.2.2. null: 不进行解码. 设置为: decode-using=”null”

2.2.3. header: 仅仅应用request.getCharacterEncoding（）解码

2.2.4. [encoding]: 仅仅应用一个指定的字符编码比如ISO-8859-1.

2.2.5. header， [encoding]: 对一个URL解码时应用request.getCharacterEncoding（）， 若是获得的值为空， 则应用encoding指定的编码.

2.3. use-query-string（可选）:

2.3.1. false: 默认. 在进行匹配的时辰， 查询字符串不会参加

2.3.2. true: 查询字符串参与的匹配

2.4. use-context（可选）:

2.4.1. false: 默认. 元素匹配时， application的contex路径将不会增长到url中

2.4.2. true: application的contex路径参与元素的匹配

3. <rule />: 0个或多个

3.1. enabled（可选）:

3.1.1. true: 默认.容许这个规矩

3.1.2. false: 放弃这个规矩

3.2. match-type（可选）:

3.2.1. regex: 默认. 应用java正则匹配

3.2.2. wildcard: 应用通配符表达式引擎

4. <outbound-ruld />: 0个或多个. 和通俗的rule很是类似， 然则这里是在response.encodeURL（）办法调用时进行重写的.

4.1. enabled（可选）:

4.1.1. true: 默认. 容许规矩

4.1.2. false: 放弃规矩

4.2. encodefirst（可选）:

4.2.1. fasle: 默认， 在运行了encodeURL（）办法之后应用这个重写规矩

4.2.2. true: 在encodeURL（）之前应用这个重写规矩

5. <name />: 一个用于记录规矩名称的可选元素， 可以在<rule />和<outbound-rule />上应用

6. <note />: 用于记录规矩描述的一个简单可选元素， 可以用在<rule />和<outbound-rule />上.

7. <condition />: 针对规矩的选择前提. 重视， 在规矩应用的时辰必须满足所有的前提.

7.1. type（可选）:

7.1.1. header: 默认. 若是设置， 头名称必须经由过程<condition />的name属性指定

7.1.2. method: 恳求办法. GET， POST， HEAD等

7.1.3. port: application运行的端口

7.1.4. time: 办事器当前时候（应用Unix时候戳）， 这个凡是被用于确保内容仅在设置的时候存活

7.1.5. year: 办事器的当前年

7.1.6. month: 办事器的当前月份

7.1.7. dayofmonth: 当天是一月的第几天， 每月第一天是1

7.1.8. dayofweek: 当天是一周的第几天， 礼拜天是7

7.1.9. ampm: 上午或下午

7.1.10. hourofday: 一天的第几许小时（24小时制）

7.1.11. minute: 当前办事器时候的分

7.1.12. second: 当前办事器时候的秒

7.1.13. millisecond: 当前办事器时候的毫秒

7.1.14. attribute: 搜检request的属性（getAttribute）值， 要搜检的属性名称经由过程<condition />的name指定

7.1.15. auth-type: 搜检request属性的值.   request.getAuthType

7.1.16. character-encoding: 接管到恳求的编码

7.1.17. content-length: 恳求的长度（对于拒绝响应大恳求很有效）

7.1.18. content-type: 恳求类型

7.1.19. context-path: 恳求的contex路径

7.1.20. cookie: 搜检cookie值， cookie的名称经由过程<condition />的name属性指定

7.1.21. parameter: 搜检恳求参数， 参数名称经由过程<condition />的name属性指定

7.1.22. path-info: 相当于request.getPathInfo（）

7.1.23. path-translated: 相当于request.getTranslated（）

7.1.24. protocol: 用于过滤和谈

7.1.25. query-string: 获得url后面的参数字符串

7.1.26. remote-addr: IP地址过滤

7.1.27. remote-host: 长途主机过滤（重视， 仅仅在应用办事器设备了查看（长途）主机名时才可用）

7.1.28. remote-user: 当前登录用户， 若是用户被授权可用

7.1.29. requested-session-id: 当前session的id

7.1.30. request-uri: 恳求URL的从和谈名到查询字符串项目组

7.1.31. request-url: 重构后的URL， 返回的URL包含和谈， 办事器名称， 端口， 路径， 但不包含查询字符串

7.1.32. session-attribute: 搜检session中的属性（getAttribute）， 属性名称经由过程<condition />的name属性设置.

7.1.33. session-isnew: 搜检session是不是新的

7.1.34. server-name: 恳求发送到的办事器的主机名（从host这个头中获得的不是机械名）

7.1.35. scheme: 恳求的scheme

7.1.36. user-in-role: 重视， 这里的值不克不及是正则表达式

7.2. name: 共同一些特别type应用的， 可所以任何值

7.3. next:

7.3.1. and: 默认. 下一个和这一个前提都必须匹配

7.3.2. or: 下一个或这一个前提匹配

7.4. operator:

7.4.1. equal: 默认. 指定正则和真实值匹配

7.4.2. notequal: 真实值和正则不匹配

7.4.3. greater: 大于， 仅用于数值

7.4.4. less: 小于

7.4.5. greaterorequal: 大于便是

7.4.6. lessorequal: 小于便是

8. < />: 凡是在<rule />和<outbound-rule />中都必须指定一个， 值可所以正则表达式（Perl5体式格式的正则）， 重视: 指定的url是和contex相干的

8.1. casesensitive:

8.1.1. false: 默认. 大小写不敏感

8.1.2. true: 大小写敏感

9. <to />: 可所以一个perl5样式的正则调换表达式

9.1. type:

9.1.1. forward: 默认. 恳求匹配这个<rule />的所有<condition />， 并且URL应用内部跳转到”to”指定的地址（重视， 这里forward到的URL必须和UrlRewriteFilter位于同一个容器中）

9.1.2. passthrough: 和forward雷同

9.1.3. redirect: 恳求匹配所有<condition />和这个<rule />的< />， 通知客户端跳转到<to />指定地址

9.1.4. permanent-redirect: 相当于做了以下工作

response.setStatus（

        HttpServletResponse.SC_MOVED_PERMANENTLY

）;

response.setHeader（“Location”， [<to />指定的值]）;

9.1.5. temporary-redirect: 相当于做了以下工作

response.setStatus（

        HttpServletResponse. SC_MOVED_TEMPORARILY

）;

response.setHeader（“Location”， [<to />指定的值]）;

9.1.6. pre-include

9.1.7. post-include

9.1.8. proxy: 恳求URL将会以全路径被****代理， 应用此特点须要引入commons-http和commons-codec包

9.2. last:

9.2.1. false: 默认. 其余<rule />将会处理惩罚若是这个匹配

9.2.2. true: 若是匹配这个规矩将不会处理惩罚

9.3. encode:

9.3.1. false: <rule />下是默认值. 在rewrite之前， 用response.encodeURL（[to的值]）编码URL

9.3.2. true: <outbound-rule />下默认值. 不会编码URL

9.4. context:

若是应用办事器设备了容许”穿透context”通信， 那么这个属性可以被用于forward（并且仅仅能用于forward）恳求到别的一个serlvet context…..也就是跨应用forward

在Tomcat上， server.xml或context.xml中设备crossContext=”true”， 例如: 容许两个应用”app”和”forum”之间通信， 那么可以如下设备:

<Context docBase=”app” path=”/app” reloadable=”true” crossContext=”true” />

<Context docBase=”forum” path=”/forum” reloadable=”true” crossContext=”true” />

10. <to />的其他方面

10.1. <to />可所以null， 意义为: 若是匹配恳求不再持续， 相当于没有调用chain.doFilter

10.2. 应用￥N获取< />中设备的子组， N必须是1至10之间的数

10.3. 任何<condition />中可以应用的type中的值都可以在<to />中应用， 比如<to>/％{parameter:page}</to>

10.4. 函数调用: ￥{函数名: 参数1:参数2}  可以在<set />和<to />中应用













































name


example


example returns


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


11. <set />: 在匹配规矩的时辰， 容许设置一些值.

11.1. type:

11.1.1. request: 默认. 类似于request.setAttribute

11.1.2. session: session.setAttribute

11.1.3. response-header: response.setHeader

11.1.4. cookie: 值以”[value][:domain[:lifetime[:path]]]”的格局设置.  是指给客户端浏览器设置cookie， cookie名称由<set />的name属性指定

11.1.4.1. value: cookie的值

11.1.4.2. domain: 办事器

11.1.4.3. lifetime: 存货时候

11.1.4.4. path: cookie的path

11.1.5. status: response.setStatus

11.1.6. content-type: response.setContentType

11.1.7. charset: response.setCharacterEncoding

11.1.8. expires: 设置HTTP头中的过期时候， 设置的格局为{数值 类型}， 比如: “1 day 2 seconds”

11.1.9. locale: response.setLocale

11.1.10. parameter: 容许将request.getParameter获得的某个参数的值在这里进行从头处理惩罚

11.1.11. method: 容许将request.getMethod（）获得的值进行从头处理惩罚

11.2. name: type是request， session， response-header， cookie的时辰， 必须设置name

11.3. 举例:

<rule>

    <condition name=”user-agent”>Mozilla/3/.0 （compatible; AvantGo .*）</condition>

    <>.*</>

    <set name=”client”>AvantGo</set>

</rule>

<rule>

    <condition name=”user-agent”>UP/.Browser/3.*SC03 .*</condition>

    <>.*</>

    <set name=”client”>Samsung SCH-6100</set>

</rule>

12. <run />: 容许在<rule />和<condition />都匹配的时辰， 履行一个对象办法

12.1. class: 全限制名的类名， 期望调用办法的类名.

12.2. method（可选）: 默认值为run.  期望调用的办法名. 该办法必须有两个参数（HttpServletRequest request， HttpServletResponse response）.  重视， 若是该对象有init（ServletConfig）或destroy（）办法， 在创建和烧毁对象的时辰会主动调用， ServletConfig中可以获得初始化参数， 参数经由过程<init-param />的体式格式传递:

<run class=”selfimpr.MyServlet” method=”doGet”>

    <init-param>

           <param-name>id</param-name>

           <param-value>1</param-value>

    </init-param>

</run>

12.3. neweachtime: 默认false. 注解是否每次恳求都创建一个对象实例.

13. Tip

13.1. 在设备中若是要应用”&”， 用&amp;

13.2. 简单起见， 给< />的设备前面和后面分别加上^， ￥， 这两个是正则表达式中的强迫开端和结尾标记

13.3. 若是应用<outbound-rule>要记得代码中的url都是编码过的

13.4. 正则表达式很是错杂灵活， 请浏览java.util.regex.Pattern中的java正则介绍

13.5. 若是感觉正则难以懂得， 可以应用通配符体式格式

13.6. contex是很是首要的， 若是有一个应用的context是”/myapp”， 并且你的恳求是”/myapp/somefolder/somepage.jsp”， 容器交给UrlRewriteFilter的url会是”/somefolder/somepage.jsp”， 这可能难以懂得， 然则在你的<rule>和<condition>中不要包含context path， 它是容器负责处理惩罚的.

14. 通配符:

通配符匹配引擎可以调换正则表达式， 在<condition>和<rule>中设置match-type是wildcard用以开启支撑通配符.（或者设置default-match-type）

例如:

/big/url/*匹配/big/url/abc.html然则不匹配/big/url/abc/dir/或/big/url/abc/

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

也可以和正则的调换一样， 每个*代表一个参数， 在<set>和<to>顶用￥N的体式格式应用

应用mod-rewrite样式的设备


filter设备


     <filter>

         <filter-name>UrlRewriteFilter</filter-name>

         <filter-class>org.tuckey.web.filters.urlrewrite.UrlRewriteFilter</filter-class>

 

         <!-- defaults to false. use mod_rewrite style configuration file （if this is true and confPath

         is not specified confPath will be set to /WEB-INF/.htaccess） -->

         <init-param>

             <param-name>modRewriteConfText</param-name>

             <param-value><![CDATA[

 

                 ＃ redirect mozilla to another area

                 RewriteCond  ％{HTTP_USER_AGENT}  ^Mozilla.*

                 RewriteRule  ^/no-moz-here￥                 /homepage.max.html  [L]

 

             ]]></param-value>

         </init-param>

 

     </filter>

 

     <filter-mapping>

         <filter-name>UrlRewriteFilter</filter-name>

         <url-pattern>/*</url-pattern>

         <dispatcher>REQUEST</dispatcher>

         <dispatcher>FORWARD</dispatcher>

     </filter-mapping>

WEB-INF/.htaccess下的具体匹配设备


＃ redirect mozilla to another area

     RewriteCond  ％{HTTP_USER_AGENT}  ^Mozilla.*

     RewriteRule  ^/no-moz-here￥                 /homepage.max.html  [L]

URL注解匹配


1. urlrewrite3.0之后， 应用JDK1.6及以上可以应用注解来生成urlrewrite的设备文件.



我知道我将为自己的学说，为真理而死，但这并不会减少我的勇气。——塞尔维特

 

评论

1 楼 xyc717 2015-01-05  

${escape:a b c} 
 
 
a+b+c 
 
 
unescape 
 
 
${unescape:a+b+c} 
 
 
a b c
这里没看明白，楼主 ，我的url里面有空格该怎么匹配，原来的地址是
/test abc-new.html
横线前面是$1 new是$2 但是如果s1里面出现了空格我之前希望$1和$2既可以匹配汉字也可以是数字和英文但那是空格我不知道怎么搞
/((?!_)(?!.*?_$)[a-zA-Z0-9_\u4e00-\u9fa5]*)-((?!_)(?!.*?_$)[a-zA-Z0-9_\u4e00-\u9fa5]*).html
我以前是这么写的