如何在 Maven 中配置编码？

Question

当我在多模块 Maven 项目上运行 maven install 时，我总是得到以下输出：

[WARNING] File encoding has not been set, using platform encoding UTF-8, i.e. build is platform dependent!

因此，我用 google 搜索了一下，但我能找到的只是我必须添加：

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

...我的 pom.xml 文件。但它已经存在了（在父 pom.xml 中）。

为 maven-resources-plugin 或 maven-compiler-plugin 配置 也无法解决此问题。

那么问题出在哪里呢？

Answer 1

好的，我已经找到问题了。

我使用一些报告插件。在 failsafe-maven-plugin 的文档中 我发现， 配置 - 当然 - 默认使用 ${project.reporting.outputEncoding} 。

因此，我将该属性添加为 project 元素的子元素，现在一切都很好：

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
</properties>

另请参阅如何防止“[警告]使用平台编码（实际上是 CP-1252）复制过滤的资源，即构建依赖于平台！”。

Answer 2

这是对之前的答案的补充，如果有人遇到斯堪的纳维亚字母的问题，并且之前的答案中的解决方案无法解决。

如果Java 源文件包含斯堪的纳维亚字母，则需要由用于编译的Java 正确解释它们（例如，常量中使用的斯堪的纳维亚字母）。

即使文件以 UTF-8 存储并且 Maven 配置为使用 UTF-8，Maven 使用的系统 Java 仍将使用系统默认值（例如，在 Windows 中：Windows-1252）。

仅通过 Maven 运行测试才可见（可能在测试中打印这些常量的值。打印的斯堪的纳维亚字母将显示为“<？>”。）
如果没有正确测试，这会损坏编译结果的类文件并且不会被注意到。

为了防止这种情况，您必须将用于编译的Java设置为使用UTF-8编码。
仅在 Maven pom.xml 文件；您需要设置环境变量：

JAVA_TOOL_OPTIONS = -Dfile.encoding=UTF8

此外，如果在 Windows 中使用 Eclipse，您可能还需要设置除此之外使用的编码（如果您通过 Eclipse 运行单独的测试）。

Answer 3

如果您结合前面的答案，这里最终是一个 pom.xml，配置为 UTF-8，应该是这样的。

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <groupId>YOUR_COMPANY</groupId>
    <artifactId>YOUR_APP</artifactId>
    <version>1.0.0-SNAPSHOT</version>

    <properties>
        <project.java.version>1.8</project.java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    </properties>

    <dependencies>
        <!-- Your dependencies -->
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.7.0</version>
                <configuration>
                    <source>${project.java.version}</source>
                    <target>${project.java.version}</target>
                    <encoding>${project.build.sourceEncoding}</encoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
                <version>3.0.2</version>
                <configuration>
                    <encoding>${project.build.sourceEncoding}</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

Answer 4

人们似乎将内容编码与内置文件/资源​​编码混合在一起。仅拥有 Maven 属性是不够的。使用 -Dfile.encoding=UTF8 无效。为了避免出现编码问题，您应该遵循以下简单规则：

1. 设置 Maven 编码，如上所述：

   UTF-8;
   UTF-8
   

2. 在代码中处理文件、字符串和 I/O 时，始终显式设置编码。如果不遵循此规则，您的应用程序取决于环境。 -Dfile.encoding=UTF8 正是负责运行时环境配置，但我们不应该依赖它。如果您有数千个客户端，则需要花费更多精力来配置系统并查找问题。您只是对它有额外的依赖，您可以通过显式设置它来避免这种依赖。 Java 中使用默认编码的大多数方法都因此被标记为已弃用。

3. 确保您正在使用的内容也采用您期望的相同编码。如果不是，前面的步骤就没有关系了！例如，如果文件的编码不是 UTF-8（但您期望如此），则该文件将无法正确处理。要检查 Linux 上的文件编码：

   文件 --mime F_PRDAUFT.dsv
   

4. 强制客户端/服务器在请求/响应中显式设置编码。以下是示例：

   @Produces("application/json; charset=UTF-8")
   @Consumes(“application/json; charset=UTF-8”)
   

Answer 5

试试这个：

<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-resources-plugin</artifactId>
        <version>2.7</version>
        <configuration>
          ...
          <encoding>UTF-8</encoding>
          ...
        </configuration>
      </plugin>
    </plugins>
    ...
  </build>
  ...
</project>

Answer 6

（截至 2023 年，但实际上一直如此）

如果你使用 Spring Boot，
你不需要做任何事情。

它已经在父级中应用了这些属性。

<properties>
    ...
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF8</project.reporting.outputEncoding>
    ...
</properties>

在一般情况下，上面这两行就足够了。
并且您不应该在任何其他地方或插件中添加某些内容，除非您知道自己在做什么。

如果您看到采取更多措施的建议，很可能它已经过时了。

Answer 7

就我而言，我使用的是 maven-dependency-plugin 因此为了解决问题，我必须添加以下属性：

  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

请参阅 Apache Maven 资源插件/指定字符编码方案