我们可以把函数的运行结果分为两类。一类是预期的结果,也就是函数在正常情况下输出的结果。一类是非预期的结果,也就是函数在异常(或叫出错)情况下输出的结果。比如,在上一节课中,获取本机名的函数,在正常情况下,函数返回字符串格式的本机名;在异常情况下,获取本机名失败,函数返回UnknownHostException异常对象。
在正常情况下,函数返回数据的类型非常明确,但是,在异常情况下,函数返回的数据类型却非常灵活,有多种选择。除了刚刚提到的类似UnknownHostException这样的异常对象之外,函数在异常情况下还可以返回错误码、NULL值、特殊值(比如-1)、空对象(比如空字符串、空集合)等。
每一种异常返回数据类型,都有各自的特点和适用场景。但有的时候,在异常情况下,函数到底该返回什么样的数据类型,并不那么容易判断。比如,上节课中,在本机名获取失败的时候,ID生成器的generate()函数应该返回什么呢?是异常?空字符?还是NULL值?又或者是其他特殊值(比如null-15293834874-fd3A9KBn,null表示本机名未获取到)呢?
函数是代码的一个非常重要的编写单元,而函数的异常处理,又是我们在编写函数的时候,时刻都要考虑的。所以,今天我们就聊一聊,如何设计函数在异常情况下的返回数据类型。
话不多说,让我们正式开始今天的学习吧!
上两节课中,我们把一份非常简单的ID生成器的代码,从“能用”重构成了“好用”。最终给出的代码看似已经很完美了,但是如果我们再用心推敲一下,代码中关于出错处理的方式,还有进一步优化的空间,值得我们拿出来再讨论一下。
为了方便你查看,我将上节课的代码拷贝到了这里。
public class RandomIdGenerator implements IdGenerator {private static final Logger logger = LoggerFactory.getLogger(RandomIdGenerator.class);@Overridepublic String generate() {String substrOfHostName = getLastFiledOfHostName();long currentTimeMillis = System.currentTimeMillis();String randomString = generateRandomAlphameric(8);String id = String.format("%s-%d-%s",substrOfHostName, currentTimeMillis, randomString);return id;}private String getLastFiledOfHostName() {String substrOfHostName = null;try {String hostName = InetAddress.getLocalHost().getHostName();substrOfHostName = getLastSubstrSplittedByDot(hostName);} catch (UnknownHostException e) {logger.warn("Failed to get the host name.", e);}return substrOfHostName;}@VisibleForTestingprotected String getLastSubstrSplittedByDot(String hostName) {String[] tokens = hostName.split("\\.");String substrOfHostName = tokens[tokens.length - 1];return substrOfHostName;}@VisibleForTestingprotected String generateRandomAlphameric(int length) {char[] randomChars = new char[length];int count = 0;Random random = new Random();while (count < length) {int maxAscii = 'z';int randomAscii = random.nextInt(maxAscii);boolean isDigit= randomAscii >= '0' && randomAscii <= '9';boolean isUppercase= randomAscii >= 'A' && randomAscii <= 'Z';boolean isLowercase= randomAscii >= 'a' && randomAscii <= 'z';if (isDigit|| isUppercase || isLowercase) {randomChars[count] = (char) (randomAscii);++count;}}return new String(randomChars);}}
这段代码中有四个函数。针对这四个函数的出错处理方式,我总结出下面这样几个问题。
对于上面这几个问题,你可以试着思考下,我先不做解答。等我们学完本节课的理论内容之后,我们下一节课再一块来分析。这一节我们重点讲解一些理论方面的知识。
关于函数出错返回数据类型,我总结了4种情况,它们分别是:错误码、NULL值、空对象、异常对象。接下来,我们就一一来看它们的用法以及适用场景。
C语言中没有异常这样的语法机制,因此,返回错误码便是最常用的出错处理方式。而在Java、Python等比较新的编程语言中,大部分情况下,我们都用异常来处理函数出错的情况,极少会用到错误码。
在C语言中,错误码的返回方式有两种:一种是直接占用函数的返回值,函数正常执行的返回值放到出参中;另一种是将错误码定义为全局变量,在函数执行出错时,函数调用者通过这个全局变量来获取错误码。针对这两种方式,我举个例子来进一步解释。具体代码如下所示:
// 错误码的返回方式一:pathname/flags/mode为入参;fd为出参,存储打开的文件句柄。int open(const char *pathname, int flags, mode_t mode, int* fd) {if (/*文件不存在*/) {return EEXIST;}if (/*没有访问权限*/) {return EACCESS;}if (/*打开文件成功*/) {return SUCCESS; // C语言中的宏定义:#define SUCCESS 0}// ...}//使用举例int fd;int result = open(“c:\test.txt”, O_RDWR, S_IRWXU|S_IRWXG|S_IRWXO, &fd);if (result == SUCCESS) {// 取出fd使用} else if (result == EEXIST) {//...} else if (result == EACESS) {//...}// 错误码的返回方式二:函数返回打开的文件句柄,错误码放到errno中。int errno; // 线程安全的全局变量int open(const char *pathname, int flags, mode_t mode){if (/*文件不存在*/) {errno = EEXIST;return -1;}if (/*没有访问权限*/) {errno = EACCESS;return -1;}// ...}// 使用举例int hFile = open(“c:\test.txt”, O_RDWR, S_IRWXU|S_IRWXG|S_IRWXO);if (-1 == hFile) {printf("Failed to open file, error no: %d.\n", errno);if (errno == EEXIST ) {// ...} else if(errno == EACCESS) {// ...}// ...}
实际上,如果你熟悉的编程语言中有异常这种语法机制,那就尽量不要使用错误码。异常相对于错误码,有诸多方面的优势,比如可以携带更多的错误信息(exception中可以有message、stack trace等信息)等。关于异常,我们待会还会非常详细地讲解。
在多数编程语言中,我们用NULL来表示“不存在”这种语义。不过,网上很多人不建议函数返回NULL值,认为这是一种不好的设计思路,主要的理由有以下两个。
我举个例子解释一下,具体代码如下所示:
public class UserService {private UserRepo userRepo; // 依赖注入public User getUser(String telephone) {// 如果用户不存在,则返回nullreturn null;}}// 使用函数getUser()User user = userService.getUser("18917718965");if (user != null) { // 做NULL值判断,否则有可能会报NPEString email = user.getEmail();if (email != null) { // 做NULL值判断,否则有可能会报NPEString escapedEmail = email.replaceAll("@", "#");}}
那我们是否可以用异常来替代NULL值,在查找用户不存在的时候,让函数抛出UserNotFoundException异常呢?
我个人觉得,尽管返回NULL值有诸多弊端,但对于以get、find、select、search、query等单词开头的查找函数来说,数据不存在,并非一种异常情况,这是一种正常行为。所以,返回代表不存在语义的NULL值比返回异常更加合理。
不过,话说回来,刚刚讲的这个理由,也并不是特别有说服力。对于查找数据不存在的情况,函数到底是该用NULL值还是异常,有一个比较重要的参考标准是,看项目中的其他类似查找函数都是如何定义的,只要整个项目遵从统一的约定即可。如果项目从零开始开发,并没有统一约定和可以参考的代码,那你选择两者中的任何一种都可以。你只需要在函数定义的地方注释清楚,让调用者清晰地知道数据不存在的时候会返回什么就可以了。
再补充说明一点,对于查找函数来说,除了返回数据对象之外,有的还会返回下标位置,比如Java中的indexOf()函数,用来实现在某个字符串中查找另一个子串第一次出现的位置。函数的返回值类型为基本类型int。这个时候,我们就无法用NULL值来表示不存在的情况了。对于这种情况,我们有两种处理思路,一种是返回NotFoundException,一种是返回一个特殊值,比如-1。不过,显然-1更加合理,理由也是同样的,也就是说“没有查找到”是一种正常而非异常的行为。
刚刚我们讲到,返回NULL值有各种弊端。应对这个问题有一个比较经典的策略,那就是应用空对象设计模式(Null Object Design Pattern)。关于这个设计模式,我们在后面章节会详细讲,现在就不展开来讲解了。不过,我们今天来讲两种比较简单、比较特殊的空对象,那就是空字符串和空集合。
当函数返回的数据是字符串类型或者集合类型的时候,我们可以用空字符串或空集合替代NULL值,来表示不存在的情况。这样,我们在使用函数的时候,就可以不用做NULL值判断。我举个例子来解释下。具体代码如下所示:
// 使用空集合替代NULLpublic class UserService {private UserRepo userRepo; // 依赖注入public List<User> getUsers(String telephonePrefix) {// 没有查找到数据return Collections.emptyList();}}// getUsers使用示例List<User> users = userService.getUsers("189");for (User user : users) { //这里不需要做NULL值判断// ...}// 使用空字符串替代NULLpublic String retrieveUppercaseLetters(String text) {// 如果text中没有大写字母,返回空字符串,而非NULL值return "";}// retrieveUppercaseLetters()使用举例String uppercaseLetters = retrieveUppercaseLetters("wangzheng");int length = uppercaseLetters.length();// 不需要做NULL值判断System.out.println("Contains " + length + " upper case letters.");
尽管前面讲了很多函数出错的返回数据类型,但是,最常用的函数出错处理方式就是抛出异常。异常可以携带更多的错误信息,比如函数调用栈信息。除此之外,异常可以将正常逻辑和异常逻辑的处理分离开来,这样代码的可读性就会更好。
不同的编程语言的异常语法稍有不同。像C加加和大部分的动态语言(Python、Ruby、JavaScript等)都只定义了一种异常类型:运行时异常(Runtime Exception)。而像Java,除了运行时异常外,还定义了另外一种异常类型:编译时异常(Compile Exception)。
对于运行时异常,我们在编写代码的时候,可以不用主动去try-catch,编译器在编译代码的时候,并不会检查代码是否有对运行时异常做了处理。相反,对于编译时异常,我们在编写代码的时候,需要主动去try-catch或者在函数定义中声明,否则编译就会报错。所以,运行时异常也叫作非受检异常(Unchecked Exception),编译时异常也叫作受检异常(Checked Exception)。
如果你熟悉的编程语言中,只定义了一种异常类型,那用起来反倒比较简单。如果你熟悉的编程语言中(比如Java),定义了两种异常类型,那在异常出现的时候,我们应该选择抛出哪种异常类型呢?是受检异常还是非受检异常?
对于代码bug(比如数组越界)以及不可恢复异常(比如数据库连接失败),即便我们捕获了,也做不了太多事情,所以,我们倾向于使用非受检异常。对于可恢复异常、业务异常,比如提现金额大于余额的异常,我们更倾向于使用受检异常,明确告知调用者需要捕获处理。
我举一个例子解释一下,代码如下所示。当Redis的地址(参数address)没有设置的时候,我们直接使用默认的地址(比如本地地址和默认端口);当Redis的地址格式不正确的时候,我们希望程序能fail-fast,也就是说,把这种情况当成不可恢复的异常,直接抛出运行时异常,将程序终止掉。
// address格式:"192.131.2.33:7896"public void parseRedisAddress(String address) {this.host = RedisConfig.DEFAULT_HOST;this.port = RedisConfig.DEFAULT_PORT;if (StringUtils.isBlank(address)) {return;}String[] ipAndPort = address.split(":");if (ipAndPort.length != 2) {throw new RuntimeException("...");}this.host = ipAndPort[0];// parseInt()解析失败会抛出NumberFormatException运行时异常this.port = Integer.parseInt(ipAndPort[1]);}
实际上,Java支持的受检异常一直被人诟病,很多人主张所有的异常情况都应该使用非受检异常。支持这种观点的理由主要有以下三个。
不过,非受检异常也有弊端,它的优点其实也正是它的缺点。从刚刚的表述中,我们可以看出,非受检异常使用起来更加灵活,怎么处理的主动权这里就交给了程序员。我们前面也讲到,过于灵活会带来不可控,非受检异常不需要显式地在函数定义中声明,那我们在使用函数的时候,就需要查看代码才能知道具体会抛出哪些异常。非受检异常不需要强制捕获处理,那程序员就有可能漏掉一些本应该捕获处理的异常。
对于应该用受检异常还是非受检异常,网上的争论有很多,但并没有一个非常强有力的理由能够说明一个就一定比另一个更好。所以,我们只需要根据团队的开发习惯,在同一个项目中,制定统一的异常处理规范即可。
**刚刚我们讲了两种异常类型,现在我们再来讲下,如何处理函数抛出的异常?**总结一下,一般有下面三种处理方法。
public void func1() throws Exception1 {// ...}public void func2() {//...try {func1();} catch(Exception1 e) {log.warn("...", e); //吐掉:try-catch打印日志}//...}
public void func1() throws Exception1 {// ...}public void func2() throws Exception1 {//原封不动的re-throw Exception1//...func1();//...}
public void func1() throws Exception1 {// ...}public void func2() throws Exception2 {//...try {func1();} catch(Exception1 e) {throw new Exception2("...", e); // wrap成新的Exception2然后re-throw}//...}
当我们面对函数抛出异常的时候,应该选择上面的哪种处理方式呢?我总结了下面三个参考原则:
总之,是否往上继续抛出,要看上层代码是否关心这个异常。关心就将它抛出,否则就直接吞掉。是否需要包装成新的异常抛出,看上层代码是否能理解这个异常、是否业务相关。如果能理解、业务相关就可以直接抛出,否则就封装成新的异常抛出。关于这部分理论知识,我们在下一节课中,会结合ID生成器的代码来进一步讲解。
好了,今天的内容到此就讲完了。我们一块来总结回顾一下,你需要掌握的重点内容。
对于函数出错返回数据类型,我总结了4种情况,它们分别是:错误码、NULL值、空对象、异常对象。
1.返回错误码
C语言没有异常这样的语法机制,返回错误码便是最常用的出错处理方式。而Java、Python等比较新的编程语言中,大部分情况下,我们都用异常来处理函数出错的情况,极少会用到错误码。
2.返回NULL值
在多数编程语言中,我们用NULL来表示“不存在”这种语义。对于查找函数来说,数据不存在并非一种异常情况,是一种正常行为,所以返回表示不存在语义的NULL值比返回异常更加合理。
3.返回空对象
返回NULL值有各种弊端,对此有一个比较经典的应对策略,那就是应用空对象设计模式。当函数返回的数据是字符串类型或者集合类型的时候,我们可以用空字符串或空集合替代NULL值,来表示不存在的情况。这样,我们在使用函数的时候,就可以不用做NULL值判断。
4.抛出异常对象
尽管前面讲了很多函数出错的返回数据类型,但是,最常用的函数出错处理方式是抛出异常。异常有两种类型:受检异常和非受检异常。
对于应该用受检异常还是非受检异常,网上的争论有很多,但也并没有一个非常强有力的理由,说明一个就一定比另一个更好。所以,我们只需要根据团队的开发习惯,在同一个项目中,制定统一的异常处理规范即可。
对于函数抛出的异常,我们有三种处理方法:直接吞掉、直接往上抛出、包裹成新的异常抛出。这一部分我们留在下一节课中结合实战进一步讲解。
结合我们今天学的理论知识,试着回答一下在文章开头针对RandomIdGenerator提到的四个问题。
欢迎在留言区写下你的答案,和同学一起交流和分享。如果有收获,也欢迎你把这篇文章分享给你的朋友。