Установите findbugs NotNull как значение по умолчанию для всех классов под пакетом
У меня есть простой код ниже для тестирования аннотации FindBugs @NonNull
с Maven. Я выполняю
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
Вы можете сделать это для отдельных пакетов, но я не нашел способ распространить его на подпакеты. Для параметров метода используется встроенная аннотация @ParametersAreNonnullByDefault
. Примените аннотацию к пакету в файле package-info.java
внутри каталога пакета.
Обратите внимание, что я использую аннотации javax.annotation
из JSR-305, которые отличает 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
, при необходимости использует шаблон нулевого объекта. Это в сочетании с благоприятными конечными полями, насколько это возможно, и небольшими классами, которые делают только одну вещь, действительно сохранили код в чистоте.
Ответ 2
Вы можете сделать это с параметрами, fileds и возвращаемым методом методом одновременно, поместив эти строки в ваш package-info.java:
@DefaultAnnotation(NonNull.class)
package com.my.package;
Когда findbugs запускается на коде в этом пакете, все методы и поля считаются ненулевыми, если вы не аннотируете их с помощью @CheckForNull.
Я также не знаю, как это применимо к подпакетам. Я делаю это для каждого пакета.