如何让 Checkstyle CustomImportOrder 正确使用 IntelliJ？

java maven intellij-idea checkstyle

2022-09-03 14:46:11

我正在尝试让Checkstyle（通过maven-checkstyle-plugin）通过使用Checkstyle CustomImportOrder模块来检查我的IntelliJ导入。尽管根据IntelliJ的默认规则订购了我的进口，但Checkstyle仍然说进口订单是错误的。

这是我的导入（根据IntelliJ规则（ctrl + o）排序）：

import org.codehaus.jackson.JsonNode;

import javax.sql.rowset.serial.SQLOutputImpl;
import java.util.ArrayList;
import java.util.List;

以下是来自 Checkstyle 的警告消息：

[WARNING] src\main\java\com\example\hej\EnKlass.java[5] (imports) CustomImportOrder: Import statement is in the wrong order. Should be in the 'SPECIAL_IMPORTS' group.
[WARNING] src\main\java\com\example\hej\EnKlass.java[6] (imports) CustomImportOrder: Import statement is in the wrong order. Should be in the 'STANDARD_JAVA_PACKAGE' group.
[WARNING] src\main\java\com\example\hej\EnKlass.java[7] (imports) CustomImportOrder: Import statement is in the wrong order. Should be in the 'STANDARD_JAVA_PACKAGE' group.

这是我的checkstyle.xml CustomImportOrder规则（由Checkstyle网站推荐给IntelliJ）：

<module name="CustomImportOrder">
    <property name="customImportOrderRules" value="THIRD_PARTY_PACKAGE###SPECIAL_IMPORTS###STANDARD_JAVA_PACKAGE###STATIC"/>
    <property name="specialImportsRegExp" value="^javax\."/>
    <property name="standardPackageRegExp" value="^java\."/>
    <property name="sortImportsInGroupAlphabetically" value="true"/>
    <property name="separateLineBetweenGroups" value="false"/>
</module>

这里可能有什么问题？我一直试图改变规则，但没有运气。我也试图删除/操纵正则表达式，但没有运气。

答案 1

IntelliJ 中的默认格式如下所示：

all other imports
<blank line>
javax.* in alphabetical order
java.* in alphabetical order
<blank line>
static imports in alphabetical order

现在，不可能在没有空行的情况下单独排序，这就是为什么你有违规行为。javajavax

我已经在GitHub上提出了这个问题来解决这个问题，它需要更改Checkstyle代码。

作为一种解决方法，您可以在IntelliJ IDEA配置之间和其中添加空行，然后调整Checkstyle以使用它应该很容易。javaxjava

答案 2

不要分开和分成单独的组 - 只需在包装前站着。javajavaxjavaxjava

检查样式.xml：

...
    <module name="CustomImportOrder">
        <property name="customImportOrderRules" value="THIRD_PARTY_PACKAGE###SPECIAL_IMPORTS###STANDARD_JAVA_PACKAGE###STATIC"/>
        <property name="sortImportsInGroupAlphabetically" value="true"/>
        <property name="standardPackageRegExp" value="^(java|javax)\."/>
        <property name="separateLineBetweenGroups" value="true"/>
    </module>
...

检查样式抑制.xml

...
<!--  Let javax.* stand before java.* - that's default Idea settings  -->
<suppress checks="CustomImportOrder"
          message="Wrong lexicographical order for 'java\.[^']+' import\. Should be before 'javax\.[^']+'\."/>
...

您还可以省略与默认值匹配的属性（以及今天） - 请查看实际文档。standardPackageRegExpseparateLineBetweenGroups