Java Map w @NonNull 值类型和@Nullable get() 方法结果？

Question

我有一个返回自定义 Map 实现的方法，其条目完全由非空键和值组成，所以我想添加类型注释以指示客户端可以迭代 Map.Entry 的而不需要检查它们用于空值： Map

问题在于 Map.get 方法 API 指定任何尝试检索 Map 中不存在的键的值的尝试都返回 null，并注释我的 get 方法实现以返回 @Nullable 字符串生成编译器警告返回类型与 Map 指定的 @NonNull 返回不兼容。

我知道今天创建的 Map.get API 可能会返回 java.util.Optional 结果或抛出 NoSuchElementException，但是，得益于现有的 Collections API，是否有可能保持与 get 方法规范和还指定我的 Map 仅包含 @NonNull 值？

非常感谢。

Answer 1

不幸的是，地图 API 与空注释并不真正兼容。 Map.get 返回泛型 V，即使您将 V 定义为 @NonNull，这违反了 API，因为 null 必须是允许的返回值。

这是一个空注释的known limitation，可能只有在实现nullity profiles for libraries 时才能解决。在那之前，唯一的解决方法是在获取值之前检查Map.containsKey，而不是在之后检查值是否为空，或者只是避免在映射值类型上使用@NonNull。

Answer 2

您似乎指的是 Eclipse 的无效性检查实现。你是对的，它并不能准确地推断对Map.get 的调用。

如果对Map.get 的调用进行更精确的推理对您很重要，您可能需要考虑使用不同的无效性检查器。例如，在 Checker Framework 上构建的 Nullness Checker 处理您的案例。如果the key is in the map 并且映射的所有元素都是非空的，它会将Map.get 的返回值视为非空。

Answer 3

这是一个简单的库，可以用作解决方法：

package xxxx;

import java.util.*;

import org.eclipse.jdt.annotation.*;

public class NullUtil
{
    @SuppressWarnings ("null")
    public static <@NonNull K, @NonNull T> @NonNull Optional<@Nullable T> get (@NonNull Map<@NonNull K, @NonNull T> m, @NonNull K key)
    {
        return Optional.ofNullable(m.get(key));
    }

    @SuppressWarnings ("null")
    public static <@NonNull K, @NonNull T> @NonNull T getOrThrow (@NonNull Map<@NonNull K, @NonNull T> m, @NonNull K key)
    {
        return Optional.ofNullable(m.get(key)).orElseThrow(
            () -> new RuntimeException("Map does not contain element '" + key + "'"));
    }

    @SuppressWarnings ("null")
    public static <@NonNull K, @NonNull T> @Nullable T getOrNull (@NonNull     Map<@NonNull K, @NonNull T> m, @NonNull K key)
    {
        return Optional.ofNullable(m.get(key)).orElse(null);
    }
}

以下是一些示例用法：

package xxxx;

import static org.junit.Assert.*;

import java.util.*;

import org.eclipse.jdt.annotation.NonNull;
import org.junit.*;

public class NullUtilTest
{
    @Before
    public void setup ()
    {
        _m.put("a", "va");
        _m.put("b", "vb");
        _m.put("c", "vc");
    }

    @Test
    @SuppressWarnings ("null")
    public void testOptional ()
    {
        assertTrue(NullUtil.get(_m, "a").isPresent());
        assertFalse(NullUtil.get(_m, "x").isPresent());

        assertEquals("va", NullUtil.get(_m, "a").orElse(null));
        assertEquals(null, NullUtil.get(_m, "x").orElse(null));

    }

    @Test
    public void testOrNull ()
    {
        assertEquals("va", NullUtil.getOrNull(_m, "a"));
        assertEquals(null, NullUtil.getOrNull(_m, "x"));
    }

    @Test
    public void testOrThrow ()
    {
        assertEquals("va", NullUtil.getOrThrow(_m, "a"));

        try
        {
            assertEquals("vx", NullUtil.getOrThrow(_m, "x"));
            fail();
        }
        catch (Exception e)
        {
            assertEquals("Map does not contain element 'x'", e.getMessage());
        }
    }

    private final @NonNull Map<@NonNull String, @NonNull String> _m = new HashMap<>();
}

Answer 4

ObjectMapper mapper = new ObjectMapper(); 
mapper.setSerializationInclusion(Include.NON_NULL);

当你有这个空值或键的错误时：

c.f.j.c.JsonGenerationException:  
  Null key for a Map not allowed in JSON (use a converting NullKeySerializer?)     
            at c.f.j.d.s.i.FailingSerializer.serialize(FailingSerializer.java:36)

你解决了像这样的覆盖序列化方法：

class MySerializer extends StdSerializer<Object> {     
        public MyDtoNullKeySerializer() {
             this(null);}     
             public MySerializer(Class<Object> t) { 
                super(t);     
            }     
      @Override   
      public void serialize(Object nullKey, JsonGenerator jsonGenerator,SerializerProvider unused) 
          throws IOException, JsonProcessingException { 
            jsonGenerator.writeFieldName("");    
        } 
}

例如完整的见这里： https://lentux-informatica.com/jackson-problema-con-maps-e-valori-null/