如何基于JSR305在Sonar中实现全局非空检查且避免冗余代码？

针对你遇到的Sonar空值检查注解冗余、package-info无法覆盖子包的问题，提供两个更优的无冗余方案：

方案一：用Lombok全局配置默认非空，自动生成JSR305注解 #

Lombok的@NonNullByDefault可以实现全局（含子包）的默认非空规则，且自动为对应元素生成JSR305的javax.annotation.Nonnull注解，完全不需要手动复制package-info文件。

步骤： #

1. 引入Lombok依赖（版本1.16.20及以上），如果项目还未使用。
2. 在项目根目录创建lombok.config文件，指定生成JSR305的javax注解（避免生成Jakarta版本）：

   lombok.nonnull.type=javax.annotation.Nonnull
   

3. 在根包的package-info.java中添加默认非空注解：

   @NonNullByDefault
   package com.your.project.root;
   
   import lombok.NonNullByDefault;
   

   这个配置会自动作用于所有子包，Lombok在编译时会为所有未显式标记@Nullable的参数、返回值、字段自动添加@Nonnull注解，Sonar就能识别并执行空值检查。

优缺点： #

• 优点：无冗余文件，配置一次覆盖全项目，代码简洁。
• 缺点：需要团队接受Lombok依赖，编译阶段需Lombok支持。

方案二：直接配置SonarQube规则，默认假设非空 #

SonarQube的空指针检查规则支持自定义默认非空的元素类型，无需修改代码，纯配置即可解决问题。

步骤： #

1. 进入SonarQube控制台，找到Java规则库中的java:S2259（"Possible null pointer dereference"）规则。
2. 编辑该规则配置，在"Default non-null element types"选项中，勾选需要默认非空的类型：
   • Parameters
   • Return values
   • Fields
3. 保存配置后，Sonar会默认认为这些元素非空，仅当显式标记javax.annotation.Nullable时，才允许空值存在。

优缺点： #

• 优点：无需修改代码、无需额外依赖，纯配置生效。
• 缺点：依赖SonarQube的规则配置，更换Sonar环境需同步配置，检查精度略低于注解方案。

避坑提示 #

• 若选择Lombok方案，确保IDE已安装Lombok插件，避免编辑器报错。
• 无论哪种方案，统一使用javax.annotation包下的Nonnull/Nullable，不要混合Jakarta注解，确保Sonar能正确识别。

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