這程式碼寫的，狗屎一樣 （下）

• 2019 年 10 月 4 日
• 筆記

文章轉載自公眾號 高德技術 ， 作者 常意

上文背景

標題是交流群中讀者對接手程式碼的吐槽，程式碼品質對於系統維護、提升系統生命力非常重要，上文已經總結了一套與Java函數相關的編碼規則，旨在給廣大Java程式設計師一些編碼建議，有助於大家編寫出更優雅、更高質、更高效的程式碼。這篇文章繼續分享編碼規則，如果有不錯的建議可以留言區留言。

上文鏈接：這程式碼寫的，狗屎一樣

11.

內部函數參數盡量使用基礎類型

11.1 案例一：內部函數參數盡量使用基礎類型

現象描述：

// 調用程式碼  double price = 5.1D;  int number = 9;  double total = calculate(price, number);    // 計算金額函數  private double calculate(Double price, Integer number) {      return price * number;  }

建議方案：

// 調用程式碼  double price = 5.1D;  int number = 9;  double total = calculate(price, number);    // 計算金額函數  private double calculate(double price, int number) {      return price * number;  }

11.2 案例二：內部函數返回值盡量使用基礎類型

現象描述：

// 獲取訂單總額函數  public double getOrderAmount(List<Product> productList) {      double amount = 0.0D;      for (Product product : productList) {          if (Objects.isNull(product) || Objects.isNull(product.getPrice())              || Objects.isNull(product.getNumber())) {              continue;          }          amount += calculate(product.getPrice(), product.getNumber());      }      return amount;  }    // 計算金額函數  private Double calculate(double price, double number) {      return price * number;  }

建議方案：

// 獲取訂單總額函數  public double getOrderAmount(List<Product> productList) {      double amount = 0.0D;      for (Product product : productList) {          if (Objects.isNull(product) || Objects.isNull(product.getPrice())              || Objects.isNull(product.getNumber())) {              continue;          }          amount += calculate(product.getPrice(), product.getNumber());      }      return amount;  }    // 計算金額函數  private double calculate(double price, double number) {      return price * number;  }

此處只是舉例說明這種現象，更好的方式是採用流式(Stream)編程。

11.3 主要收益

• 內部函數盡量使用基礎類型，避免了隱式封裝類型的打包和拆包；
• 內部函數參數使用基礎類型，用語法上避免了內部函數的參數空指針判斷；
• 內部函數返回值使用基礎類型，用語法上避免了調用函數的返回值空指針判斷。

12.

盡量避免返回的數組和列表為null

12.1 案例一：盡量避免返回的數組為null，引起不必要的空指針判斷

現象描述：

// 調用程式碼  UserVO[] users = queryUser();  if (Objects.nonNull(users)) {      for (UserVO user : users) {          // 處理用戶資訊      }  }    // 查詢用戶函數  private UserVO[] queryUser() {      // 查詢用戶列表      List<UserDO> userList = userDAO.queryAll();      if (CollectionUtils.isEmpty(userList)) {          return null;      }        // 轉化用戶數組      UserVO[] users = new UserVO[userList.size()];      for (int i = 0; i < userList.size(); i++) {          UserDO user = userList.get(i);          users[i] = new UserVO();          users[i].setId(user.getId());          users[i].setName(user.getName());      }        // 返回用戶數組      return users;  }

建議方案：

// 調用程式碼  UserVO[] users = queryUser();  for (UserVO user : users) {      // 處理用戶資訊  }    // 查詢用戶函數  private UserVO[] queryUser() {      // 查詢用戶列表      List<UserDO> userList = userDAO.queryAll();      if (CollectionUtils.isEmpty(userList)) {          return new UserVO[0];      }        // 轉化用戶數組      UserVO[] users = new UserVO[userList.size()];      for (int i = 0; i < userList.size(); i++) {          UserDO user = userList.get(i);          users[i] = new UserVO();          users[i].setId(user.getId());          users[i].setName(user.getName());      }        // 返回用戶數組      return users;  }

12.2 案例二：盡量避免返回的列表為null，引起不必要的空指針判斷

