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>

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对象模式。结合尽可能多地支持最终字段和只做一件事的小类确实保持了代码的清洁。

Answer 2

您可以通过将这些行放在package-info.java中来同时对参数，fileds和方法返回值执行此操作：

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

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

我也不知道如何将其应用于子包。我为每个包都这样做。

将findbugs NotNull设置为包下所有类的默认值

2 个答案: