目录:

版本：Ver 0.3

在手机上我们需要持久化应用的一些数据(典型的如本地的设置信息)，同时又希望能重装应用或换一台手机登录后能把这些数据再同步回来。业界有SyncMl标准，覆盖的功能很完善，正因为要保证兼容性，开源的实现都较重。如何借鉴这个标准自己来实现一个多端双向同步可扩展的功能呢？

App使用同步协议可以将原本必须在线操作的功能（如：删除一个联系人，修改一个联系人的备注信息）也可以在断网情况下完成。

我们假设一些前提：

1. 同一时刻只有一端（iPhone，iPad或其他移动设备）能和服务器同步；
2. 客户端和服务端的时间一致或误差较小；可在长连建立时通过协议记录时间差
3. 客户端保存全量数据（对于客户端只保存部分数据的情况后面再做讨论）；

应用场景

1. 通讯录同步
2. 最近联系人
3. App客户端设置
4. 最近会话列表
5. 黑名单
6. 群设置
7. 群成员
8. 用户的一些设置和开关

名词解释

1. LCID - Local Unique Identifiers， 客户端生成的记录ID，客户端唯一；
2. GUID - Global Unique Identifiers， 服务端生成的记录ID，全局唯一；
3. Anchor - 同步锚点，可以使用递增的序列号或时间戳来表示，用来发现两端数据变化的部分；
4. Session - 同步会话，由客户端发起，Session Id唯一。

客户端表设计

每条记录包含两个同步用的字段：

status － 用来标识记录的状态

anchor － 用来记录服务端同步过来的时间戳。

服务端表设计

modified － 记录在服务端的修改时间

双向同步流程示例

1. Client 增加2条记录

客户端新增记录时，需要将Status设为0

2. Client 修改1条记录

客户端修改记录时，需要将Status更新为1

3. Client 发送本地更新

执行SQL SELECT * FROM table WHERE status < 9 ORDER BY modified ASC 找出客户端本地需要同步到服务端的记录，通过网络分批串行发送给服务端，一个请求可能包含多条记录，只有上一个请求得到响应后才能发起下一个请求。

发送的同步消息需包含anchor：

4. Server 处理同步消息

服务端收到请求后先比较客户端的anchor（其实就是上一次同步服务端的modified）和服务端的记录MODIFIED，只有服务端modified=客户端anchor的才能继续同步，否则说明客户端在上一次同步后服务端又更行了，需要解决冲突后再继续(见:冲突解决1)；继续同步的记录则根据记录状态做ADD，UPDATE或DELETE操作。

REPLACE INTO table (id, key, value) VALUES (?, ?, ?)

更新后服务端数据表如下：

请求响应数据如下(使用了服务端modified时间作为anchor)：

5. Client 根据响应更新本地记录

得到服务端的同步消息响应后，客户端应判断发出同步请求时的modified和此时本地记录的modified是否一致，防止在同步期间本地数据被用户再次更新。

相应的SQL如下： UPDATE table SET status=9, anchor=?, modified=? WHERE id=? and modified=?

6. Client 请求 Server 增量同步

因为服务端的modified是随着时间递增的。客户端本地保存的记录中最大的anchor：Max(anchor)可以认为是上一次同步的时间。如果服务端有比Max(anchor)更大的modified的记录, 则需要向客户端同步。

假设另一个客户端在服务器上增加了一条新的纪录并更新了一条记录：

根据客户端的Max(anchor)=4，服务端执行SELECT * FROM table WHERE modified > 4 ORDER BY modified ASC来获取未同步的数据, 并通过网络分批串行发给客户端。

7. Client 处理同步消息

客户端根据增量消息更新本地表。处理消息时，只能更新状态为已同步或不存在的记录（也就是status=9），防止在增量同步过程中，客户端本地记录被用户修改。

8. Client 删除记录

客户端需要做逻辑删除，将status设成-1

客户端同步引擎根据status<9将这条消息发送给服务端（注：如果anchor=0可以不发送），服务端按第四步同样的处理方法将服务端记录标记为删除，并给客户端同步成功的响应；客户端在得到响应后可以将本地记录物理删除。

9. 服务端 删除记录

如果增量下行到客户端的消息中包含了删除记录的消息，客户端可以直接物理删除。

FAQ

服务端解决客户端Anchor和记录Modified不一致的情况

有可能是手机A在上一次同步成功后更新了一条记录后断线造成更新未同步；过段时间后换了另一只手机B对同一条记录做了修改并同步成功；再切换回手机A继续同步时，服务端会发现A发送过来的ANCHOR较服务端MODIFIED小而拒绝这条记录的同步，并在响应内将服务端的记录返回给客户端(以服务端记录为准)。

数据量较多如何同步？

从服务端同步到客户端的数据量可能比较多，一次网络交互不能传输过量的数据，所以一次同步Session可能有多条消息，每条消息包含多条记录。

同一Session的消息具有以下特点：

1. 可以由客户端或服务端任何一方主动发起第一个消息，所有消息都包含相同的Session Id；
2. 同一个Session发送的多条消息具有时序，记录可按Anchor从小到大依次发送；

基于Session的事务实现

客户端采用临时表或文件缓存服务端分批发送的响应，在最后一批数据到达后，启用事务批量将变更保存到本地数据库。如果服务端部分响应超时，则放弃本次同步。这个方案的缺点是在弱网下会浪费手机流量。

ChangeLog表实现

服务端如果使用database时间戳做anchor, 在同一时刻如有大量记录发生变更，在增量同步到客户端时可能只成功同步了部分数据，按Max(anchor)方法再次发起增量同步时候可能会丢失部分数据，因此在可能批量修改大量数据的业务场景下，我们可以使用ChangeLog表来实现anchor，mysql的auto_increment可以使得ChangeLog表中的anchor字段严格递增并唯一。这样客户端即使只同步了部分增量消息也能从断点恢复。

多端Anchor保存问题

客户端保存

每个客户端保存自己的anchor，由客户端在重新登录时主动请求服务端同步，缺点是有可能没有新数据时候也会发起请求，多消耗流量；优点是服务端不需要维护每个客户端的同步状态；

服务端保存

每个客户端上一次同步的anchor保存在服务端，由服务端在客户端登录成功后主动发起同步请求；

并发问题？

同步消息是否可以并行发送给客户端来提高性能？

如果需要支持多端同时在线呢？

客户端anchor最好由服务端保存和维护，由服务端push通知客户端来同步；

参考文档

1. http://en.wikipedia.org/wiki/SyncML

See also

• 使用Gradle生成包含所有依赖库(.jar或.aar)的aar包
• 使用Gradle生成一个App的不同版本，且可以同时安装在一个手机上
• 安装第三方App到电视盒子
• Gradle的Properties
• Android异步编程