提高代码质量，从观念到实践--Clean Code 培训总结

小鱼儿 2022-05-14 00:59 230阅读 0赞

## 编程价值观 ##

之前我总是认为好的代码精简是第一位，这样才够“优雅”，我写20行代码的功能，别人10行就能实现就是比我厉害。但在工程的世界，程序员写代码不只是给自己看的，还要考虑到后面会有同事要来维护你的代码。因此什么是好代码要重新定义：**不应该追求代码行数最少，而应该将阅读代码所用时间最少作为第一位**。  
下面列出的这些组织代码原则可以帮助实现这一核心目标：

*  公有方法应该像目录一样，展示的是流程逻辑，具体实现封装为私有方法
 *  查询与操作分离
 *  一行代码只做一件事
 *  一个方法只做一件事。不要抽象出 queryDataAndPrint()这种方法
 *  一个循环中只做一件事
 *  每个变量只用于单一用途
 *  嵌套深度不超过3层
 *  一个方法长度不超过30行

> 经常说：所有那些函数调用都增加了不必要的负担。事实上，一流的编辑器优化通常会自动把短的代码段转成内联函数。在现代的计算机上，函数调用的代价接近于0.

## 编程技巧（干货） ##

下面介绍一些具体的提升代码质量的技巧。

### 1, 使用卫语句 ###

Replace Nested Conditional with Guard Clauses （以卫语句取代嵌套条件表达式）的精髓是：给某个分支以特别的重视。它告诉阅读者：这种情况很罕见，如果它真的发生了，请做一些必要的整理工作，然后退出。请对比下面两种写法:

// 多重嵌套，不好的实现
    double getPayAmount(){
        double result;
        if(_isDead){
            result = deadAmount();
        } else {
            if (_isSeparated){
                result = separatedAmount();
            } else {
                if (_isRetired){
                    result = retiredAmount();
                } else {
                    result = normalPayAmount()
                }
            }
        }
        return result;
    }

// 卫语句方式
    double getPayAmount(){
        if(_isDead){
            return deadAmount();
        }
        if(_isSeparated){
            return separatedAmount();
        }
        if(_isRetired){
            return retiredAmount();
        }
        return normalPayAmount();
    }

可以看出，使用卫语句把复杂的的条件表达式拆分成多个条件表达式后，结构清晰了很多。

### 2, 正常代码和异常处理分离 ###

先看一下你是不是也写过这样的代码，嵌套好几层的条件表达式，只为了拿到正常条件下的非空值

// 从第三方查询信息
    queryCustCashAmout(){
        QueryCustResponse response = thirdPartyFacade.getCustInfo();
        if(response != null) {
            CustomerLoanInfo cust = response.getCustLoanInfo();
            if(cust != null){
                return cust.getCashAmount();
            }
        }
        return -1;
    }

一种有效的方式是将正常的处理流程和异常的流程分离，看下面的代码是不是结构清晰多了

queryCustCashAmout(){
        try{
            QueryCustResponse response = thirdPartyFacade.getCustInfo();
            CustomerLoanInfo cust = response.getCustLoanInfo();
            return cust.getCashAmount();
        }catch(Exception e){
            log.error('查询客户现金额度异常',e);
            return -1;
        }
    }

### 3, 消除控制标记 ###

先看一段代码

这个方法中的index\_to\_remove就是控制标记，用来判断是否执行某个操作。它所带来的麻烦远超过它带来的便利。检查下你代码中有没有控制标记，去除他们条件语句真是的用途会清晰的多。

### 4, 封装第三方方法 ###

工程的世界中，需求总是在变得，代码也要跟着不停迭代。考虑到你使用的第三方方法也会更改，把它封装一下，这样第三方代码更改时你只需要更改一处。