Skip to content

获取动态流

1. 接口定位

  • 接口名称: 获取动态流
  • 所属域: client/moments
  • 业务目标: 拉取当前登录用户的 moments feed

2. 请求定义

  • Method: POST
  • Path: /chatx/moments/feed
  • Content-Type: 推荐 application/json(服务端按 JSON body 解析)
  • operationID: 必填,请通过 Header operationID 传入
  • 鉴权: 必填,请通过 Header token 传入有效登录令牌
  • 幂等性: 幂等(只读接口)

3. 请求参数

Header 参数

字段必填类型说明
operationIDstring链路追踪 ID
tokenstring用户登录 token

Body 参数

字段必填类型说明
cursorstring游标;传上一页最后一条动态的 postID,为空表示首页
limitint32返回条数;当前实现对 limit <= 0limit > 50 统一按 20 处理

字段说明

  • API 层会在转发前把当前登录用户的 userID 注入请求体,客户端无需传入。
  • cursorpostID,但实际翻页依据是该动态的 createTime
  • cursor 对应动态查不到时,当前实现不会追加游标过滤,效果等同重新拉首页。

4. 响应结构

通用响应包裹

字段类型说明
errCodeint错误码,0 表示成功
errMsgstring错误简述
errDltstring错误详情
dataobject业务数据

data 字段

字段类型说明
postsarray<object>动态列表,按创建时间倒序返回
nextCursorstring下一页游标;为空表示没有更多数据

post 对象

字段类型说明
postIDstring动态 ID
userIDstring发布者用户 ID
contentstring文本内容
mediaURLsarray<string>媒体 URL 列表
visibilityint32动态可见性,代码注释定义 0=public1=friends_only2=private
createTimeint64创建时间,毫秒时间戳
likeCountint64点赞数
commentCountint64评论总数
isLikedbool当前登录用户是否已点赞
authorobject发布者公开资料
commentPreviewarray<object>最新评论预览,最多 3 条,按新到旧返回
commentPreviewCursorstring评论预览继续向后翻页的游标;为空表示当前没有预览评论

author 或 commenter 对象

字段类型说明
userIDstring用户 ID
nicknamestring昵称
faceURLstring头像 URL

commentPreview 对象

字段类型说明
commentIDstring评论 ID
postIDstring所属动态 ID
userIDstring评论人用户 ID
replyToCommentIDstring回复目标评论 ID;顶级评论为空
contentstring评论内容
createTimeint64创建时间,毫秒时间戳
commenterobject评论人公开资料

5. 业务规则

  • 路由组统一经过 CheckToken 中间件,token 缺失或无效会直接失败。
  • API 层会把 token 解析出的当前用户 userID 写入请求,再调用服务端。
  • Feed 先通过 OpenIM 查询当前用户好友列表,再把当前用户自己追加进候选用户集合。
  • Feed 仅查询 visibility <= friends_only 的未删除动态,因此当前实现不会把 private 动态放进 feed,这条规则同样作用于用户自己的动态。
  • 动态按 createTime 倒序返回。
  • nextCursor 仅在本页返回条数恰好等于实际查询 limit 时设置为最后一条动态的 postID
  • likeCountcommentCountisLikedauthorcommentPreview 都是在返回前补齐的聚合字段。

6. 错误码与失败场景

错误码场景典型报错
1001Header 缺少 operationIDheader must have operationID
1001Header 缺少 tokentoken is empty
-token 无法解析由鉴权或 ParseToken 链路返回
-查询好友列表失败由 OpenIM 调用链路返回
-查询动态失败由数据库层返回

7. 示例

fetch 请求示例

javascript
fetch("http://localhost:10010/chatx/moments/feed", {
  method: "POST",
  headers: {
    operationID: "moments-feed-001",
    token: "user-token",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    cursor: "",
    limit: 20,
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例(JSON)

json
{
  "cursor": "",
  "limit": 20
}

成功响应示例

json
{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "posts": [
      {
        "postID": "3d6c7ec4-0f1b-4b9d-9a6c-621ef62f8b52",
        "userID": "u_1001",
        "content": "今天发一条动态",
        "mediaURLs": ["https://cdn.example.com/moments/a.jpg"],
        "visibility": 1,
        "createTime": 1774920000000,
        "likeCount": 3,
        "commentCount": 2,
        "isLiked": true,
        "author": {
          "userID": "u_1001",
          "nickname": "Alice",
          "faceURL": "https://cdn.example.com/avatar/a.png"
        },
        "commentPreview": [],
        "commentPreviewCursor": ""
      }
    ],
    "nextCursor": "3d6c7ec4-0f1b-4b9d-9a6c-621ef62f8b52"
  }
}

失败响应示例

json
{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "token is empty"
}

8. 时序流程

  1. 校验 operationIDtoken
  2. API 层解析 token,并把当前用户 userID 注入请求。
  3. 服务端 读取当前用户好友列表,并追加当前用户自己。
  4. 数据库按候选用户集合、可见性和游标条件查询动态。
  5. 服务端 聚合点赞、评论、作者资料和评论预览。
  6. 返回 postsnextCursor

9. 变更记录

  • 2026-03-31: 首版发布,基于 chatx moments API、协议定义和 服务端、数据库实现整理。