在小编几年的开发经验中,经常看到项目中存在到处空值判断的情况,这些判断,会让人觉得摸不着头绪,它的出现很有可能和当前的业务逻辑并没有关系。但它会让你很头疼。
有时候,更可怕的是系统因为这些空值的情况,会抛出空指针异常,导致业务系统发生问题。
此篇文章,总结了几种关于空值的处理手法,希望对读者有帮助。
业务中的空值
场景
存在一个 UserSearchService用来提供用户查询的功能:
问题现场
对于面向对象语言来讲,抽象层级特别的重要。尤其是对接口的抽象,它在设计和开发中占很大的比重,我们在开发时希望尽量面向接口编程。
对于以上描述的接口方法来看,大概可以推断出可能它包含了以下两个含义:
- listUser(): 查询用户列表
- get(Integerid): 查询单个用户
在所有的开发中,XP推崇的TDD模式可以很好的引导我们对接口的定义,所以我们将TDD作为开发代码的”推动者”。
对于以上的接口,当我们使用TDD进行测试用例先行时,发现了潜在的问题:
- listUser() 如果没有数据,那它是返回空集合还是null呢?
- get(Integerid) 如果没有这个对象,是抛异常还是返回null呢?
深入listUser研究
我们先来讨论
listUser()
这个接口,经常看到如下实现:
这段代码返回是null,从我多年的开发经验来讲,对于集合这样返回值,最好不要返回null,因为如果返回了null,会给调用者带来很多麻烦。你将会把这种调用风险交给调用者来控制。
如果调用者是一个谨慎的人,他会进行是否为null的条件判断。如果他并非谨慎,或者他是一个面向接口编程的狂热分子(当然,面向接口编程是正确的方向),他会按照自己的理解去调用接口,而不进行是否为null的条件判断,如果这样的话,是非常危险的,它很有可能出现空指针异常!
基于此,我们将它进行优化:
对于接口( ListlistUser()),它一定会返回List,即使没有数据,它仍然会返回List(集合中没有任何元素);
通过以上的修改,我们成功的避免了有可能发生的空指针异常,这样的写法更安全!
深入研究get方法
对于接口
User get(Integer id)
对于接口( ListlistUser()),它一定会返回List,即使没有数据,它仍然会返回List(集合中没有任何元素);
通过以上的修改,我们成功的避免了有可能发生的空指针异常,这样的写法更安全!
深入研究get方法
对于接口
User get(Integer id)
你能看到的现象是,我给出id,它一定会给我返回User.但事实真的很有可能不是这样的。
我看到过的实现:
public User get(Integer id){
return userRepository.selectByPrimaryKey(id);//从数据库中通过id直接获取实体对象
}
相信很多人也都会这样写。
通过代码的时候得知它的返回值很有可能是null! 但我们通过的接口是分辨不出来的!
这个是个非常危险的事情。尤其对于调用者来说!
我给出的建议是,需要在接口明明时补充文档,比如对于异常的说明,使用注解@exception:
public interface UserSearchService{
/**
* 根据用户id获取用户信息
* @param id 用户id
* @return 用户实体
* @exception UserNotFoundException
*/
User get(Integer id);
}
我们把接口定义加上了说明之后,调用者会看到,如果调用此接口,很有可能抛出“UserNotFoundException(找不到用户)”这样的异常。
这种方式可以在调用者调用接口的时候看到接口的定义,但是,这种方式是”弱提示”的!
如果调用者忽略了注释,有可能就对业务系统产生了风险,这个风险有可能导致一个亿!
除了以上这种”弱提示”的方式,还有一种方式是,返回值是有可能为空的。那要怎么办呢?
我认为我们需要增加一个接口,用来描述这种场景.
引入jdk8的Optional,或者使用guava的Optional.看如下定义:
public interface UserSearchService{
/**
* 根据用户id获取用户信息
* @param id 用户id
* @return 用户实体,此实体有可能是缺省值
*/
Optional<User> getOptional(Integer id);
}
Optional有两个含义: 存在 or 缺省。
那么通过阅读接口getOptional(),我们可以很快的了解返回值的意图,这个其实是我们想看到的,它去除了二义性。
它的实现可以写成:
public Optional<User> getOptional(Integer id){
return Optional.ofNullable(userRepository.selectByPrimaryKey(id));
}
深入入参
通过上述的所有接口的描述,你能确定入参id一定是必传的吗?我觉得答案应该是:不能确定。除非接口的文档注释上加以说明。
那如何约束入参呢?
推荐两种方式:
- 强制约束
- 文档性约束(弱提示)
1.强制约束,我们可以通过jsr 303进行严格的约束声明:
public interface UserSearchService{
/**
* 根据用户id获取用户信息
* @param id 用户id
* @return 用户实体
* @exception UserNotFoundException
*/
User get(@NotNull Integer id);
/**
* 根据用户id获取用户信息
* @param id 用户id
* @return 用户实体,此实体有可能是缺省值
*/
Optional<User> getOptional(@NotNull Integer id);
}
当然,这样写,要配合AOP的操作进行验证,但让spring已经提供了很好的集成方案,在此就不在赘述了。
2.文档性约束
在很多时候,我们会遇到遗留代码,对于遗留代码,整体性改造的可能性很小。
我们更希望通过阅读接口的实现,来进行接口的说明。
jsr 305规范,给了我们一个描述接口入参的一个方式(需要引入库 com.google.code.findbugs:jsr305):
可以使用注解: @Nullable @Nonnull @CheckForNull 进行接口说明。比如:
public interface UserSearchService{
/**
* 根据用户id获取用户信息
* @param id 用户id
* @return 用户实体
* @exception UserNotFoundException
*/
@CheckForNull
User get(@NonNull Integer id);
/**
* 根据用户id获取用户信息
* @param id 用户id
* @return 用户实体,此实体有可能是缺省值
*/
Optional<User> getOptional(@NonNull Integer id);
}
小结
通过 空集合返回值,Optional,jsr 303,jsr 305这几种方式,可以让我们的代码可读性更强,出错率更低!
- 空集合返回值 :如果有集合这样返回值时,除非真的有说服自己的理由,否则,一定要返回空集合,而不是null
- Optional: 如果你的代码是jdk8,就引入它!如果不是,则使用Guava的Optional,或者升级jdk版本!它很大程度的能增加了接口的可读性!
- jsr 303: 如果新的项目正在开发,不防加上这个试试!一定有一种特别爽的感觉!
- jsr 305: 如果老的项目在你的手上,你可以尝试的加上这种文档型注解,有助于你后期的重构,或者新功能增加了,对于老接口的理解!
本文暂时没有评论,来添加一个吧(●'◡'●)