Java函數優雅之道（上）

時間 2019-11-09

標籤 java 函數優雅之道欄目 Java 简体版

原文原文鏈接

導讀

隨着軟件項目代碼的日積月累，系統維護成本變得愈來愈高，是全部軟件團隊面臨的共同問題。持續地優化代碼，提升代碼的質量，是提高系統生命力的有效手段之一。軟件系統思惟有句話「Less coding, more thinking（少編碼、多思考）」，也有這麼一句俚語「Think more, code less（思考越多，編碼越少）」。因此，咱們在編碼中多思考多總結，努力提高本身的編碼水平，才能編寫出更優雅、更高質、更高效的代碼。程序員

本文總結了一套與Java函數相關的編碼規則，旨在給廣大Java程序員一些編碼建議，有助於你們編寫出更優雅、更高質、更高效的代碼。這套編碼規則，經過在高德採集部門的實踐，已經取得了不錯的成效。數據庫

使用通用工具函數

案例一

現象描述：apache

不完善的寫法：編程

thisName != null && thisName.equals(name);

更完善的寫法：框架

(thisName == name) || (thisName != null && thisName.equals(name));

建議方案：less

Objects.equals(name, thisName);

案例二

現象描述：ide

!(list == null || list.isEmpty());

建議方案：函數式編程

import org.apache.commons.collections4.CollectionUtils;
CollectionUtils.isNotEmpty(list);

主要收益

函數式編程，業務代碼減小，邏輯一目瞭然；
通用工具函數，邏輯考慮周全，出問題機率低。

拆分超大函數

當一個函數超過80行後，就屬於超大函數，須要進行拆分。函數

案例一：每個代碼塊均可以封裝爲一個函數

每個代碼塊必然有一個註釋，用於解釋這個代碼塊的功能。工具

若是代碼塊前方有一行註釋，就是在提醒你——能夠將這段代碼替換成一個函數，並且能夠在註釋的基礎上給這個函數命名。若是函數有一個描述恰當的名字，就不須要去看內部代碼到底是如何實現的。

現象描述：

// 每日生活函數
public void liveDaily() {
    // 吃飯
    // 吃飯相關代碼幾十行

    // 編碼
    // 編碼相關代碼幾十行

    // 睡覺
    // 睡覺相關代碼幾十行
}

建議方案：

// 每日生活函數
public void liveDaily() {
    // 吃飯
    eat();

    // 編碼
    code();

    // 睡覺
    sleep();
}

// 吃飯函數
private void eat() {
    // 吃飯相關代碼
}

// 編碼函數
private void code() {
    // 編碼相關代碼
}

// 睡覺函數
private void sleep() {
    // 睡覺相關代碼
}

案例二：每個循環體均可以封裝爲一個函數

現象描述：

// 生活函數
public void live() {
    while (isAlive) {
        // 吃飯
        eat();

        // 編碼
        code();

        // 睡覺
        sleep();
    }
}

建議方案：

// 生活函數
public void live() {
    while (isAlive) {
        // 每日生活
        liveDaily();
    }
}

// 每日生活函數
private void liveDaily() {
    // 吃飯
    eat();

    // 編碼
    code();

    // 睡覺
    sleep();
}

案例三：每個條件體均可以封裝爲一個函數

現象描述：

// 外出函數
public void goOut() {
    // 判斷是否週末
    // 判斷是否週末: 是週末則遊玩
    if (isWeekday()) {
        // 遊玩代碼幾十行
    }
    // 判斷是否週末: 非週末則工做
    else {
        // 工做代碼幾十行
    }
}

建議方案：

// 外出函數
public void goOut() {
    // 判斷是否週末
    // 判斷是否週末: 是週末則遊玩
    if (isWeekday()) {
        play();
    }
    // 判斷是否週末: 非週末則工做
    else {
        work();
    }
}

// 遊玩函數
private void play() {
    // 遊玩代碼幾十行
}

// 工做函數
private void work() {
    // 工做代碼幾十行
}

主要收益

函數越短小精悍，功能就越單一，每每生命週期較長；
一個函數越長，就越不容易理解和維護，維護人員不敢輕易修改；
在過長函數中，每每含有難以發現的重複代碼。

