java学习笔记--springboot集成UrlRewrite实现URL伪静态化[jar包和war包]

前言

最近项目seo那边提出，要将所有的URL都做成伪静态的URL，虾米？有木有搞错！？项目都完成了好不好？改需求项目还不延期？

而且，我还是一个刚毕业的两百斤的宝宝好不好，我不会呀。。。

于是，我就百度了小半天，大致实现了这个功能，其实最开始的时候，我连UrlReWrite这个工具包都不知道，所以大半的时间都浪费在找解决方案上了。

我也想过自己写拦截器实现，但是又想了想，这个问题不可能没人遇到过，网上肯定有解决方案。

然后找到了urlrewrite这个工具包，可惜的是，网上没有springboot整合的样例，于是就自己摸索的写了一下。也能够成功使用。

当然期间我也遇到了其他的问题，这里会在记录的过程中给出解决方案。

正文

第一步,引入依赖

这一步好像没什么好说的,使用urlrewriteFilter自然要引入依赖的jar包. 点击查看maven仓库

<dependency>
		<groupId>org.tuckey</groupId>
		<artifactId>urlrewritefilter</artifactId>
		<version>4.0.4</version>
	</dependency>

第二步,配置过滤器

springboot配置过滤器,你要问我怎么配置过滤器, 戳这儿~

@Configuration
public class CustomerFilter {
    @Bean
    public FilterRegistrationBean urlRewrite(){
        UrlRewriteFilter rewriteFilter=new UrlRewriteFilter();
        FilterRegistrationBean registration = new FilterRegistrationBean(rewriteFilter);
        registration.setUrlPatterns(Arrays.asList("/*"));
        Map initParam=new HashMap();
        initParam.put("confPath","urlrewirte.xml");
        initParam.put("infoLevel","INFO");
        registration.setInitParameters(initParam);
        return  registration;
    }
}

注意看上面的代码.

registration.setUrlPatterns(Arrays.asList("/*"));

这一行的作用是配置拦截器拦截所有的请求.

Map initParam=new HashMap(); initParam.put("confPath","urlrewirte.xml");

initParam.put("modRewriteConfText","RewriteRule ^/(\\w+)/_([\\w\\d])+\\.html$ /$1.html?param=$2 [F]");

initParam.put("logLevel","DEBUG");

registration.setInitParameters(initParam);上面设置了三个初始化参数.

特别需要注意的是:

confPath的作用是,指定URLRewrite配置文件的位置,默认在WEB-INF下,但是我使用的内嵌式的服务器,所以是没有这个目录的,为了解决这个问题,

我可是翻了不少的地方,直接写配置文件名称,表示该文件在类加载路径下.如果你是maven构建的项目,那就是resource下.

这个也比较好理解的.

但是有一点需要注意的是,如果打的不是war包而是jar包的话,那么指定confPath参数是没有作用的,因为它读取不到你的配置文件.

这时候有两种方式解决这个问题,第一个就是

initParam.put("modRewriteConfText","RewriteRule ^/(\\w+)/_([\\w\\d])+\\.html$ /$1.html?param=$2 [F]");

指定modRewriteConfText参数,后面跟表达式,来指定规则,关于表达式,这里给出介绍戳这儿~

如果指定了modRewriteConfText参数,那么就可以不指定confPath参数了.

第二种方式,可以选择重写UrlRewriteFilter的loadUrlRewriterLocal方法,改变他加载配置文件的方式.

这里值得一提的是,我最初没有考虑到jar包读取配置文件的状况,发到测试环境上之后,用了半天的时间,定位这个问题,也是挺傻的...

到这儿的时候,不妨打个断点看看这个过滤器有没有被加载,然后再进行下面的操作.

其实到这儿,基本的配置就搞定了..虾米?是不是简单的过分了...

这时候只需要搞定最后一步就可以了,就是编写配置文件.

他重写url的方式还是挺多的,但是这儿,我只是需要很简单的地方.

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE urlrewrite PUBLIC "-//tuckey.org//DTD UrlRewrite 3.2//EN"
        "http://tuckey.org/res/dtds/urlrewrite3.2.dtd">
<urlrewrite>
    <rule>
        <!--拦截页面以/_开头的数据,作为转发给前端使用-->
        <from>^/(\w+)/_([\w\d])+\.html$</from>
        <!-- to: 真实的URL -->
        <to type="forward">/$1.html?param=$2</to>
    </rule>
    
</urlrewrite>

这里可以添加多条拦截规则,每一条拦截规则使用rule标签包裹.

这里没有特别需要注意的地方.

如果只是简单的使用的话,记住下面这一点就足够了.

首先,如果你会用正则表达式的话,可以通过正则表达式来处理,如果不会,可以使用通配符.

这里给出的例子是使用正则表达式的方式.

<from>^/(\w+)/_([\w\d])+\.html$</from>
<!-- to: 真实的URL --> <to type="forward">/$1.html?param=$2</to>

主要看着一块代码.from标签内的表示匹配的模式,<to>标签内的是想要转换的模式.

看to标签里有$1和$2,这里表示的是前面正则表达式用括号包裹的模式匹配到的内容.第一个()内的数据就是$1,第二个就是$2,依次类推.

如果你按照我写的步骤来,到这一步,基本是没有问题的.

如果你需要更精确的重写方式.可以 戳这儿~

如果你看不懂英文,可以 戳这儿~

额咳咳,到这,好像没啥问题,是不是很纠结说好的问题总结呢.骗你的...并木有啊.

修订记录

2017年8月1日,添加关于部署jar包的解决方式.

转载于:https://my.oschina.net/u/3101282/blog/1502875