如何使用 checkstyle 或 PMD 强制执行构造函数注入？

编程问答 2022-05-24

问题描述

我想在 GWT 项目中使用 Guice 注释 com.google.inject.Inject 强制执行构造函数注入，该注释位于用于字段注入的字段和用于构造函数注入的构造函数中。

该项目已经使用了 checkstyle 和 PMD。

Afaik 我可以通过禁止对字段进行注释来简单地强制构造函数注入，但是我发现没有 checkstyle 模块或 PMD 规则可以执行此操作。我确定我遗漏了一些东西，因为它似乎是静态代码分析工具的日常任务。

解决方法

这听起来很适合 Checkstyle 的 MatchXpath 检查。您可以像这样在配置中添加两个模块：

<module name="MatchXpath">
  <property name="query" value="//VARIABLE_DEF/MODIFIERS/ANNOTATION/IDENT[@text='Inject']"/>
  <message key="matchxpath.match"
                     value="Inject annotation only allowed on constructors."/>
</module>

<module name="MatchXpath">
  <property name="query" value="//METHOD_DEF/MODIFIERS/ANNOTATION[./IDENT[@text='Inject']]"/>
  <message key="matchxpath.match"
                     value="Inject annotation only allowed on constructors."/>
</module>

示例java文件：

public class Communication {
    @Inject @Named("SMSComms")
    CommunicationMode smsComms;

    @Inject
    public void setEmailCommunicator(@Named("EmailComms") CommunicationMode emailComms) {
        this.emailComms = emailComms;
    }

    @Inject
    public Communication(@Named("IMComms") CommunicationMode imComms) {
        this.imComms = imComms;
    }
}

结果：


➜  src java -jar checkstyle-8.40-all.jar -c config.xml Communication.java
Starting audit...
[ERROR] src/Communication.java:2:6: Inject annotation only allowed on constructors. [MatchXpath]
[ERROR] src/Communication.java:5:5: Inject annotation only allowed on constructors. [MatchXpath]
Audit done.
Checkstyle ends with 2 errors.
annotationsannotationscheckstyleguiceguiceguicejavajavapmdpmd