SonarQube 8.3如何通过API查询项目问题修正操作人并生成分析报告
SonarQube 8.3 关联问题修正操作的用户身份实现方案
核心场景边界
在8.3版本的能力范围内,两类常见的问题修正操作的用户信息可获取性存在差异:
- 用户直接在SonarQube UI端完成的标记操作,包括手动将问题设置为已解决、误报、不予修复等状态,这类操作自带明确的操作人记录
- 开发修改代码后,通过后续代码扫描自动闭环消除的问题,这类操作没有直接的SonarQube端操作人记录,需要通过关联代码提交信息间接匹配
可用API实现路径(匹配8.3版本原生能力)
1. UI端手动修正操作的用户信息获取
- 调用
api/issues/search接口拉取目标项目下的问题列表,拉取时可携带参数changelog=true,直接返回单问题的全量变更日志 - 从返回的变更日志中筛选变更类型为状态调整、解决结果设置的条目,条目内直接包含两类唯一标识字段:
user:用户在SonarQube系统内的固定唯一IDuserName:用户在系统内配置的显示姓名
- 对于代码规模较大、问题数量较多的项目,可改用单问题维度的
api/issues/changelog接口拉取变更记录,降低单次接口调用的响应压力
2. 扫描自动闭环问题的用户身份匹配
- 调用
api/project_analyses/search接口拉取项目历史分析记录,获取每次扫描关联的代码提交列表,每个提交条目自带提交作者标识 - 匹配逻辑:对比相邻两次分析的问题状态,当发现某条历史分析标记的bug、代码异味问题在新一次分析后变为已解决状态时,将该问题关联到对应分析周期内的代码提交作者
- 调用
api/users/search接口将提交作者标识匹配为SonarQube系统内的正式用户ID、姓名信息,完成身份关联
落地注意事项
- 权限要求:用于调用API的服务账号,需要被授予对应项目的问题管理权限,以及全局用户搜索权限,否则返回的变更日志、用户字段会因权限不足返回空值
- 同步效率优化:建议以问题的
update_date作为增量同步游标,仅拉取上次同步时间之后存在变更的问题,避免全量拉取带来的服务器性能损耗 - 批量操作兼容:即使用户在UI端完成批量问题标记,每个关联问题的变更日志都会独立生成操作人记录,不会丢失身份关联信息
内容的提问来源于stack exchange,提问作者Vishal Patidar
相关产品推荐
相关产品推荐

