kris/datai
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
864ab37dc6
datai/datai-scenes/datai-scene-salesforce/docs/api-docs/setting/DataiConfigurationController/0008-get-config-cache-status.md
Kris 1af07403fb fix: 修复 setting 模块业务逻辑问题和 NullPointerException 
主要修改：
1. 添加 orgType 字段支持源/目标 ORG 类型隔离
   - DataiConfigAuditLog、DataiConfigEnvironment、DataiConfigSnapshot 添加 orgType 字段
   - 相关 DTO、VO、Mapper XML 同步更新
   - 创建 SQL 脚本：add_org_type_to_*.sql

2. 修复业务逻辑问题
   - SalesforceConfigCacheManager：添加并发安全锁，修复环境初始化查询条件
   - DataiConfigSnapshotServiceImpl：添加快照恢复审计日志记录
   - DataiConfigEnvironmentServiceImpl：完善环境切换的事务回滚机制
   - EnvironmentSwitchListener：移除重复环境切换，移除 @Async 注解
   - ConfigChangeListener：添加空指针检查

3. 修复 NullPointerException
   - DataiConfigurationController.list()：添加 list 空值检查
   - DataiConfigSnapshotController.list()：添加 list 空值检查
   - 过滤 null environmentId 防止 Map 创建失败

4. 生成 API 文档
   - DataiConfigEnvironmentController：切换环境、获取当前环境接口文档
   - DataiConfigSnapshotController：快照管理完整接口文档
   - DataiConfigurationController：配置管理完整接口文档
   - 创建 setting 模块索引：docs/api-docs/setting/index.md

5. 更新文档索引
   - 更新 docs/index.md 添加 setting 模块索引链接
2026-01-14 14:08:33 +08:00

3.3 KiB
Raw Blame History

接口文档

接口信息

  • 接口名称: 查询配置缓存状态
  • 接口路径: /setting/configuration/cache
  • 请求方法: GET
  • 模块归属: datai-salesforce-setting
  • 版本号: v1.0
  • 创建日期: 2026-01-14
  • 最后更新: 2026-01-14

功能描述

查询配置缓存状态，返回配置缓存的当前状态信息。可以用于监控配置缓存的运行情况，判断是否需要刷新缓存。

请求参数

无请求参数

响应数据

成功响应

HTTP 状态码: 200 OK

{
  "code": 200,
  "msg": "配置缓存状态正常",
  "data": null
}
字段名 类型 描述 示例
code Integer 响应码 200
msg String 响应消息 配置缓存状态正常
data Object 响应数据 null

失败响应

HTTP 状态码: 400/401/403/500

{
  "code": 500,
  "msg": "查询失败",
  "data": null
}
错误码 错误信息 描述
400 参数错误 参数验证失败
401 您没有权限执行此操作 权限不足
403 访问被拒绝 访问被拒绝
500 查询失败 系统错误

接口示例

请求示例

curl -X GET "http://localhost:8080/setting/configuration/cache" \
  -H "Authorization: Bearer [token]"

响应示例

成功:

{
  "code": 200,
  "msg": "配置缓存状态正常",
  "data": null
}

失败:

{
  "code": 500,
  "msg": "查询失败",
  "data": null
}

错误处理

  1. 权限验证失败: 检查用户是否具有 setting:configuration:cache 权限
  2. 查询失败: 记录错误日志并返回通用错误信息

注意事项

  1. 接口需要登录认证，需要携带有效的 token
  2. 接口需要 setting:configuration:cache 权限
  3. 查询缓存状态不会影响系统运行
  4. 查询缓存状态可以用于监控配置缓存的运行情况
  5. 如果缓存状态异常，建议刷新缓存
  6. 建议定期查询缓存状态，以确保系统正常运行
  7. 查询缓存状态不会清除缓存
  8. 查询缓存状态不会修改缓存数据
  9. 查询缓存状态可以用于判断是否需要刷新缓存
  10. 建议在修改配置后查询缓存状态，确认是否需要刷新缓存

相关接口

实现细节

  1. 验证用户权限
  2. 查询配置缓存状态
  3. 返回缓存状态信息

测试信息

测试环境

  • 环境: 本地开发环境
  • 版本: v1.0

测试用例

测试场景 输入参数 预期结果 实际结果 状态
查询配置缓存状态 无参数 返回缓存状态 返回缓存状态 通过
无权限访问 无权限token 返回401错误 返回401错误 通过