# 第 14 章：读到哪与未读数

> Ana 在电脑上看完了徒步群，手机上的红点还是 37。每个会话旁边那个数字，服务端怎么记，才能又准、又在几台设备上一样？

深入理解 IM 系统 · https://im.liko.page/zh/unread/

Ana 在电脑上看完了徒步群的新消息，合上电脑。拿起手机，徒步群旁边的红点还是 37。

红点上的数字是**未读数**：这个会话里还有几条她没读。它要数得对；在电脑上读过的，手机上也要消掉。

## 1. 先看产品要什么

“读了没有”，不同产品答得不一样。按要服务端多做什么，分成四档：

| 档 | 情况 | 服务端要做什么 |
|---|---|---|
| 客户端自己定 | 打开就算读，还是消息上了屏才算；显示数字、“99+”，还是只显示红点 | 什么也不加，手机报“读到第几条”就行 |
| 一个数就够 | 几台设备要一致；进群以前的不算 | 每人每个会话记一个“读到哪”（第 4 节） |
| 一个数不够，旁边加一点 | 要精确数字，可系统消息和自己发的不该算（第 5 节）；跳到 @ 那条看了，中间的还算未读；手动“标为未读”（第 6 节） | 在“读到哪”旁边另记一点 |
| 换了产品 | 每条消息都要知道谁读了、谁没读（办公 IM） | 按条记，另一套方案（第 39 章） |

这个系列的主线是社交 App，群最多 500 人。它这样选：按会话记，几台设备一致；点开会话停在第一条没读的；未读数要准；自己发一条消息，不算读完了上面那些。

## 2. 谁来数：手机还是服务端

