java函数优雅之道（下）

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

案例一

现象描述：

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

// 发送审核员结算数据函数

public void sendAuditorSettleData() {

List<WorkerSettleData> settleDataList = auditTaskDAO.statAuditorSettleData();

for (WorkerSettleData settleData : settleDataList) {

WorkerPushData pushData = new WorkerPushData();

pushData.setId(settleData.getWorkerId());

pushData.setType(WorkerPushDataType.AUDITOR);

pushData.setData(settleData);

pushService.push(pushData);

}

// 发送验收员结算数据函数

public void sendCheckerSettleData() {

List<WorkerSettleData> settleDataList = auditTaskDAO.statCheckerSettleData();

for (WorkerSettleData settleData : settleDataList) {

WorkerPushData pushData = new WorkerPushData();

pushData.setId(settleData.getWorkerId());

pushData.setType(WorkerPushDataType.CHECKER);

pushData.setData(settleData);

pushService.push(pushData);

}

建议方案

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

// 发送审核员结算数据函数

public void sendAuditorSettleData() {

sendWorkerSettleData(WorkerPushDataType.AUDITOR, () -> auditTaskDAO.statAuditorSettleData());

}

// 发送验收员结算数据函数

public void sendCheckerSettleData() {

sendWorkerSettleData(WorkerPushDataType.CHECKER, () -> auditTaskDAO.statCheckerSettleData());

}

// 发送作业员结算数据函数

public void sendWorkerSettleData(WorkerPushDataType dataType, WorkerSettleDataProvider dataProvider) {

List<WorkerSettleData> settleDataList = dataProvider.statWorkerSettleData();

for (WorkerSettleData settleData : settleDataList) {

WorkerPushData pushData = new WorkerPushData();

pushData.setId(settleData.getWorkerId());

pushData.setType(dataType);

pushData.setData(settleData);

pushService.push(pushData);

}

// 作业员结算数据提供者接口

private interface WorkerSettleDataProvider {

// 统计作业员结算数据

public List<WorkerSettleData> statWorkerSettleData();

}

主要收益

把核心逻辑从各个业务函数中抽析，使业务代码更清晰更易维护；
避免重复性代码多次编写，精简重复函数越多收益越大。

减少函数代码层级

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

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

现象描述：

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

// 获取用户余额函数

public Double getUserBalance(Long userId) {

User user = getUser(userId);

if (Objects.nonNull(user)) {

UserAccount account = user.getAccount();

if (Objects.nonNull(account)) {

return account.getBalance();

}

return null;

}

建议方案

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

// 获取用户余额函数

public Double getUserBalance(Long userId) {

// 获取用户信息

User user = getUser(userId);

if (Objects.isNull(user)) {

return null;

}

// 获取用户账户

UserAccount account = user.getAccount();

if (Objects.isNull(account)) {

return null;

}

// 返回账户余额

return account.getBalance();

}

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

现象描述：

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

// 获取合计余额函数

public double getTotalBalance(List<User> userList) {

// 初始合计余额

double totalBalance = 0.0D;

// 依次累加余额

for (User user : userList) {

// 获取用户账户

UserAccount account = user.getAccount();

if (Objects.nonNull(account)) {

// 累加用户余额

Double balance = account.getBalance();

if (Objects.nonNull(balance)) {

totalBalance += balance;

}

// 返回合计余额

return totalBalance;

}

建议方案

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

// 获取合计余额函数

public double getTotalBalance(List<User> userList) {

// 初始合计余额

double totalBalance = 0.0D;

// 依次累加余额

for (User user : userList) {

// 获取用户账户

UserAccount account = user.getAccount();

if (Objects.isNull(account)) {

continue;

}

// 累加用户余额

Double balance = account.getBalance();

if (Objects.nonNull(balance)) {

totalBalance += balance;

}

// 返回合计余额

return totalBalance;

}

特殊说明

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

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

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

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

主要收益

代码层级减少，代码缩进减少；
模块划分清晰，方便阅读维护。

封装条件表达式函数

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

现象描述：

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

// 获取门票价格函数

public double getTicketPrice(Date currDate) {

if (Objects.nonNull(currDate) && currDate.after(DISCOUNT_BEGIN_DATE)

&& currDate.before(DISCOUNT_END_DATE)) {

return TICKET_PRICE * DISCOUNT_RATE;

}

return TICKET_PRICE;

}

建议方案

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

// 获取门票价格函数

public double getTicketPrice(Date currDate) {

if (isDiscountDate(currDate)) {

return TICKET_PRICE * DISCOUNT_RATE;

}

return TICKET_PRICE;

}

// 是否折扣日期函数

private static boolean isDiscountDate(Date currDate) {

return Objects.nonNull(currDate) &&

currDate.after(DISCOUNT_BEGIN_DATE)

&& currDate.before(DISCOUNT_END_DATE);

}

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

现象描述：

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

// 获取土豪用户列表

public List<User> getRichUserList(List<User> userList) {

// 初始土豪用户列表

List<User> richUserList = new ArrayList<>();

// 依次查找土豪用户

for (User user : userList) {

// 获取用户账户

UserAccount account = user.getAccount();

if (Objects.nonNull(account)) {

// 判断用户余额

Double balance = account.getBalance();

if (Objects.nonNull(balance) && balance.compareTo(RICH_THRESHOLD) >= 0) {

// 添加土豪用户

richUserList.add(user);

}

// 返回土豪用户列表

return richUserList;

}

建议方案

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

// 获取土豪用户列表

public List<User> getRichUserList(List<User> userList) {

// 初始土豪用户列表

List<User> richUserList = new ArrayList<>();

// 依次查找土豪用户

for (User user : userList) {

// 判断土豪用户

if (isRichUser(user)) {

// 添加土豪用户

richUserList.add(user);

}

// 返回土豪用户列表

return richUserList;

}

// 是否土豪用户

private boolean isRichUser(User user) {

// 获取用户账户

UserAccount account = user.getAccount();

if (Objects.isNull(account)) {

return false;

}

// 获取用户余额

Double balance = account.getBalance();

if (Objects.isNull(balance)) {

return false;

}

// 比较用户余额

return balance.compareTo(RICH_THRESHOLD) >= 0;

}

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

主要收益

把条件表达式从业务函数中独立，使业务逻辑更清晰；
封装的条件表达式为独立函数，可以在代码中重复使用。

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

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

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

现象描述：

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

// 创建用户信息

User user = new User();

... // 赋值用户相关信息

createUser(user);

// 创建用户函数

private void createUser(User user){

// 判断用户为空

if(Objects.isNull(user)) {

return;

}

// 创建用户信息

userDAO.insert(user);

userRedis.save(user);

}

建议方案

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

// 创建用户信息

User user = new User();

... // 赋值用户相关信息

createUser(user);

// 创建用户函数

private void createUser(User user){

// 创建用户信息

userDAO.insert(user);

userRedis.save(user);

}

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

现象描述：

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

// 保存用户函数

public void saveUser(Long id, String name) {

// 构建用户信息

User user = buildUser(id, name);

if (Objects.isNull(user)) {

throw new BizRuntimeException("构建用户信息为空");

}

// 保存用户信息

userDAO.insert(user);

userRedis.save(user);

}

// 构建用户函数

private User buildUser(Long id, String name) {

User user = new User();

user.setId(id);

user.setName(name);

return user;

}

建议方案

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

// 保存用户函数

public void saveUser(Long id, String name) {

// 构建用户信息

User user = buildUser(id, name);

// 保存用户信息

userDAO.insert(user);

userRedis.save(user);

}

// 构建用户函数

private User buildUser(Long id, String name) {

User user = new User();

user.setId(id);

user.setName(name);

return user;

}

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

现象描述：

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

// 查询用户列表

List<UserDO> userList = userDAO.queryAll();

if (CollectionUtils.isEmpty(userList)) {

return;

}

// 转化用户列表

List<UserVO> userVoList = new ArrayList<>(userList.size());

for (UserDO user : userList) {

UserVO userVo = new UserVO();

userVo.setId(user.getId());

userVo.setName(user.getName());

userVoList.add(userVo);

}

// 依次处理用户

for (UserVO userVo : userVoList) {

// 判断用户为空

if (Objects.isNull(userVo)) {

continue;

}

// 处理相关逻辑

...

}

建议方案

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

// 查询用户列表

List<UserDO> userList = userDAO.queryAll();

if (CollectionUtils.isEmpty(userList)) {

return;

}

// 转化用户列表

List<UserVO> userVoList = new ArrayList<>(userList.size());

for (UserDO user : userList) {

UserVO userVo = new UserVO();

userVo.setId(user.getId());

userVo.setName(user.getName());

userVoList.add(userVo);

}

// 依次处理用户

for (UserVO userVo : userVoList) {

// 处理相关逻辑

...

}

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

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

现象描述：

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

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

// 查询用户函数

public List<UserVO> queryUser(Long id, String name) {

// 查询用户列表

List<UserDO> userList = userDAO.query(id, name);

if (Objects.isNull(userList)) {

return Collections.emptyList();

}

// 转化用户列表

List<UserVO> voList = new ArrayList<>(userList.size());

for (UserDO user : userList) {

// 判断对象为空

if (Objects.isNull(user)) {

continue;

}

// 添加用户信息

UserVO vo = new UserVO();

BeanUtils.copyProperties(user, vo);

voList.add(vo);

}

// 返回用户列表

return voList;

}

建议方案

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

// 查询用户函数

public List<UserVO> queryUser(Long id, String name) {

// 查询用户列表

List<UserDO> userList = userDAO.query(id, name);

// 转化用户列表

List<UserVO> voList = new ArrayList<>(userList.size());

for (UserDO user : userList) {

UserVO vo = new UserVO();

BeanUtils.copyProperties(user, vo);

voList.add(vo);

}

// 返回用户列表

return voList;

}

主要收益

避免不必要的空指针判断，精简业务代码处理逻辑，提高业务代码运行效率；
这些不必要的空指针判断，基本属于永远不执行的Death代码，删除有助于代码维护。

爱学习的小肥猪

发布了667 篇原创文章 · 获赞 6 · 访问量 9048

私信关注

java函数优雅之道（下）

猜你喜欢