业务逻辑中如何更好的处理空值？

最新推荐文章于 2024-05-07 08:41:09 发布

转载最新推荐文章于 2024-05-07 08:41:09 发布

· 542 阅读

版权

原文链接：https://lrwinx.github.io/2018/08/30/java%E5%8C%A0%E4%BA%BA%E6%89%8B%E6%B3%95-%E4%BC%98%E9%9B%85%E7%9A%84%E5%A4%84%E7%90%86%E7%A9%BA%E5%80%BC/

分布式架构专栏收录该内容

24 篇文章

订阅专栏

本文探讨了Java集合处理的最佳实践，特别是在返回空集合而非null，以及如何利用Optional提高代码可读性和安全性方面。深入分析了listUser和get方法的实现，提出了使用Optional的场景化建议，包括作为单个实体返回值时的判空约定。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

文章目录

1 场景

存在一个UserSearchService用来提供用户查询的功能:

public interface UserSearchService{
  List<User> listUser();

  User get(Integer id);
}

2 问题现场

对于面向对象语言来讲，抽象层级特别的重要。尤其是对接口的抽象，它在设计和开发中占很大的比重，我们在开发时希望尽量面向接口编程。
对于以上描述的接口方法来看，大概可以推断出可能它包含了以下两个含义:

listUser(): 查询用户列表
get(Integer id): 查询单个用户

当我们进行代码逻辑简单的推断分析之后：

listUser() 如果没有数据，那它是返回空集合还是null呢？
get(Integer id) 如果没有这个对象，是抛异常还是返回null呢？

2.1 深入listUser研究

我们先来讨论：

listUser()

这个接口，我们经常看到如下实现：

public List<User> listUser(){
    List<User> userList = userListRepostity.selectByExample(new UserExample());
    if(CollectionUtils.isEmpty(userList)){//spring util工具类
      return null;
    }
    return userList;
}

这段代码返回时null，从我多年的开发经验来讲，对于集合这样返回值，最好不要返回null，因为如果返回了null，会给调用者带来很多麻烦。你将会把这种调用风险交给调用者来控制。

如果调用者是一个谨慎的人，他会进行是否为null的条件判断。如果他并非谨慎，或者他是一个面向接口编程的狂热分子(当然，面向接口编程是正确的方向)，他会按照自己的理解去调用接口，而不进行是否为null的条件判断，如果这样的话，是非常危险的，它很有可能出现空指针异常！

根据墨菲定律来判断: “很有可能出现的问题，在将来一定会出现!”

基于此，我们将它进行优化：

public List<User> listUser(){
    List<User> userList = userListRepostity.selectByExample(new UserExample());
    if(CollectionUtils.isEmpty(userList)){
      return Lists.newArrayList();//guava类库提供的方式
    }
    return userList;
}

对于接口（List listUser()）它一定会返回List，即使没有数据，它仍然会返回List（集合中没有任何元素）;
通过以上的修改，我们成功的避免了有可能发生的空指针异常，这样的写法更安全！

2.2 深入研究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));
}

2.3 深入入参

通过上述的所有接口的描述，你能确定入参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);
}

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，jsr303，jsr305这几种方式，可以让我们的代码可读性更强，出错率更低

空集合返回值：如果有集合这样返回值时，除非真的有说服自己的理由，否则，一定要返回空集合，而不是null
Optional: 如果你的代码是jdk8，就引入它！如果不是，则使用Guava的Optional,或者升级jdk版本！它很大程度的能增加了接口的可读性！
jsr 303: 如果新的项目正在开发，不防加上这个试试！一定有一种特别爽的感觉!
jsr 305: 如果老的项目在你的手上，你可以尝试的加上这种文档型注解，有助于你后期的重构，或者新功能增加了，对于老接口的理解!

2.4 Optional的场景化的使用建议

2.4.1 Optional不要作为参数

如果你写了一个public 方法，这个方法规定了一些输入参数，这些参数中有一些是可以传入null的，那这个时候是否可以使用Optional呢？

我给的建议是: 一定不要这样使用!

举个例子：

public interface UserService{
  List<User> listUser(Optional<String> username);
}

这个例子的方法 listUser,可能在告诉我们需要根据username查询所有数据集合，如果username是空，也要返回所有的用户集合.

当我们看到这个方法的时候，会觉得有一些歧义:

“如果username是absent,是返回空集合吗？还是返回全部的用户数据集合？”

Optioanl是一种分支的判断，那我们究竟是关注 Optional还是Optional.get()呢？
我给大家的建议是，如果不想要这样的歧义，就不要使用它！

2.4.2 Optional作为单个实体的返回值，可以进行判空约定

单个实体的返回：
那Optioanl可以做为返回值吗？
其实它是非常满足是否存在这个语义的。
你如说，你要根据id获取用户信息，这个用户有可能存在或者不存在。
你可以这样使用:

public interface UserService{
  Optional<User> get(Integer id);
}

当调用这个方法的时候，调用者很清楚get方法返回的数据，有可能不存在，这样可以做一些更合理的判断，更好的防止空指针的错误！

当然，如果业务方真的需要根据id必须查询出User的话，就不要这样使用了，请说明，你要抛出的异常.

只有当考虑它返回null是合理的情况下，才进行Optional的返回

2.4.3 集合实体的返回，不建议使用Optional

集合实体的返回如果是Optional的化，会让调用者产生困惑，是否我判断了Optional之后，还用进行isEmpty的判断嘛？

2.4.4 单纯的使用Optional变量

对于

Optional<User> userOptional = .....

如果有这样的变量userOptional ，请记住：

一定不能直接使用get ，如果这样用，就丧失了Optional本身的含义（比如userOptional .get() ）
不要直接使用getOrThrow ,如果你有这样的需求：获取不到就抛异常。那就要考虑，是否是调用的接口设计的是否合理

2.4.5 getter场景下的Optional不建议使用

对于一个java bean,所有的属性都有可能返回null,那是否需要改写所有的getter成为Optional类型呢？

我给大家的建议是，不要这样滥用Optional.

即便我java bean中的getter是符合Optional的，但是因为java bean 太多了，这样会导致你的代码有50%以上进行Optinal的判断，这样便污染了代码。(我想说，其实你的实体中的字段应该都是由业务含义的，会认真的思考过它存在的价值的，不能因为Optional的存在而滥用)

我们应该更关注于业务，而不只是空值的判断。

请不要在getter中滥用Optional.