Java函數(shù)的編碼規(guī)則有哪些

小編給大家分享一下Java函數(shù)的編碼規(guī)則有哪些，相信大部分人都還不怎么了解，因此分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后大有收獲，下面讓我們一起去了解一下吧！

內(nèi)部函數(shù)參數(shù)盡量使用基礎(chǔ)類(lèi)型

案例一：內(nèi)部函數(shù)參數(shù)盡量使用基礎(chǔ)類(lèi)型

現(xiàn)象描述：

// 調(diào)用代碼double price = 5.1D;
int number = 9;
double total = calculate(price, number);// 計(jì)算金額函數(shù)private double calculate(Double price, Integer number) {    return price * number;
}

建議方案：

// 調(diào)用代碼double price = 5.1D;
int number = 9;
double total = calculate(price, number);// 計(jì)算金額函數(shù)private double calculate(double price, int number) {    return price * number;
}

案例二：內(nèi)部函數(shù)返回值盡量使用基礎(chǔ)類(lèi)型

現(xiàn)象描述：

// 獲取訂單總額函數(shù)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;
}// 計(jì)算金額函數(shù)private Double calculate(double price, double number) {    return price * number;
}

建議方案：

// 獲取訂單總額函數(shù)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;
}// 計(jì)算金額函數(shù)private double calculate(double price, double number) {    return price * number;
}

此處只是舉例說(shuō)明這種現(xiàn)象，更好的方式是采用流式(Stream)編程。

主要收益

• 內(nèi)部函數(shù)盡量使用基礎(chǔ)類(lèi)型，避免了隱式封裝類(lèi)型的打包和拆包；

• 內(nèi)部函數(shù)參數(shù)使用基礎(chǔ)類(lèi)型，用語(yǔ)法上避免了內(nèi)部函數(shù)的參數(shù)空指針判斷；

• 內(nèi)部函數(shù)返回值使用基礎(chǔ)類(lèi)型，用語(yǔ)法上避免了調(diào)用函數(shù)的返回值空指針判斷。

盡量避免返回的數(shù)組和列表為null

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

現(xiàn)象描述：

// 調(diào)用代碼UserVO[] users = queryUser();if (Objects.nonNull(users)) {    for (UserVO user : users) {        // 處理用戶信息
    }
}// 查詢(xún)用戶函數(shù)private UserVO[] queryUser() {    // 查詢(xún)用戶列表
    List<UserDO> userList = userDAO.queryAll();    if (CollectionUtils.isEmpty(userList)) {        return null;
    }    // 轉(zhuǎn)化用戶數(shù)組
    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());
    }    // 返回用戶數(shù)組
    return users;
}

建議方案：

// 調(diào)用代碼UserVO[] users = queryUser();for (UserVO user : users) {    // 處理用戶信息}// 查詢(xún)用戶函數(shù)private UserVO[] queryUser() {    // 查詢(xún)用戶列表
    List<UserDO> userList = userDAO.queryAll();    if (CollectionUtils.isEmpty(userList)) {        return new UserVO[0];
    }    // 轉(zhuǎn)化用戶數(shù)組
    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());
    }    // 返回用戶數(shù)組
    return users;
}

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

現(xiàn)象描述：

// 調(diào)用代碼List<UserVO> userList = queryUser();if (Objects.nonNull(userList)) {    for (UserVO user : userList) {        // 處理用戶信息
    }
}// 查詢(xún)用戶函數(shù)private List<UserVO> queryUser(){    // 查詢(xún)用戶列表
    List<UserDO> userList = userDAO.queryAll();    if(CollectionUtils.isEmpty(userList)) {        return null;
    }    // 轉(zhuǎn)化用戶列表
    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;
}

建議方案：

// 調(diào)用代碼List<UserVO> userList = queryUser();for (UserVO user : userList) {   // 處理用戶信息
 }// 查詢(xún)用戶函數(shù)private List<UserVO> queryUser(){    // 查詢(xún)用戶列表
    List<UserDO> userList = userDAO.queryAll();    if(CollectionUtils.isEmpty(userList)) {        return Collections.emptyList();
    }    // 轉(zhuǎn)化用戶列表
    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;
}

主要收益

• 保證返回的數(shù)組和列表不為null, 避免調(diào)用函數(shù)的空指針判斷。

封裝函數(shù)傳入?yún)?shù)

案例一：當(dāng)傳入?yún)?shù)過(guò)多時(shí)，應(yīng)封裝為參數(shù)類(lèi)

Java規(guī)范不允許函數(shù)參數(shù)太多，不便于維護(hù)也不便于擴(kuò)展。

現(xiàn)象描述：

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

建議方案：

