SonarQube + Lombok配置

Question

我正在启动一个新项目，我需要使用SonarQube，我想使用Lombok，我已经在Eclipse中配置了它，除了静态分析之外，一切都很好。

• 未使用的私有字段:当我有一个@Data类时，所有字段都报告为Unused private field。
• @Getter(lazy=true)：当我使用这个注释时，我得到了Redundant nullcheck of value known to be non-null (参见@Getter(lazy=true) )(这与编译的代码相关)。

我认为一个可能的解决方案是delombok项目，编译和运行Sonar。

SonarQube Jira中的类似问题

• [CodeGen - Lombok]错误警告提示(未使用的私有字段)
• 提供一个新的java规则来检查未使用的私有字段，它将支持字节码生成(cd Lombok)
• [CodeGen - Lombok]错误警告提示

( @SuppressWarnings("PMD.UnusedPrivateField")解决方案不适用于最新的SonarQube 4.2 )

我该如何解决这个问题？

Answer 1

作为解决办法，我现在让声纳对delombok生成的代码进行分析。

我想这也不是一个完美的解决方案，因为我正在分析生成的代码，而不是实际由开发人员编写的代码。不过，我发现这是一个比在Sonar中使用@SuppressWarnings, //NOSONAR或关闭规则更好的解决方案。

请参阅下面的示例，以便在Maven中实现这一点。将此添加到您的pom.xml中：

<properties>
    ...
    <!-- This is exposed as a workaround to do the sonar analysis in combination with delombok -->
    <src.dir>src/main/java</src.dir>
    ...
</properties>
...
<plugins>
    ...
    <plugin>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok-maven-plugin</artifactId>
        <version>${lombok-plugin.version}</version>
        <executions>
            <execution>
                <phase>verify</phase>
                <goals>
                    <goal>delombok</goal>
                </goals>
                <configuration>
                    <addOutputDirectory>false</addOutputDirectory>
                    <sourceDirectory>src/main/java</sourceDirectory>
                </configuration>
            </execution>
        </executions>
    </plugin>
    ...
</plugins>
...
<profiles>
...
<profile>
        <!-- we have to use this profile to analyse code with sonar until https://jira.codehaus.org/browse/MSONAR-70 is fixed ! -->
        <id>sonar</id>
        <properties>
            <src.dir>target/generated-sources/delombok</src.dir>
        </properties>
        <build>
            <plugins>
                <plugin>
                    <groupId>org.projectlombok</groupId>
                    <artifactId>lombok-maven-plugin</artifactId>
                    <version>${lombok-plugin.version}</version>
                    <executions>
                        <execution>
                            <phase>verify</phase>
                            <goals>
                                <goal>delombok</goal>
                            </goals>
                            <configuration>
                                <addOutputDirectory>true</addOutputDirectory>
                                <sourceDirectory>src/main/java</sourceDirectory>
                            </configuration>
                        </execution>
                    </executions>
                </plugin>
                <plugin>
                    <groupId>org.codehaus.mojo</groupId>
                    <artifactId>sonar-maven-plugin</artifactId>
                    <version>2.2</version>
                </plugin>
            </plugins>
        </build>
    </profile>
    ...
</profiles>

Answer 2

我添加了一个拉请求以支持Lombok的更多注释。

有关二进制文件，请访问此处：

• SonarQube 4.5.X (或船舶声纳-java-插件-2.4.jar)
• SonarQube 5.0.X (或船舶声纳-java-插件-2.8.jar)

Answer 3

不久前，我问了一个类似的问题：声呐4.2和lombok

基本上，您不能再用代码中的注释(比如@SuppressWarnings)来完成这个任务了。相反，您需要在SonarQube中设置(全局)规则排除：

单击“设置->排除->问题”并在“多标准上的忽略问题”部分中添加条目，然后输入以下内容：

Rule Key Pattern  File Path Pattern
squid:S1068       **/models/**/*.java

它使您的源代码稍微干净一些(因为您不再需要@SuppressWarnings了)，但是我不喜欢设置全局规则的想法，因为它可能会导致其他问题。

更新：

对于“已知为非空值的冗余空检查”，可以添加如下内容：

Rule Key Pattern                                   File Path Pattern
findbugs:RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE  **/xxxxx.java

另一种可能(或不可能)对你有用：

Rule Key Pattern                        File Path Pattern
common-java:InsufficientBranchCoverage  **/models/**/*.java