跳到正文
  1. How-to
  2. 在真实项目里
  3. 重构:换个写法,功能不变

重构:换个写法,功能不变

一句话先把现在的输出存一份,再改结构。改完拿同样的输出对比,证明一点没变。

一次中等重构一到两次对话适用:代码越改越乱,想整理结构,但用户那边什么都不能变完整教程第 5 步:设计、动手、收拾干净

先照抄一个

最短的写法
/pstack:poteto-mode 把解析逻辑收到一个模块里,零行为变化。先记下现在的输出,改完证明它没变。

重构的意思是:代码的结构变了,程序的行为一点没变。

  • 零行为变化:用户看到的东西都不变。它会把这次当成重构,不加功能,也不修 bug。
  • 先记下现在的输出:先存一份「改之前」,改完才有得比。只说「类型检查通过」不算,那只能说明代码能编译。
  1. 1存一份现在的输出基线:build 一次,复制 dist
  2. 2改结构先删再加
  3. 3再出一份同样的命令
  4. 4两份对比diff 为空,就是一点没变
图示不用读懂每一行代码,看最后那条 diff 的输出就够了。

Astro 静态站的例子

十几个页面各写了一段格式化日期的代码,写法还不太一样。你想收成一个工具函数。

Astro 静态站的例子
/pstack:poteto-mode 把各个页面里格式化日期的代码收到一个工具函数里,零行为变化。
动手之前:先跑 npm run build,把 dist 目录整个复制一份作为基线。
改完再 build 一次,和基线 diff。所有 HTML 文件的 diff 必须为空。
旧的写法全部删掉,不要留兼容的旧函数。
给我看 diff 命令和它的输出。
  • dist 的 diff 为空:为空就是没变,多一行就是变了。你不用读懂每行代码,看这条命令的输出就够。
  • 不留兼容的旧函数:调用的地方都改过去,旧的同一次删掉。

diff 不为空,就让它逐条解释。有的差异可能是你原来几个页面的格式本来就不一样。

发出去以后看哪里

开头:它拿什么记下了现状。 一个测试、一份输出快照,或一个对比脚本。

中间:先删再加。 它会先删掉没用的代码,再加新结构。

最后:对比结果。 回复里有:改了什么结构、拿什么比的、比的结果、哪些改动撤回了。改完代码没变好读,它会撤回。

中途发现了 bug

整理时常会发现「这里原来就是错的」。拆开做:

  1. 先完成重构并提交。 旧 bug 原样留着。
  2. 再另开一个任务修 bug。 见修一个 bug。

这样重构那一步还能和基线严格对比。边重构边修,你就分不清哪些差异是修好的、哪些是改坏的。

其实想改行为?

那就不是重构。直接说出来,按加功能来做,见加一个新功能。跨很多模块的大调整,它会交给 /pstack:figure-it-out 先设计好整个流程。

卡住了?

它说「类型检查和测试都过了」,就算没变。

回它:「类型检查不算对比。先记下改之前的真实输出,改完用同样的输入再跑,把 diff 给我看。」已经改完了,就让它切回改之前的提交,重新生成基线。

它一上来就新建文件、加抽象层。

回它:「subtract-before-you-add.」意思是先删掉没用的,再在更简单的基础上加。这是 pstack 认识的一条原则名,原样打出来它就懂。

它留了一个旧函数,说是为了兼容。

回它:「migrate-callers-then-delete-legacy-apis. 把所有调用方迁过去,旧函数这一次就删掉。」这条原则名的意思就是这句话。它只管项目内部的代码。有外部用户在用这个接口,先告诉它。

改完代码反而更绕了。

直接说:「这次改动让读代码的人要多跳几层,撤回。」没变好读,本来就该撤回。

它顺手修了一个 bug。

回它:「先撤回 bug 修复,按原来的行为完成重构并验证。bug 另开一个任务。」

本站是 pstack 的非官方入门教程,不是官方文档;pstack 由 poteto 开发,命令和行为以官方仓库为准。教程原始源码见 GitHub。

由 airali部署,基于小小东的 MIT 授权教程改编。