現象描述：

// 調用程式碼  List<UserVO> userList = queryUser();  if (Objects.nonNull(userList)) {      for (UserVO user : userList) {          // 處理用戶資訊      }  }    // 查詢用戶函數  private List<UserVO> queryUser(){      // 查詢用戶列表      List<UserDO> userList = userDAO.queryAll();      if(CollectionUtils.isEmpty(userList)) {          return null;      }        // 轉化用戶列表      List<UserVO> userVoList = new ArrayList<>(userList.size());      for(UserDO user : userList) {          UserVO userVo = new UserVO();          userVo.setId(user.getId());          userVo.setName(user.getName());          userVoList.add(userVo);      }        // 返回用戶列表      return userVoList;  }

建議方案：

// 調用程式碼  List<UserVO> userList = queryUser();  for (UserVO user : userList) {     // 處理用戶資訊   }    // 查詢用戶函數  private List<UserVO> queryUser(){      // 查詢用戶列表      List<UserDO> userList = userDAO.queryAll();      if(CollectionUtils.isEmpty(userList)) {          return Collections.emptyList();      }        // 轉化用戶列表      List<UserVO> userVoList = new ArrayList<>(userList.size());      for(UserDO user : userList) {          UserVO userVo = new UserVO();          userVo.setId(user.getId());          userVo.setName(user.getName());          userVoList.add(userVo);      }        // 返回用戶列表      return userVoList;  }

12.3 主要收益

• 保證返回的數組和列表不為null, 避免調用函數的空指針判斷。

13.

封裝函數傳入參數

13.1 案例一：當傳入參數過多時，應封裝為參數類

Java規範不允許函數參數太多，不便於維護也不便於擴展。

現象描述：

// 修改用戶函數  public void modifyUser(Long id, String name, String phone, Integer age,      Integer sex, String address, String description) {      // 具體實現邏輯  }

建議方案：

// 修改用戶函數  public void modifyUser(User user) {      // 具體實現內容  }    // 用戶類  @Getter  @Setter  @ToString  private class User{      private Long id;      private String name;      private String phone;      private Integer age;      private Integer sex;      private String address;      private String description;  }

13.2 案例二：當傳入成組參數時，應封裝為參數類

既然參數成組出現，就需要封裝一個類去描述這種現象。

現象描述：

// 獲取距離函數  public double getDistance(double x1, double y1, double x2, double y2) {      // 具體實現邏輯  }

建議方案：

// 獲取距離函數  public double getDistance(Point point1, Point point2) {      // 具體實現邏輯  }    // 點類  @Getter  @Setter  @ToString  private class Point{      private double x;      private double y;  }

13.3 主要收益

• 封裝過多函數參數為類，使函數更便於擴展和維護；
• 封裝成組函數參數為類，使業務概念更明確更清晰。

14.

盡量用函數替換匿名內部類的實現

Java匿名內部類的優缺點: 在匿名內部類（包括Lambda表達式）中可以直接訪問外部類的成員，包括類的成員變數、函數的內部變數。正因為可以隨意訪問外部變數，所以會導致程式碼邊界不清晰。

首先推薦用Lambda表達式簡化匿名內部類，其次推薦用函數替換複雜的Lambda表達式的實現。

14.1 案例一：盡量用函數替換匿名內部類（包括Lambda表達式）的實現

現象描述：

// 發送結算數據  sendWorkerSettleData(WorkerPushDataType.CHECKER, () -> {      Date beginDate = DateUtils.addDays(currDate, -aheadDays);      Date endDate = DateUtils.addDays(currDate, 1);      return auditTaskDAO.statCheckerSettleData(beginDate, endDate);  });

建議方案：

// 發送結算數據  sendWorkerSettleData(WorkerPushDataType.CHECKER, () -> statCheckerSettleData(currDate, aheadDays));    // 統計驗收員結算數據函數  private List<WorkerSettleData> statCheckerSettleData(Date currDate, int aheadDays) {      Date beginDate = DateUtils.addDays(currDate, -aheadDays);      Date endDate = DateUtils.addDays(currDate, 1);      return auditTaskDAO.statCheckerSettleData(beginDate, endDate);  }

