使用Optioanl优雅的处理空值

业务中的空值

场景

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

public interface UserSearchService{
List listUser();

User get(Integer id);
}

问题现场

对于面向对象语言来说，抽象层级特别的重要。尤为是对接口的抽象，它在设计和开发中占很大的比重，咱们在开发时但愿尽可能面向接口编程。

对于以上描述的接口方法来看，大概能够推断出可能它包含了如下两个含义:
listUser(): 查询用户列表
get(Integer id): 查询单个用户

在全部的开发中，XP推崇的TDD模式能够很好的引导咱们对接口的定义，因此咱们将TDD做为开发代码的”推进者”。

对于以上的接口，当咱们使用TDD进行测试用例先行时，发现了潜在的问题：
listUser() 若是没有数据，那它是返回空集合仍是null呢？
get(Integer id) 若是没有这个对象，是抛异常仍是返回null呢？

深刻listUser研究

咱们先来讨论listUser()这个接口，我常常看到以下实现:
public List listUser(){
List userList = userListRepostity.selectByExample(new UserExample());
if(CollectionUtils.isEmpty(userList)){//spring util工具类
return null;
}
return userList;
}

这段代码返回是null,从我多年的开发经验来说，对于集合这样返回值，最好不要返回null，由于若是返回了null，会给调用者带来不少麻烦。你将会把这种调用风险交给调用者来控制。

若是调用者是一个谨慎的人，他会进行是否为null的条件判断。若是他并不是谨慎，或者他是一个面向接口编程的狂热分子(固然，面向接口编程是正确的方向)，他会按照本身的理解去调用接口，而不进行是否为null的条件判断，若是这样的话，是很是危险的，它颇有可能出现空指针异常！
根据墨菲定律来判断: “颇有可能出现的问题，在未来必定会出现!”

基于此，咱们将它进行优化:
public List listUser(){
List userList = userListRepostity.selectByExample(new UserExample());
if(CollectionUtils.isEmpty(userList)){
return Lists.newArrayList();//guava类库提供的方式
}
return userList;
}

对于接口(List listUser())，它必定会返回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 getOptional(Integer id);
  }
  Optional有两个含义: 存在 or 缺省。

那么经过阅读接口getOptional()，咱们能够很快的了解返回值的意图，这个实际上是咱们想看到的，它去除了二义性。

它的实现能够写成:
public Optional 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 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 getOptional(@NonNull Integer id);
  }

小结

经过 空集合返回值,Optional,jsr 303，jsr 305这几种方式，可让咱们的代码可读性更强，出错率更低！

空集合返回值 ： 若是有集合这样返回值时，除非真的有说服本身的理由，不然，必定要返回空集合，而不是null

Optional: 若是你的代码是jdk8，就引入它！ 若是不是，则使用Guava的Optional,或者升级jdk版本！ 它很大程度的能增长了接口的可读性！

jsr 303: 若是新的项目正在开发，不防加上这个试试！ 必定有一种特别爽的感受!

jsr 305: 若是老的项目在你的手上，你能够尝试的加上这种文档型注解，有助于你后期的重构，或者新功能增长了，对于老接口的理解!

空对象模式

场景

咱们来看一个DTO转化的场景，对象:

@Data
static class PersonDTO{
private String dtoName;
private String dtoAge;
}

@Data
static class Person{
private String name;
private String age;
}
需求是将Person对象转化成PersonDTO，而后进行返回。
固然对于实际操做来说，返回若是Person为空，将返回null,可是PersonDTO是不能返回null的（尤为Rest接口返回的这种DTO）。

在这里，咱们只关注转化操做，看以下代码:
@Test
public void shouldConvertDTO(){

PersonDTO personDTO = new PersonDTO();

Person person = new Person();
if(!Objects.isNull(person)){
personDTO.setDtoAge(person.getAge());
personDTO.setDtoName(person.getName());
}else{
personDTO.setDtoAge("");
personDTO.setDtoName("");
}
}

优化修改

这样的数据转化，咱们认识可读性很是差，每一个字段的判断，若是是空就设置为空字符串(“”)

换一种思惟方式进行思考，咱们是拿到Person这个类的数据，而后进行赋值操做(setXXX),实际上是不关系Person的具体实现是谁的。

