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

Posted 2023-02-19

【中文标题】将 findbugs NotNull 设置为包下所有类的默认值

【英文标题】：Set findbugs NotNull as default for all classes under a package

【发布时间】：2012-10-29 22:41:17

【问题描述】：

我有下面的简单代码，用于使用 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>

【参考方案1】：

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

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

当 findbugs 在该包中的代码上运行时，所有方法和字段都假定为非空，除非您使用 @CheckForNull 对其进行注释。

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

【参考方案2】：

您可以对单个包执行此操作，但我还没有找到将其传播到子包的方法。对于方法参数，使用内置的包注释@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 值的动机带来的一个好处是在适当的情况下使用空对象模式。再加上尽可能多地偏爱 final 字段和只做一件事的小类，确实让代码保持干净。