1

是否有使用 ErrorProne 对类型和参数强制注释的示例？

例如， 

@EventKey private static final String VALID_KEY = "asdf";

Map<@EventKey String, Object> map = new HashMap<>();

public void addSomeValues() {
    map.put("invalid_key", new Object()); // should error
    map.put(VALID_KEY, new Object()); // should pass
}

public void put(@EventKey String key, Object value) {
    map.put(key, value);
}

public void usingCustomPut(){

    put("invalid_key", new Object()); // should error
    put(VALID_KEY, new Object()); // should pass
}
4

1 回答 1

2

Error Prone 有一组硬编码的检查。您可以扩展 Error Prone，但这需要对其进行分叉、编辑源代码、重建它并使用您自己的自定义版本。

Checker Framework是一个可插入的类型检查器，设计用于检查类型注释。它服务于您的目的。

假设您定义了@EventKey如下所示的注释。（这是按照创建新检查器的说明进行的。）

然后你可以运行命令

java -jar "${CHECKERFRAMEWORK}/checker/dist/checker.jar" -cp . \
-processor org.checkerframework.common.subtyping.SubtypingChecker \
-Aquals=UnknownEventKey,EventKey TestCase.java

它的行为完全符合您的意愿，允许正确的行和禁止不正确的行（通过编译器错误消息）。

（一个警告：Checker Framework 也会对 assignment 发出警告VALID_KEY = "asdf"，因为它无法知道该分配是合法的。如果您确定它是合法的，则可以取消该警告。）

为了完整起见，以下是注释定义：

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
import org.checkerframework.framework.qual.DefaultQualifierInHierarchy;
import org.checkerframework.framework.qual.SubtypeOf;

/** The value might or might not be an Event Key. */
@Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})
@SubtypeOf({})
@DefaultQualifierInHierarchy
public @interface UnknownEventKey {}

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
import org.checkerframework.framework.qual.ImplicitFor;
import org.checkerframework.framework.qual.LiteralKind;
import org.checkerframework.framework.qual.SubtypeOf;

/** The value is an Event Key. */
@Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})
@SubtypeOf({UnknownEventKey.class})
@ImplicitFor(literals = LiteralKind.NULL)
public @interface EventKey {}
于 2019-06-12T21:47:19.740 回答