背圣经算法(含接口需求)

活石APP

背圣经接口需求
2/6

针对App

对于App，将会在本地保存背诵经文数据库，包括：
+ 背诵主题表，用来显示有哪些背诵主题
+ 背诵内容表，用来显示具体要背诵的具体内容
+ 服务端功能
+ 负责计算复习背诵的算法
+ 负责在算法处理好的时间里，下发数据
+ 负责接受打卡天数和进度，并提供这部分数据的下发功能
+ 所有数据，在用户点击【完成背诵】后，统一由客户端上传。

背诵圣经接口

• 下发本日需要新增背诵经文接口

  • 按用户进行下发，即不同用户所收到的新增背诵内容接口不同
  • 参数包括：背诵主题ID、背诵内容ID、日期
  • 需要注意：必须是上一轮新增背诵完成后，才下发新的背诵内容，否则继续下发同一份内容
  • 背诵内容ID，只需要下发一个ID即可。也就是说，下发的时候，只需要下发当前背诵主题的第一个新增背诵ID。
    例如今天理论上要背诵主题2的4-5节，此时下发只需要通知客户端从主题2的第4节开始作为新增背诵即可。因为可能用户实际操作里，会忽略经文，最后实际背诵的经文是4节和6节。那最后客户端上报主题2的4节和6节为今日新增背诵，5节为忽略经文。则下一个回合，下发的新增背诵主题ID，就是主题2的第7节。

• 下发本日需要复习哪些经文的接口

  • 按用户进行下发，即不同用户所收到的复习内容不同
  • 参数包括：背诵主题ID、背诵内容ID、日期
  • 需要注意：必须是上一轮复习背诵完成后，才下发新的背诵内容，否则继续下发同一份内容
  • 用户在首日启用背圣经时，需要复习的经文为空值
  • 下发需要复习的内容，需要涉及到复习算法部分。这部分算法见下文《背诵算法1.0》部分

• 上传忽略的经文接口

  • 由客户端上传，记录对应背诵主题ID，忽略内容ID
  • 对同个用户，将在本次主题内，不再新增、复习时下发该忽略的内容

• 上传打卡天数、新增的背诵经文

  • 由客户端上报打卡天数
  • 收到客户端上报的打卡天数，可以认为是本轮新增背诵顺利完成。否则为本轮背诵未完成，则下发的新增背诵内容、复习背诵内容均不自增，保持原数据下轮继续下发。
  • 新增背诵经文，即由客户端告诉服务端，用户实际背诵了哪些经文，便于下一回合新增经文的下发

• 下发打卡天数和背诵进度接口

  • 背诵进度计数：（当前已背+已经忽略）的总节数/该主题下的总节数*100% （四舍五入取整数）
  • 实际上就是 当前新增背诵的节ID/该主题下的最大ID *100% （四舍五入）

具体问题

• 用户当天没有打开App背诵，3天后才打开怎么办
  用户只要没有完成背诵，即是没有打卡，没有从客户端完成上传打卡信息操作。此时服务端认为该次背诵未成功。此时无论是背诵进度、打卡天数、新增背诵、复习背诵等均保持不变，等候下一次请求下发

• 什么时候上传数据
  用户完整背诵完成，并点击了【完成背诵】后，统一上传新增背诵经文、忽略经文、打卡天数等

背诵算法1.0
核心逻辑：
1. 复习内容——固定复习周期
2. 新增内容——用户当日没有完成的情况下持续延后

正常背诵逻辑

• 每个自然日只新增2节背诵内容
• 每日的背诵池分为两类：新增内容，复习内容
  
  • 新增内容：即每天新增的2节背诵内容。
  • 复习内容：即每天需要复习的内容

• 每个自然日背诵池内新增背诵内容在完成首次背诵后按照一定的规律写入未来时间，规律如下：

  • 第1个记忆周期：1天
  • 第2个记忆周期：2天
  • 第3个记忆周期：4天
  • 第4个记忆周期：7天
  • 第5个记忆周期：15天

  即7月1日完成了2节的背诵，则将这两节内容依次写入7月2日，7月4日，7月8日，7月15日，7月30日的当日背诵池内。

• 在对应的时间里，按约定的格式下发需要新增背诵和复习背诵的内容。

特殊情况处理

用户没有完成打卡（服务端没收到上传的打卡数据），即认为没有完成一轮复习，所有新增背诵和复习背诵均保持不变，在下一日下发同样内容