同一函數內代碼塊級別儘可能一致

案例一

現象描述：

// 每日生活函數
public void liveDaily() {
    // 吃飯
    eat();

    // 編碼
    code();

    // 睡覺
    // 睡覺相關代碼幾十行
}

很明顯，睡覺這塊代碼塊，跟eat（吃飯）和code（編碼）不在同一級別上，顯得比較突兀。若是把寫代碼比做寫文章，eat（吃飯）和code（編碼）是段落大意，而睡覺這塊代碼塊屬於一個詳細段落。而在liveDaily（每日生活）這個函數上，只須要寫出主要流程（段落大意）便可。

建議方案：

public void liveDaily() {
    // 吃飯
    eat();

    // 編碼
    code();

    // 睡覺
    sleep();
}

// 睡覺
private void sleep() {
    // 睡覺相關代碼
}

主要收益

函數調用代表用途，函數實現表達邏輯，井井有條便於理解；
不用層次的代碼塊放在一個函數中，容易讓人以爲代碼頭重腳輕。

封裝相同功能代碼爲函數

案例一：封裝相同代碼爲函數

現象描述：

// 禁用用戶函數
public void disableUser() {
    // 禁用黑名單用戶
    List<Long> userIdList = queryBlackUser();
    for (Long userId : userIdList) {
        User userUpdate = new User();
        userUpdate.setId(userId);
        userUpdate.setEnable(Boolean.FALSE);
        userDAO.update(userUpdate);
    }

    // 禁用過時用戶
    userIdList = queryExpiredUser();
    for (Long userId : userIdList) {
        User userUpdate = new User();
        userUpdate.setId(userId);
        userUpdate.setEnable(Boolean.FALSE);
        userDAO.update(userUpdate);
    }
}

建議方案：

// 禁用用戶函數
public void disableUser() {
    // 禁用黑名單用戶
    List<Long> userIdList = queryBlackUser();
    for (Long userId : userIdList) {
        disableUser(userId);
    }

    // 禁用過時用戶
    userIdList = queryExpiredUser();
    for (Long userId : userIdList) {
        disableUser(userId);
    }
}

// 禁用用戶函數
private void disableUser(Long userId) {
    User userUpdate = new User();
    userUpdate.setId(userId);
    userUpdate.setEnable(Boolean.FALSE);
    userDAO.update(userUpdate);
}

案例二：封裝類似代碼爲函數

封裝類似代碼爲函數，差別性經過函數參數控制。

現象描述：

// 經過工單函數
public void adoptOrder(Long orderId) {
    Order orderUpdate = new Order();
    orderUpdate.setId(orderId);
    orderUpdate.setStatus(OrderStatus.ADOPTED);
    orderUpdate.setAuditTime(new Date());
    orderDAO.update(orderUpdate);
}

// 駁回工單函數
public void rejectOrder(Long orderId) {
    Order orderUpdate = new Order();
    orderUpdate.setId(orderId);
    orderUpdate.setStatus(OrderStatus.REJECTED);
    orderUpdate.setAuditTime(new Date());
    orderDAO.update(orderUpdate);
}

建議方案：

// 經過工單函數
public void adoptOrder(Long orderId) {
    auditOrder(orderId, OrderStatus.ADOPTED);
}

// 駁回工單函數
public void rejectOrder(Long orderId) {
    auditOrder(orderId, OrderStatus.REJECTED);
}

// 審覈工單函數
private void auditOrder(Long orderId, OrderStatus orderStatus) {
    Order orderUpdate = new Order();
    orderUpdate.setId(orderId);
    orderUpdate.setStatus(orderStatus);
    orderUpdate.setAuditTime(new Date());
    orderDAO.update(orderUpdate);
}

主要收益

封裝公共函數，減小代碼行數，提升代碼質量；
封裝公共函數，使業務代碼更精煉，可讀性可維護性更強。

封裝獲取參數值函數

案例一

現象描述：

// 是否經過函數
public boolean isPassed(Long userId) {
    // 獲取經過閾值
    double thisPassThreshold = PASS_THRESHOLD;
    if (Objects.nonNull(passThreshold)) {
        thisPassThreshold = passThreshold;
    }

    // 獲取經過率
    double passRate = getPassRate(userId);

    // 判讀是否經過
    return passRate >= thisPassThreshold;
}

