如何处理外部库中标注@NotNull却返回null的方法？

针对外部库@NotNull方法实际返回null、空判断被SonarQube标记为死代码（java:S2583）的问题，以下是几种局部解决的方案，无需全局抑制：

1. 本地包装方法屏蔽外部注解 #

自己写一个无注解的包装方法，将外部库的调用包裹起来。静态分析工具会忽略外部库的@NotNull声明，转而信任本地方法的无注解状态，从而认可空判断的必要性：

// 本地包装方法，不添加任何非空注解
private Company wrapGetCompany(CompanyKey companyKey) {
    return externalLibraryInstance.getCompany(companyKey);
}

// 业务代码中调用包装方法
Company company = wrapGetCompany(companyKey);
if (company != null) {
    // 正常业务逻辑
} else {
    // 空值处理逻辑
}

2. 精准局部抑制Sonar规则 #

不在整个方法上添加抑制注解，而是仅在空判断相关的代码位置添加，精准屏蔽单条规则的警告：

Company company = externalLibraryInstance.getCompany(companyKey);
// 仅抑制当前空判断的java:S2583警告
@SuppressWarnings("java:S2583")
if (company != null) {
    // 正常业务逻辑
} else {
    // 空值处理逻辑
}

也可以直接在变量声明处添加抑制，覆盖外部库的@NotNull对静态分析的影响：

// 仅抑制当前变量的java:S2583警告
@SuppressWarnings("java:S2583")
Company company = externalLibraryInstance.getCompany(companyKey);
if (company != null) {
    // 正常业务逻辑
}

3. 自定义空判断工具方法 #

通过自定义一个简单的空判断工具方法，让静态分析工具无法确定条件的恒定性，从而避免标记死代码：

// 自定义工具类中的方法，无需添加任何注解
public static <T> boolean isNotNull(T obj) {
    return obj != null;
}

// 业务代码中调用工具方法
Company company = externalLibraryInstance.getCompany(companyKey);
if (isNotNull(company)) {
    // 正常业务逻辑
} else {
    // 空值处理逻辑
}

静态分析工具通常不会深入解析自定义工具方法的实现细节，会默认认为该条件可能为true或false，因此不会将空判断标记为死代码。

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