如何解决当 IDE 可以推断无效时,@Nullable 是否仍应用于方法返回?
像 IntelliJ IDEA 这样的 IDE 能够推断出一个方法何时可以返回 null——而且似乎非常可靠。鉴于此,方法是否仍应使用 @Nullable
进行注释?
解决方法
是的。
签名和实现之间存在着巨大的差异。
要采用的正确心态是将代码视为不断运动的事物。每天都会带来另外 50 次涉及代码许多部分的提交;新版本是连续的,或者至少经常出现,并且版本之间存在整个维度的“兼容性”。很少有“新版本”与旧版本完全不兼容,以至于任何针对旧版本编写的内容都完全违反了新版本。通常,“新版本”旨在与针对“旧版本”编写的所有代码 100% 兼容。这通常是意图,但并不完全是 100% 真实 - 可以想象极端异国情调/学术场景。
最常见的事情是 99.9% 兼容。
重点是:事情发生了变化。
签名决定了在不同版本之间可以更改和不可以更改的内容,同时仍称其为“兼容”。 javadoc 包含在其中(如果 javadoc 承诺例如一个方法永远不会返回空字符串,并且在一些小更新中它现在确实如此,那么您就搞砸了,这应该是一个标记为“不兼容”的更新,即如果你关注semver,你好“2.0版”)。
签名是一把双刃剑。一方面,它通过阐明您可以依赖的内容使生活变得轻松。如果 @Nullable
在签名中或被“推断”,则调用此方法的代码知道返回的值可能为空,而如果没有该注释或推理,调用者将无法获得编译时通知的好处那个应该准备好接收空值。
但另一方面,一旦你在签名中拼出它,就是这样。你现在卡住了。 它永远不会改变,除非您采用很少有图书馆采用的“v2”(不兼容更新)想法。
因此,自动化工具永远不能将一堆规则堆砌到您的签名中。如果您编写的代码当前可以通过代码分析得出null
永远不会从中返回的结论,那么IDE如果添加了对签名的推断 - 毕竟,也许它只是一个占位符,您打算让此方法稍后在某个时间点更新中返回 null;任何针对此方法编写的代码都应该处理空值,即使现在永远不会发生。
Nullable 是一种特殊的雪花,因为它是类型松散的一种情况,根据定义与未来兼容。 (@Nullable String
实际上是 @NonNull String
的超类型),因此推断 @Nullable
然后默默地将其作为签名的一部分实际上是无害的,但这是一种罕见的情况,因此推理引擎可能不应该只为那些不会造成伤害的场景付出大量努力来静默更新签名。
与“签名是关于这个 API 的承诺现在和永远保持,而实现可以随时更改”问题分开,@Nullable
的全部要点的一部分是让编译器成为第二对眼睛。当您从未明确标记为 @Nullable
的方法中返回潜在的空值时,您应该将 IDE 配置为主动警告您(从不出错,编译器应该警告而不是错误以使调试更简单,并且您应该永远不要将带有警告的代码发送到生产级端点)。
更具体地说:
-
@Nullable
应该是一个 TYPE_USE 而不是一个 METHOD 目标注解,尽管大多数空注解框架把它搞砸了。 Eclipse 和 checkerframework 使其正确。 - 如果您使用这些注释,则需要使用默认机制,因为用
@NonNull
或@Nullable
注释每个源文件中的每个最后一个类型是荒谬的。通常,这是在包或类上粘贴@NonNullByDefault
的问题。在这一点上,未能在方法的返回类型上粘贴@Nullable
意味着它是非空的,因此任何在方法中返回空的尝试都将直接成为警告(正如所讨论的,这意味着它可以'在你清除警告之前不要被释放)。
IDE 可能非常有能力推断这些值,但机器推断的可空性并没有像明确标记的函数那样清楚地传达开发人员的意图。放置注释将明确说明函数的意图是可空的还是不为空的,并且该函数的使用者将更有信心这不会改变。
此外,IntelliJ 提供 deeper integration 这些功能以自动添加运行时断言,以确保即使在运行时也能维护使用 @Nullable 和 @NotNull 定义的合同。
检查由常量条件和异常以及@NotNull/@Nullable 问题检查完成。您可以在设置/首选项 Ctrl+Alt+S 对话框中配置这些检查的工作方式。转到编辑器 |检查 |爪哇|可能的错误。
当您编译项目时,IDE 会向所有使用 @NotNull 注释的方法和参数添加断言。如果在需要 @NotNull 的代码中传递 null,则断言将失败。您可以禁用此选项并在“设置/首选项”对话框 Ctrl+Alt+S 中配置注释列表。转到构建、执行、部署 |编译器。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。