SyncLogAPIController(同步日志 API)¶
用户中心模块的同步日志控制器,提供用户中心数据同步日志的创建、更新与存在性检查能力。该控制器由宿主服务以 Feign 方式内部调用(SyncLogAPI 接口),用于记录与跟踪跨系统数据同步操作的执行情况,属于后端服务间数据面接口。
- 控制器全限定名:
cn.myapps.usercenter.controller.SyncLogAPIController - 接口(Feign 契约):
cn.myapps.usercenter.controller.SyncLogAPI - Tag:同步日志API
- 类级
@RequestMapping:${myapps.context-path.usercenter:}/SyncLogPO - 基址:
<host>/usercenter/SyncLogPO - 独立部署(
obpm-usercenter-war/obpm-usercenter-consul):server.servlet.context-path=/usercenter,占位符${myapps.context-path.usercenter:}缺省为空,故实际基址为<host>:<port>/usercenter/SyncLogPO(war 端口 8080,consul 端口 8088)。 - 统一部署(
obpm-lite):server.servlet.context-path=/,yml 显式配置myapps.context-path.usercenter=/usercenter,故实际基址同样为<host>:8888/usercenter/SyncLogPO。 - 接口类型:REST 资源
注意:与 usercenter 其他控制器不同,本控制器类级
@RequestMapping的资源段为SyncLogPO(首字母大写、与 PO 类同名),并非小写的synclog。调用时须按源码原样使用/SyncLogPO路径段。
公共说明¶
鉴权¶
(据源码)usercenter 模块本身**不定义**任何安全过滤器或鉴权拦截器,仅注册 PersistenceHandlerInterceptor(用于 DAO 资源清理——事务提交与 Hibernate Session 关闭,不做权限判断)。本控制器 /SyncLogPO/** 路径下所有端点**不做用户级身份校验**——既不读取 accessToken,也不读取 adminToken/designerToken,控制器方法内也不调用任何 getUser() 之类方法。
usercenter 作为共享库被宿主服务加载后,会继承 obpm-common 提供的 CommonSecurityFilter(由 CommWebMvcConfig 以 @Bean 注册,URL 模式 /*,order=-1,详见 index.md「鉴权说明」),对 /SyncLogPO/** 的影响仅限:
- HTTP 方法限制:未携带合法
systemToken请求头时,仅允许GET/POST/HEAD/OPTIONS方法;直接发起PUT/DELETE/PATCH等请求会被CommonSecurityFilter以 HTTP405(HTML 错误页,无 JSON 体)拒绝。 systemToken放行:携带合法systemToken请求头(系统间 Feign 调用,JWT 内username固定为systemToken)的请求被标记pass=true并绕过上述方法限制——这是本控制器PUT /update在生产中正常工作的前提。
结论:本控制器的真实访问控制依赖**网络层隔离**(仅由可信的内部服务经 Feign 调用,附
systemToken请求头),并非用户令牌。终端用户不应直接访问这些端点。
响应结构¶
本控制器不使用统一 Resource 结构(与 ../index.md「统一响应结构」不同)。响应遵循以下规则:
| 情形 | HTTP 状态 | 响应体 |
|---|---|---|
返回值为 void 的方法(创建/更新)成功 |
200 | 空响应体 |
返回值为 boolean 的方法(isExsit)成功 |
200 | 直接序列化的 JSON 布尔值(true/false,裸布尔,不包裹对象) |
| 业务/系统异常 | 500 | {"errcode":500,"errmsg":"<异常信息>"}(由 obpm-common 的 CommonsExceptionResolver 全局异常处理器渲染,仅含 errcode/errmsg 两字段,无 data/errors) |
HTTP 方法不被允许(无 systemToken 的 PUT) |
405 | HTML 错误页(由 CommonSecurityFilter 直接返回) |
| 系统启动中 | 500 | HTML 错误页(由 CommonSecurityFilter 直接返回) |
事务说明:
create/update在控制器层未显式包裹beginTransaction/commitTransaction(与MediaApiController不同),事务边界由 DAO 层或PersistenceHandlerInterceptor的postHandle阶段统一提交;若 DAO 抛出异常,仍由CommonsExceptionResolver渲染为 HTTP 500。
数据模型:SyncLogPO¶
cn.myapps.usercenter.dao.sync.log.SyncLogPO 为普通 POJO(未继承 AuthtimeValueObject,未标注 @JSR303),表示一条同步日志记录。主要字段:id(主键)、action(操作动作)、actionTime(操作时间,java.util.Date)、tableName(涉及的表名)、status(状态,int,默认 1)、dataOperation(操作数据描述)、msg(结果信息)。
1. 创建同步日志¶
创建一条新的同步日志记录。
- 接口类型:REST 资源
- 请求方式:
POST - 请求路径:
/create(完整:<host>/usercenter/SyncLogPO/create) - 鉴权:内部(建议经
systemToken的 Feign 调用;直接调用因 POST 方法不被CommonSecurityFilter拦截故技术上无需 token,但本控制器为内部数据面接口) - Tag:同步日志API
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| body | body | SyncLogPO |
是 | 同步日志信息,通常包含 action、actionTime、tableName、status、dataOperation、msg 等字段 |
请求示例¶
POST /usercenter/SyncLogPO/create HTTP/1.1
Content-Type: application/json
systemToken: <系统间 JWT>
{
"action": "sync-user",
"actionTime": "2026-08-04T08:30:00.000+0800",
"tableName": "T_USER",
"status": 1,
"dataOperation": "INSERT",
"msg": "同步成功"
}
响应¶
结构:成功为**空响应体**(返回类型 void);失败为 {"errcode":500,"errmsg":"<异常信息>"},HTTP 500。
成功示例:(HTTP 200,空响应体)
失败示例:
2. 更新同步日志¶
根据 ID 更新同步日志信息。
- 接口类型:REST 资源
- 请求方式:
PUT - 请求路径:
/update(完整:<host>/usercenter/SyncLogPO/update) - 鉴权:内部(
PUT方法需携带合法systemToken请求头,否则被CommonSecurityFilter以 HTTP405拒绝) - Tag:同步日志API
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| body | body | SyncLogPO |
是 | 待更新日志(须含主键 id),可携带需更新的字段(如 status、msg) |
请求示例¶
PUT /usercenter/SyncLogPO/update HTTP/1.1
Content-Type: application/json
systemToken: <系统间 JWT>
{
"id": "__LOG001",
"status": 0,
"msg": "同步失败:远端超时"
}
响应¶
结构:成功为**空响应体**(返回类型 void);失败为 {"errcode":500,"errmsg":"<异常信息>"},HTTP 500。若未带 systemToken,HTTP 405(HTML 错误页)。
成功示例:(HTTP 200,空响应体)
失败示例:
3. 检查日志是否存在¶
根据 ID 检查同步日志是否存在。源码方法名为 isExsit(拼写与「isExist」不同),路径段原样保留。
- 接口类型:REST 资源
- 请求方式:
GET - 请求路径:
/isExsit(完整:<host>/usercenter/SyncLogPO/isExsit) - 鉴权:内部
- Tag:同步日志API
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| id | query | string | 是 | 同步日志 ID |
请求示例¶
响应¶
结构:成功为**裸 JSON 布尔值**(true/false,不包裹 Resource)。
成功示例:
失败示例: