标签：core NonNull Spring 305 使用 注解 null
说明
在Spring 5的 spring-core jar包中添加了 jsr-305 相关注解。在 Spring 源码中已经被大量使用。如下图：
JSR-305介绍
诸如 FindBugs、IntelliJ、Checkstyle 和 PMD 这样的静态分析工具在 Java 开发中得到了广泛应用。这些工具都很强大，但是有一些共同的问题它们都很难解决。在 API 的设计中，有一些决策是不言而喻的，比如何时值可以为 null，或者何时数字值不能为负。完备的 API 会将这些设计细节记录在 JavaDoc 之中，但是分析工具却无法发现类似细节，从而有可能将其忽略或是导致错误的检测结果。
为了解决这些问题，有些静态分析工具开发人员试图使用注解来定义相关细节。比如 FindBugs 和 IntelliJ 都定义了自己的注解，以表示方法何时返回 null。不过，这两个工具使用的注解有细微不同，也因此有了标准化的需求。由 FindBugs 创建人 Bill Pugh 带领制定的 JSR-305 标准，试图创建一套标准注解供分析工具使用，同时希望允许开发人员根据自己的需要添加额外的注解。当前提案中包括供判断是否为空、正负号、开发语言和线程等方面的众多注解。
更多jsr-305介绍请查看，JSR-305：供检查软件缺陷用的注解[1]
使用场景
由上文的介绍，我们知晓了 jsr-305 的目标：供检查软件缺陷用。方便静态代码检查工具及时查找出潜在的 bug。所以这些注解特别适合基础组件和工具包，增强 IDE 提示，减少潜在 bug。
lutool 1.x 中复制了spring 5中的 jsr-305 相关注解到源码中，到 mica - Spring boot 微服务开发核心包[2] 由于依赖的 Spring boot 2.1.x，则直接使用 spring core 中的注解。
使用
添加包级规则
1.@NonNullFields表示Field不为null。
2.@NonNullApi表示方法参数和返回值不为null。
3.对于不想使用包级别不为null，可直接使用@NonNull，使用方式同下文@Nullable。
在包下添加package-info.java，内容如下：
@NonNullApi@NonNullFieldspackage net.dreamlu.mica.core.utils;import org.springframework.lang.NonNullApi;import org.springframework.lang.NonNullFields;
添加完该注解后编写代码时编辑器会给出提示，如下图：
@Nullable
对于部分可为空的Field、方法参数和返回值需要使用@Nullable进行标示。
参数可为null
public static boolean isBlank(@Nullable final CharSequence cs) { return !StringUtils.hasText(cs);}返回值可为null
@Nullablepublic static String getCookieVal(HttpServletRequest request, String name) { Cookie cookie = getCookie(request, name); return cookie != null ? cookie.getValue() : null;}属性可为null
@Nullableprivate String msg;
标签：core,NonNull,Spring,305,使用,注解,null 来源： https://blog.51cto.com/15016434/2646077
本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享； 2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关； 3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关； 4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除； 5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。