前阵子做技术方案评审,一位同事上来就贴了一大段写好的PHP代码,让大家直接看。会议室里安静了几秒,然后有人问:你这段逻辑的核心思路是什么?他又从头讲了一遍,大家才明白他要做的是订单超时后的自动关闭。这个场景我见过太多次了。如果他在贴代码之前,先用十行伪代码把流程摆出来,评审十分钟就能结束,不需要反复追问。
伪代码这个概念,大家从学校就听过,但工作以后真正用好的人不多。它不追求任何一门语言的语法正确,追求的是把“逻辑”本身说清楚。面试算法题的时候,我先写伪代码再翻译成题目要求的语言;做方案设计的时候,我先在文档里写伪代码,再画架构图;跨端协作的时候,iOS、Android、后端三个人坐在一起,伪代码是我们唯一不需要翻译的共同语言。
这篇内容就是想把伪代码这件事讲透:它到底解决什么问题、核心要素有哪些、好的和差的差在哪里、怎么从需求一步步落到真实代码,以及我这些年踩过的伪代码的坑。适合的人群很简单:写代码的人、要做技术方案的人、准备面试的人,还包括想把自己的想法讲清楚的非技术同学。
1. 伪代码是先想清楚再动手,不是写完代码后的文档装饰
很多人觉得写代码之前画个流程图就够了,我的实际体会是:流程图适合表达大框架,但一旦涉及分支条件、循环边界、异常处理,流程图很容易画成一团乱麻。伪代码是介于自然语言和真实代码之间的表达方式,它足够精确,又不会被语法细节拖住。
举个例子,你要实现“当用户取消订单时,如果订单已经支付,走退款流程;如果还没支付,直接关闭;如果正在配送中,则不允许取消”。用流程图画,三个分支加上异常处理,线条会绕来绕去;用伪代码写,三五行就能把规则定下来:
text复制函数 取消订单(订单):
如果 订单.状态 == 已支付:
调用 退款(订单)
否则如果 订单.状态 == 待支付:
设置 订单.状态 = 已关闭
否则:
返回 错误("配送中订单不可取消")
这段伪代码还没谈数据库事务、消息队列、退款回调,但核心规则的骨架已经清楚了。开发拿到它,翻译成任何语言都不难。
1.1 伪代码的读者是你自己,也是三个月后的你
伪代码最大的价值是“让人看懂”,而不是“让机器运行”。它的读者有三类人:你自己(在写代码前梳理思路)、你的同事(在评审时理解方案)、面试官(在考察思路时判断能力)。
既然是沟通工具,就要注意两个问题。第一,不要写只有自己能看懂的缩写和暗号;第二,不要省略关键的异常分支,省略了等于没说。很多人伪代码写得含糊,本质上是思路本身没理清。
我经常用一句话问自己:如果我把这段伪代码发给一个不了解这个项目的同事,他能不能在五分钟内复述出完整逻辑?如果答案是不能,说明伪代码还没有写到位。这个标准听起来简单,实际操作中能难倒不少人,因为大部分人写着写着就陷入了“用代码思维表达”的陷阱,忘记了伪代码的本质是沟通。
1.2 为什么伪代码比架构图更接近真相
做方案设计时,很多人习惯先画架构图。架构图擅长表达系统间的关系:谁调用谁、数据流向哪里、有几个服务。但架构图画不出严格的分支顺序,也画不出金额校验的边界条件。伪代码可以。
架构图回答的是“系统有哪些角色,它们之间怎么协作”,伪代码回答的是“一个具体的请求从进入到结束,每一步到底做了什么判断、什么操作”。两者互补,但伪代码更接近落地实现。我自己做设计文档的习惯是:先写一版伪代码,再画架构图。伪代码帮助我把逻辑边界定下来,架构图帮助我把系统边界画出来。顺序反过来,常常会画出漂亮的架构图,但核心逻辑还是一团糨糊。
需要模型API调用? 免费领10W Token,多模型网关一键接入 Claude、DeepSeek 等主流模型。
2. 伪代码的五块骨架:变量、分支、循环、函数、注释
伪代码没有官方语法,但好的伪代码有一套约定俗成的表达方式。这套方式不是谁规定的,是实践沉淀下来的:它让任何懂一点编程的人看到就能理解,让任何语言背景的人都能无障碍阅读。
| 伪代码要素 | 典型表达 | 对应真实代码概念 |
|---|---|---|
| 变量与赋值 | 设置 / 令 / ← | 变量声明、赋值 |
| 条件分支 | 如果…否则如果…否则 | if / else if / else |
| 循环遍历 | 遍历…中的…,按索引 i 从…到… | for / foreach / while |
| 函数抽象 | 函数…,调用… | 函数定义、调用 |
| 数据结构 | 队列、哈希表、栈、列表 | 对应语言的数据容器 |
| 注释 | // 说明 | 代码注释 |
2.1 变量与赋值:表达状态变化
伪代码里必须出现状态。你可以用“设置”“令”“让”这类词表示赋值,也可以用箭头符号“←”表示,更接近数学表达。重点是把“谁的状态变了,变成了什么”写清楚。
text复制currentUser ← 从会话中获取当前用户
剩余次数 = 用户.每日额度 - 今日已用次数
像这样写,逻辑的每一步都有状态变化,别人看起来就像在追踪一个过程。注意伪代码里不必声明类型,但关键的初始值最好写出来,尤其是那些影响后续逻辑的值。比如“剩余次数”这个变量,如果你不写它的初始值从哪来,读的人就无法判断这个值是实时计算的还是缓存里的快照。
2.2 分支条件:把所有可能性摆上台面
条件判断是伪代码里最重要的部分。真实业务里,问题往往不出在主流程,而出在分支没写全。所以我建议伪代码里把“否则”分支都显式写出来,哪怕后续这个分支什么都不做,也应该有个注释说明“这里无需处理”。
text复制如果 用户.会员等级 >= 3:
运费 = 0
否则:
运费 = 基础运费
这样写的好处是,开发在看到伪代码时不会被“如果”后面的条件搞晕,因为所有结果路径都摆在那里了。伪代码里不要写复杂的条件嵌套,如果嵌套超过两层,就该抽成函数或拆分成多个条件判断。嵌套太深的伪代码,读起来和复杂的真实代码一样痛苦,那就失去了伪代码的意义。
2.3 循环与遍历:处理批量对象的通用套路
处理集合、列表、队列时,用“遍历”表达最自然。伪代码里的循环要写清楚三件事:遍历什么、每次做什么、循环结束后的状态。
text复制遍历 待处理订单列表 中的 订单:
如果 订单.超时时间 < 当前时间:
调用 自动关闭订单(订单)
这里“遍历”就是 for each,“调用”就是函数调用。如果你需要索引,可以写“遍历 i 从 0 到 数组长度-1”。伪代码阶段不需要纠结用 for 还是 while,但循环的退出条件必须明确,否则逻辑又回到了模糊状态。
2.4 函数与抽象:让逻辑分层
好的伪代码应该像一篇好文章,有总起、有分述、有层次。主流程部分只写大步骤,复杂的子逻辑用函数名表示,然后在函数调用之下单独展开。
text复制函数 处理支付回调(回调数据):
验证 回调数据.签名
根据 回调数据.订单号 获取 订单
调用 更新订单支付状态(订单, 回调数据.支付结果)
调用 触发支付成功后续动作(订单)
主流程读起来像目录,子流程在下面单独展示。这个抽象层级非常重要,它决定了评审的人能不能快速抓住重点。如果一个函数体超过二三十行,就应该考虑把其中的子步骤再抽一层。伪代码的每一层,对应的应该是一个可以独立理解、独立测试的逻辑单元。
2.5 数据结构与关键存储表达:别回避核心设计
有些逻辑涉及队列、哈希表、栈等数据结构,伪代码阶段也应该写清楚。比如“把这个任务放入优先级队列,权重为 3”,比如“用 Map 记录用户ID到设备列表的映射”。数据结构选择是方案设计的关键,伪代码里不能含糊。
我见过一些人写伪代码时,遇到数据结构就一句话带过:“把数据存起来”。但存到什么结构里、用什么作为key、是全局唯一还是按用户维度隔离,这些都会影响后续实现。伪代码阶段把这些定下来,后面写代码时就不用重新纠结了。
2.6 注释:标注意图而不是解释语法
伪代码本身的注释主要用来写“为什么”。比如:
text复制// 这里必须先释放锁再发送消息,避免发送过程中其他线程阻塞
调用 发送消息(消息)
伪代码里写这种注释,能让后面接手的人理解设计意图,而不是靠猜。至于“这行代码把库存减一”这种解释型注释,伪代码里完全没必要写,因为伪代码本身已经足够直白。
3. 好的伪代码和烂的伪代码,差在哪里:一组对照实例
光讲要素不够,我拿一个真实场景来做对照。需求是:实现一个库存扣减接口,用户发起购买请求时,检查库存、扣减库存、生成订单。看起来简单,但伪代码写法不同,方案质量完全不同。
3.1 反面示例:能看懂每个词,但看不懂整个逻辑
text复制处理购买请求:
检查库存
如果库存够:
扣库存
生成订单
返回结果
这段伪代码的问题很明显:
- “检查库存”检查什么库存?查哪个数据源?是查数据库还是查缓存?
- “库存够”的判定条件是什么?是剩余量大于0,还是大于等于购买数量?
- “扣库存”扣完怎么防止超卖?有没有原子操作或锁?
- “生成订单”失败怎么办?库存要不要回滚?
- 两个请求同时通过了“检查库存”,如何避免都扣成功?
如果拿这段伪代码去评审,技术负责人至少要追问十多个问题,因为它实际上什么都没说清楚。这类伪代码最大的危害在于:它看起来写了,实际上没写。评审时容易被“一眼带过”,到了开发阶段才发现所有关键决策都要重新定。
3.2 正面示例:把规则和例外全部写清楚
text复制函数 处理购买请求(用户ID, 商品ID, 购买数量):
以 商品ID 为键 加分布式锁
尝试:
库存 ← 从数据库读取 商品ID 的库存
如果 库存 < 购买数量:
返回 失败("库存不足")
新库存 = 库存 - 购买数量
更新 商品ID 的库存 = 新库存 // 此处依赖锁保证并发安全
订单号 = 创建订单(用户ID, 商品ID, 购买数量, 金额)
返回 成功(订单号)
最终:
释放锁
同样是扣库存,这段伪代码把并发控制方式(锁)、库存阈值、数据库更新、订单创建和失败兜底路径都交代清楚了。开发拿到就能直接写,测试拿到也能据此设计用例。差别不在于字数多少,而在于每一个关键路径上的决策点都被显式写出来了。
3.3 命名、粒度和语言倾向
好的伪代码在命名上也有讲究。变量名用“库存”“订单”“用户”这样有业务含义的词,而不是 a、b、c。函数命名最好用动宾结构,“获取用户信息”“创建订单”“发送通知”,一眼就知道干什么。
粒度方面,伪代码的每一行应该对应真实代码中的 3 到 10 行。太粗了没有信息量,太细了又变成了某一种语言。比如“将字符串按逗号分割并去除首尾空格后转成整数列表”这一行,在真实代码里可能是三到五行,但伪代码里写一行就够了,因为这一步的语义足够清晰,不需要展开到具体API。
还有一个常见倾向问题,就是写着写着就写成了某个具体语言。比如写着写着写出了 $array 或者 List<String>,这就失去了伪代码的语言无关性。我一般会刻意避免使用某个语言特有的关键字和语法,使用通用的表达方式。如果某一段逻辑必须依赖特定语言的特性,我会用注释标出来,而不是直接把语言语法写进伪代码。
3.4 我给伪代码定的四条评判标准
这些年我逐渐形成了一套评判伪代码质量的标准,分享出来:
- 能不能让一个不懂当前代码库的人看懂主要流程
- 分支和异常路径是否完整,边界条件是否提及
- 抽象层级是否合理,主流程没有被复杂细节淹没
- 能否在不改变语义的情况下,翻译成至少两种语言
如果哪条不满足,我会认为伪代码还需要继续迭代。这不是苛刻,因为伪代码的目标就是减少后续沟通和返工的成本。伪代码写好了,开发和测试阶段节省的时间,远远超过写伪代码本身花的时间。
4. 完整演练:从退款需求到伪代码再到落地代码
前面讲了很多概念,这节我用一个相对完整的需求,走一遍从需求到伪代码再到真实代码的全过程。需求是:用户发起退款申请,系统判断订单是否满足退款条件,满足则进入退款流程,不满足则提示原因。
4.1 需求本身包含的隐含规则
这个需求听起来简单,但实际隐含了很多规则:
- 退款条件:订单已支付、退款金额不能超过剩余可退金额、订单不是已退款状态
- 同一订单可能多次退款,需要记录剩余可退金额
- 退款不是立即到账,需要生成退款单并异步回调
- 如果订单处于售后中,需要额外处理
这些规则如果不在伪代码阶段写出来,开发过程中一定会反复确认。我见过不少项目,就是因为这类隐含规则没有在方案阶段理清,导致开发到一半才发现“订单已退款了还能再退款”这种漏洞。
4.2 第一版伪代码:先搭主流程
text复制函数 申请退款(用户ID, 订单ID, 申请金额):
订单 ← 根据 订单ID 获取 订单,并校验归属 用户ID
如果 订单 == 无:
返回 错误("订单不存在")
如果 订单.支付状态 != 已支付:
返回 错误("订单未支付")
剩余可退额 ← 订单.实付金额 - 订单.已退款金额
如果 申请金额 > 剩余可退额:
返回 错误("退款金额超限")
退款单号 ← 创建退款单(订单ID, 用户ID, 申请金额)
调用 异步发起退款(退款单号)
返回 成功("退款受理")
这版伪代码把主体流程和核心校验都列出来了。但评审时发现了两个问题:第一,没有处理本地事务,创建退款单和异步发起退款之间如果异步步骤失败,退款单会残留;第二,订单如果是已被删除状态,需要额外处理。这些问题如果不写伪代码,往往要在联调阶段才暴露。
4.3 伪代码迭代:把事务和异常补上
text复制函数 申请退款(用户ID, 订单ID, 申请金额):
订单 ← 根据 订单ID 获取 订单,并校验归属 用户ID
如果 订单 == 无 或 订单.状态 == 已删除:
返回 错误("订单不存在")
如果 订单.支付状态 != 已支付:
返回 错误("订单未支付")
如果 订单.状态 == 售后中:
返回 错误("售后处理中,请勿重复申请")
剩余可退额 ← 订单.实付金额 - 订单.已退款金额
如果 申请金额 <= 0 或 申请金额 > 剩余可退额:
返回 错误("退款金额不合法")
开启 本地事务:
退款单号 ← 创建退款单(订单ID, 用户ID, 申请金额, 状态=待处理)
更新 订单.已退款金额 = 订单.已退款金额 + 申请金额
提交 事务
调用 异步发起退款(退款单号) // 失败时通过补偿任务重试
返回 成功("退款受理")
这一版的伪代码已经是可交付的方案级别。事务边界、金额校验、状态机、补偿机制都体现出来了。注意这里把“创建退款单”和“更新已退款金额”放进了同一个本地事务,这是为了保证数据一致性:如果退款单创建成功但金额没更新,后续计算剩余可退额就会出错。
4.4 翻译成真实代码
以Python为例,这段伪代码翻译成真实代码非常直接:
python复制def apply_refund(user_id: int, order_id: int, amount: float):
order = get_order_by_id(order_id)
if order is None or order.status == OrderStatus.DELETED:
return error("订单不存在")
if order.payment_status != PaymentStatus.PAID:
return error("订单未支付")
if order.status == OrderStatus.AFTER_SALE:
return error("售后处理中,请勿重复申请")
remain_amount = order.paid_amount - order.refunded_amount
if amount <= 0 or amount > remain_amount:
return error("退款金额不合法")
with transaction():
refund_no = create_refund_order(order.id, user_id, amount, RefundStatus.PENDING)
order.refunded_amount += amount
order.save()
async_refund(refund_no) # 失败时通过补偿任务重试
return success("退款受理")
从伪代码到真实代码的翻译几乎没有难度,因为伪代码阶段已经把逻辑和边界都定好了。这也是我认为伪代码真正价值所在:它让“思考”和“打字”两个阶段分开,思考时只关注逻辑,打字时只关注语法。真正需要动脑子的决策,在伪代码阶段就已经完成了。
4.5 伪代码阶段的沉淀物
实战中,伪代码做好之后最好直接放进设计文档,标注一下“核心逻辑示意”。后续开发、测试、复盘都以这份伪代码为锚点。即使之后重构换语言,这份伪代码也能继续使用,因为它描述的是业务逻辑本身,而不是语言实现细节。
我做过一个跨语言重构项目,旧系统用Java,新系统用Go,重构时最值钱的文档就是当初方案评审时留下的那几段伪代码。业务规则、边界条件、异常路径都在里面,团队成员照着伪代码翻译成Go,比对着旧Java代码猜业务规则快得多。
5. 这些伪代码的坑,我每个都踩过
最后分享几个我自己在伪代码使用中踩过的坑。这些坑单看都不大,但组合起来会让伪代码从一个好工具变成一种负担。
5.1 坑一:写着写着就写成了某种语言
我最早写伪代码,写着写着就把 if、for、while 全写上了,变量名也用了Java风格,后来直接变成了类Java代码。这样的坏处是,团队里其他语言背景的同事读着别扭,而且容易把语言特性代入讨论,偏离了逻辑本身。
现在的做法是,伪代码里尽量用中文关键词加结构化的缩进,可以保留少数广为人知的英文关键字(如 if/else/for),但变量名一定用业务词汇。这样无论团队用什么语言栈,读起来都没有障碍。
5.2 坑二:伪代码过于口语化,逻辑依然是糊的
和上面的坑相反,有人写的伪代码过于口语化。比如写“看一下用户有没有权限,有的话就让它过”。这句话里“看一下”“有的话”“让它过”都太模糊。是查角色还是查权限表?“过”是放行接口还是返回成功?这样的伪代码没有起到梳理逻辑的作用。
现在我要求团队写伪代码时,每个关键动作都要有明确的宾语和结果。不要写“处理一下”,要写“调用退款接口,返回成功或失败”;不要写“判断一下”,要写“判断订单状态是否为已支付”。伪代码的每一个动词都应该能翻译成对应的函数或操作。
5.3 坑三:在伪代码里做性能优化
伪代码阶段过分关注索引、缓存、批处理,是个很常见的错误。有一阵子我写伪代码时总想着“要不要加缓存”“数据库要不要分表”,结果主流程被大量优化细节淹没。
后来我总结出一个原则:伪代码阶段只讲逻辑和边界,性能优化放在真实代码实现和压测阶段再讨论。伪代码里偶尔可以用注释提一句“此处预计有性能瓶颈,待压测验证”,但不应该把优化方案写进主干。逻辑还没想清楚就想着优化,这是本末倒置。
5.4 坑四:不写边界条件和错误分支
很多伪代码的问题不是主流程有问题,而是边界条件完全没有提到。等到实现时才发现,空值、重复请求、并发冲突、超时这些情况都要处理。
我后来给团队定了一条规则:伪代码评审时,只盯着“空值、超限、重复、并发”这四个词找问题,每个函数都必须回答这四类场景。这个方法很笨,但有效。现在每次写完伪代码,我都会主动过一遍这四个场景,把对应的处理分支补上。
5.5 坑五:伪代码没有版本控制
伪代码经常出现在聊天记录和文档正文里,改来改去之后,旧版本就找不到了。方案讨论过程中,失去前后对比意味着很难回溯“为什么当时决定要加这个条件”。
我现在会把伪代码放在设计文档的独立代码块里,并标注修订日期和变更原因。比如“10月12日:增加订单删除状态校验,原因:线上出现已删除订单仍可发起退款的问题”。这样方案迭代时,整个思考过程是有痕迹的。这个习惯在项目复盘时尤其有价值,能帮团队看清哪些决策是经过充分讨论的,哪些是拍脑袋定的。
5.6 我现在的伪代码使用习惯
写代码之前,先用 5 到 10 行伪代码把核心流程写下来,然后自问三个问题:这个流程有没有遗漏边界条件?别人能否看懂?翻译成目标语言有没有歧义?
评审别人的方案时,如果对方没有伪代码,我会要求他补充。这是快速了解一个方案成本最低的方式。很多时候你会惊讶地发现,对方讲五分钟都没讲清楚的需求,写十行伪代码就一目了然了。
面试候选人时,我也会特别留意候选人写伪代码的条理。这不是形式主义,因为伪代码的混乱通常暴露的是逻辑的混乱。有些人代码写得飞快,但让他先用伪代码讲讲思路就露馅了,说明他对问题的理解还不够透彻。
说到底,伪代码示意这件事,看似不起眼,但它体现了工程师最重要的能力之一:把复杂问题拆成清晰步骤、并用他人能理解的方式表达出来的能力。这个能力,值得刻意练习。
