二、业务需求示例
我们要做一件事情doSomething:
- 第一步先做 A,A 过程要先执行 a1, 然后执行 a2, 然后执行 a3 这三个子过程。
- 第二步再做 B,B 过程需要执行 b1,然后 b2 这两个子过程。
这个示例逻辑的图形表述如下:是一个树,包含树的根,枝干,和叶子。
例子是有通用性的,现实世界的任何事情或业务都可以用类似的树形结构来表述。
三、正确的代码实现
1. 和逻辑树映射的代码树
正确的代码结构应该是和逻辑映射的,代码结构如下:
我们真实写代码的时候,一般并不会直接写出如上结构,而是会先写出「3.2 代码块 + 注释」的结构来。
2. 代码块 + 合理注释
如下代码通过代码块来映射逻辑,上面图中的子方法对应代码中的注释。
void doSomething(){
//A
a1逻辑伪代码.....;//a1
a2逻辑伪代码.....;//a2
a3逻辑伪代码.....;//a3
//B
b1逻辑伪代码;//b1
b2逻辑伪代码;//b2
}
3. 抽取小方法
可以再上面的基础上更优秀些,对代码块进行抽取小方法,更符合业务描述(更符合业务的树形结构)。推荐阅读:看看人家 SpringBoot + vue后台管理系统,多么优雅...
void doSomething(){
doA();
doB();
}
void doA(){
a1逻辑伪代码.....;
a2逻辑伪代码.....;
a3逻辑伪代码.....;
}
void doB(){
b1逻辑伪代码;
b2逻辑伪代码;
}
当然你也可以继续对 a1,a2,a3,b1,b2 等小逻辑映射为小方法,以上提到几种写法都是正确的,关于小方法是否抽取,后续单独在《代码长度与母语的关系》中讨论。下面我们来看看不正确的写法。
四、不正确的代码实现 ===========
当你看到下面的不正确的写法的时候,你也许会觉得不可思议,真的会写出这样的代码?现实是:项目中我见到很多更糟糕的代码,会把下面提到的问题,以及其他编程技艺的问题排列组合出现。
1. 第一种问题:不对等
第一种常见的问题不太严重,只对部分逻辑进行了抽取,造成方法中执行不对等;比如只对 b() 逻辑进行了抽取,但对等的 a()逻辑并未抽取;
void doSomething(){
a1逻辑伪代码.....;
a2逻辑伪代码.....;
a3逻辑伪代码.....;
doB();
}
void doB(){
b1逻辑伪代码;
b2逻辑伪代码;
}
改进办法参考上面第 3 部分正确的写法,至少可以在doB();之前加空行,并对 a1,a2,a3 加个注释,也会易读很多(当然这是一种妥协写法)。
void doSomething(){
//a逻辑
a1逻辑伪代码.....;
a2逻辑伪代码.....;
a3逻辑伪代码.....;
//b逻辑
doB();
}
void doB(){
b1逻辑伪代码;
b2逻辑伪代码;
}
2. 第二种问题:部分抽取
第二种是对整体的部分逻辑进行了抽取,这种方法很难命名,会给个词不达意的名字,或使用整体的名字,这个就相对严重了,已经影响到了代码阅读和理解。
比如电脑是一个整体,可以命名是电脑;如果只给你一部分(CPU,主板,显卡)怎么命名让人能明白?电脑部分零件?但电脑部分零件并不能让人明白,因为它不是一个逻辑主体。CPU 是一个逻辑主体,封装了运算。
如下图,只对 a1,a2 进行了抽取,然后名字依然称为 a,看到代码会很疑惑,a3 明显也属于 a。
void doSomething(){
doA();
a3逻辑伪代码.....;
doB();
}
void doA(){
a1逻辑伪代码.....;
a2逻辑伪代码.....;
}
void doB(){
b1逻辑伪代码;
b2逻辑伪代码;
}
3. 第三种问题:抽取错误
第三种是最严重的问题,抽取错误,和逻辑不匹配。
如下:把 A 的部分逻辑和 B 的部分逻辑一起抽取。
如果在这个基础上再对抽取的部分起个晦涩的名字(其实这种抽取也起不到好名字),然后应用一些设计模式来把代码更分散(缺点隐藏起来),就成功的完成了只有自己可以看懂的代码(可能表面看起来还很高大上)。
由此得出结论,先别想着抽取小方法或应用设计模式。先能平铺直叙的写出符合逻辑的代码吧。
小方法抽取和设计模式不一定能解决问题,也能隐藏问题。
很多难以读懂的代码都是受《重构》和《设计模式》的包装,质量差的代码不可怕,如果再抽取和包装,可以想想是多恐怖。
五、补丁和模式思考
(1) 补丁代码思考,代码的腐烂
很多人看到这里,会觉得自己绝对不会写出这么烂的代码;确实一开始也许不会,但伴随新需求,不同人不断打补丁(为了不影响线上,老代码不让动),最后就会演进未这几个问题综合展现的代码。阅读这样的代码不看到最底层代码,根本不知道代码在做什么,因为方法名已经不可信。
(2) 不要急于使用设计模式,写好基础代码
写出一个好的基础代码的过程:先梳理清楚逻辑树(树形结构,同层对等),然后做到代码符合逻辑树(代码树自然也符合树形结构,同层的方法对等)。
打好基础后,可以再针对基础代码的痛点,应用复杂手段(比如设计模式)来解决,关于方法抽取和方法长度,后续单独文章讨论。