解决maven打包时文件未编译及文件编译乱码

原创已于 2025-05-29 10:25:12 修改 · 1.1k 阅读

22 ·

本内容遵循CC 4.0 BY-SA版权协议

GEO检测

标签

#maven #java

于 2025-05-29 10:21:37 首次发布

引言

在日常编码结束后我们在打包项目文件，或者在调试项目接口时会遇到加入的配置文件、模板文件打包后打开直接乱码，导致接口返回的参数或者运行时报错搞你心态。这时候我们就需要疯狂的找资料，看资料去解决该问题。

该文章主要就是解决maven在打包时出现乱码，文件未被编译问题。该文章若有不对欢迎大家指出改正。

话不多说就是干。

一、maven打包文件未被编译

1、场景

在项目中会遇到模板文件明明依旧导入到系统中，可是在编译的时候迟迟没用编译成class文件，导致在接口调试时文件未被写入且并没用返回流文件。

2、原因分析

1、模板文件放置位置不正确，未将模板那文件放置在src/main/resources/下

2、文件位置正确但是有新的文件夹包含着，例如下图所示：

3、解决方案

1、将模板文件放置到src/main/resources/目录下

2、如果文件在该目录下，且文件被其他文件夹所包含，那么检查打包时文件是否被编译。同时检查在引用该文件时的目录是否正确

3、如果上述两步都没问题那么修改pom.xml文件配置

①配置 <resources> 确保模板文件被包含，并在 pom.xml 中的 <build> 部分添加或修改如下配置，确保模板文件被正确处理：

<resources>
    <!-- 主资源目录，启用过滤 -->
    <resource>
        <directory>src/main/resources</directory>
        <filtering>true</filtering>
        <includes>
            <include>**/*.properties</include>
            <include>**/*.xml</include>
            <include>**/*.yml</include>
            <include>**/*.yaml</include>
            <include>**/*.doc</include>
            <include>**/*.docx</include>
            <include>**/*.xls</include>
            <include>**/*.xlsx</include>
        </includes>
    </resource>
</resources>

②使用 <nonFilteredFileExtensions> 排除可能干扰的文件格式，确保 maven-resources-plugin 不会对非文本文件进行编码转换：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-resources-plugin</artifactId>
    <configuration>
        <encoding>UTF-8</encoding>
        <nonFilteredFileExtensions>
            <nonFilteredFileExtension>xlsx</nonFilteredFileExtension>
            <nonFilteredFileExtension>docx</nonFilteredFileExtension>
        </nonFilteredFileExtensions>
    </configuration>
</plugin>

到此，上述方案解决maven在编译时，模板文件未被编译问题。

二、maven打包时配置文件乱码

1、场景

在项目中会遇到客户要求按照他们的模板文件进行导出，或者需要将后端更改为https协议等等。那么这个时候我们需要拿到客户的模板文件进行数据导出，数据写入（https配置的证书文件）。

2、乱码分析

Maven 默认会对 src/main/resources 中的文件进行编码处理（UTF-8），尤其是启用 <filtering>true</filtering> 时，会尝试对文件内容进行变量替换（如 ${profile.name}）。但这种操作对于非文本文件（如二进制文件、模板文件等）会导致内容被破坏。

3、解决方案

注意：所有文件需要放在src/main/resources目录下，否则尽管配置了该标签依旧不生效

1、配置 <nonFilteredFileExtensions> 排除特殊文件

确保这些文件不会被 Maven 的资源插件 (maven-resources-plugin) 处理，同时在pom.xml中引入以下标签，需要将什么文件不被处理在<nonFilteredFileExtensions>标签中加入即可

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-resources-plugin</artifactId>
    <configuration>
        <encoding>UTF-8</encoding>
        <nonFilteredFileExtensions>
            <nonFilteredFileExtension>p12</nonFilteredFileExtension>
            <nonFilteredFileExtension>cer</nonFilteredFileExtension>
            <nonFilteredFileExtension>pem</nonFilteredFileExtension>
            <nonFilteredFileExtension>pfx</nonFilteredFileExtension>
            <nonFilteredFileExtension>xlsx</nonFilteredFileExtension>
            <nonFilteredFileExtension>xls</nonFilteredFileExtension>
            <nonFilteredFileExtension>doc</nonFilteredFileExtension>
            <nonFilteredFileExtension>docx</nonFilteredFileExtension>
            <!-- 可以继续添加其他需要排除的扩展名 -->
        </nonFilteredFileExtensions>
    </configuration>
</plugin>

2、区分资源目录配置

区分资源目录配置：启用/关闭 filtering

<resources>
    <!-- 文本资源，启用过滤 -->
    <resource>
        <directory>src/main/resources</directory>
        <filtering>true</filtering>
        <excludes>
            <exclude>**/*.p12</exclude>
            <exclude>**/*.keystore</exclude>
            <!-- 其他非文本文件 -->
        </excludes>
    </resource>

    <!-- 二进制资源，禁用过滤 -->
    <resource>
        <directory>src/main/resources</directory>
        <filtering>false</filtering>
        <includes>
            <include>**/*.p12</include>
            <include>**/*.keystore</include>
            <!-- 其他非文本文件 -->
        </includes>
    </resource>
</resources>

那么到此，就解决了maven编译时文件被编译打包乱码问题。

PS：如果遇到配置文件乱码，可参考以前写的文章------>解决idea文件properties中文乱码问题_idea properties文件中文乱码-CSDN博客