其實，還有一個更簡單的辦法。在調用函數sendWorkerSettleData（發送作業員結算數據）之前計算開始日期、結束日期，就直接可以用函數auditTaskDAO.statCheckerSettleData(beginDate, endDate)代替匿名內部類實現。

14.2 案例二：拆分複雜匿名內部類實現介面為多個函數類介面

如果一個匿名內部類實現的介面幾個函數間關聯性不大，可以把這個介面拆分為幾個函數式介面，便於使用Lambda表達式。

現象描述：

// 清除過期數據  cleanExpiredData("用戶日誌表", new CleanExpiredDataOperator() {      @Override      public List<Date> queryExpiredDate(Integer remainDays) {          return userDAO.queryExpiredDate(remainDays);      }      @Override      public void cleanExpiredData(Date expiredDate) {          userDAO.cleanExpiredData(expiredDate);      }  });    // 清除過期數據函數  private void cleanExpiredData(String tableName, CleanExpiredDataOperator ,  cleanExpiredDataOperator) {      // 功能實現程式碼  }    // 清除過期操作介面  interface CleanExpiredDataOperator {      // 查詢過期日期      public List<Date> queryExpiredDate(Integer remainDays);      // 清除過期數據      public void cleanExpiredData(Date expiredDate);  }

建議方案：

// 清除過期數據  cleanExpiredData("用戶日誌表", userDAO::queryExpiredDate,userDAO::cleanExpiredData);    // 清除過期數據函數  private void cleanExpiredData(String tableName, QueryExpiredDateOperator queryExpiredDateOperator, CleanExpiredDataOperator cleanExpiredDataOperator) {      // 功能實現程式碼  }    // 查詢過期日期介面  interface QueryExpiredDateOperator {      // 查詢過期日期      public List<Date> queryExpiredDate(Integer remainDays);  }    // 清除過期操作介面  interface CleanExpiredDataOperator {      // 清除過期數據      public void cleanExpiredData(Date expiredDate);  }

14.3 主要收益

• 定義函數並指定參數，明確規定了匿名內部類的程式碼邊界；
• 利用Lambda表達式簡化匿名內部類實現，使程式碼更簡潔。

15.

利用return精簡不必要的程式碼

15.1 案例一：刪除不必要的if

現象描述：

// 是否通過函數  public boolean isPassed(Double passRate) {      if (Objects.nonNull(passRate) && passRate.compareTo(PASS_THRESHOLD) >= 0) {          return true;      }      return false;  }

建議方案：

// 是否通過函數  public boolean isPassed(Double passRate) {      return Objects.nonNull(passRate) && passRate.compareTo(PASS_THRESHOLD) >= 0;  }

15.2 案例二：刪除不必要的else

現象描述：

// 結算工資函數  public double settleSalary(Long workId, int workDays) {      // 根據是否合格處理      if (isQualified(workId)) {          return settleQualifiedSalary(workDays);      } else {          return settleUnqualifiedSalary(workDays);      }  }

建議方案：

// 結算工資函數  public double settleSalary(Long workId, int workDays) {      // 根據是否合格處理      if (isQualified(workId)) {          return settleQualifiedSalary(workDays);      }      return settleUnqualifiedSalary(workDays);  }

15.3 案例三：刪除不必要的變數

現象描述：

// 查詢用戶函數  public List<UserDO> queryUser(Long id, String name) {      UserQuery userQuery = new UserQuery();      userQuery.setId(id);      userQuery.setName(name);      List<UserDO> userList = userDAO.query(userQuery);      return userList;  }

建議方案：

// 查詢用戶函數  public List<UserDO> queryUser(Long id, String name) {      UserQuery userQuery = new UserQuery();      userQuery.setId(id);      userQuery.setName(name);      return userDAO.query(userQuery);  }

15.4 主要收益

• 精簡不必要的程式碼，讓程式碼看起來更清爽

16.

利用臨時變數優化程式碼

