代码整洁之道【6】-- 错误处理

很多程序完全由错误处理所占据，导致几乎看不明白代码所做的事。
这一章来学一下编写整洁又鲁棒的

一、使用异常而非返回状态码

早期有些语言不支持异常，所以只能用错误标识或者返回给调用者状态码。

这类手段的问题：他们搞乱了调用者代码。什么意思呢？就是调用者调用这个函数之后需要立马检查错误，根据状态码处理相应逻辑。但是这个步骤很容易在编程的时候被遗忘。所以，最好用异常的解决方法来做，比如遇到错误抛出异常。

二、先写try-catch-finally语句

在编写可能抛出异常的代码时，先写try-Catch-Finally语句；

三、使用不可控异常（unchecked exception）

关于到底是使用unchecked exception还是checked exception，我觉得并不能一概而论。因为这两种类型的exception各有优缺点。

使用checked exception的代价就是违反开放/闭合原则。如果你在方法中抛出checked exception，而catch语句在三个层级之上，你就得在catch语句和抛出异常处之间的每个方法签名中声明该异常。

使用unchecked exception的话，程序员自己容易忘记处理导致发生RuntimeException，因为编译器并不强制程序员捕获或传播unchecked exception。

四、给出异常发生的环境说明

应创建信息充分的错误消息，并和异常一起传递出去，以便判断错误的来源和原因，方便问题定位；

五、依调用者需要定义异常类

看如下两段代码：

// bad practice
ACMEPort port = new ACMEPort(12);
try {
    port.open();
} catch(DeviceResponseException e) {
    reportPortError(e);
    logger.log("Device response exception",e);
} catch(ATM1212UnlockedException e) {
    reportPortError(e);
    logger.log("Unlock exception",e);
} catch(GMXError e) {
    reportPortError(e);
    logger.log("Device response exception",e);
} finally {
    // .....
}

上面的代码段包含了一大堆重复的代码。其实我们可以通过打包调用API，让它返回通用的自定义异常类型（本例中是：PortDeviceFailure），从而简化代码。

// good practice
LocalPort port = new LocalPort(12);
try {
    port.open();
} catch(PortDeviceFailure e) {
    reportError(e);
    logger.log(e.getMessage(),e);
} finally {
    // .....
}

public class LocalPort{
 private ACMEPort innerPort;
 
 public LocalPort(int portNumber){
     innerPort = new ACMEPort(portNumber);
 }
 
 public open() {
  try {
       innerPort.open();
   } catch(DeviceResponseException e) {
           // 自定义的异常类
       throw new PortDeviceFailure(e);
   } catch(ATM1212UnlockedException e) {
       throw new PortDeviceFailure(e);
   } catch(GMXError e) {
       throw new PortDeviceFailure(e);
   }
 }
}

将第三方API打包是个良好的实践手段。当你打包一个第三方API时，你就降低了对它的依赖：未来你可以不太痛苦地改用其他代码库。（因为你打包了，依赖第三方代码的点就会相对比较集中，方便修改）

六、定义常规流程

创建一个类或配置一个对象，用来处理特例。

你来处理特例，客户代码就不需要应付异常行为了。异常行为被封装到特例对象中了。

七、别返回null值

千万别返回null值，返回null值基本上是在给自己增加工作量，也是在给调用添乱。只要有一处没检查null值，应用程序就会失控。

如果你打算在方法中返回null值，不如抛出异常，或是返回特例对象。如果你在调用某个第三方API中可能返回null值的方法，可以考虑用新方法打包原有的方法，在新方法中抛出异常或返回特例对象。

在许多情况下，特例对象都是一种良好的解决方案。设想有这么一段代码：

List employees = getEmployees();
if(employees != null){
    for(Employee e : employees){
        totalPay += e.getPay();
    }
}

现在getEmployees()可能返回null，如果把返回null改成返回空列表，那判空语句就可以省略了：

List employees = getEmployees();
for(Employee e : employees){
    totalPay += e.getPay();
}

八、别传递null值

千万别将null值传递给其他方法，除非API要求你向它传递null值。
解释一下：如果允许传递null值，需要在方法里做各种非空判断。如果不做大量非空检查，会出现运行时错误。

在大多数编程语言中，没有良好的方法能对付由调用者意外传入的null值。恰当的做法是，禁止传入null值。

参考
《代码整洁之道》