| | 手机数 | 手机数，加服务端的粗数 | 服务端数 |
|---|---|---|---|
| 怎么做 | 数本地库里还没读的、该算的消息 | 重新同步时用服务端给的粗数（最新 seq 减读到的 seq）；在线时每来一条别人发的、该算的新消息就加一 | 服务端存好、算好，随会话记录发下去 |
| 好处 | 手机认得每条是什么，系统消息、自己发的，一看就排除 | 在线时准，服务端简单 | 几台设备一样；App 关着也知道数 |
| 难处 | 未读的消息得全在手机上；几台设备各数各的 | 两种数法不一样：粗数把系统消息也算进去，一重新同步数字就跳 | 服务端得知道哪条该算（第 5 节） |
| 例子 | 端到端加密的产品（第 42 章）：服务端看不到内容，分不清哪条该算，由手机数 | [OpenIM 的 SDK](https://github.com/openimsdk/openim-sdk-core/blob/061ac67/internal/conversation_msg/sync.go) | Telegram：每个会话带一个 `unread_count`（[dialog](https://core.telegram.org/constructor/dialog)） |

主线选服务端数，理由有两条：

- **手机上没有全部消息。** 第 6 章定了：回来时每个落后的会话只拉最新一条。徒步群一周没看，有 7,000 条未读；手机要自己数，得先把它们都下载下来，每条约 200 字节，共 1.4 MB，只为了显示一个数字。
- **App 关着时也要有数。** 图标上的角标，只能由服务端放进系统推送里（第 17 章）。

## 3. 先想到的：计数器

服务端数，最常见的起步是计数器：每人每个会话一个未读数，来一条加一，读了清零。它会错在两个地方：

- **待办重做时会多加。** 第 11 章里，一条消息先记成一行“待办”，后台再照着它去改每个成员的会话记录。改到一半挂了，重启后这行待办从头再做一遍，已经改过的人会再改一次。写“最新 seq = 4,812”，写两遍还是 4,812，所以那时说没关系；可“未读数加一”做两遍，5 就变成了 7，一条消息算了两次。
- **清零会晚到。** Ana 在电脑上读完就合上盖子，“已读”要等电脑再连上网才发出去。这中间徒步群又来了 3 条，计数器跟着加了 3；电脑连上后清零才到，计数器归 0，可这 3 条她一条也没看。

计数器只记“还剩几条”，不记“读到了哪”。错了算不回来，只能等下一次清零。

## 4. 一个数：读到哪

Ana 的每条会话记录（每人每个会话一行）上，多记一个**读到哪**（read_seq，已读游标）：这个 seq 以前的，她都读了。第 11 章已经在同一行记着最新 seq，于是：

**未读数 = 最新 seq − 读到哪**

这里先假设会话里只有别人发的普通消息。Ana 自己发的、系统消息也占 seq，第 5 节再扣。

规则：

1. **手机看到哪，报到哪。** 开着的会话，最多一秒报一次。
2. **只往上涨。** `UPDATE … SET read_seq = N WHERE … AND read_seq < N`。晚到的、重复的报告，什么也不改。
3. **涨了，记录版本跟着涨。** 记录版本是第 11 章每人一个、只往上涨的号：Ana 的哪行会话记录变了，就从她的那一行（users 表）取一个新号贴上，她的每台设备只拉号比自己大的行。所以电脑上读了，手机下次同步就拿到，红点消了。
4. **进群从进群那条开始。** 新成员的读到哪设成入群那条系统消息的 seq。第 12 章“新人可看进群前 100 条”的那些都在它前面，能看，不算未读。

还有一处要做对：**读会跑在记录前面。** Ana 在群里回一句，手机马上显示这条、报“读到这条”；可待办要晚一点才把最新 seq 写进记录。比如回的这句是 4,823，记录上的最新 seq 还是 4,822，读到哪却已经是 4,823，未读数 = 4,822 − 4,823 = −1。办法是读的事务里同时写 `latest_seq = GREATEST(latest_seq, N)`。

自己发的消息要不要把读到哪往前挪，也在下一节说。

## 5. 第二步：只数该数的

这是服务端数的代价：手机认得每条是什么，服务端只认得 seq。而 seq 每条消息都有，包括两种不该算的：

- **系统消息**：入群、退群、改群名，第 12、13 章它们都占一个 seq。
- **Ana 自己发的**：她回的那句，不是她的未读。

有一种省事的做法：自己发一条，就把读到哪挪到这条。[OpenIM 的服务端代码](https://github.com/openimsdk/open-im-server/blob/175a7bb/pkg/common/storage/controller/msg_transfer.go)（和第 2 节的 SDK 是两处）就这样，存消息时把发送者的已读 seq 设成这条的 seq。在会话里看完再回，这没问题；可 Ana 从通知栏直接回一句，上面那些她没看的，就都算读了。

所以每条消息再带两个数，都在第 5 章取 seq 的那个事务里写好：

- **到这条为止的计数**：这个会话里，到这条为止有几条该算未读的。系统消息不加一，沿用上一条的数。它是全会话共用的，Ana 自己发的也加一，算她的未读时再扣。
- **发送者流水号**：发的人在这个会话里发的第几条。

| seq | 4,821 | 4,822 | 4,823 | 4,824 |
|---|---|---|---|---|
| 是什么 | 消息 | Cara 进群 | Ana 发的 | 消息 |
| 到这条为止的计数 | 101 | 101 | 102 | 103 |
| 发送者流水号 | – | – | 7 | – |

Ana 读到 4,820，用 seq 减是 4 条。正确的算法要四个数，都存在她的会话记录上：

- **最新的计数**和**她最新的流水号**：待办改她的会话记录时顺手写上，只往上涨。这里是 103 和 7。
- **读到处的计数**：读的时候查 4,820 那条消息。这里是 100。
- **读到处她的流水号**：读的时候查她在 4,820 及以前发的最后一条，按“会话 + 发送者 + seq”建个索引，一次查询。这里是 6。

> 未读数 = (103 − 100) − (7 − 6) = **2**，正好是 4,821 和 4,824。

服务端发记录时用这四个数算好未读数，一起发给手机。第 4 节的“读跑在前面”在这里一样：读的事务里，把最新的计数改成它和读到的那条消息上的计数中大的那个，她最新的流水号也一样。

下面是徒步群的一小时。Ana 用手机读了几次，在会话里回过几句，也从通知栏回过两句；电脑读过两次，报告都晚了 4 分钟：

*（互动图：请在网页上查看 https://im.liko.page/zh/unread/）*

虚线是她真实的未读数，实线是服务端显示的。消息或报告还在路上的分钟不算，剩下 62 个能对照的分钟里：

- **计数器**：46 个对不上。待办重做时多加，晚到的清零少算。
- **读到哪，最后到的为准**：这是没有“只往上涨”的样子。电脑的旧报告最后才到，把读到哪拨了回去，最后停在 7，实际是 0。
- **读到哪，只往上涨**：设备之间对了，可系统消息和自己发的都算了进去。
- **再只数该数的**，但自己发了就算读：从通知栏回的两次，分别吞掉 3 条和 19 条。
- **再扣掉自己的**：每一分钟都对。

## 6. 一个数不够的地方

**跳到 @。** 有人在 4,900 @ 了 Ana，她读到 4,800。点 @ 按钮直接跳过去，中间 99 条她没看，读到哪不能挪到 4,900。所以被 @ 的另记一行（谁、哪个会话、哪条），看过就删；红点旁的 @ 只数比读到哪新的那些行，读到哪越过了就不算。Telegram 一样：会话上有 `unread_mentions_count`，@ 按钮一条条跳，读完最后一条才清掉（[mentions](https://core.telegram.org/api/mentions)）。

**手动“标为未读”。** 不能把读到哪往回拨，只往上涨的规则不许，另一台设备也会把它报回去。另记一个标记，下次读的时候清掉。清的时候可能没有新消息，所以写成 `SET read_seq = GREATEST(read_seq, N), marked_unread = false … WHERE read_seq < N OR marked_unread`：标记清了，读到哪照样不往回走。Telegram 也是单独一个 `unread_mark`。

普通消息就没这么好办了：跳到 @ 时跳过的那一段，一个数记不住。开放聊天协议 Matrix 用两个位置把历史分成三段：读完的、可能读了一部分的、还没看到的（[read markers](https://spec.matrix.org/latest/client-server-api/#fully-read-markers)）。要再细，就只能按条记了。

## 7. 算一下

- **手机：** 一行会话记录从第 11 章的 28 字节变成 39 字节：读到哪 4、未读数 4、未读 @ 数 2、标为未读 1。
- **报告次数：** 一次报告盖住前面所有消息，读到哪不动的报告不写，所以报告最多和收到的消息一样多。v2 高峰每秒 139 条消息、每条平均到 6.67 个人（第 11 章），就是每秒约 927 次。
- **写的行数：** 每次报告改两行：Ana 的 users 行（取记录版本）和那条会话记录，每秒 1,853 行。加上第 11 章的 1,853 行，共 3,707 行，约占一台存储写入能力（每秒 2 万行）的 18.5%。
- **服务端存：** 每条消息多 8 字节，一天 400 万条，共 32 MB。

图上的“换一小时”能换不同的一小时。连换 200 个：计数器约一半的分钟对不上，108 个小时到最后还停在错的数上；这一章的做法一分钟也没错。

## 8. 代价

- **读也是写。** 读到新的地方就涨一次版本号，另一台设备就要同步一次。
- **发和读都多一次查询。** 发消息时要取发送者流水号（在第 5 章取 seq 的同一个事务里）；读的时候要查两样。
- **@所有人很贵。** 500 人的群就是 500 行；也可以在每人的会话记录上记一个“有人 @ 了所有人”的标记，省掉这 500 行。
- **过期的报告也能清掉“标为未读”。** 电脑上很早以前读的报告晚到，会把刚标的未读清掉。

## 9. 其他答案

- **手机数，或手机数加服务端的粗数**（第 2 节）。手机会下载全部消息的产品，手机数最省事，用不着计数和流水号。
- **计数器，定期对账。** 简单，平时差一点，定期用“最新 seq − 读到哪”纠正。
- **自己发了就算读到这里**（第 5 节）。少一个流水号，代价是从通知栏回复会吞掉没读的。
- **只显示红点，不显示数字。** 用不着计数，seq 相减就够；很多产品对免打扰的会话就这样。
- **按条记已读。** 每人每条一行：一个 500 人的群一天 1,000 条，就是 50 万行，按会话记只有 500 个读到哪。办公 IM 要每条都知道谁没读，才值得（第 39 章）。
- **记读过的区间。** 每人每个会话记几段，比如 [1–40]、[45–50]，跳着读也记得住。

## 10. 这一章的决定

*（互动图：请在网页上查看 https://im.liko.page/zh/unread/）*

**决策卡**

- 问题：未读数要准，还要在几台设备上一样。计数器会因为待办重做时多加、清零晚到而算错；最新 seq 减读到哪，会把系统消息和自己发的算进去。
- 选择：服务端数：每人每个会话一个读到哪，只往上涨，随记录版本同步到每台设备；每条消息带上到这条为止的计数和发送者流水号，服务端扣掉自己发的，算准未读数随记录下发。
- 代价：读也是写（高峰每秒最多约 927 次）；每条消息多 8 字节，一天 32 MB；每次读多两次查询；@ 和“标为未读”另记。
- 什么时候重新考虑：对方读了没（第 15 章）；离线手机的角标（第 17 章）；撤回一条没读的（第 18 章）；按条记已读（第 39 章）。
- 其他答案：手机数（端到端加密）；手机数加服务端的粗数（OpenIM SDK）；计数器加对账；自己发了就算读；只显示红点；按条记；记读过的区间。

Ana 自己读到哪，服务端和每台设备都清楚了。可她发出去的消息呢？Ben 读了没有，群里几个人读了？下一章：已读回执。