建議方案：

// 是否經過函數
public boolean isPassed(Long userId) {
    // 獲取經過閾值
    double thisPassThreshold = getPassThreshold();

    // 獲取經過率
    double passRate = getPassRate(userId);

    // 判讀是否經過
    return passRate >= thisPassThreshold;
}

// 獲取經過閾值函數
private double getPassThreshold() {
    if (Objects.nonNull(passThreshold)) {
        return passThreshold;
    }
    return PASS_THRESHOLD;
}

主要收益

把獲取參數值從業務函數中獨立，使業務邏輯更清晰；
封裝的獲取參數值爲獨立函數，能夠在代碼中重複使用。

經過接口參數化封裝相同邏輯

案例一

現象描述：

// 發送審覈員結算數據函數
public void sendAuditorSettleData() {
    List<WorkerSettleData> settleDataList = auditTaskDAO.statAuditorSettleData();
    for (WorkerSettleData settleData : settleDataList) {
        WorkerPushData pushData = new WorkerPushData();
        pushData.setId(settleData.getWorkerId());
        pushData.setType(WorkerPushDataType.AUDITOR);
        pushData.setData(settleData);
        pushService.push(pushData);
    }
}

// 發送驗收員結算數據函數
public void sendCheckerSettleData() {
    List<WorkerSettleData> settleDataList = auditTaskDAO.statCheckerSettleData();
    for (WorkerSettleData settleData : settleDataList) {
        WorkerPushData pushData = new WorkerPushData();
        pushData.setId(settleData.getWorkerId());
        pushData.setType(WorkerPushDataType.CHECKER);
        pushData.setData(settleData);
        pushService.push(pushData);
    }
}

建議方案：

// 發送審覈員結算數據函數
public void sendAuditorSettleData() {
    sendWorkerSettleData(WorkerPushDataType.AUDITOR, () -> auditTaskDAO.statAuditorSettleData());
}

// 發送驗收員結算數據函數
public void sendCheckerSettleData() {
    sendWorkerSettleData(WorkerPushDataType.CHECKER, () -> auditTaskDAO.statCheckerSettleData());
}

// 發送做業員結算數據函數
public void sendWorkerSettleData(WorkerPushDataType dataType, WorkerSettleDataProvider dataProvider) {
    List<WorkerSettleData> settleDataList = dataProvider.statWorkerSettleData();
    for (WorkerSettleData settleData : settleDataList) {
        WorkerPushData pushData = new WorkerPushData();
        pushData.setId(settleData.getWorkerId());
        pushData.setType(dataType);
        pushData.setData(settleData);
        pushService.push(pushData);
    }
}

// 做業員結算數據提供者接口
private interface WorkerSettleDataProvider {
    // 統計做業員結算數據
    public List<WorkerSettleData> statWorkerSettleData();
}

主要收益

把核心邏輯從各個業務函數中抽析，使業務代碼更清晰更易維護；
避免重複性代碼屢次編寫，精簡重複函數越多收益越大。

減小函數代碼層級

若是要使函數優美，建議函數代碼層級在1-4之間，過多的縮進會讓函數難以閱讀。

案例一：利用return提早返回函數

現象描述：

// 獲取用戶餘額函數
public Double getUserBalance(Long userId) {
    User user = getUser(userId);
    if (Objects.nonNull(user)) {
        UserAccount account = user.getAccount();
        if (Objects.nonNull(account)) {
            return account.getBalance();
        }
    }
    return null;
}

建議方案：

// 獲取用戶餘額函數
public Double getUserBalance(Long userId) {
    // 獲取用戶信息
    User user = getUser(userId);
    if (Objects.isNull(user)) {
        return null;
    }

    // 獲取用戶帳戶
    UserAccount account = user.getAccount();
    if (Objects.isNull(account)) {
        return null;
    }

    // 返回帳戶餘額
    return account.getBalance();
}

案例二：利用continue提早結束循環

現象描述：

