返回null的方法中的java @Nonnull批注

Question

我有一个从哈希图中获取内容的方法，一个简化的示例（虽然没有多大意义，但目前已经足够好了）是：

private Map<String,String> map = new HashMap<String,String>();

public String get(String key) {
    return map.get(key);
}

当给定键的条目明显不存在时，此方法可以返回null。事实是，我想对此方法进行注释@NonNull（因为它用在了数不胜数的地方，而且我不喜欢Intellij向我发送有关生产NPE的检查警告，因此我不想关闭该检查，我也不想在每次调用此方法时都检查返回的值是否不同于null，这是因为我总是将此方法与始终在映射中的一堆键一起使用，因此由于程序逻辑，该方法是一定要返回一个@NonNull值。

我很想只用来注释它@NonNull，但谁知道有人可能用某处定义的键以外的名称来调用它，并实际上导致了NullPointerException。你会怎么做？一个断言听起来很诱人。还是您只是更改方法以引发RuntimException？还是AssertionError？

谢谢。

编辑：

这是实际的实现：

/**
 * Typesafe heterogeneous container pattern - implementation
 */
public class HandlersMap {

    private final Map<Class<? extends TableHandler>, TableHandler> handlers;

    public HandlersMap() {
        handlers = new HashMap<Class<? extends TableHandler>, TableHandler>();
        putHandler(RolesTableHandler.class, new RolesTableHandler());
        putHandler(UsersTableHandler.class, new UsersTableHandler());
        putHandler(DevicesTableHandler.class, new DevicesTableHandler());
    }

    private <T extends TableHandler> void putHandler(@NonNull final Class<T> type, @NonNull final T instance) {
        handlers.put(type, type.cast(instance));
    }

    @NonNull
    public <T extends TableHandler> T getHandler(@NonNull final Class<T> type) {
        assert handlers.get(type) != null;
        return type.cast(handlers.get(type));
    }

    public Collection<TableHandler> values() {
        return handlers.values();
    }

    public int size() {
        return handlers.size();
    }

    public Map<Class<? extends TableHandler>, TableHandler> getMap() {
        return this.handlers;
    }

}

Answer 1

在@Nonnull没有验证给定密钥是否存在的情况下进行注释绝对是错误的选择。

由于您似乎指示给定的键应该存在，因此这意味着缺少键是无效的参数，因此检查这种情况并IllegalArgumentException为缺少的元素抛出a 是正确的做法。

另外，根据映射的初始化方式，您可能需要考虑为键值创建一个枚举，使用a EnumMap代替a HashMap，并让您的get()方法采用该枚举而不是自由格式String。这样，您将进行一些编译时检查，以确保也使用正确的值。

即使在那种情况下，您仍然需要检查是否存在，以防万一请求的枚举值尚未添加到地图中。