maven - 如何使用 checkstyle-plugin 验证源文件中使用的编码？

Question

简单的事情:如果所选文件(.java、.xml)未正确编码(我想强制执行)，我希望能够通过 checkstyle 中断构建源文件中的 UTF-8)。

我目前正在将 checkstyle 用于许多其他构建破坏者，例如强制执行正确的换行和/或制表符的使用，但似乎没有像 FileEncodingChecker 这样的东西。

问题:如果 checkstyle 根本无法做到这一点:是否还有其他插件可以完成这项工作？

Answer 1

Maven 编码(源和资源)由标准 project.build.sourceEncoding 属性处理，该属性确实应该存在并设置为 UTF-8 值，作为一个好的做法。
来自官方文档maven-resources-plugin

The best practice is to define encoding for copying filtered resources via the property ${project.build.sourceEncoding} which should be defined in the pom properties section

此属性被选取为 encoding 的默认值。 maven-compiler-plugin 和 encoding 的属性maven-resources-plugin 的属性。

<小时/>

要进一步加强其存在，您可以使用 maven-enforcer-plugin及其 requireProperty规则，以强制 project.build.sourceEncoding 属性及其值以 UTF-8 存在。也就是说，如果未设置该属性并且没有该确切值，则构建将会失败。

下面是此类配置的示例，添加到您的 pom.xml 文件的 build/plugins 部分:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-enforcer-plugin</artifactId>
    <version>1.4.1</version>
    <executions>
        <execution>
            <id>enforce-property</id>
            <goals>
                <goal>enforce</goal>
            </goals>
            <configuration>
                <rules>
                    <requireProperty>
                        <property>project.build.sourceEncoding</property>
                        <message>Encoding must be set and at UTF-8!</message>
                        <regex>UTF-8</regex>
                        <regexMessage>Encoding must be set and at UTF-8</regexMessage>
                    </requireProperty>
                </rules>
                <fail>true</fail>
            </configuration>
        </execution>
    </executions>
</plugin>

<小时/>

请注意，可以对 project.reporting.outputEncoding 属性执行相同的操作。

<小时/>

有关 Stack Overflow 的进一步阅读:

• How to configure encoding in maven
• Maven platform encoding
• Maven: Source Encoding in UTF-8 not working?

<小时/>

奖励:由于我们在 Stack Overflow，CEO 可能会很高兴再次看到他的旧文章:The Absolute Minimum Every Software Developer Absolutely, Positively Must Know About Unicode and Character Sets

<小时/>

测试
给出以下 Java 代码:

package com.sample;

public class Main {

    public void 漢字() {
    }

}

并在 Maven 中设置以下内容:

<properties>
    <project.build.sourceEncoding>US-ASCII</project.build.sourceEncoding>
</properties>

实际上会使构建失败，因为 US-ASCII 是 7 位并且会导致非法字符错误。 UTF-8 不会发生同样的情况，它使用 8 位。