java函数优雅之道（上）

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

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

使用通用工具函数

案例一

现象描述：

不完善的写法：

[Java] 纯文本查看 复制代码

?

1	thisName != null && thisName.equals(name);

更完善的写法：

[Java] 纯文本查看 复制代码

?

1	(thisName == name) || (thisName != null && thisName.equals(name));

建议方案：

[Java] 纯文本查看 复制代码

?

1	Objects.equals(name, thisName);

案例二

现象描述：

[Java] 纯文本查看 复制代码

?

1	!(list == null || list.isEmpty());

建议方案

[Java] 纯文本查看 复制代码

?

1 2	import org.apache.commons.collections4.CollectionUtils; CollectionUtils.isNotEmpty(list);

主要收益

• 函数式编程，业务代码减少，逻辑一目了然；
• 通用工具函数，逻辑考虑周全，出问题概率低。

拆分超大函数

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

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

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

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

现象描述：

[Java] 纯文本查看 复制代码

?

01 02 03 04 05 06 07 08 09 10 11

// 每日生活函数 public void liveDaily() {     // 吃饭     // 吃饭相关代码几十行       // 编码     // 编码相关代码几十行       // 睡觉     // 睡觉相关代码几十行 }

建议方案

[Java] 纯文本查看 复制代码

?

01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26

// 每日生活函数 public void liveDaily() {     // 吃饭     eat();       // 编码     code();       // 睡觉     sleep(); }   // 吃饭函数 private void eat() {     // 吃饭相关代码 }   // 编码函数 private void code() {     // 编码相关代码 }   // 睡觉函数 private void sleep() {     // 睡觉相关代码 }

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

现象描述

[Java] 纯文本查看 复制代码

?

01 02 03 04 05 06 07 08 09 10 11 12 13

// 生活函数 public void live() {     while (isAlive) {         // 吃饭         eat();           // 编码         code();           // 睡觉         sleep();     } }

建议方案

[Java] 纯文本查看 复制代码

?

01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19

// 生活函数 public void live() {     while (isAlive) {         // 每日生活         liveDaily();     } }   // 每日生活函数 private void liveDaily() {     // 吃饭     eat();       // 编码     code();       // 睡觉     sleep(); }

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

现象描述：

[Java] 纯文本查看 复制代码

?

01 02 03 04 05 06 07 08 09 10 11 12

// 外出函数 public void goOut() {     // 判断是否周末     // 判断是否周末: 是周末则游玩     if (isWeekday()) {         // 游玩代码几十行     }     // 判断是否周末: 非周末则工作     else {         // 工作代码几十行     } }

建议方案

[Java] 纯文本查看 复制代码

?

01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22

// 外出函数 public void goOut() {     // 判断是否周末     // 判断是否周末: 是周末则游玩     if (isWeekday()) {         play();     }     // 判断是否周末: 非周末则工作     else {         work();     } }   // 游玩函数 private void play() {     // 游玩代码几十行 }   // 工作函数 private void work() {     // 工作代码几十行 }

主要收益

• 函数越短小精悍，功能就越单一，往往生命周期较长；
• 一个函数越长，就越不容易理解和维护，维护人员不敢轻易修改；
• 在过长函数中，往往含有难以发现的重复代码。

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

案例一

现象描述：

[Java] 纯文本查看 复制代码

?

01 02 03 04 05 06 07 08 09 10 11

// 每日生活函数 public void liveDaily() {     // 吃饭     eat();       // 编码     code();       // 睡觉     // 睡觉相关代码几十行 }

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

建议方案：

[Java] 纯文本查看 复制代码

?

01 02 03 04 05 06 07 08 09 10 11 12 13 14 15