那咱们能够建立一个Person子类:

static class NullPerson extends Person{
@Override
public String getAge() {
return "";
}

@Override
public String getName() {
return "";
}
}
它做为Person的一种特例而存在，若是当Person为空的时候，则返回一些get*的默认行为.

因此代码能够修改成:

@Test
public void shouldConvertDTO(){

PersonDTO personDTO = new PersonDTO();

Person person = getPerson();
personDTO.setDtoAge(person.getAge());
personDTO.setDtoName(person.getName());
}

private Person getPerson(){
return new NullPerson();//若是Person是null ,则返回空对象
}
其中getPerson()方法，能够用来根据业务逻辑获取Person有可能的对象（对当前例子来说，若是Person不存在，返回Person的的特例NUllPerson），若是修改为这样，代码的可读性就会变的很强了。

使用Optional能够进行优化

空对象模式，它的弊端在于须要建立一个特例对象，可是若是特例的状况比较多，咱们是否是须要建立多个特例对象呢，虽然咱们也使用了面向对象的多态特性，可是，业务的复杂性若是真的让咱们建立多个特例对象，咱们仍是要再三考虑一下这种模式，它可能会带来代码的复杂性。

对于上述代码，还可使用Optional进行优化。

@Test
public void shouldConvertDTO(){

PersonDTO personDTO = new PersonDTO();

Optional.ofNullable(getPerson()).ifPresent(person -> {
  personDTO.setDtoAge(person.getAge());
  personDTO.setDtoName(person.getName());
});

}

private Person getPerson(){
return null;
}

Optional对空值的使用，我以为更为贴切，它只适用于”是否存在”的场景。
若是只对控制的存在判断，我建议使用Optional.

Optioanl的正确使用

Optional如此强大，它表达了计算机最原始的特性(0 or 1),那它如何正确的被使用呢!

Optional不要做为参数

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

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

举个例子:

public interface UserService{
List listUser(Optional username);
}
这个例子的方法 listUser,可能在告诉咱们须要根据username查询全部数据集合，若是username是空，也要返回全部的用户集合.

当咱们看到这个方法的时候，会以为有一些歧义:

“若是username是absent(缺省),是返回空集合吗？仍是返回所有的用户数据集合？”

Optioanl是一种分支的判断，那咱们到底是关注 Optional仍是Optional.get()呢？

我给你们的建议是，若是不想要这样的歧义，就不要使用它！

若是你真的想表达两个含义，就給它拆分出两个接口:

public interface UserService{
List listUser(String username);
List listUser();
}
我以为这样的语义更强，而且更能知足 软件设计原则中的 “单一职责”。

若是你以为你的入参真的有必要可能传null,那请使用jsr 303或者jsr 305进行说明和验证!

请记住! Optional不能做为入参的参数!

Optional做为返回值

当个实体的返回

那Optioanl能够作为返回值吗？
其实它是很是知足是否存在这个语义的。

你如说，你要根据id获取用户信息，这个用户有可能存在或者不存在。

你能够这样使用:

public interface UserService{
Optional get(Integer id);
}
当调用这个方法的时候，调用者很清楚get方法返回的数据，有可能不存在，这样能够作一些更合理的判断，更好的防止空指针的错误！

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

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

集合实体的返回

不是全部的返回值均可以这样用的！ 若是你返回的是集合：

public interface UserService{
Optional<List > listUser();
}
这样的返回结果，会让调用者不知所措，是否我判断Optional以后，还用进行isEmpty的判断呢？

这样带来的返回值歧义！ 我认为是没有必要的。

咱们要约定，对于List这种集合返回值，若是集合真的是null的，请返回空集合(Lists.newArrayList);

使用Optional变量

Optional userOpt = ...
若是有这样的变量userOpt,请记住 ：

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

getter中的使用

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

我给你们的建议是，不要这样滥用Optional.

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

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

请不要在getter中滥用Optional.

小结

能够这样总结Optional的使用：

当使用值为空的状况，并不是源于错误时，可使用Optional! Optional不要用于集合操做! 不要滥用Optional,好比在java bean的getter中!