<menu id="ycqsw"></menu><nav id="ycqsw"><code id="ycqsw"></code></nav>
<dd id="ycqsw"><menu id="ycqsw"></menu></dd>
    • <nav id="ycqsw"></nav>
    <menu id="ycqsw"><strong id="ycqsw"></strong></menu>
    <xmp id="ycqsw"><nav id="ycqsw"></nav>
    1. 長城號首頁
    2. 投稿

    java編碼規范有哪些（阿里巴巴java編碼規范）

    長城號SEO專員 ? ? 投稿

    本文總結了一套與Java函數相關的編碼規則，旨在給廣大Java程序員一些編碼建議，有助于大家編寫出更優雅、更高質、更高效的代碼。

    上文鏈接：link

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

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

    現象描述：

    // 調用代碼
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;
}

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

    現象描述：

    // 獲取訂單總額函數
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)編程。

    主要收益

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

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

    案例一：盡量避免返回的數組為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;
}

    案例二：盡量避免返回的列表為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;
}

    主要收益

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

    封裝函數傳入參數

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

    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;
}

    當傳入成組參數時，應封裝為參數類

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

    現象描述：

    // 獲取距離函數
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;
}

    主要收益

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

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

    Java匿名內部類的優缺點:

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

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

    案例一：盡量用函數替換匿名內部類（包括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)代替匿名內部類實現。

    案例二：拆分復雜匿名內部類實現接口為多個函數類接口

    如果一個匿名內部類實現的接口幾個函數間關聯性不大，可以把這個接口拆分為幾個函數式接口，便于使用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);
}

    主要收益

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

    利用return精簡不必要的代碼

    案例一：刪除不必要的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;
}

    案例二：刪除不必要的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);
}

    案例三：刪除不必要的變量

    現象描述：

    // 查詢用戶函數
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);
}

    主要收益

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

    利用臨時變量優化代碼

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

    案例一：利用臨時變量厘清邏輯

    現象描述：

    // 是否土豪用戶函數
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;
}

    這個方案，增加了代碼行數，但是邏輯更清晰。

    有時候，當代碼的精簡性和可讀性發生沖突時，個人更偏向于保留代碼的可讀性。

    案例二：利用臨時變量精簡代碼

    現象描述：

    // 構建用戶函數
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;
}

    主要收益

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

    僅保留函數需要的參數

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

    案例一：刪除多余的參數

    現象描述：

    // 修改用戶狀態函數
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);
}

    案例二：用屬性取代對象

    現象描述：

    // 刪除用戶函數
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個，可以不必使用該規則。

    主要收益

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

    后記

    “眾人拾柴火焰高”。如果有更多更好的觀點，亦或有更好的代碼案例，歡迎大家進行補充說明。筆者希望以此文拋磚引玉，如果最終形成一套完善的Java編碼規范，善莫大焉。

    贊 (0)

    相關推薦

    版權聲明：本文內容由互聯網用戶自發貢獻，該文觀點僅代表作者本人。本站僅提供信息存儲空間服務，不擁有所有權，不承擔相關法律責任。如發現本站有涉嫌抄襲侵權/違法違規的內容， 請發送郵件至 舉報，一經查實，本站將立刻刪除。

    發表評論

    登錄后才能評論
    国产精品区一区二区免费