使用文档 - ScanBoot

🚀 快速开始

ScanBoot 提供 Web 界面，3 步即可完成代码审查：

填写 Git 项目地址 - 支持 GitHub / GitLab / Gitee 等
选择分析类型 - API 接口 / 定时任务 / 消息队列
点击开始分析 - 等待结果，查看审查报告

💡 提示：公开仓库无需填写 Token，私有仓库需要提供访问令牌。

🖥️ Web 界面使用

1. 填写项目信息

参数	说明	示例
Git 项目 URL	项目仓库地址	https://github.com/user/project
分支名称	要分析的分支	master / main / develop
访问令牌	私有仓库需要	ghp_xxx (GitHub) / glpat-xxx (GitLab)

2. 选择分析范围

参数	说明
控制器名称 = `all`	扫描所有 Controller
控制器名称 = `UserController`	只扫描指定 Controller
接口方法名 = `login,register`	只扫描指定方法
最大深度 = `10`	调用链追踪深度（建议 5-15）

3. 查看分析进度

分析过程分为三个阶段，页面会实时显示进度：

📥 下载项目 - 从 Git 仓库克隆代码
🔗 链路提取 - 解析 AST，构建调用链
🤖 AI 审查 - 对每个入口进行深度审查

📊 分析类型说明

API 接口分析

扫描所有 @RestController / @Controller 中的 HTTP 接口：

支持 @GetMapping / @PostMapping / @RequestMapping 等
自动识别请求参数、路径变量、请求体
追踪从 Controller 到 SQL 的完整调用链

定时任务分析

扫描所有 @Scheduled 注解的方法：

支持 cron 表达式、fixedRate、fixedDelay
检查幂等性、重复执行风险
分析数据处理逻辑和异常处理

消息队列分析

扫描消息消费者方法：

支持 Kafka (@KafkaListener)
支持 RabbitMQ (@RabbitListener)
支持 RocketMQ (@RocketMQMessageListener)
检查消息确认、重复消费、顺序性问题

📋 结果解读

风险等级

等级	说明	建议
🔴 高风险	可能导致线上事故	必须修复后再上线
🟡 中风险	存在潜在问题	建议尽快修复
🟢 低风险	代码规范或优化建议	可选修复

问题分类

参数校验 - 缺少入参验证、边界检查
SQL 注入 - 动态拼接 SQL、未参数化查询
业务逻辑 - 逻辑漏洞、边界条件处理
并发安全 - 竞态条件、幂等性问题
异常处理 - 异常被吞、未正确处理
性能问题 - N+1 查询、全表扫描风险
安全漏洞 - 敏感信息泄露、权限问题
代码规范 - 命名、注释、代码结构

❓ 常见问题

Q: 分析需要多长时间？

取决于项目规模和接口数量。通常：

50 个接口：约 5 分钟
200 个接口：约 15 分钟
500 个接口：约 30-40 分钟

Q: 代码会被保存吗？

不会。分析完成后，代码会自动从服务器删除，我们不保留任何源代码。

Q: 支持哪些 Git 平台？

支持所有标准 Git 仓库：GitHub、GitLab、Gitee、Bitbucket、Coding，以及任意自建 Git 服务器。

Q: 私有仓库如何获取 Token？

GitHub：Settings → Developer settings → Personal access tokens
GitLab：Preferences → Access Tokens
Gitee：设置 → 私人令牌

Q: 分析失败怎么办？

常见原因：

Git URL 格式错误或仓库不存在
分支名称不正确
私有仓库未提供 Token 或 Token 权限不足
项目不是 Java/Spring Boot 项目

💡 需要帮助？联系我们：mingyuegx@126.com

📖 使用文档

📑 目录导航