获取用户动态列表
1. 接口定位
- 接口名称: 获取用户动态列表
- 所属域: client/moments
- 业务目标: 按用户 ID 查询该用户的动态列表
2. 请求定义
- Method:
POST - Path:
/chatx/moments/post/list - Content-Type: 推荐
application/json - operationID: 必填,请通过 Header
operationID传入 - 鉴权: 必填,请通过 Header
token传入有效登录令牌 - 幂等性: 幂等(只读接口)
3. 请求参数
Header 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| operationID | 是 | string | 链路追踪 ID |
| token | 是 | string | 用户登录 token |
Body 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| targetUserID | 是 | string | 要查询的目标用户 ID |
| pagination | 否 | object | 分页对象;不传时默认第一页、每页 20 条 |
| pagination.pageNumber | 否 | int32 | 页码 |
| pagination.showNumber | 否 | int32 | 每页条数 |
字段说明
- API 层会在转发前把当前登录用户的
callerUserID注入请求体,客户端无需传入。 - 当
pagination为空时,服务端 默认使用pageNumber=1、showNumber=20。 - 当前实现直接按
targetUserID查询未删除动态,代码链路中没有看到基于visibility的额外过滤。
4. 响应结构
通用响应包裹
| 字段 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码,0 表示成功 |
| errMsg | string | 错误简述 |
| errDlt | string | 错误详情 |
| data | object | 业务数据 |
data 字段
| 字段 | 类型 | 说明 |
|---|---|---|
| total | uint32 | 动态总数 |
| posts | array<object> | 动态列表,按创建时间倒序返回 |
post 对象
| 字段 | 类型 | 说明 |
|---|---|---|
| postID | string | 动态 ID |
| userID | string | 发布者用户 ID |
| content | string | 文本内容 |
| mediaURLs | array<string> | 媒体 URL 列表 |
| visibility | int32 | 动态可见性原始值 |
| createTime | int64 | 创建时间,毫秒时间戳 |
| likeCount | int64 | 点赞数 |
| commentCount | int64 | 评论总数 |
| isLiked | bool | 当前调用者是否已点赞 |
| author | object | 发布者公开资料 |
| commentPreview | array<object> | 最新评论预览,最多 3 条,按新到旧返回 |
| commentPreviewCursor | string | 评论预览继续向后翻页的游标 |
author 或 commenter 对象
| 字段 | 类型 | 说明 |
|---|---|---|
| userID | string | 用户 ID |
| nickname | string | 昵称 |
| faceURL | string | 头像 URL |
commentPreview 对象
| 字段 | 类型 | 说明 |
|---|---|---|
| commentID | string | 评论 ID |
| postID | string | 所属动态 ID |
| userID | string | 评论人用户 ID |
| replyToCommentID | string | 回复目标评论 ID |
| content | string | 评论内容 |
| createTime | int64 | 创建时间,毫秒时间戳 |
| commenter | object | 评论人公开资料 |
5. 业务规则
- 路由统一要求
token。 - API 层会把当前登录用户写入
callerUserID,这个值会影响返回里的isLiked计算。 - 数据库按
targetUserID + delete_time=nil查询动态,并按createTime倒序分页。 - 当前实现会返回目标用户的所有未删除动态,未在本链路中额外过滤
visibility。 - 每条动态返回前都会补齐点赞数、评论数、作者公开资料和最新 3 条评论预览。
6. 错误码与失败场景
| 错误码 | 场景 | 典型报错 |
|---|---|---|
| 1001 | Header 缺少 operationID | header must have operationID |
| 1001 | Header 缺少 token | token is empty |
| 1001 | targetUserID 为空 | 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. 时序流程
- 校验
operationID和token。 - API 层解析 token,并把当前用户写入
callerUserID。 - 服务端 校验
targetUserID。 - 数据库按目标用户分页查询未删除动态。
- 服务端 为每条动态补齐聚合字段和评论预览。
- 返回
total和posts。
9. 变更记录
- 2026-03-31: 首版发布,基于 chatx moments API、协议定义和 服务端、数据库实现整理。