公司剛入職了一名 Java 中級開發,短短 4 行程式碼居然湊齊了 3 個 bug!我哭了~~

Java技术栈發表於2024-05-27

作者:l拉不拉米
連結:https://juejin.cn/post/7031445206152577061

一、前言

公司剛入職了一名中級Java開發,經過一個星期的適應學習,各方面表現還不錯,於是分配了一個小的迭代給新人做。

需求很簡單,把從第三方拉取的資料匹配到自身公司後臺設定的渠道後,聚合到一個列表中,批次入庫。

然而就在匹配的邏輯中,上線後報了個NPE,這是作為一名中級開發不應犯的簡單錯誤,新人被我狠狠的訓了,記生產事故一次。

二、事故重現

虛擬碼

說明:虛擬碼並非真實線上程式碼,只是為了更方便,更形象的重現事故現場而編寫的;真實的業務場景往往更加複雜,NPE的漏洞隱藏在更深處,不易code view出來,也不易測試出來;生產環境NPE是較常見的異常,希望大家不要糾結為什麼測試沒測出來,關鍵還是透過這樣一個案例瞭解NPE的原因和解決方案。

// 後臺設定的渠道
String channelNo = channelDao.getOne().getChannelNo();
// 第三方拉取的資料
List<ThirdData> thirdDataList = httpClientUtils.getThirdDatas(DateUtils.today());
// 匹配過濾
thirdDataList.stream().filter(o ->channelNo.equals(o.getChannelNo())).collect(Collectors.toList());
// 批次入庫
thirdDataDao.saveAll(thirdDataList);

分析與解決

有經驗、技術紮實的同學看到這裡應該或多或少能發現問題了。其實啊,這四段程式碼是作者精心設計的,可謂是臥龍鳳雛😀😀。

短短四行程式碼居然湊齊了3個NPE,我枯了/(ㄒoㄒ)/~~

我們逐行分析:

第一行分析

channelDao.getOne()如果返回為null,那麼呼叫getChannelNo()會報NPE

解決辦法

1、使用防禦性程式設計,提前返回(需根據具體業務場景而定)

// 如果channelNo是方法邏輯執行的必須元素,推薦用此方法
Channel channel = channelDao.getOne();
if (channel == null) {
    return;
}

2、使用三目運算,返回空字串("")

// 返回兜底的空字串
String channelNo = channelDao.getOne() == null ? "" : channelDao.getOne().getChannelNo();

3、使用Optional函式,返回空字串("")

String channelNo = Optional.ofNullable(channelDao.getOne()).orElse("");

第三行分析(1)

thirdDataList如果為null,那麼呼叫stream()會報NPE

透過下面的原始碼截圖就能知道原因:

推薦一個開源免費的 Spring Boot 實戰專案:

https://github.com/javastacks/spring-boot-best-practice

解決辦法

1、使用防禦性程式設計,提前返回(推薦)

// 推薦使用集合工具類判空
if (CollectionUtils.isEmpty(thirdDataList)) {
    return;
}

2、使用if條件語句包裹(不推薦)

if (CollectionUtils.isNotEmpty(thirdDataList)) {
    // 執行後面的邏輯
}

第三行分析(2)

channelNo如果返回為null,那麼執行channelNo.equals(o.getChannelNo())會報NPE

我們知道,按Java的規範String的equals()方法的呼叫,要求左邊是確定值,就是為了避免呼叫方為null的情況。然而這裡呼叫方和equals的入參都是變數,這種情況該怎麼辦呢?

1、再加一句判斷:

channelNo != null && channelNo.equals(o.getChannelNo())

2、其實可以用java.uti包下的Objects類的equals方法

Objects.equals(channelNo, o.getChannelNo())

看原始碼一目瞭然,該方法對左邊的物件做了非空判斷

3、用其他開源的工具類庫或者自己實現

org.apache.commons.lang3.StringUtils
cn.hutool.core.util.StrUtil;

最後

在這裡l拉不拉米要推薦一款IDEA的外掛:

SonarLint

能動態的幫您檢查程式碼漏洞,像NPE這種程式碼風險都會給於相應的提示。

SonarLint還有一個大名鼎鼎的服務端叫SonarQube

更多文章推薦:

1.Spring Boot 3.x 教程,太全了!

2.2,000+ 道 Java面試題及答案整理(2024最新版)

3.免費獲取 IDEA 啟用碼的 7 種方式(2024最新版)

覺得不錯,別忘了隨手點贊+轉發哦!

相關文章