// 修改用戶函數(shù)public void modifyUser(User user) {    // 具體實(shí)現(xiàn)內(nèi)容}// 用戶類(lèi)@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;
}

當(dāng)傳入成組參數(shù)時(shí)，應(yīng)封裝為參數(shù)類(lèi)

既然參數(shù)成組出現(xiàn)，就需要封裝一個(gè)類(lèi)去描述這種現(xiàn)象。

現(xiàn)象描述：

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

建議方案：

// 獲取距離函數(shù)public double getDistance(Point point1, Point point2) {    // 具體實(shí)現(xiàn)邏輯}// 點(diǎn)類(lèi)@Getter
@Setter
@ToString
private class Point{
    private double x;
    private double y;
}

主要收益

• 封裝過(guò)多函數(shù)參數(shù)為類(lèi)，使函數(shù)更便于擴(kuò)展和維護(hù)；

• 封裝成組函數(shù)參數(shù)為類(lèi)，使業(yè)務(wù)概念更明確更清晰。

盡量用函數(shù)替換匿名內(nèi)部類(lèi)的實(shí)現(xiàn)

Java匿名內(nèi)部類(lèi)的優(yōu)缺點(diǎn):
在匿名內(nèi)部類(lèi)（包括Lambda表達(dá)式）中可以直接訪問(wèn)外部類(lèi)的成員，包括類(lèi)的成員變量、函數(shù)的內(nèi)部變量。正因?yàn)榭梢噪S意訪問(wèn)外部變量，所以會(huì)導(dǎo)致代碼邊界不清晰。

首先推薦用Lambda表達(dá)式簡(jiǎn)化匿名內(nèi)部類(lèi)，其次推薦用函數(shù)替換復(fù)雜的Lambda表達(dá)式的實(shí)現(xiàn)。

案例一：盡量用函數(shù)替換匿名內(nèi)部類(lèi)（包括Lambda表達(dá)式）的實(shí)現(xiàn)

現(xiàn)象描述：

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

建議方案：

// 發(fā)送結(jié)算數(shù)據(jù)sendWorkerSettleData(WorkerPushDataType.CHECKER, () -> statCheckerSettleData(currDate, aheadDays));// 統(tǒng)計(jì)驗(yàn)收員結(jié)算數(shù)據(jù)函數(shù)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);
}

其實(shí)，還有一個(gè)更簡(jiǎn)單的辦法。在調(diào)用函數(shù)sendWorkerSettleData（發(fā)送作業(yè)員結(jié)算數(shù)據(jù)）之前計(jì)算開(kāi)始日期、結(jié)束日期，就直接可以用函數(shù)auditTaskDAO.statCheckerSettleData(beginDate, endDate)代替匿名內(nèi)部類(lèi)實(shí)現(xiàn)。

案例二：拆分復(fù)雜匿名內(nèi)部類(lèi)實(shí)現(xiàn)接口為多個(gè)函數(shù)類(lèi)接口

如果一個(gè)匿名內(nèi)部類(lèi)實(shí)現(xiàn)的接口幾個(gè)函數(shù)間關(guān)聯(lián)性不大，可以把這個(gè)接口拆分為幾個(gè)函數(shù)式接口，便于使用Lambda表達(dá)式。

現(xiàn)象描述：

// 清除過(guò)期數(shù)據(jù)cleanExpiredData("用戶日志表", new CleanExpiredDataOperator() {
    @Override
    public List<Date> queryExpiredDate(Integer remainDays) {        return userDAO.queryExpiredDate(remainDays);
    }
    @Override
    public void cleanExpiredData(Date expiredDate) {
        userDAO.cleanExpiredData(expiredDate);
    }
});// 清除過(guò)期數(shù)據(jù)函數(shù)private void cleanExpiredData(String tableName, CleanExpiredDataOperator ,
cleanExpiredDataOperator) {    // 功能實(shí)現(xiàn)代碼}// 清除過(guò)期操作接口interface CleanExpiredDataOperator {    // 查詢(xún)過(guò)期日期
    public List<Date> queryExpiredDate(Integer remainDays);    // 清除過(guò)期數(shù)據(jù)
    public void cleanExpiredData(Date expiredDate);
}

建議方案：

// 清除過(guò)期數(shù)據(jù)cleanExpiredData("用戶日志表", userDAO::queryExpiredDate,userDAO::cleanExpiredData);// 清除過(guò)期數(shù)據(jù)函數(shù)private void cleanExpiredData(String tableName, QueryExpiredDateOperator queryExpiredDateOperator, CleanExpiredDataOperator cleanExpiredDataOperator) {    // 功能實(shí)現(xiàn)代碼}// 查詢(xún)過(guò)期日期接口interface QueryExpiredDateOperator {    // 查詢(xún)過(guò)期日期
    public List<Date> queryExpiredDate(Integer remainDays);
}// 清除過(guò)期操作接口interface CleanExpiredDataOperator {    // 清除過(guò)期數(shù)據(jù)
    public void cleanExpiredData(Date expiredDate);
}

