Как определить, что устаревший метод будет принимать типы Nullable?

Question

Рассмотрим это:

@Nullable Object obj = null; 
Optional<Object> optional = Optional.ofNullable(obj); 

Это терпит неудачу, потому что шахматная структура предполагает ofNullable не может принимать null значения (в конце концов, его параметр не помеченных как @Nullable).

Есть ли хороший способ проверить рамки проверки, что этот метод (или другие методы в устаревшем коде, который я не могу изменить), принимает типы @Nullable везде, не изменяя код везде?

Answer 1

EDIT: этот ответ был основан на @mernst помощь в комментариях и в Checker Framework's Issue tracker

Если вы, как и я, не хотят или не могут использовать аннотированный JDK, вы столкнетесь с этой проблемой.

Примечание: В большинстве магазинов Java, с которыми я работал, мы просто не можем переключить какой компилятор мы используем или предоставить «пользовательский» JDK (это действительно немыслимо). Для того, чтобы быть переносимым, мне пришлось бы добавить пользовательский JDK в исходный репозиторий, для начала или распространить его на каждую машину, включая серверы CI, где компилируется код, и убедитесь, что они находятся на одном и том же пути по разным ОС. Просто не круто.

Решение должно предоставить stub classes и передать их в качестве аргумента в процесс javac.

Это можно сделать довольно легко с помощью любого инструмента, который вы используете для компиляции.

Например, с помощью Maven (с использованием стандартного compiler plugin):

<plugin> 
    <groupId>org.apache.maven.plugins</groupId> 
    <artifactId>maven-compiler-plugin</artifactId> 
    <version>3.1</version> 
    <configuration> 
     <source>1.8</source> 
     <target>1.8</target> 
     <annotationProcessors> 
      <annotationProcessor>org.checkerframework.checker.nullness.NullnessChecker</annotationProcessor> 
     </annotationProcessors> 
     <compilerArgs> 
      <arg>-Astubs=checkerframework/stubs</arg> 
      <arg>-AstubWarnIfNotFound</arg> 
     </compilerArgs> 
    </configuration> 
</plugin> 

Кроме того, необходимо добавить эти зависимости для вашего проекта:

<dependency> 
     <groupId>org.checkerframework</groupId> 
     <artifactId>checker-qual</artifactId> 
     <version>1.9.2</version> 
     <optional>true</optional> 
    </dependency> 
    <dependency> 
     <groupId>org.checkerframework</groupId> 
     <artifactId>checker</artifactId> 
     <version>1.9.2</version> 
     <optional>true</optional> 
    </dependency> 

Здесь checkerframework/stubs является каталогом (по отношению к местоположение пом), содержащий заглушки. Необязательно, мой заглушка выглядит так (как ни странно, заглушки должны быть названы * .astub, поэтому этот файл называется необязательным.astub):

package java.util; 

import org.checkerframework.checker.interning.qual.*; 

import javax.annotation.Nullable; 

class Optional<T> { 
    static <T> Optional<T> ofNullable(@Nullable T value); 

    @Nullable T orElse(@Nullable T other); 
} 

Этот подход прост, требует мало работы, не связывайтесь с какой компилятор использовать или библиотеки Java на всех, убеждаются эти определения используются только с checkerframework (так что я могу, для например, добавьте это в профиль Maven и включите его, только если я хочу просто передать аргумент Maven), будет работать через машины и ОС без предварительной настройки в истинном Java-способе делать что-то.

Answer 2

Я не уверен, почему вы говорите «его параметр не отмечен как @Nullable». Когда я смотрю на файл шахматных рамки/проверки/JDK/nullness/SRC/Java/Util/Optional.java, я вижу следующий аннотированный метод:

public static <T> Optional<@NonNull T> ofNullable(@Nullable T value) { 
    return value == null ? empty() : of(value); 
} 

Кроме того, когда я запустить Framework Checker по следующему коду он не предупреждает.

// run like this: 
// javacheck -g TestOptional.java -processor nullness 

import java.util.*; 
import org.checkerframework.checker.nullness.qual.Nullable; 
import org.checkerframework.checker.nullness.qual.NonNull; 

public class TestOptional { 

    void m() { 

    @Nullable Object obj = null; 
    Optional<Object> optional1 = Optional.ofNullable(obj); 

    } 

} 

Я не уверен, что происходит в вашем случае, потому что вы не предоставили полный тестовый случай, вы не сказали, какую команду вы запускали, и вы не дали реальное сообщение об ошибке , (Вы поставили диагноз, но я не уверен, что это точно.)

Возможно, предоставление более подробной информации позволит лучше понять вашу проблему.