你写的代码不够优雅

本文探讨了如何提升代码的优雅性,包括使用通用工具函数、拆分超大函数、保持代码块级别一致、封装相同功能代码以及避免不必要的空指针判断。通过这些实践,可以使代码更加简洁、易于理解和维护。
摘要由CSDN通过智能技术生成

使用通用工具函数
2.1 案例一

现象描述:

不完善的写法:

thisName != null && thisName.equals(name);
更完善的写法:
(thisName == name) || (thisName != null && thisName.equals(name));
建议方案:
Objects.equals(name, thisName);
2.2 案例二

现象描述:
!(list == null || list.isEmpty());
建议方案:
import org.apache.commons.collections4.CollectionUtils;
CollectionUtils.isNotEmpty(list);
2.3 主要收益

函数式编程,业务代码减少,逻辑一目了然;

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

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

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

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

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

现象描述:

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

// 编码
// 编码相关代码几十行

// 睡觉
// 睡觉相关代码几十行

}
建议方案:
// 每日生活函数
public void liveDaily() {
// 吃饭
eat();

// 编码
code();

// 睡觉
sleep();

}

// 吃饭函数
private void eat() {
// 吃饭相关代码
}

// 编码函数
private void code() {
// 编码相关代码
}

// 睡觉函数
private void sleep() {
// 睡觉相关代码
}
3.2 案例二:每一个循环体都可以封装为一个函
现象描述:

// 生活函数
public void live() {
while (isAlive) {
// 吃饭
eat();

    // 编码
    code();

    // 睡觉
    sleep();
}

}
建议方案:
// 生活函数
public void live() {
while (isAlive) {
// 每日生活
liveDaily();
}
}

// 每日生活函数
private void liveDaily() {
// 吃饭
eat();

// 编码
code();

// 睡觉
sleep();

}
3.3 案例三:每一个条件体都可以封装为一个函
现象描述:

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

// 游玩函数
private void play() {
// 游玩代码几十行
}

// 工作函数
private void work() {
// 工作代码几十行
}
3.4 主要收益

函数越短小精悍,功能就越单一,往往生命周期较长;

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

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

4.同一函数内代码块级别尽量一致
4.1 案例一
现象描述:
// 每日生活函数
public void liveDaily() {
// 吃饭
eat();

// 编码
code();

// 睡觉
// 睡觉相关代码几十行

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

建议方案:
public void liveDaily() {
// 吃饭
eat();

// 编码
code();

// 睡觉
sleep();

}

// 睡觉
private void sleep() {
// 睡觉相关代码
}
4.2 主要收益

函数调用表明用途,函数实现表达逻辑,层次分明便于理解;

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

5.封装相同功能代码为函数
5.1 案例一&

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值