如何优雅地根治 null 值引起的 Bug,看我的!
阅读本文大概需要 9 分钟。
来自:https://lrwinx.github.io
UserSearchService
用来提供用户查询的功能:
publicinterfaceUserSearchService{
List<User> listUser();
Userget(Integer id);
}
listUser()
: 查询用户列表get(Integerid)
: 查询单个用户
listUser()
如果没有数据,那它是返回空集合还是null呢?get(Integerid)
如果没有这个对象,是抛异常还是返回null呢?
listUser()
publicList<User> listUser(){
List<User> userList = userListRepostity.selectByExample(newUserExample());
if(CollectionUtils.isEmpty(userList)){//spring util工具类
returnnull;
}
return userList;
}
publicList<User> listUser(){
List<User> userList = userListRepostity.selectByExample(newUserExample());
if(CollectionUtils.isEmpty(userList)){
returnLists.newArrayList(); //guava类库提供的方式
}
return userList;
}
ListlistUser()
),它一定会返回List,即使没有数据,它仍然会返回List(集合中没有任何元素);
Userget(Integer id)
publicUserget(Integer id){
return userRepository.selectByPrimaryKey(id);//从数据库中通过id直接获取实体对象
}
publicinterfaceUserSearchService{
/**
* 根据用户id获取用户信息
* @param id 用户id
* @return 用户实体
* @exception UserNotFoundException
*/
Userget(Integer id);
}
publicinterfaceUserSearchService{
/**
* 根据用户id获取用户信息
* @param id 用户id
* @return 用户实体,此实体有可能是缺省值
*/
Optional<User> getOptional(Integer id);
}
publicOptional<User> getOptional(Integer id){
returnOptional.ofNullable(userRepository.selectByPrimaryKey(id));
}
强制约束
文档性约束(弱提示)
publicinterfaceUserSearchService{
/**
* 根据用户id获取用户信息
* @param id 用户id
* @return 用户实体
* @exception UserNotFoundException
*/
Userget(@NotNullInteger id);
/**
* 根据用户id获取用户信息
* @param id 用户id
* @return 用户实体,此实体有可能是缺省值
*/
Optional<User> getOptional(@NotNullInteger id);
}
com.google.code.findbugs:jsr305
):@Nullable
@Nonnull
@CheckForNull
进行接口说明。比如:
publicinterfaceUserSearchService{
/**
* 根据用户id获取用户信息
* @param id 用户id
* @return 用户实体
* @exception UserNotFoundException
*/
@CheckForNull
Userget(@NonNullInteger id);
/**
* 根据用户id获取用户信息
* @param id 用户id
* @return 用户实体,此实体有可能是缺省值
*/
Optional<User> getOptional(@NonNullInteger id);
}
空集合返回值 :如果有集合这样返回值时,除非真的有说服自己的理由,否则,一定要返回空集合,而不是null
Optional: 如果你的代码是jdk8,就引入它!如果不是,则使用Guava的Optional,或者升级jdk版本!它很大程度的能增加了接口的可读性!
jsr 303: 如果新的项目正在开发,不防加上这个试试!一定有一种特别爽的感觉!
jsr 305: 如果老的项目在你的手上,你可以尝试的加上这种文档型注解,有助于你后期的重构,或者新功能增加了,对于老接口的理解!
@Data
staticclassPersonDTO{
privateString dtoName;
privateString dtoAge;
}
@Data
staticclassPerson{
privateString name;
privateString age;
}
@Test
publicvoid shouldConvertDTO(){
PersonDTO personDTO = newPersonDTO();
Person person = newPerson();
if(!Objects.isNull(person)){
personDTO.setDtoAge(person.getAge());
personDTO.setDtoName(person.getName());
}else{
personDTO.setDtoAge("");
personDTO.setDtoName("");
}
}
staticclassNullPersonextendsPerson{
@Override
publicString getAge() {
return"";
}
@Override
publicString getName() {
return"";
}
}
@Test
publicvoid shouldConvertDTO(){
PersonDTO personDTO = newPersonDTO();
Person person = getPerson();
personDTO.setDtoAge(person.getAge());
personDTO.setDtoName(person.getName());
}
privatePerson getPerson(){
returnnewNullPerson(); //如果Person是null ,则返回空对象
}
getPerson()
方法,可以用来根据业务逻辑获取Person有可能的对象(对当前例子来讲,如果Person不存在,返回Person的的特例NUllPerson),如果修改成这样,代码的可读性就会变的很强了。
@Test
publicvoid shouldConvertDTO(){
PersonDTO personDTO = newPersonDTO();
Optional.ofNullable(getPerson()).ifPresent(person -> {
personDTO.setDtoAge(person.getAge());
personDTO.setDtoName(person.getName());
});
}
privatePerson getPerson(){
returnnull;
}
publicinterfaceUserService{
List<User> listUser(Optional<String> username);
}
“如果username是absent,是返回空集合吗?还是返回全部的用户数据集合?”
publicinterfaceUserService{
List<User> listUser(String username);
List<User> listUser();
}
publicinterfaceUserService{
Optional<User> get(Integer id);
}
publicinterfaceUserService{
Optional<List<User>> listUser();
}
Optional<User> userOpt = ...
一定不能直接使用get ,如果这样用,就丧失了Optional本身的含义 ( 比如userOp.get() )
不要直接使用getOrThrow ,如果你有这样的需求:获取不到就抛异常。那就要考虑,是否是调用的接口设计的是否合理
当使用值为空的情况,并非源于错误时,可以使用Optional!
Optional不要用于集合操作!
不要滥用Optional,比如在java bean的getter中!
推荐阅读:
最近面试BAT,整理一份面试资料《Java面试BATJ通关手册》,覆盖了Java核心技术、JVM、Java并发、SSM、微服务、数据库、数据结构等等。
朕已阅