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

Question

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

该项目已经使用了检查风格和PMD。

我可以简单地通过禁止字段上的注释来强制构造函数注入，但是我找不到检查风格模块或PMD规则来做到这一点。我肯定我错过了一些东西，因为它似乎是静态代码分析工具的日常任务。

Answer 1

这听起来像是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.