maven-war-plugin二进制文件损坏问题

最新推荐文章于 2023-01-09 17:50:31 发布

明明如月学长

最新推荐文章于 2023-01-09 17:50:31 发布

阅读量2.4k

点赞数 2

分类专栏：问题积累文章标签： Java 问题

本文链接：https://blog.csdn.net/w605283073/article/details/100047769

版权

问题积累专栏收录该内容

91 篇文章 17 订阅

订阅专栏

一、问题描述

最近一个朋友在windows上遇到一个非常诡异的现象，maven项目的资源包下有一个字体文件夹，里面存放了一个字体。

打包后字体损坏，文件大小也增加了很多。

pom.xml的build标签配置大致如下：

<build>
        <finalName>some</finalName>
        <pluginManagement>
            <plugins>
                <plugin>
                    <artifactId>maven-war-plugin</artifactId>
                    <version>3.2.2</version>
                    <configuration>
                        <!-- 将类文件打成jar包 -->
                        <archiveClasses>true</archiveClasses>
                        <!-- 将资源文件打到classes目录下 -->
                        <webResources>
                            <resource>
                                <directory>src/main/resources</directory>
                                <targetPath>WEB-INF/classes</targetPath>
                                <filtering>true</filtering>
                            </resource>
                        </webResources>
                    </configuration>
    
            </plugins>
        </pluginManagement>
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                    <include>**/*.conf</include>

                </includes>
                <filtering>false</filtering>
            </resource>

            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                    <include>**/*.conf</include>
                </includes>
                <filtering>false</filtering>
            </resource>
        </resources>
    </build>

二、解决尝试

2.1 对比文件信息

通过新旧字体文件的对比发现，打包后的字体文件更大且被损毁。

猜测可能是maven插件问题。

2.2 换环境法

在mac 上一个新的项目，拷贝 build 配置，复制资源目录。
运行maven插件的，clear和compile后发现，target 下 classes文件夹下字体文件正常，打jar包后解压也正常，这就很诡异了。

让朋友用maven插件，先clear 后 compile这个maven项目，发现 classes文件夹下没有字体文件。

观察build配置，发现没包含字体类型，因此修改resource 的 includes 标签，添加包含 ttf文件格式。

结果classes文件夹下的字体正常，而项目目录下的字体仍然不正常。

这就尴尬了，两个目录一个正常一个不正常， windows下和mac下编译效果不同。

2.3 官方文档大法

https://maven.apache.org/plugins/maven-war-plugin/examples/adding-filtering-webresources.html

To prevent corrupting your binary files when filtering is enabled, you can configure a list of file extensions that will not be filtered.

翻译：为了避免开启 filter后你的二进制文件被损毁，你可配置不被过滤的文件拓展名列表

 ...
        <configuration>
          <!-- the default value is the filter list under build -->
          <!-- specifying a filter will override the filter list under build -->
          <filters>
            <filter>properties/config.prop</filter>
          </filters>
          <nonFilteredFileExtensions>
            <!-- default value contains jpg,jpeg,gif,bmp,png -->
            <nonFilteredFileExtension>pdf</nonFilteredFileExtension>
          </nonFilteredFileExtensions>
          <webResources>
            <resource>
              <directory>resource2</directory>
              <!-- it's not a good idea to filter binary files -->
              <filtering>false</filtering>
            </resource>
            <resource>
              <directory>configurations</directory>
              <!-- enable filtering -->
              <filtering>true</filtering>
              <excludes>
                <exclude>**/properties</exclude>
              </excludes>
            </resource>
          </webResources>
        </configuration>
        ...

从注释我们还可以发现，默认 jpg,jpeg,gif,bmp,png这几种图片类型是包含的。

该描述和本诡异问题表现非常相符，因此加上这一段：

<nonFilteredFileExtensions>
      <!-- default value contains jpg,jpeg,gif,bmp,png -->
      <nonFilteredFileExtension>pdf</nonFilteredFileExtension>
</nonFilteredFileExtensions>

重新编译打包项目，发现字体正常，问题解决。

另外该文档还讲到：

Note: In versions 2.2 and earlier of this plugin the platform encoding was used when filtering resources. Depending on what that encoding was you could end up with scrambled characters after filtering. Starting with version 2.3 this plugin respects the property project.build.sourceEncoding when filtering resources. One notable exception to this is that .xml files are filtered using the encoding specified inside the xml-file itself.

2.2和之前的版本过滤资源时使用平台的默认编码。从这里可以猜测过滤资源时会使用到字符编码。

关于这里的过滤的具体含义，感兴趣可以从官方文档中深入学习，也可拉取源码进行研究，这里浅尝辄止不作展开。