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

news2024/12/29 11:42:29

1.业务逻辑与代码

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

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

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

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

2.业务需求示例

我们要做一件事情doSomething：

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

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

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

在这里插入图片描述

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

3.正确的代码实现

3.1 和逻辑树映射的代码树

正确的代码结构应该是和逻辑映射的，代码结构如下：
在这里插入图片描述
我们真实写代码的时候，一般并不会直接写出如上结构，而是会先写出「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（）逻辑并未抽取；
在这里插入图片描述

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。
在这里插入图片描述

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

void doB(){
    b1逻辑伪代码;
    b2逻辑伪代码;
}