Skip to content

获取用户动态列表

1. 接口定位

  • 接口名称: 获取用户动态列表
  • 所属域: client/moments
  • 业务目标: 按用户 ID 查询该用户的动态列表

2. 请求定义

  • Method: POST
  • Path: /chatx/moments/post/list
  • Content-Type: 推荐 application/json
  • operationID: 必填,请通过 Header operationID 传入
  • 鉴权: 必填,请通过 Header token 传入有效登录令牌
  • 幂等性: 幂等(只读接口)

3. 请求参数

Header 参数

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

Body 参数

字段必填类型说明
targetUserIDstring要查询的目标用户 ID
paginationobject分页对象;不传时默认第一页、每页 20 条
pagination.pageNumberint32页码
pagination.showNumberint32每页条数

字段说明

  • API 层会在转发前把当前登录用户的 callerUserID 注入请求体,客户端无需传入。
  • pagination 为空时,服务端 默认使用 pageNumber=1showNumber=20
  • 当前实现直接按 targetUserID 查询未删除动态,代码链路中没有看到基于 visibility 的额外过滤。

4. 响应结构

通用响应包裹

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

data 字段

字段类型说明
totaluint32动态总数
postsarray<object>动态列表,按创建时间倒序返回

post 对象

字段类型说明
postIDstring动态 ID
userIDstring发布者用户 ID
contentstring文本内容
mediaURLsarray<string>媒体 URL 列表
visibilityint32动态可见性原始值
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. 业务规则

  • 路由统一要求 token
  • API 层会把当前登录用户写入 callerUserID,这个值会影响返回里的 isLiked 计算。
  • 数据库按 targetUserID + delete_time=nil 查询动态,并按 createTime 倒序分页。
  • 当前实现会返回目标用户的所有未删除动态,未在本链路中额外过滤 visibility
  • 每条动态返回前都会补齐点赞数、评论数、作者公开资料和最新 3 条评论预览。

6. 错误码与失败场景

错误码场景典型报错
1001Header 缺少 operationIDheader must have operationID
1001Header 缺少 tokentoken is empty
1001targetUserID 为空targetUserID is required
-查询动态失败由数据库层返回
-查询用户公开资料失败由用户资料查询链路返回

7. 示例

fetch 请求示例

javascript
fetch("http://localhost:10010/chatx/moments/post/list", {
  method: "POST",
  headers: {
    operationID: "moments-post-list-001",
    token: "user-token",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    targetUserID: "u_1001",
    pagination: {
      pageNumber: 1,
      showNumber: 20,
    },
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例(JSON)

json
{
  "targetUserID": "u_1001",
  "pagination": {
    "pageNumber": 1,
    "showNumber": 20
  }
}

成功响应示例

json
{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "total": 2,
    "posts": [
      {
        "postID": "p_10001",
        "userID": "u_1001",
        "content": "第一条动态",
        "mediaURLs": [],
        "visibility": 2,
        "createTime": 1774920300000,
        "likeCount": 1,
        "commentCount": 1,
        "isLiked": false,
        "author": {
          "userID": "u_1001",
          "nickname": "Alice",
          "faceURL": "https://cdn.example.com/avatar/a.png"
        },
        "commentPreview": [],
        "commentPreviewCursor": ""
      }
    ]
  }
}

失败响应示例

json
{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "targetUserID is required"
}

8. 时序流程

  1. 校验 operationIDtoken
  2. API 层解析 token,并把当前用户写入 callerUserID
  3. 服务端 校验 targetUserID
  4. 数据库按目标用户分页查询未删除动态。
  5. 服务端 为每条动态补齐聚合字段和评论预览。
  6. 返回 totalposts

9. 变更记录

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