在一些程式碼中，經常會看到a.getB().getC()…getN()的寫法，姑且叫做「函數的級聯調用」，程式碼健壯性和可讀性太差。建議：杜絕函數的級聯調用，利用臨時變數進行拆分，並做好對象空指針檢查。

16.1 案例一：利用臨時變數釐清邏輯

現象描述：

// 是否土豪用戶函數  private boolean isRichUser(User user) {      return Objects.nonNull(user.getAccount())          && Objects.nonNull(user.getAccount().getBalance())          && user.getAccount().getBalance().compareTo(RICH_THRESHOLD) >= 0;  }

這是精簡程式碼控的最愛，但是可讀性實在太差。

建議方案：

// 是否土豪用戶函數  private boolean isRichUser(User user) {      // 獲取用戶賬戶      UserAccount account = user.getAccount();      if (Objects.isNull(account)) {          return false;      }        // 獲取用戶餘額      Double balance = account.getBalance();      if (Objects.isNull(balance)) {          return false;      }        // 比較用戶餘額      return balance.compareTo(RICH_THRESHOLD) >= 0;  }

這個方案，增加了程式碼行數，但是邏輯更清晰。 有時候，當程式碼的精簡性和可讀性發生衝突時，個人更偏向於保留程式碼的可讀性。

16.2 案例二：利用臨時變數精簡程式碼

現象描述：

// 構建用戶函數  public UserVO buildUser(UserDO user) {      UserVO vo = new UserVO();      vo.setId(user.getId());      vo.setName(user.getName());      if (Objects.nonNull(user.getAccount())) {          vo.setBalance(user.getAccount().getBalance());          vo.setDebt(user.getAccount().getDebt());      }      return vo;  }

這麼寫，大約是為了節約一個臨時變數把。

建議方案：

// 構建用戶函數  public UserVO buildUser1(UserDO user) {      UserVO vo = new UserVO();      vo.setId(user.getId());      vo.setName(user.getName());      UserAccount account = user.getAccount();      if (Objects.nonNull(account)) {          vo.setBalance(account.getBalance());          vo.setDebt(account.getDebt());      }      return vo;  }

16.3 主要收益

• 利用臨時變數釐清邏輯，顯得業務邏輯更清晰；
• 利用臨時變數精簡程式碼，看變數名稱即知其義，減少了大量無用程式碼；
• 如果獲取函數比較複雜耗時，利用臨時變數可以提高運行效率；
• 利用臨時變數避免函數的級聯調用，可有效預防空指針異常。

17.

僅保留函數需要的參數

在一些程式碼中，經常會看到a.getB().getC()…getN()的寫法，姑且叫做「函數的級聯調用」，程式碼健壯性和可讀性太差。建議：杜絕函數的級聯調用，利用臨時變數進行拆分，並做好對象空指針檢查。

17.1 案例一：刪除多餘的參數

現象描述：

// 修改用戶狀態函數  private void modifyUserStatus(Long userId, Integer status, String unused) {      userCache.modifyStatus(userId, status);      userDAO.modifyStatus(userId, status);  }

其中，unused參數是無用參數。

建議方案：

// 修改用戶狀態函數  private void modifyUserStatus(Long userId, Integer status) {      userCache.modifyStatus(userId, status);      userDAO.modifyStatus(userId, status);  }

17.2 案例二：用屬性取代對象

現象描述：

// 刪除用戶函數  private void deleteUser(User user) {      userCache.delete(user.getId());      userDAO.delete(user.getId());  }

建議方案：

// 刪除用戶函數  private void deleteUser(Long userId) {      userCache.delete(userId);      userDAO.delete(userId);  }

建議方案：

調用函數時，參數對象不需要專門構建，而函數使用其屬性超過3個，可以不必使用該規則。

17.3 主要收益

• 僅保留函數需要的參數，明確了調用時需要賦值的參數，避免了調用時還要去構造些無用參數。

18.

後記

"眾人拾柴火焰高"。如果有更多更好的觀點，亦或有更好的程式碼案例，歡迎大家進行補充說明。

筆者希望以此文拋磚引玉，如果最終形成一套完善的Java編碼規範，善莫大焉。

（完）