10

以下に、Mavenで FindBugs@NonNullアノテーションをテストするための簡単なコードを示します。私は実行します

mvn clean install

print(null)また、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>
4

2 に答える 2

16

これは個々のパッケージに対して行うことができますが、サブパッケージに伝播させる方法が見つかりませんでした。メソッドパラメータには、組み込みのパッケージアノテーションを使用します@ParametersAreNonnullByDefault。package-info.javaパッケージのディレクトリ内のファイル内のパッケージに注釈を適用します。

FindBugsが尊重するJSR-305javax.annotationのアノテーションを使用していることに注意してください。

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
}

数か月前にかなり複雑なシステムを最初から書き直し始めました。すべてのパッケージにこれらの3つのアノテーション（フィールド、パラメーター、戻り値）が適用されています。値を回避するインセンティブから得られる利点の1つnullは、必要に応じてNullObjectパターンを使用することです。これは、可能な限り最終フィールドを優先することと、1つのことだけを実行する小さなクラスを組み合わせることで、コードを実際にクリーンに保ちました。

于 2012-11-10T05:25:41.913 に答える