如何优雅地进行错误处理(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
。
作者:TheAlchemist
链接:https://www.jianshu.com/p/b3760c7a0815
來源:简书
简书著作权归作者所有,任何形式的转载都请联系作者获得授权并注明出处。
如何优雅地进行错误处理(clean code阅读笔记之六)的更多相关文章
- “Clean Code” 读书笔记序
最近开始研读 Robert C.Martin 的 “Clean Code”,为了巩固学习,会把每一章的笔记整理到博客中.而这篇博文作为一个索引和总结,会陆续加入各章的笔记链接,以及全部读完后的心得体会 ...
- Clean Code读书笔记
第一章 整洁代码 1.编程要做什么 代码呈现了需求的细节,在某些层面上,这些细节无法被忽略或抽象,必须明确.而将需求明确到机器可以执行的细节程度,就是编程要做的事. 2.项目过程中经常遇到这样的问题: ...
- 《代码整洁之道》(Clean Code)- 读书笔记
一.关于Bob大叔的Clean Code <代码整洁之道>主要讲述了一系列行之有效的整洁代码操作实践.软件质量,不但依赖于架构及项目管理,而且与代码质量紧密相关.这一点,无论是敏捷开发流派 ...
- 《clean code》讲述代码中的道,而不是术
Clean code 看<clean code>一书,学习高手写出的代码,简单高效的代 1.目标 Bjarne Stroustrup:优雅且高效:直截了当:减少依赖:只做好一件事 Grad ...
- 代码整洁之道Clean Code笔记
@ 目录 第 1 章 Clean Code 整洁代码(3星) ?为什么要整洁的代码 ?什么叫做整洁代码 第 2 章 Meaningful Names 有意义的命名(3星) 第 3 章 Function ...
- Writing Clean Code 读后感
最近花了一些时间看了这本书,书名是 <Writing Clean Code ── Microsoft Techniques for Developing Bug-free C Programs& ...
- 《Clean Code》 代码简洁之道
作者介绍 原文作者: Robert C. Martin, Object Mentor公司总裁,面向对象设计.模式.UML.敏捷方法学和极限编程领域的资深顾问,是<敏捷软件开发:原则.模式.与实践 ...
- 聊聊clean code
clean code,顾名思义就是整洁的代码,或者说清晰.漂亮的代码,相信大多数工程师都希望自己能写出这样的代码. 也许这是个千人千面的话题,每个工程师都有自己的理解.比如我,从一个天天被骂代码写得烂 ...
- Clean Code之JavaScript代码示例
译者按: 简洁的代码可以避免写出过多的BUG. 原文: JavaScript Clean Code - Best Practices 译者: Fundebug 本文采用意译,版权归原作者所有 引文 作 ...
随机推荐
- http服务 WCF、Web API、Web service、WCF REST之间的区别
http服务 WCF.Web API.Web service.WCF REST之间的区别 在.net平台下,有大量的技术让你创建一个HTTP服务,像Web Service,WCF,现在又出了Web ...
- day5学python 基础+装饰器内容
基础+装饰器内容 递归特性# 1.必须有一个明确的结束条件# 2.每次进入更深一层递归时,问题规模相比上次递归应有所减少# 3.递归效率不高 def run(n): print(n) if int(n ...
- mysql主从服务器
#mysql主从服务器 mysql-bin.003673 | 106 查看错误日志show variables like '%log_error%'; replicate-do-table=testm ...
- Python基本数据类型集合、格式化、函数
一.变量总结 1.1 变量定义 记录某种状态或者数值,并用某个名称代表这个数值或状态. 1.2 变量在内存中的表现形式 Python 中一切皆为对象,数字是对象,列表是对象,函数也是对象,任何东西都是 ...
- 小程序tabBar显示问题
我一直在纠结为什么小程序在有的页面显示,有的页面不显示 查了一下才知道,小程序tabBar只在tabBar中的list定义了页面的才会显示,其余页面不会显示 如下例:tabBar只在画红框的页面显示
- springcloud微服务 总结一
一 什么是微服务 译文: 微服务架构是一种架构模式,它提倡将单一应用程序划分成一组小的服务,服务之间互相协调.互相配合,为用户提供最终价值.每个服务运行在其独立的进程中,服务与服务间采用轻量级的通信机 ...
- 递归缓存技术,缓存机制Memoization
先看一下代码: 再看一下执行时间: 可以看出第一个阶乘的执行时间是3ms,后面的由于缓存了之前的计算结果,所以直接返回结果. 原理就是缓存之前的计算,避免重复计算.关键在于建立缓存数组. 可以看一下执 ...
- js中的slice和splic
一:slice 的用法 slice() 用于数组方法可从已有的数组中返回选定的元素,也就是在该方法中指定的元素.该方法不会改变原数组,,返回值是一个新的数组. 选取的范围是 从 当前位(0) 开始(索 ...
- python之文件读写(1)
1. 从文件读取数据 关于对文件的操作,使用open(filename, mode),打开文件.与之对应的,close()用来关闭文件.对文件操作完毕切记要关闭. open函数参数: mode 参数有 ...
- CodeForces - 1110C-Meaningless Operation(打表找规律)
Can the greatest common divisor and bitwise operations have anything in common? It is time to answer ...