Java空注解合规场景下Map.getOrDefault()非空返回方案确认

问题背景 #

需要让Java代码符合空注解规范，确保Map.getOrDefault()的返回值可以标注为@NotNull——即无论指定键是否存在（包括键为null的情况），最终都返回非空List；同时在不关闭空安全警告的前提下，用最简方式解决类型不匹配的警告。由于无法控制Map的创建，必须兼容键为null的场景。

现有方案分析 #

先看几种常见写法的问题：

1. 未添加@NotNull注解

   // 当键为null且无对应映射时，可能返回null，不符合非空预期
   List<String> value = m.getOrDefault(key, new ArrayList<>());
   

   这种写法没有明确标注非空约束，且实际存在返回null的风险，不符合规范要求。

2. 直接添加@NotNull注解

   // 编译器会抛出空类型不匹配警告：Map.getOrDefault()可能返回null
   @NotNull List<String> value = m.getOrDefault(key, new ArrayList<>());
   

   虽然标注了@NotNull，但根据JDK SDK规范，getOrDefault()的返回值可能为null（比如当键为null且Map中没有null键的映射时），因此编译器会触发警告，无法通过检查。

3. 使用Objects.requireNonNullElse兜底

   // 确保返回非空结果，同时消除空安全警告
   @NotNull List<String> value = Objects.requireNonNullElse(m.getOrDefault(key, null), new ArrayList<>());
   

   这种写法是无依赖场景下的最优解，原因如下：

   • 利用JDK自带的Objects.requireNonNullElse（Java 9及以上版本可用），无需引入第三方库；
   • 先通过getOrDefault(key, null)获取原始结果（可能为null），再用requireNonNullElse兜底为空List，确保最终返回值绝对非空；
   • 完全符合@NotNull注解的约束，编译器不会再抛出空安全警告；
   • 代码简洁，逻辑清晰，兼容键为null的场景。

Java 8兼容方案 #

如果项目仍在使用Java 8（无requireNonNullElse方法），可以用Optional实现等价逻辑：

@NotNull List<String> value = Optional.ofNullable(m.getOrDefault(key, null)).orElse(new ArrayList<>());

同样能保证返回非空值并消除警告，只是代码稍长一点。

内容的提问来源于stack exchange，提问作者Zhro