clean code之代码可维护性_write clean code

错误处理是十分必要的，但是如果对错误处理使用不当则会让代码变得十分臃肿，让阅读者看不清代码的逻辑，更严重的是，这也会让程序变得十分脆弱。本文中将列出一些使用错误处理的技巧，帮助你写出既简洁又健壮的代码。

使用Exception而不是返回码

返回码是一个历史遗留问题，在以前的没有Exception的语言（比如c语言）中，它是有效且必要的，但是在有Exception的语言中使用返回码是没有任何益处的。

对于使用返回码的函数，调用者在得到调用结果（这里是返回码）之后要立即去验证返回码，这对于代码的可读性和结构的合理性都是极大的挑战，使用「异常处理」能让业务逻辑和错误处理在代码结构上分离，代码的结构和逻辑会更清晰。

首先把try-catch-finally块写出来

当遇到需要做异常处理的时候，首先把try-catch-finally块写出来，这能帮助你写出更好的异常处理代码。

永远使用unchecked异常

这又是一个非常有争议性的话题，到底是使用checked异常，还是unchecked异常。

_checked异常（通常是Exception的子类）是Java中的一个概念，它是指如果一个方法抛出此异常，那么它就必须被显式地捕获或者传递，通常是在方法上添加声明。

unchecked异常指的是可能随时抛出的异常（通常是RuntimeException，Error，和他们的子类）。

推荐阅读：Unchecked Exceptions — The Controversy，在这篇Oracle的官方指南中讲到：如果你要从某个异常中恢复，那么就使用checked异常，否则使用unchecked异常，意思就是unchecked的异常表示系统出问题了，那么必须停下来，去检查到底什么问题，然后解决。_

作者的观点是：如果在某些特殊的情况下必须要捕获异常并作出处理，那么不得不使用checked异常。但是在通常的开发过程中应当避免使用checked异常。

checked异常的使用确实带来了一些好处，但是也同时也造成了一些问题，最重要的是它违反了「开闭」原则。比如如果一个方法抛出某个checked异常，而这个异常的处理（通常是catch）是在3个方法调用层级之上，那么当你修改最底层这个方法的抛出异常时，所有在这个调用链中的方法签名都需要被修改。这明显违反了「对修改关闭」的原则，也违反了面向对象中「封装内部实现」的特性。

提供异常的上下文

在异常中一定要提供可供这个异常的捕获者（通常是在catch中）用来分辨这个异常的上下文信息，使之可以通过log或其他方式最终呈现出来。

按照调用者的需求定义异常类

当我们定义一个异常类时，可以按照这个异常类所属的模块，抑或是这个异常类的类型来定义，但是当我们在程序中定义一个异常类时，更多的则应该是在考虑「这个异常会在什么情况下被捕获」。代码6-1中展示了普通的按照类型定义的异常类，

//代码6-1 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"); } finally {... } 

代码6-2中展示了使用一个包装类定义的一个新的异常类，不仅代码看起来更加清晰简单，而且还会带来更多其他的好处。

//代码6-2 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 void 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); } } ... } 

像代码6-2中那样对于第三方的类库中的API进行封装会带来很多好处。实际上，封装第三方API可以算是一种最佳实践。

当你在你的项目中对第三方类库进行了自己的封装之后，相当于解耦了你的项目和这个第三方类库，你可以轻易的将这个类库更换掉，更重要的是，你可以不需要一定遵循这个类库的设计来使用它，比如代码6-2中所示的，本来类库中定义了多个重合

定义常规流程

虽然我们可以写出很好的错误处理代码，它们外形优雅、结构清晰，但是有时候我们并不是想要「终止代码的逻辑流程」而抛出异常，这种情况就不要使用异常类来处理，应该使用更常规的流程来处理，比如代码6-3中异常处理。

//代码6-3 try { MealExpenses expenses = expenseReportDAO.getMeals(employee.getID()); m_total += expenses.getTotal(); } catch(MealExpensesNotFound e) { m_total += getMealPerDiem(); } 

代码6-3中的错误处理只是为了处理一种特殊状况（可能是数据库中找不到此次吃饭的消费情况），而不是要中止计算而抛出异常，那么它可以被重构为代码6-4中的样子。

//代码6-4 MealExpenses expenses = expenseReportDAO.getMeals(employee.getID()); m_total += expenses.getTotal(); //这里引入一个新的特殊情况的类 public class PerDiemMealExpenses implements MealExpenses { public int getTotal() { // return the per diem default } } 

这种编程模式被叫做特殊情况模式，它使用一个新的类来处理这种特殊情况，那么就不需要抛出异常类，因为在异常的情况下也会返回一个MealExpenses对象，那么整个流程看起来就和普通的业务流程一样了。

不要返回Null

Null是邪恶了，不要在代码中返回Null。

如果你的代码中有返回Null的情况，那么在代码的任何地方都可能抛出NullPointerException而导致系统崩溃退出，你的代码中也可能会存在一大堆的判断「一个对象是否为Null」的代码，这可能是所有开发者都不愿意看到的情况，可以使用代码6-4中所使用的特殊情况模式来避免返回Null，永远返回一个有值的对象。

不要传递Null

在函数调用的参数中传递Null是比返回Null更邪恶的事情。所以在你自己的代码中，永远不要传递Null。