网站域名实名认证吗,洛阳霞光seo网络公司,erp软件前十名,注册城乡规划师培训机构哪个好原标题#xff1a;Java 匠人手法 - 优雅的处理空值作者#xff1a;Lrwin导语在笔者几年的开发经验中#xff0c;经常看到项目中存在到处空值判断的情况#xff0c;这些判断#xff0c;会让人觉得摸不这头绪#xff0c;它的出现很有可能和当前的业务逻辑并没有关系。但它会…原标题Java 匠人手法 - 优雅的处理空值作者Lrwin导语在笔者几年的开发经验中经常看到项目中存在到处空值判断的情况这些判断会让人觉得摸不这头绪它的出现很有可能和当前的业务逻辑并没有关系。但它会让你很头疼。有时候更可怕的是系统因为这些空值的情况会抛出空指针异常导致业务系统发生问题。此篇文章我总结了几种关于空值的处理手法希望对读者有帮助。业务中的空值场景存在一个UserSearchService用来提供用户查询的功能:publicinterface UserSearchService{List listUser;User get(Integer id);}问题现场对于面向对象语言来讲抽象层级特别的重要。尤其是对接口的抽象它在设计和开发中占很大的比重我们在开发时希望尽量面向接口编程。对于以上描述的接口方法来看大概可以推断出可能它包含了以下两个含义:listUser: 查询用户列表get(Integer id): 查询单个用户在所有的开发中XP推崇的TDD模式可以很好的引导我们对接口的定义所以我们将TDD作为开发代码的”推动者”。对于以上的接口当我们使用TDD进行测试用例先行时发现了潜在的问题listUser 如果没有数据那它是返回空集合还是null呢get(Integer id) 如果没有这个对象是抛异常还是返回null呢深入listUser研究我们先来讨论listUser这个接口我经常看到如下实现:publicList listUser{List userList userListRepostity.selectByExample( newUserExample);if(CollectionUtils.isEmpty(userList)){ //spring util工具类returnnull;}returnuserList;}这段代码返回是null,从我多年的开发经验来讲对于集合这样返回值最好不要返回null因为如果返回了null会给调用者带来很多麻烦。你将会把这种调用风险交给调用者来控制。如果调用者是一个谨慎的人他会进行是否为null的条件判断。如果他并非谨慎或者他是一个面向接口编程的狂热分子(当然面向接口编程是正确的方向)他会按照自己的理解去调用接口而不进行是否为null的条件判断如果这样的话是非常危险的它很有可能出现空指针异常根据墨菲定律来判断: “很有可能出现的问题在将来一定会出现!”基于此我们将它进行优化:publicList listUser{List userList userListRepostity.selectByExample( newUserExample);if(CollectionUtils.isEmpty(userList)){returnLists.newArrayList; //guava类库提供的方式}returnuserList;}对于接口(List listUser)它一定会返回List即使没有数据它仍然会返回List(集合中没有任何元素);通过以上的修改我们成功的避免了有可能发生的空指针异常这样的写法更安全深入研究get方法对于接口User get(Integer id)你能看到的现象是我给出id它一定会给我返回User.但事实真的很有可能不是这样的。我看到过的实现:publicUser get(Integer id){returnuserRepository.selectByPrimaryKey(id); //从数据库中通过id直接获取实体对象}相信很多人也都会这样写。通过代码的时候得知它的返回值很有可能是null! 但我们通过的接口是分辨不出来的!这个是个非常危险的事情。尤其对于调用者来说我给出的建议是需要在接口明明时补充文档,比如对于异常的说明,使用注解exception:publicinterface UserSearchService{/*** 根据用户id获取用户信息* param id 用户id* return 用户实体* exception UserNotFoundException*/User get(Integer id);}我们把接口定义加上了说明之后调用者会看到如果调用此接口很有可能抛出“UserNotFoundException(找不到用户)”这样的异常。这种方式可以在调用者调用接口的时候看到接口的定义但是这种方式是”弱提示”的如果调用者忽略了注释有可能就对业务系统产生了风险这个风险有可能导致一个亿除了以上这种”弱提示”的方式还有一种方式是返回值是有可能为空的。那要怎么办呢我认为我们需要增加一个接口用来描述这种场景.引入jdk8的Optional,或者使用guava的Optional.看如下定义:publicinterface UserSearchService{/*** 根据用户id获取用户信息* param id 用户id* return 用户实体,此实体有可能是缺省值*/Optional getOptional(Integer id);}Optional有两个含义: 存在 or 缺省。那么通过阅读接口getOptional我们可以很快的了解返回值的意图这个其实是我们想看到的它去除了二义性。它的实现可以写成:publicOptional getOptional(Integer id){returnOptional.ofNullable(userRepository.selectByPrimaryKey(id));}深入入参通过上述的所有接口的描述你能确定入参id一定是必传的吗我觉得答案应该是不能确定。除非接口的文档注释上加以说明。那如何约束入参呢?我给大家推荐两种方式强制约束文档性约束(弱提示)1.强制约束我们可以通过jsr 303进行严格的约束声明:publicinterface 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 进行接口说明。比如:publicinterface UserSearchService{/*** 根据用户id获取用户信息* param id 用户id* return 用户实体* exception UserNotFoundException*/ CheckForNullUser get(NonNull Integer id);/*** 根据用户id获取用户信息* param id 用户id* return 用户实体,此实体有可能是缺省值*/Optional getOptional(NonNull Integer id);}小结通过 空集合返回值,Optional,jsr 303jsr 305这几种方式可以让我们的代码可读性更强出错率更低空集合返回值 如果有集合这样返回值时除非真的有说服自己的理由否则一定要返回空集合而不是nullOptional: 如果你的代码是jdk8就引入它如果不是则使用Guava的Optional,或者升级jdk版本它很大程度的能增加了接口的可读性jsr 303: 如果新的项目正在开发不防加上这个试试一定有一种特别爽的感觉!jsr 305: 如果老的项目在你的手上你可以尝试的加上这种文档型注解有助于你后期的重构或者新功能增加了对于老接口的理解!空对象模式场景我们来看一个DTO转化的场景对象:DatastaticclassPersonDTO{privateString dtoName;privateString dtoAge;}DatastaticclassPerson{privateString name;privateString age;}需求是将Person对象转化成PersonDTO然后进行返回。当然对于实际操作来讲返回如果Person为空将返回null,但是PersonDTO是不能返回null的(尤其Rest接口返回的这种DTO)。在这里我们只关注转化操作看如下代码: TestpublicvoidshouldConvertDTO{PersonDTO personDTO newPersonDTO;Person person newPerson;if(!Objects.isNull(person)){personDTO.setDtoAge(person.getAge);personDTO.setDtoName(person.getName);} else{personDTO.setDtoAge( );personDTO.setDtoName( );}}优化修改这样的数据转化我们认识可读性非常差每个字段的判断如果是空就设置为空字符串(“”)换一种思维方式进行思考我们是拿到Person这个类的数据然后进行赋值操作(setXXX),其实是不关系Person的具体实现是谁的。那我们可以创建一个Person子类:staticclassNullPerson extends Person{ OverridepublicString getAge{return;} OverridepublicString getName{return;}}它作为Person的一种特例而存在如果当Person为空的时候则返回一些get*的默认行为.所以代码可以修改为: TestpublicvoidshouldConvertDTO{PersonDTO personDTO newPersonDTO;Person person getPerson;personDTO.setDtoAge(person.getAge);personDTO.setDtoName(person.getName);}privatePerson getPerson{returnnewNullPerson; //如果Person是null ,则返回空对象}其中getPerson方法可以用来根据业务逻辑获取Person有可能的对象(对当前例子来讲如果Person不存在返回Person的的特例NUllPerson)如果修改成这样代码的可读性就会变的很强了。使用Optional可以进行优化空对象模式它的弊端在于需要创建一个特例对象但是如果特例的情况比较多我们是不是需要创建多个特例对象呢虽然我们也使用了面向对象的多态特性但是业务的复杂性如果真的让我们创建多个特例对象我们还是要再三考虑一下这种模式它可能会带来代码的复杂性。对于上述代码还可以使用Optional进行优化。 TestpublicvoidshouldConvertDTO{PersonDTO personDTO newPersonDTO;Optional.ofNullable(getPerson).ifPresent(person - {personDTO.setDtoAge(person.getAge);personDTO.setDtoName(person.getName);});}privatePerson getPerson{returnnull;}Optional对空值的使用我觉得更为贴切它只适用于”是否存在”的场景。如果只对控制的存在判断我建议使用Optional.Optioanl的正确使用Optional如此强大它表达了计算机最原始的特性(0 or 1),那它如何正确的被使用呢!Optional不要作为参数如果你写了一个public方法这个方法规定了一些输入参数这些参数中有一些是可以传入null的那这时候是否可以使用Optional呢我给的建议是: 一定不要这样使用!举个例子:publicinterface UserService{List listUser(Optional username);}这个例子的方法 listUser,可能在告诉我们需要根据username查询所有数据集合如果username是空也要返回所有的用户集合.当我们看到这个方法的时候会觉得有一些歧义:“如果username是absent,是返回空集合吗还是返回全部的用户数据集合”Optioanl是一种分支的判断那我们究竟是关注 Optional还是Optional.get呢我给大家的建议是如果不想要这样的歧义就不要使用它如果你真的想表达两个含义就給它拆分出两个接口:publicinterface UserService{List listUser(String username);List listUser;}我觉得这样的语义更强并且更能满足 软件设计原则中的 “单一职责”。如果你觉得你的入参真的有必要可能传null,那请使用jsr 303或者jsr 305进行说明和验证!请记住! Optional不能作为入参的参数!Optional作为返回值当个实体的返回那Optioanl可以做为返回值吗其实它是非常满足是否存在这个语义的。你如说你要根据id获取用户信息这个用户有可能存在或者不存在。你可以这样使用:publicinterface UserService{Optional get(Integer id);}当调用这个方法的时候调用者很清楚get方法返回的数据有可能不存在这样可以做一些更合理的判断更好的防止空指针的错误当然如果业务方真的需要根据id必须查询出User的话就不要这样使用了请说明你要抛出的异常.只有当考虑它返回null是合理的情况下才进行Optional的返回集合实体的返回不是所有的返回值都可以这样用的如果你返回的是集合publicinterface UserService{Optional 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中!(点击标题可跳转阅读)返回搜狐查看更多责任编辑
