CodeChecker API开发指南：构建自定义分析工具和集成方案

CodeChecker API开发指南：构建自定义分析工具和集成方案

【免费下载链接】codecheckerCodeChecker is an analyzer tooling, defect database and viewer extension for static and dynamic analyzer tools.项目地址: https://gitcode.com/gh_mirrors/co/codechecker

CodeChecker是一款强大的静态和动态分析工具，它提供了丰富的API接口，让开发者能够轻松构建自定义分析工具和集成方案。通过CodeChecker API，您可以访问分析结果、管理项目、配置分析规则等，为您的开发流程带来极大的灵活性和效率提升。

CodeChecker API架构概览

CodeChecker的API系统采用Thrift框架构建，提供了跨语言的接口支持。整个API架构可以分为几个主要部分：数据模型定义、核心服务接口和客户端实现。

API核心模块

CodeChecker的API主要定义在web/api/目录下，包含多个Thrift文件：

• codechecker_api_shared.thrift：定义共享数据类型和异常处理
• report_server.thrift：核心分析报告服务接口
• products.thrift：产品管理接口
• tasks.thrift：后台任务管理接口

这些文件定义了CodeChecker API的完整契约，包括数据结构、服务方法和错误处理机制。

核心API接口详解

CodeChecker提供了丰富的API接口，涵盖了从分析结果查询到项目管理的各个方面。以下是一些核心接口的详细介绍：

分析结果查询接口

report_server.thrift中定义的codeCheckerDBAccess服务提供了强大的分析结果查询能力：

ReportDataList getRunResults( 1: list<i64> runIds, 2: i64 limit, 3: i64 offset, 4: list<SortMode> sortType, 5: ReportFilter reportFilter, 6: CompareData cmpData, 7: optional bool getDetails ) throws (1: RequestFailed requestError)

这个接口允许您：

• 指定要查询的分析运行ID
• 分页获取结果
• 按多种条件排序（文件名、检查器名称、严重程度等）
• 应用复杂的过滤条件
• 比较不同运行的结果

分析任务管理接口

通过massStoreRunAsynchronous接口，您可以异步提交分析任务：

TaskToken massStoreRunAsynchronous( 1: string zipfileBlob, 2: SubmittedRunOptions storeOpts ) throws (1: RequestFailed requestError)

这个接口接受分析结果ZIP文件和存储选项，返回一个任务令牌，您可以使用该令牌查询任务状态。

代码审查状态管理

CodeChecker API允许您管理代码审查状态：

bool changeReviewStatus( 1: i64 reportId, 2: ReviewStatus status, 3: string message ) throws (1: RequestFailed requestError)

通过这个接口，您可以将报告标记为已确认、误报或有意为之等状态。

快速开始：使用Python客户端

CodeChecker提供了Python客户端库，让您可以轻松地与API交互。以下是一个简单的示例，展示如何查询分析结果：

安装客户端

首先，确保您已克隆CodeChecker仓库：

git clone https://gitcode.com/gh_mirrors/co/codechecker

基本查询示例

from codechecker_api.v1 import codeCheckerDBAccess from codechecker_api.v1.codeCheckerDBAccess import ttypes # 创建客户端连接 client = codeCheckerDBAccess.Client(...) # 定义查询参数 run_ids = [1, 2, 3] limit = 100 offset = 0 sort_mode = [ttypes.SortMode(type=ttypes.SortType.SEVERITY, ord=ttypes.Order.DESC)] report_filter = ttypes.ReportFilter(severity=[ttypes.Severity.HIGH, ttypes.Severity.CRITICAL]) # 执行查询 results = client.getRunResults(run_ids, limit, offset, sort_mode, report_filter, None, False) # 处理结果 for report in results: print(f"发现问题: {report.checkerMsg} 在 {report.checkedFile}:{report.line}")

高级应用：构建自定义分析仪表板

利用CodeChecker API，您可以构建自定义的分析仪表板，实时监控项目质量状况。下面是一个构建仪表板的基本步骤：

1. 数据收集

使用API收集分析数据：

# 获取严重程度统计 severity_counts = client.getSeverityCounts(run_ids, report_filter, None) # 获取检查器统计 checker_counts = client.getCheckerCounts(run_ids, report_filter, None, 100, 0)

2. 数据可视化

将收集的数据可视化，您可以使用Matplotlib或其他可视化库：

3. 定期更新

设置定时任务，定期更新仪表板数据：

import schedule import time def update_dashboard(): # 收集并更新数据 ... schedule.every(1).hour.do(update_dashboard) while True: schedule.run_pending() time.sleep(1)

API最佳实践

错误处理

始终正确处理API调用可能抛出的异常：

try: results = client.getRunResults(...) except codechecker_api_shared.ttypes.RequestFailed as e: print(f"API调用失败: {e.message} (错误码: {e.errorCode})") # 根据错误码采取适当的处理措施

分页处理

当处理大量数据时，务必使用分页：

offset = 0 limit = 100 while True: results = client.getRunResults(..., limit=limit, offset=offset) if not results: break # 处理当前页结果 ... offset += limit

性能优化

• 只请求您需要的数据
• 使用适当的过滤条件减少返回数据量
• 对于大型查询，考虑使用异步接口

常见问题解答

Q: 如何获取特定分析运行的详细报告？

A: 使用getReportDetails接口：

report_details = client.getReportDetails(report_id) print("错误路径:") for event in report_details.pathEvents: print(f" {event.filePath}:{event.startLine} - {event.msg}")

Q: 如何比较两个不同分析运行的结果？

A: 使用getDiffResultsHash接口：

diff_hashes = client.getDiffResultsHash( runIds=[new_run_id], reportHashes=[], diffType=ttypes.DiffType.NEW, tagIds=[base_run_tag_id] )

Q: 如何以编程方式添加评论？

A: 使用addComment接口：

comment = ttypes.CommentData( message="这是一个需要优先修复的问题", kind=ttypes.CommentKind.USER ) client.addComment(report_id, comment)

总结

CodeChecker API为开发者提供了强大的工具，用于构建自定义分析工具和集成方案。通过充分利用这些API，您可以将静态分析无缝集成到您的开发流程中，提高代码质量并加速问题修复。

无论是构建自定义仪表板、自动化分析流程，还是与其他开发工具集成，CodeChecker API都提供了灵活而强大的接口来满足您的需求。开始探索CodeChecker API，释放静态分析的全部潜力！

更多API详情，请参考项目中的API定义文件和官方文档。

【免费下载链接】codecheckerCodeChecker is an analyzer tooling, defect database and viewer extension for static and dynamic analyzer tools.项目地址: https://gitcode.com/gh_mirrors/co/codechecker