将 findbugs 的 NotNull 设置为默认值，适用于某个包下的所有类。

Question

我有以下简单的代码用于测试使用Maven检查FindBugs时的@NonNull注解。 我执行：

mvn clean install

因为print(null)违反了非空条件，所以它无法正确构建。

您可以使用类注释将NonNull设置为类中所有方法参数的默认值。

@DefaultAnnotation(NonNull.class)

如何将NonNull设置为给定包（以及子包）中所有类中的所有方法参数的默认值？

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>

  <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>
</project>

- David Portabella

Answer 1

你可以为单个软件包执行此操作，但我没有找到一种方法将其传播到子软件包。对于方法参数，请使用内置的软件包注释 @ParametersAreNonnullByDefault。在软件包目录中的 package-info.java 文件中将注释应用于软件包。请注意，我正在使用来自 JSR-305 的 javax.annotation 注释，FindBugs 会予以尊重。 com/example/foo/package-info.java

/**
 * Package that doesn't allow null values as method parameters.
 */
@ParametersAreNonnullByDefault
package com.example.foo;

import javax.annotation.ParametersAreNonnullByDefault;

对于字段和方法返回值，您需要创建自己的注释。我通过复制ParametersAreNonnullByDefault的源代码并更改ElementType枚举来实现这一点。

com/example/util/FieldsAreNonnullByDefault.java

package com.example.util;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

import javax.annotation.Nonnull;
import javax.annotation.meta.TypeQualifierDefault;

/**
 * Applies the {@link Nonnull} annotation to every class field unless overridden.
 */
@Documented
@Nonnull
@TypeQualifierDefault(ElementType.FIELD)  // <-- use METHOD for return values
@Retention(RetentionPolicy.RUNTIME)
public @interface FieldsAreNonnullByDefault
{
    // nothing to add
}

几个月前，我开始从头重写一个相当复杂的系统，每个包都应用了这三个注释（字段、参数和返回值）。避免使用null值的奖励之一是在适当的情况下使用Null Object模式。这与尽可能喜欢使用final字段以及只执行一件事情的小类相结合，真正保持了代码的清晰。

- David Harkness

Answer 2

您可以通过在package-info.java文件中添加以下内容，同时对参数、字段和方法返回值进行操作：

@DefaultAnnotation(NonNull.class)
package com.my.package;

当findbugs在该包中运行代码时，除非您使用@CheckForNull注释方法和字段，否则假定它们都是非空的。

我也不知道如何使其适用于子包。 我为每个包执行此操作。

- mdhirsch