手把手教你，如何先梳理业务逻辑再写代码

红太狼 2024-03-08 08:52 52阅读 0赞

#### 1.业务逻辑与代码 ####

###### 代码是需求逻辑的一种展现形式 ######

[需][Link 1]求文档是业务逻辑的一种展现形式，而代码不过是业务逻辑的另一种表现形式；如果逻辑本身有问题，那么它的各种展示形式自然也是错的，所以写代码前应该先思考清楚业务逻辑。

###### Review代码很多时候是逻辑问题 ######

在Review代码经验中发现：混乱的代码并不仅仅是代码编写技艺问题，很多时候是因为逻辑没有梳理清楚。逻辑混乱，自然代码也混乱。梳理清楚业务逻辑，就为代码打下了良好的基础。当然业务逻辑梳理清楚后，业务逻辑到代码的映射依然有可能出问题，这是编程技艺要解决的问题。下面通过一个简单的例子来演示这个过程：

#### 2.业务需求示例 ####

我们要做一件事情doSomething：

第一步先做 A，A 过程要先执行 a1, 然后执行 a2, 然后执行 a3 这三个子过程。

第二步再做 B，B 过程需要执行 b1，然后 b2 这两个子过程。

这个示例逻辑的图形表述如下：是一个树，包含树的根，枝干，和叶子。

![在这里插入图片描述][97ba5361439349d2bcfd0494bead63d7.png]

> 例子是有通用性的，现实世界的任何事情或业务都可以用类似的树形结构来表述。

#### 3.正确的代码实现 ####

###### 3.1 和逻辑树映射的代码树 ######

正确的代码结构应该是和逻辑映射的，代码结构如下：  
![在这里插入图片描述][df0750776d584d15850eac00943e7bcc.png]  
我们真实写代码的时候，一般并不会直接写出如上结构，而是会先写出「3.2 代码块 + 注释」的结构来。

###### 3.2 代码块 + 合理注释 ######

如下代码通过代码块来映射逻辑，上面图中的子方法对应代码中的注释。

void doSomething(){
        
        //A
        a1逻辑伪代码.....;//a1
        a2逻辑伪代码.....;//a2
        a3逻辑伪代码.....;//a3
    
        //B
        b1逻辑伪代码;//b1
        b2逻辑伪代码;//b2
    }

###### 3.3 抽取小方法 ######

可以再上面的基础上更优秀些，对代码块进行抽取小方法，更符合业务描述（更符合业务的树形结构）。推荐阅读：看看人家 SpringBoot + vue后台管理系统，多么优雅…

void doSomething(){
        
        doA();
        doB();
    }
    
    void doA(){
        
        a1逻辑伪代码.....;
        a2逻辑伪代码.....;
        a3逻辑伪代码.....;
    }
    void doB(){
        
        b1逻辑伪代码;
        b2逻辑伪代码;
    }

当然你也可以继续对 a1,a2,a3,b1,b2 等小逻辑映射为小方法，以上提到几种写法都是正确的，关于小方法是否抽取，后续单独在《代码长度与母语的关系》中讨论。下面我们来看看不正确的写法。

#### 4.不正确的代码实现 ####

当你看到下面的不正确的写法的时候，你也许会觉得不可思议，真的会写出这样的代码？现实是：项目中我见到很多更糟糕的代码，会把下面提到的问题，以及其他编程技艺的问题排列组合出现。

###### 4.1 第一种问题：不对等 ######

第一种常见的问题不太严重，只对部分逻辑进行了抽取，造成方法中执行不对等；比如只对 b() 逻辑进行了抽取，但对等的 a（）逻辑并未抽取；  
![在这里插入图片描述][d44c03f76e82472c83d77f93e32e93b7.png]

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逻辑伪代码;
    }

###### 4.2 第二种问题：部分抽取 ######

第二种是对整体的部分逻辑进行了抽取，这种方法很难命名，会给个词不达意的名字，或使用整体的名字，这个就相对严重了，已经影响到了代码阅读和理解。

> 比如电脑是一个整体，可以命名是电脑；如果只给你一部分（CPU，主板，显卡）怎么命名让人能明白？电脑部分零件？但电脑部分零件并不能让人明白，因为它不是一个逻辑主体。CPU是一个逻辑主体，封装了运算。

