maven-replacer-plugin 静态资源版本号解决方案（css/js等）

maven-replacer-plugin 静态资源版本号解决方案（css/js等）

本文介绍如何使用 maven 的 com.google.code.maven-replacer-plugin 插件来自动添加版本号，防止浏览器缓存。

目录

• 1.解决方案
• 2.原始文件和最终生成效果
• 3.pom.xml 中插件添加
• 4.html中 css/js 文件引用规则
• 5.结语

1.解决方案

解决问题：
    防止浏览器缓存，修改静态文件（js/css）后无效，需要强刷。

解决方案：
    使用 maven 的 com.google.code.maven-replacer-plugin 插件，
    在项目打包 package 时自动为静态文件追加 xxx.js?v=time 的后缀，
    从而解决浏览器修改后浏览器缓存问题，此插件只会在生成 war 包源码时生效，不需要修改任何代码。

2.原始文件和最终生成效果

原始文件：
<script src="${resource!}/js/xxx/xxx.js"></script>

打包后：
<script src="${resource!}/js/xxx/xxx.js?v=20180316082543"></script> 

3.pom.xml 中插件添加

<properties>
    <!-- maven.build.timestamp 默认时间戳格式 -->
    <maven.build.timestamp.format>yyyyMMddHHmmss</maven.build.timestamp.format>
</properties>

<plugins>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-war-plugin</artifactId>
        <configuration>
            <!-- 使用缓存 -->
            <useCache>true</useCache>
            <packagingExcludes>WEB-INF/web.xml</packagingExcludes>
        </configuration>
        <executions>
            <!-- 在打包之前执行，打包后包含已经执行后的文件 -->
            <execution>
                <id>prepare-war</id>
                <phase>prepare-package</phase>
                <goals>
                    <goal>exploded</goal>
                </goals>
            </execution>
        </executions>
    </plugin>
    <plugin>
        <groupId>com.google.code.maven-replacer-plugin</groupId>
        <artifactId>replacer</artifactId>
        <version>1.5.3</version>
        <executions>
            <!-- 打包前进行替换 -->
            <execution>
                <phase>prepare-package</phase>
                <goals>
                    <goal>replace</goal>
                </goals>
            </execution>
        </executions>
        <configuration>
            <!-- 自动识别到项目target文件夹 -->
            <basedir>${build.directory}</basedir>
            <!-- 替换的文件所在目录规则 -->
            <includes>
                <include>${build.finalName}/WEB-INF/views/*.html</include>
                <include>${build.finalName}/WEB-INF/views/**/*.html</include>
            </includes>
            <replacements>
                <!-- 更改规则，在css/js文件末尾追加?v=时间戳，反斜杠表示字符转义  (注原来有版本号的?v=1就不会再追加版本号了)-->
                <replacement>
                    <token>\.css\"</token>
                    <value>.css?v=${maven.build.timestamp}\"</value>
                </replacement>
                <replacement>
                    <token>\.css\'</token>
                    <value>.css?v=${maven.build.timestamp}\'</value>
                </replacement>
                <replacement>
                    <token>\.js\"</token>
                    <value>.js?v=${maven.build.timestamp}\"</value>
                </replacement>
                <replacement>
                    <token>\.js\'</token>
                    <value>.js?v=${maven.build.timestamp}\'</value>
                </replacement>
            </replacements>
        </configuration>
    </plugin>
</plugins> 

4.html中 css/js 文件引用规则

文件引用结尾处，必须是pom.xml文件中添加的规则：

<script src="${resource!}/js/xxx/xxx.js" type="text/javascript"></script>
<script src="${resource!}/js/xxx/xxx.min.js?v=1" type="text/javascript"></script><!--这种已经加上版本号的就不会再得新追加版本号了-->

<link href="${resource!}/css/xxx/xxx.css" rel="stylesheet" type="text/css">