public void liveDaily() {     // 吃饭     eat();       // 编码     code();       // 睡觉     sleep(); }   // 睡觉 private void sleep() {     // 睡觉相关代码 }

主要收益

• 函数调用表明用途，函数实现表达逻辑，层次分明便于理解；
• 不用层次的代码块放在一个函数中，容易让人觉得代码头重脚轻。

封装相同功能代码为函数
 

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

现象描述：

[Java] 纯文本查看 复制代码

?

01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20

// 禁用用户函数 public void disableUser() {     // 禁用黑名单用户     List<Long> userIdList = queryBlackUser();     for (Long userId : userIdList) {         User userUpdate = new User();         userUpdate.setId(userId);         userUpdate.setEnable(Boolean.FALSE);         userDAO.update(userUpdate);     }       // 禁用过期用户     userIdList = queryExpiredUser();     for (Long userId : userIdList) {         User userUpdate = new User();         userUpdate.setId(userId);         userUpdate.setEnable(Boolean.FALSE);         userDAO.update(userUpdate);     } }

建议方案

[Java] 纯文本查看 复制代码

?

01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22

// 禁用用户函数 public void disableUser() {     // 禁用黑名单用户     List<Long> userIdList = queryBlackUser();     for (Long userId : userIdList) {         disableUser(userId);     }       // 禁用过期用户     userIdList = queryExpiredUser();     for (Long userId : userIdList) {         disableUser(userId);     } }   // 禁用用户函数 private void disableUser(Long userId) {     User userUpdate = new User();     userUpdate.setId(userId);     userUpdate.setEnable(Boolean.FALSE);     userDAO.update(userUpdate); }

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

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

现象描述：

[Java] 纯文本查看 复制代码

?

01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17

// 通过工单函数 public void adoptOrder(Long orderId) {     Order orderUpdate = new Order();     orderUpdate.setId(orderId);     orderUpdate.setStatus(OrderStatus.ADOPTED);     orderUpdate.setAuditTime(new Date());     orderDAO.update(orderUpdate); }   // 驳回工单函数 public void rejectOrder(Long orderId) {     Order orderUpdate = new Order();     orderUpdate.setId(orderId);     orderUpdate.setStatus(OrderStatus.REJECTED);     orderUpdate.setAuditTime(new Date());     orderDAO.update(orderUpdate); }

建议方案

[Java] 纯文本查看 复制代码

?

01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18

// 通过工单函数 public void adoptOrder(Long orderId) {     auditOrder(orderId, OrderStatus.ADOPTED); }   // 驳回工单函数 public void rejectOrder(Long orderId) {     auditOrder(orderId, OrderStatus.REJECTED); }   // 审核工单函数 private void auditOrder(Long orderId, OrderStatus orderStatus) {     Order orderUpdate = new Order();     orderUpdate.setId(orderId);     orderUpdate.setStatus(orderStatus);     orderUpdate.setAuditTime(new Date());     orderDAO.update(orderUpdate); }

主要收益

• 封装公共函数，减少代码行数，提高代码质量；
• 封装公共函数，使业务代码更精炼，可读性可维护性更强。

封装获取参数值函数

案例一

现象描述：

[Java] 纯文本查看 复制代码

?

01 02 03 04 05 06 07 08 09 10 11 12 13 14

// 是否通过函数 public boolean isPassed(Long userId) {     // 获取通过阈值     double thisPassThreshold = PASS_THRESHOLD;     if (Objects.nonNull(passThreshold)) {         thisPassThreshold = passThreshold;     }       // 获取通过率     double passRate = getPassRate(userId);       // 判读是否通过     return passRate >= thisPassThreshold; }

建议方案

[Java] 纯文本查看 复制代码

?

01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19

// 是否通过函数 public boolean isPassed(Long userId) {     // 获取通过阈值     double thisPassThreshold = getPassThreshold();       // 获取通过率     double passRate = getPassRate(userId);       // 判读是否通过     return passRate >= thisPassThreshold; }   // 获取通过阈值函数 private double getPassThreshold() {     if (Objects.nonNull(passThreshold)) {         return passThreshold;     }     return PASS_THRESHOLD; }

主要收益

• 把获取参数值从业务函数中独立，使业务逻辑更清晰；
• 封装的获取参数值为独立函数，可以在代码中重复使用。