编码规范 | Java函数优雅之道（上）

点击上方蓝字,关注猿天地！

1.

导读

随着软件项目代码的日积月累，系统维护成本变得越来越高，是所有软件团队面临的共同问题。持续地优化代码，提高代码的质量，是提升系统生命力的有效手段之一。软件系统思维有句话“Less coding, more thinking（少编码、多思考）”，也有这么一句俚语“Think more, code less（思考越多，编码越少）”。所以，我们在编码中多思考多总结，努力提升自己的编码水平，才能编写出更优雅、更高质、更高效的代码。

本文总结了一套与Java函数相关的编码规则，旨在给广大Java程序员一些编码建议，有助于大家编写出更优雅、更高质、更高效的代码。这套编码规则，通过在高德采集部门的实践，已经取得了不错的成效。

2.

使用通用工具函数

2.1 案例一

现象描述：

不完善的写法：

更完善的写法：

建议方案：

2.2 案例二

现象描述：

建议方案：

2.3 主要收益

• 函数式编程，业务代码减少，逻辑一目了然；

• 通用工具函数，逻辑考虑周全，出问题概率低。

3.

拆分超大函数

当一个函数超过80行后，就属于超大函数，需要进行拆分。

3.1 案例一：每一个代码块都可以封装为一个函

每一个代码块必然有一个注释，用于解释这个代码块的功能。

如果代码块前方有一行注释，就是在提醒你——可以将这段代码替换成一个函数，而且可以在注释的基础上给这个函数命名。如果函数有一个描述恰当的名字，就不需要去看内部代码究竟是如何实现的。

现象描述：

建议方案：

3.2 案例二：每一个循环体都可以封装为一个函

现象描述：

建议方案：

3.3 案例三：每一个条件体都可以封装为一个函

现象描述：

建议方案：

3.4 主要收益

• 函数越短小精悍，功能就越单一，往往生命周期较长；

• 一个函数越长，就越不容易理解和维护，维护人员不敢轻易修改；

• 在过长函数中，往往含有难以发现的重复代码。

4.

同一函数内代码块级别尽量一致

4.1 案例一

现象描述：

很明显，睡觉这块代码块，跟eat（吃饭）和code（编码）不在同一级别上，显得比较突兀。如果把写代码比作写文章，eat（吃饭）和code（编码）是段落大意，而睡觉这块代码块属于一个详细段落。而在liveDaily（每日生活）这个函数上，只需要写出主要流程（段落大意）即可。

建议方案：

4.2 主要收益

• 函数调用表明用途，函数实现表达逻辑，层次分明便于理解；

• 不用层次的代码块放在一个函数中，容易让人觉得代码头重脚轻。

5.

封装相同功能代码为函数

5.1 案例一：封装相同代码为函数

现象描述：

建议方案：

5.2 案例二：封装相似代码为函数

封装相似代码为函数，差异性通过函数参数控制。

现象描述：

建议方案：

5.3 主要收益

• 封装公共函数，减少代码行数，提高代码质量；

• 封装公共函数，使业务代码更精炼，可读性可维护性更强。

6.

封装获取参数值函数

6.1 案例一

现象描述：

建议方案：

6.2 主要收益

• 把获取参数值从业务函数中独立，使业务逻辑更清晰；

• 封装的获取参数值为独立函数，可以在代码中重复使用。

7.

通过接口参数化封装相同逻辑

7.1 案例一

现象描述：

建议方案：

7.2 主要收益

• 把核心逻辑从各个业务函数中抽析，使业务代码更清晰更易维护；

• 避免重复性代码多次编写，精简重复函数越多收益越大。

8.

减少函数代码层级

如果要使函数优美，建议函数代码层级在1-4之间，过多的缩进会让函数难以阅读。

8.1 案例一：利用return提前返回函数

现象描述：

建议方案：

8.2 案例二：利用continue提前结束循环

现象描述：

建议方案：

特殊说明

其它方式：在循环体中，先调用案例1的函数getUserBalance(获取用户余额)，再进行对余额进行累加。

在循环体中，建议最多使用一次continue。如果需要有使用多次continue的需求，建议把循环体封装为一个函数。

8.3 案例三：利用条件表达式函数减少层级

请参考下一章的”案例2: 把复杂条件表达式封装为函数”

8.4 主要收益

• 代码层级减少，代码缩进减少；

• 模块划分清晰，方便阅读维护。

9.

封装条件表达式函数

9.1 案例一：把简单条件表达式封装为函数

现象描述：

建议方案：

9.2 案例二：把复杂条件表达式封装为函数

现象描述：

建议方案：

以上代码也可以用采用流式(Stream)编程的过滤来实现。

9.3 主要收益

• 把条件表达式从业务函数中独立，使业务逻辑更清晰；

• 封装的条件表达式为独立函数，可以在代码中重复使用。

10.

尽量避免不必要的空指针判断

本章只适用于项目内部代码，并且是自己了解的代码，才能够尽量避免不必要的空指针判断。对于第三方中间件和系统接口，必须做好空指针判断，以保证代码的健壮性。

10.1 案例一：调用函数保证参数不为空，被调用函数尽量避免不必要的空指针判断

现象描述：

建议方案：

10.2 案例二：被调用函数保证返回不为空,调用函数尽量避免不必要的空指针判断

现象描述：

建议方案：

10.3 案例三：赋值逻辑保证列表数据项不为空，处理逻辑尽量避免不必要的空指针判断

现象描述：

建议方案：

10.4 案例四：MyBatis查询函数返回列表和数据项不为空，可以不用空指针判断

MyBatis是一款优秀的持久层框架，是在项目中使用的最广泛的数据库中间件之一。通过对MyBatis源码进行分析，查询函数返回的列表和数据项都不为空，在代码中可以不用进行空指针判断。

现象描述：

这种写法没有问题，只是过于保守了。

建议方案：

10.5 主要收益

• 避免不必要的空指针判断，精简业务代码处理逻辑，提高业务代码运行效率；

• 这些不必要的空指针判断，基本属于永远不执行的Death代码，删除有助于代码维护。

文章知识点与官方知识档案匹配，可进一步学习相关知识Java技能树首页概览91459 人正在系统学习中

来源：尹吉欢