如下图，只对 a1,a2 进行了抽取，然后名字依然称为 a，看到代码会很疑惑，a3 明显也属于 a。  
![在这里插入图片描述][d39202ee84804cef92a17f5878415c09.png]

void doSomething(){
        
        doA();
        a3逻辑伪代码.....;
        doB();
    }
    void doA(){
        
        a1逻辑伪代码.....;
        a2逻辑伪代码.....;
    }
    
    void doB(){
        
        b1逻辑伪代码;
        b2逻辑伪代码;
    }

###### 4.3 第三种问题：抽取错误 ######

第三种是最严重的问题，抽取错误，和逻辑不匹配。

如下：把 A 的部分逻辑和 B 的部分逻辑一起抽取。

如果在这个基础上再对抽取的部分起个晦涩的名字（其实这种抽取也起不到好名字），然后应用一些设计模式来把代码更分散（缺点隐藏起来），就成功的完成了只有自己可以看懂的代码（可能表面看起来还很高大上）。  
![在这里插入图片描述][b2abc21d33ea422790ab8e84908c525b.png]

> 由此得出结论，先别想着抽取小方法或应用设计模式。先能平铺直叙的写出符合逻辑的代码吧。
> 
> 小方法抽取和设计模式不一定能解决问题，也能隐藏问题。

很多难以读懂的代码都是受《重构》和《设计模式》的包装，质量差的代码不可怕，如果再抽取和包装，可以想想是多恐怖。

#### 5.补丁和模式思考 ####

**补丁代码思考，代码的腐烂**

很多人看到这里，会觉得自己绝对不会写出这么烂的代码；确实一开始也许不会，但伴随新需求，不同人不断打补丁（为了不影响线上，老代码不让动），最后就会演进未这几个问题综合展现的代码。阅读这样的代码不看到最底层代码，根本不知道代码在做什么，因为方法名已经不可信。

**不要急于使用设计模式，写好基础代码**

写出一个好的基础代码的过程：

> 先梳理清楚逻辑树（树形结构，同层对等），然后做到代码符合逻辑树（代码树自然也符合树形结构，同层的方法对等）。

打好基础后，可以再针对基础代码的痛点，应用复杂手段（比如设计模式）来解决

[Link 1]: https://mp.weixin.qq.com/s/2V89PZrUnEPnqBz52Tc0Rw?st=06D82C540A3A78B3B7B8F76C8E9C9417BF5443F435012C424E7AF14B5521BBA46E88B7E43E0559B4B62A5610DC473555DCB0864A284397596AE93AA8B985EC7BCCDC68F23B9DA0F3CFBB667EC925EAE6C1DEF5B9CA4AA148B74001A8E6CCE9D4A1D7EB58BD71B4E398027B5E0B637597A23CF656CA86668830FB675128433E90A2B87BE95AC74FFDDC24901050407BE90A0B2A41C07D81FF304DC08A32001B0877DADA464D70959D569F31ACE357FA27B00060AEF2A62137739EEF782938392B57160DE0AEE007BA17DADD0AB711C807BE3236710AEA9D475F343DAF4BA1C32760603D209E98D97E1FE875254BF06108&vid=1688855454421461&cst=B67338CAD14B3A2F042D39687FC7994EC5B7DF06025C6BD6AE546844A4A0A0A6BD1ADCEE544790472CD12F06261D27E3&deviceid=d9b3708d-7791-40d3-8f3b-6f3af5ab1266&version=4.0.6.6516&platform=win
[97ba5361439349d2bcfd0494bead63d7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/08/4284c2ccf1564c2ba422111708eea329.png
[df0750776d584d15850eac00943e7bcc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/08/3138c7f2e5fb432083380e8522d3de70.png
[d44c03f76e82472c83d77f93e32e93b7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/08/0d58aef5dc204cfa953d0cfde25e0b60.png
[d39202ee84804cef92a17f5878415c09.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/08/5f5dbe231d0949a9a3fa4b00e5a8dc5a.png
[b2abc21d33ea422790ab8e84908c525b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/08/2a08839c01094da599879a022a419558.png