// 獲取合計餘額函數
public double getTotalBalance(List<User> userList) {
    // 初始合計餘額
    double totalBalance = 0.0D;

    // 依次累加餘額
    for (User user : userList) {
        // 獲取用戶帳戶
        UserAccount account = user.getAccount();
        if (Objects.nonNull(account)) {
            // 累加用戶餘額
            Double balance = account.getBalance();
            if (Objects.nonNull(balance)) {
                totalBalance += balance;
            }
        }
    }

    // 返回合計餘額
    return totalBalance;
}

建議方案：

// 獲取合計餘額函數
public double getTotalBalance(List<User> userList) {
    // 初始合計餘額
    double totalBalance = 0.0D;

    // 依次累加餘額
    for (User user : userList) {
        // 獲取用戶帳戶
        UserAccount account = user.getAccount();
        if (Objects.isNull(account)) {
            continue;
        }

        // 累加用戶餘額
        Double balance = account.getBalance();
        if (Objects.nonNull(balance)) {
            totalBalance += balance;
        }
    }

    // 返回合計餘額
    return totalBalance;
}

特殊說明：

其它方式：在循環體中，先調用案例1的函數getUserBalance(獲取用戶餘額)，再進行對餘額進行累加。

在循環體中，建議最多使用一次continue。若是須要有使用屢次continue的需求，建議把循環體封裝爲一個函數。

案例三：利用條件表達式函數減小層級

請參考下一章的"案例2: 把複雜條件表達式封裝爲函數"

主要收益

代碼層級減小，代碼縮進減小；
模塊劃分清晰，方便閱讀維護。

封裝條件表達式函數

案例一：把簡單條件表達式封裝爲函數

現象描述：

// 獲取門票價格函數
public double getTicketPrice(Date currDate) {
    if (Objects.nonNull(currDate) && currDate.after(DISCOUNT_BEGIN_DATE)
        && currDate.before(DISCOUNT_END_DATE)) {
        return TICKET_PRICE * DISCOUNT_RATE;
    }
    return TICKET_PRICE;
}

建議方案：

// 獲取門票價格函數
public double getTicketPrice(Date currDate) {
    if (isDiscountDate(currDate)) {
        return TICKET_PRICE * DISCOUNT_RATE;
    }
    return TICKET_PRICE;
}

// 是否折扣日期函數
private static boolean isDiscountDate(Date currDate) {
    return Objects.nonNull(currDate) && 
currDate.after(DISCOUNT_BEGIN_DATE)
        && currDate.before(DISCOUNT_END_DATE);
}

案例二：把複雜條件表達式封裝爲函數

現象描述：

// 獲取土豪用戶列表
public List<User> getRichUserList(List<User> userList) {
    // 初始土豪用戶列表
    List<User> richUserList = new ArrayList<>();

    // 依次查找土豪用戶
    for (User user : userList) {
        // 獲取用戶帳戶
        UserAccount account = user.getAccount();
        if (Objects.nonNull(account)) {
            // 判斷用戶餘額
            Double balance = account.getBalance();
            if (Objects.nonNull(balance) && balance.compareTo(RICH_THRESHOLD) >= 0) {
                // 添加土豪用戶
                richUserList.add(user);
            }
        }
    }

    // 返回土豪用戶列表
    return richUserList;
}

建議方案：

// 獲取土豪用戶列表
public List<User> getRichUserList(List<User> userList) {
    // 初始土豪用戶列表
    List<User> richUserList = new ArrayList<>();

    // 依次查找土豪用戶
    for (User user : userList) {
        // 判斷土豪用戶
        if (isRichUser(user)) {
            // 添加土豪用戶
            richUserList.add(user);
        }
    }

    // 返回土豪用戶列表
    return richUserList;
}

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

以上代碼也能夠用採用流式(Stream)編程的過濾來實現。

主要收益

把條件表達式從業務函數中獨立，使業務邏輯更清晰；
封裝的條件表達式爲獨立函數，能夠在代碼中重複使用。

儘可能避免沒必要要的空指針判斷

本章只適用於項目內部代碼，而且是本身瞭解的代碼，纔可以儘可能避免沒必要要的空指針判斷。對於第三方中間件和系統接口，必須作好空指針判斷，以保證代碼的健壯性。

案例一：調用函數保證參數不爲空，被調用函數儘可能避免沒必要要的空指針判斷

現象描述：

// 建立用戶信息
User user = new User();
... // 賦值用戶相關信息
createUser(user);