主要收益

• 定義函數(shù)并指定參數(shù)，明確規(guī)定了匿名內(nèi)部類(lèi)的代碼邊界；

• 利用Lambda表達(dá)式簡(jiǎn)化匿名內(nèi)部類(lèi)實(shí)現(xiàn)，使代碼更簡(jiǎn)潔。

利用return精簡(jiǎn)不必要的代碼

案例一：刪除不必要的if

現(xiàn)象描述：

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

建議方案：

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

案例二：刪除不必要的else

現(xiàn)象描述：

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

建議方案：

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

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

現(xiàn)象描述：

// 查詢(xún)用戶函數(shù)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;
}

建議方案：

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

主要收益

• 精簡(jiǎn)不必要的代碼，讓代碼看起來(lái)更清爽

利用臨時(shí)變量?jī)?yōu)化代碼

在一些代碼中，經(jīng)常會(huì)看到a.getB().getC()...getN()的寫(xiě)法，姑且叫做“函數(shù)的級(jí)聯(lián)調(diào)用”，代碼健壯性和可讀性太差。建議：杜絕函數(shù)的級(jí)聯(lián)調(diào)用，利用臨時(shí)變量進(jìn)行拆分，并做好對(duì)象空指針檢查。

案例一：利用臨時(shí)變量厘清邏輯

現(xiàn)象描述：

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

這是精簡(jiǎn)代碼控的最?lèi)?ài)，但是可讀性實(shí)在太差。

建議方案：

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

這個(gè)方案，增加了代碼行數(shù)，但是邏輯更清晰。
有時(shí)候，當(dāng)代碼的精簡(jiǎn)性和可讀性發(fā)生沖突時(shí)，個(gè)人更偏向于保留代碼的可讀性。

案例二：利用臨時(shí)變量精簡(jiǎn)代碼

現(xiàn)象描述：

// 構(gòu)建用戶函數(shù)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;
}

這么寫(xiě)，大約是為了節(jié)約一個(gè)臨時(shí)變量把。

建議方案：

// 構(gòu)建用戶函數(shù)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;
}

主要收益

• 利用臨時(shí)變量厘清邏輯，顯得業(yè)務(wù)邏輯更清晰；

• 利用臨時(shí)變量精簡(jiǎn)代碼，看變量名稱(chēng)即知其義，減少了大量無(wú)用代碼；

• 如果獲取函數(shù)比較復(fù)雜耗時(shí)，利用臨時(shí)變量可以提高運(yùn)行效率；

• 利用臨時(shí)變量避免函數(shù)的級(jí)聯(lián)調(diào)用，可有效預(yù)防空指針異常。

僅保留函數(shù)需要的參數(shù)

在一些代碼中，經(jīng)常會(huì)看到a.getB().getC()...getN()的寫(xiě)法，姑且叫做“函數(shù)的級(jí)聯(lián)調(diào)用”，代碼健壯性和可讀性太差。建議：杜絕函數(shù)的級(jí)聯(lián)調(diào)用，利用臨時(shí)變量進(jìn)行拆分，并做好對(duì)象空指針檢查。

案例一：刪除多余的參數(shù)

現(xiàn)象描述：

// 修改用戶狀態(tài)函數(shù)private void modifyUserStatus(Long userId, Integer status, String unused) {
    userCache.modifyStatus(userId, status);
    userDAO.modifyStatus(userId, status);
}
其中，unused參數(shù)是無(wú)用參數(shù)。
建議方案：// 修改用戶狀態(tài)函數(shù)private void modifyUserStatus(Long userId, Integer status) {
    userCache.modifyStatus(userId, status);
    userDAO.modifyStatus(userId, status);
}

案例二：用屬性取代對(duì)象

現(xiàn)象描述：

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

建議方案：

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

建議方案：

調(diào)用函數(shù)時(shí)，參數(shù)對(duì)象不需要專(zhuān)門(mén)構(gòu)建，而函數(shù)使用其屬性超過(guò)3個(gè)，可以不必使用該規(guī)則。

主要收益

僅保留函數(shù)需要的參數(shù)，明確了調(diào)用時(shí)需要賦值的參數(shù)，避免了調(diào)用時(shí)還要去構(gòu)造些無(wú)用參數(shù)。

以上是“Java函數(shù)的編碼規(guī)則有哪些”這篇文章的所有內(nèi)容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內(nèi)容對(duì)大家有所幫助，如果還想學(xué)習(xí)更多知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道！