强制 maven 在非空违规情况下构建失败

Posted 2023-02-19

【中文标题】强制 maven 在非空违规情况下构建失败

【英文标题】：force maven to fail the build on nonnull violations

【发布时间】：2012-10-28 19:22:24

【问题描述】：

我有下面的简单代码，用于使用 maven 测试 findbugs NonNull 注释。

我执行“mvn clean install site”， 我得到一个目录 target/site/css 和 target/site/images， 但仅此而已。 我期待收到一份报告，说 println(null) 违反了 NonNull 条件。

我需要做什么才能获得该报告？

另外， 如果有 NonNull 违规，有没有办法防止“mvn clean install”成功？

---

注意：我知道我可以使用 Sonar 获得此类报告； 但是，如果出现此类错误，我希望“mvn clean install”失败， 之后无需使用可选的声纳工具。

---

src/main/java/test/Hello.java

package test;
import edu.umd.cs.findbugs.annotations.NonNull;
public class Hello 
    static public void print(@NonNull Object value) 
        System.out.println("value: " + value.toString());
    

    static public void main(String[] args) 
        if (args.length > 0) 
            print(args[0]);
         else 
            print(null);
        
    

和 pom.xml 文件：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>hello</groupId>
  <artifactId>hello</artifactId>
  <version>1.0</version>

  <dependencies>
    <dependency>
      <groupId>net.sourceforge.findbugs</groupId>
      <artifactId>annotations</artifactId>
      <version>1.3.2</version>
    </dependency>
    <dependency>
      <groupId>net.sourceforge.findbugs</groupId>
      <artifactId>jsr305</artifactId>
      <version>1.3.7</version>
    </dependency>
  </dependencies>

  <reporting>
    <plugins>
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>findbugs-maven-plugin</artifactId>
        <version>2.5.2</version>
      </plugin>
    </plugins>
  </reporting>
</project>

---

更新、解决方案

解决方案，基于奥古斯托的回答： 将此添加到 pom.xml 文件中，在项目下：

  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <source>1.6</source>
          <target>1.6</target>
        </configuration>
      </plugin>
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>findbugs-maven-plugin</artifactId>
        <version>2.5.2</version>
        <configuration>
          <includeTests>true</includeTests>
        </configuration>
        <executions>
          <execution>
            <phase>compile</phase>
            <goals>
              <goal>check</goal>
            </goals>
          </execution>
          <execution>
            <id>findbugs-test-compile</id>
            <phase>test-compile</phase>
            <goals>
              <goal>check</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>

这样，如果出现 NonNull 违规，“mvn clean install”将失败。

报告对我不起作用，因为我使用的是 maven 3， 并且报告功能在 maven 3 中发生了变化（现在它使用了一个普通的 maven 插件）

【问题讨论】：

您还尝试了什么？您是否阅读了解释如何操作的手册条目？ mojo.codehaus.org/findbugs-maven-plugin/plugin-info.html ?

感谢 Augusto，解决了这个问题；请添加一个答案，以便我接受。

我刚刚添加了答案。谢谢！

好问题和答案，但解决方案发现的错误远不止注释问题。如何限制 FindBugs 只关心注释？

【参考方案1】：

大卫，

您的问题的答案在findbugs maven plugin documentation 中（请参阅 findbugs:check）