// 建立用戶函數
private void createUser(User user){
    // 判斷用戶爲空
    if(Objects.isNull(user)) {
        return;
    }

    // 建立用戶信息
    userDAO.insert(user);
    userRedis.save(user);
}

建議方案：

// 建立用戶信息
User user = new User();
... // 賦值用戶相關信息
createUser(user);

// 建立用戶函數
private void createUser(User user){
    // 建立用戶信息
    userDAO.insert(user);
    userRedis.save(user);
}

案例二：被調用函數保證返回不爲空,調用函數儘可能避免沒必要要的空指針判斷

現象描述：

// 保存用戶函數
public void saveUser(Long id, String name) {
    // 構建用戶信息
    User user = buildUser(id, name);
    if (Objects.isNull(user)) {
        throw new BizRuntimeException("構建用戶信息爲空");
    }

    // 保存用戶信息
    userDAO.insert(user);
    userRedis.save(user);
}

// 構建用戶函數
private User buildUser(Long id, String name) {
    User user = new User();
    user.setId(id);
    user.setName(name);
    return user;
}

建議方案：

// 保存用戶函數
public void saveUser(Long id, String name) {
    // 構建用戶信息
    User user = buildUser(id, name);

    // 保存用戶信息
    userDAO.insert(user);
    userRedis.save(user);
}

// 構建用戶函數
private User buildUser(Long id, String name) {
    User user = new User();
    user.setId(id);
    user.setName(name);
    return user;
}

案例三：賦值邏輯保證列表數據項不爲空，處理邏輯儘可能避免沒必要要的空指針判斷

現象描述：

// 查詢用戶列表
List<UserDO> userList = userDAO.queryAll();
if (CollectionUtils.isEmpty(userList)) {
    return;
}

// 轉化用戶列表
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);
}

// 依次處理用戶
for (UserVO userVo : userVoList) {
    // 判斷用戶爲空
    if (Objects.isNull(userVo)) {
        continue;
    }

    // 處理相關邏輯
    ...
}

建議方案：

// 查詢用戶列表
List<UserDO> userList = userDAO.queryAll();
if (CollectionUtils.isEmpty(userList)) {
    return;
}

// 轉化用戶列表
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);
}

// 依次處理用戶
for (UserVO userVo : userVoList) {
    // 處理相關邏輯
    ...
}

案例四：MyBatis查詢函數返回列表和數據項不爲空，能夠不用空指針判斷

MyBatis是一款優秀的持久層框架，是在項目中使用的最普遍的數據庫中間件之一。經過對MyBatis源碼進行分析，查詢函數返回的列表和數據項都不爲空，在代碼中能夠不用進行空指針判斷。

現象描述：

這種寫法沒有問題，只是過於保守了。

// 查詢用戶函數
public List<UserVO> queryUser(Long id, String name) {
    // 查詢用戶列表
    List<UserDO> userList = userDAO.query(id, name);
    if (Objects.isNull(userList)) {
        return Collections.emptyList();
    }

    // 轉化用戶列表
    List<UserVO> voList = new ArrayList<>(userList.size());
    for (UserDO user : userList) {
        // 判斷對象爲空
        if (Objects.isNull(user)) {
            continue;
        }

        // 添加用戶信息
        UserVO vo = new UserVO();
        BeanUtils.copyProperties(user, vo);
        voList.add(vo);
    }

    // 返回用戶列表
    return voList;
}

建議方案：

// 查詢用戶函數
public List<UserVO> queryUser(Long id, String name) {
    // 查詢用戶列表
    List<UserDO> userList = userDAO.query(id, name);

    // 轉化用戶列表
    List<UserVO> voList = new ArrayList<>(userList.size());
    for (UserDO user : userList) {
        UserVO vo = new UserVO();
        BeanUtils.copyProperties(user, vo);
        voList.add(vo);
    }

    // 返回用戶列表
    return voList;
}

主要收益

避免沒必要要的空指針判斷，精簡業務代碼處理邏輯，提升業務代碼運行效率；
這些沒必要要的空指針判斷，基本屬於永遠不執行的Death代碼，刪除有助於代碼維護。

本文內容參考自高德代碼規範。

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。