编码规范 | Java函数优雅之道(下)
收藏


上文背景


本文总结了一套与Java函数相关的编码规则,旨在给广大Java程序员一些编码建议,有助于大家编写出更优雅、更高质、更高效的代码。


上文链接:编码规范 | Java函数优雅之道(上)


内部函数参数尽量使用基础类型


案例一:内部函数参数尽量使用基础类型


现象描述:



建议方案:



案例二:内部函数返回值尽量使用基础类型


现象描述:



建议方案:



此处只是举例说明这种现象,更好的方式是采用流式(Stream)编程。


主要收益


  • 内部函数尽量使用基础类型,避免了隐式封装类型的打包和拆包;

  • 内部函数参数使用基础类型,用语法上避免了内部函数的参数空指针判断;

  • 内部函数返回值使用基础类型,用语法上避免了调用函数的返回值空指针判断。


尽量避免返回的数组和列表为null


案例一:尽量避免返回的数组为null,引起不必要的空指针判断


现象描述:



建议方案:



案例二:尽量避免返回的列表为null,引起不必要的空指针判断


现象描述:



建议方案:



主要收益


  • 保证返回的数组和列表不为null, 避免调用函数的空指针判断。


封装函数传入参数


案例一:当传入参数过多时,应封装为参数类


Java规范不允许函数参数太多,不便于维护也不便于扩展。


现象描述:



建议方案:



当传入成组参数时,应封装为参数类


既然参数成组出现,就需要封装一个类去描述这种现象。


现象描述:



建议方案:



主要收益


  • 封装过多函数参数为类,使函数更便于扩展和维护;

  • 封装成组函数参数为类,使业务概念更明确更清晰。


尽量用函数替换匿名内部类的实现


Java匿名内部类的优缺点:


  • 在匿名内部类(包括Lambda表达式)中可以直接访问外部类的成员,包括类的成员变量、函数的内部变量。正因为可以随意访问外部变量,所以会导致代码边界不清晰。

  • 首先推荐用Lambda表达式简化匿名内部类,其次推荐用函数替换复杂的Lambda表达式的实现。


案例一:尽量用函数替换匿名内部类(包括Lambda表达式)的实现


现象描述:



建议方案:



其实,还有一个更简单的办法。在调用函数sendWorkerSettleData(发送作业员结算数据)之前计算开始日期、结束日期,就直接可以用函数auditTaskDAO.statCheckerSettleData(beginDate, endDate)代替匿名内部类实现。


案例二:拆分复杂匿名内部类实现接口为多个函数类接口


如果一个匿名内部类实现的接口几个函数间关联性不大,可以把这个接口拆分为几个函数式接口,便于使用Lambda表达式。


现象描述:



建议方案:



主要收益


  • 定义函数并指定参数,明确规定了匿名内部类的代码边界;

  • 利用Lambda表达式简化匿名内部类实现,使代码更简洁。


利用return精简不必要的代码


案例一:删除不必要的if


现象描述:



建议方案:



案例二:删除不必要的else


现象描述:



建议方案:



案例三:删除不必要的变量


现象描述:



建议方案:



主要收益


  • 精简不必要的代码,让代码看起来更清爽


利用临时变量优化代码


在一些代码中,经常会看到a.getB().getC()...getN()的写法,姑且叫做“函数的级联调用”,代码健壮性和可读性太差。建议:杜绝函数的级联调用,利用临时变量进行拆分,并做好对象空指针检查。


案例一:利用临时变量厘清逻辑


现象描述:



这是精简代码控的最爱,但是可读性实在太差。


建议方案:



这个方案,增加了代码行数,但是逻辑更清晰。


有时候,当代码的精简性和可读性发生冲突时,个人更偏向于保留代码的可读性。


案例二:利用临时变量精简代码


现象描述:



这么写,大约是为了节约一个临时变量把。


建议方案:



主要收益


  • 利用临时变量厘清逻辑,显得业务逻辑更清晰;

  • 利用临时变量精简代码,看变量名称即知其义,减少了大量无用代码;

  • 如果获取函数比较复杂耗时,利用临时变量可以提高运行效率;

  • 利用临时变量避免函数的级联调用,可有效预防空指针异常。


仅保留函数需要的参数


在一些代码中,经常会看到a.getB().getC()...getN()的写法,姑且叫做“函数的级联调用”,代码健壮性和可读性太差。建议:杜绝函数的级联调用,利用临时变量进行拆分,并做好对象空指针检查。


案例一:删除多余的参数


现象描述:



案例二:用属性取代对象


现象描述:



建议方案:



建议方案:


调用函数时,参数对象不需要专门构建,而函数使用其属性超过3个,可以不必使用该规则。


主要收益


  • 仅保留函数需要的参数,明确了调用时需要赋值的参数,避免了调用时还要去构造些无用参数。


后记


"众人拾柴火焰高"。如果有更多更好的观点,亦或有更好的代码案例,欢迎大家进行补充说明。笔者希望以此文抛砖引玉,如果最终形成一套完善的Java编码规范,善莫大焉。


更多精彩


识别二维码进入马上免费试用



如果觉得本文还不错,点击在看一下!
点此详细了解!

官方公众号