第一课:抽象,从需求建立模型
用学习进度的完整案例,理解抽象保留什么、忽略什么,以及如何检验一个模型是否够用。
本章目录CONTENTS ↓
给学习网站增加“学习进度”,应该记录什么?打开过的页面、阅读时长、已读章节,还是一个百分比?这些选择会影响页面能回答什么问题,也会影响后续功能怎样实现。
抽象与建模是设计的起点:先明确系统需要表达什么,再决定怎样组织和实现它。 本课沿着一个完整案例,练习选择信息、定义操作,再用反例检查模型。
本课的三个重点
- 根据用途决定保留哪些信息。
- 用查询和操作检验模型是否足够。
- 需求变化后,重新检查被忽略的细节是否重要。
先明确“学习进度”的含义
假设第一版只服务一个学习者,一门课程有固定的 A、B、C 三章。用户可以手动将某章标记为已读,也可以撤销。页面需要显示每章的已读状态,以及整门课程的已读比例。
这里的“已读”表示用户主动做出的标记。它不自动代表用户已经理解或掌握。明确这一含义,才能判断记录的数据是否真正支持功能。
这个版本需要完成四件事:查询某章是否已读、标记已读、撤销标记、计算已读比例。 后面的模型都要接受这四项要求的检验。
只记数量,丢失了什么?
一种直观的做法是保存“已读数量”。例如总共 3 章,已经读完 2 章,就显示 2/3。这个模型很简洁,也确实能满足显示比例的要求。
但仅凭“读完了 2 章”,能否判断 C 是否已读?再把 C 标记为已读时,数量应该增加吗?下面两种情况能揭示问题。
情况一
C 原来未读,需要加入。
情况二
C 已经读过,状态保持。
只知道“2 章”,无法判断这次应不应该增加计数。
两种情况的计数都是 2,但 C 的状态不同。对它们执行同一个操作“将 C 标记为已读”,所需结果也不同:一种要增加数量,另一种要保持数量。
模型把必须区分的两种情况合并了,因此无法独立决定正确结果。 我们缺少的信息是:具体哪些章节已经被标记。
“已读数量”仍然是有用的展示信息;只是它不足以单独承担这个功能的完整状态。检验模型时,不能只看它能否显示当前页面,还要检查它能否支持后续操作。
保留章节身份,建立集合模型
为了区分 A、B 已读和 A、C 已读,可以记录一个已读章节集合。集合表示哪些章节属于已读状态,每个章节只出现一次。
例如,课程章节是 A、B、C,已读集合是 {A, C}。这一表示保留了章节身份:可以直接查询 C 是否属于集合,也可以通过集合大小得到已读数量。
这里先定义概念;集合在程序中怎样保存,后续再选择。一个数组、一组数据库记录,也可能实现相同的集合规则。
| 所需操作 | 在模型中的含义 |
|---|---|
| 查询 C 是否已读 | 检查 C 是否属于已读集合 |
| 将 B 标记为已读 | 将 B 加入集合 |
| 再次将 C 标记为已读 | C 已经在集合中,集合不变 |
| 撤销 A 的标记 | 将 A 从集合中移除 |
| 显示已读比例 | 已读集合的大小 ÷ 课程章节总数 |
还需要一个始终成立的约束:已读集合中的每个章节,都必须属于这门课程。 不存在的 D 不能被计入进度。在本例中,课程固定且恰有 3 章,因此分母始终为 3。
下面可以直接操作这个模型。连续标记同一章,再撤销一次,观察章节状态、集合和比例是否一致。
目前没有已读章节。
从空集合开始,按顺序执行“标记 A、再次标记 A、标记 C、撤销 A”,完整结果如下。重复标记只改变操作历史,不改变当前已读状态。
| 操作之后 | 已读集合 | 已读比例 |
|---|---|---|
| 初始 | 空集 | 0/3 |
| 标记 A | {A} |
1/3 |
| 再次标记 A | {A} |
1/3 |
| 标记 C | {A, C} |
2/3 |
| 撤销 A | {C} |
1/3 |
如果撤销一个本来未读的章节,本课约定集合保持不变。这使每个允许的操作都有明确结果。
抽象发生在“保留与忽略”之间
真实阅读过程有很多细节:几点打开页面、使用什么设备、先读哪章、重复读了几次。在当前功能中,我们只保留“哪些章节现在被标记为已读”。
本例中的抽象,是围绕明确用途,用较简单的模型保留相关信息,并忽略当前用途不需要的细节。 两段不同的操作经历,就可能对应同一个模型。
经历一
A → C
{A, C}
先标记 A,再标记 C。
经历二
C → A → A
{A, C}
顺序不同,还重复标记了 A。
当前状态相同,但无法从集合还原“最后标记了谁”。
这次合并为什么合理?对于当前要求,两段经历得到的每章状态与已读比例相同;再标记或撤销任意一章,也可以从相同的集合出发,得到相同结果。因此,这些操作不需要知道之前的标记顺序和次数。
对比前面的计数模型:计数忽略了章节身份,而身份恰好影响查询和更新;集合忽略了标记顺序,而顺序暂时不影响这些行为。判断能否忽略某种差异,要检查它是否影响所需的行为。
MIT 的软件构造课程用较高层概念隐藏低层细节来解释抽象,并进一步通过操作及其规格描述抽象数据类型。本课的模型选择,为后面设计操作、接口和保证条件作准备。MIT:抽象数据类型
需求变化,会改变模型是否够用
现在增加一个需求:显示用户最后标记为已读的章节。
上图中,经历一最后标记的是 C,经历二最后标记的是 A。然而,它们的集合都是 {A, C}。只靠集合无法还原这一差异。
如果只需显示最后一次标记的章节,可以额外保存该信息,并定义撤销时如何处理;如果还要展示每次标记与撤销的时间,就需要保存更多历史。新增哪些数据,应由新增行为决定。
这里说的是“最后标记”,如果产品真正需要“最后打开的章节”,就应记录打开行为。两种动作可能发生在不同时间,不能直接混用。
再看购物车:若允许同一商品购买多件,仅保存“有哪些商品”的集合也不够,因为还需要数量。阅读状态可以忽略重复标记,而购物车数量可能依赖重复添加。相似的操作外形,不代表相同的业务含义。
从模型走向可检查的设计
有了模型,就能把“增加学习进度”写成更明确的实现要求:
进度由用户手动标记的已读章节决定。每章只贡献一次进度,重复标记不增加数量,撤销后不再计入;撤销未读章节保持状态。只能标记本课程中的章节,页面同时展示各章状态和整体比例。
这些规则为实现和审查提供了依据。无论由谁编写代码,都可以检查:重复操作是否错误累加、撤销后是否一致更新、是否接受了不存在的章节。
这一课得到的设计路径是:先明确用途和行为,再选择需要保留的信息,最后用具体场景和反例检验模型。 下一步将从“模型能表达什么”走向“模块向外提供什么操作、承诺什么保证”。
延伸阅读
- MIT 6.102:抽象数据类型:理解操作、规格与内部表示的关系。
- MIT 6.102:抽象函数与表示不变式:后续进一步连接模型与具体实现。
- Stanford CS190:Software Design Studio:参考信息隐藏、API 设计及评审修订的课程组织。
本课的学习进度案例为教学示例。
这一页,先记到这里。