chipeak/XCodeReviewer

Public

WeChat Login

Code Issues Pull requests Events Packages Insights

main

XCodeReviewer/README.md

lintsinghua<129816813+lintsinghua@users.noreply.github.com>

Update README.md

306a19ec

PreviewCode viewBlame

XCodeReviewer - 您的智能代码审计伙伴 🚀

中文 • English

XCodeReviewer 是一个由大型语言模型（LLM）驱动的现代化代码审计平台，旨在为开发者提供智能、全面且极具深度的代码质量分析和审查服务。

🌟 为什么选择 XCodeReviewer？

在快节奏的软件开发中，保证代码质量至关重要。传统代码审计工具规则死板、效率低下，而人工审计则耗时耗力。XCodeReviewer 借助 Google Gemini AI 的强大能力，彻底改变了代码审查的方式：

AI 驱动的深度分析：超越传统静态分析，理解代码意图，发现深层逻辑问题。
多维度、全方位评估：从安全性、性能、可维护性到代码风格，提供 360 度无死角的质量评估。
清晰、可行的修复建议：独创 What-Why-How 模式，不仅告诉您“是什么”问题，还解释“为什么”，并提供“如何修复”的具体代码示例。
实时反馈，即时提升：无论是代码片段还是整个代码仓库，都能获得快速、准确的分析结果。
现代化、高颜值的用户界面：基于 React + TypeScript 构建，提供流畅、直观的操作体验。

🎬 项目演示

主要功能界面

智能仪表盘

智能仪表盘 实时展示项目统计、质量趋势和系统性能，提供全面的代码审计概览

即时分析

即时分析 支持代码片段快速分析，提供详细的 What-Why-How 解释和修复建议

项目管理

项目管理 集成 GitHub/GitLab 仓库，支持多语言项目审计和批量代码分析

🚀 快速开始

🐳 Docker 部署（推荐）

使用 Docker 可以快速部署应用，无需配置 Node.js 环境。

克隆项目


git clone https://github.com/lintsinghua/XCodeReviewer.git
cd XCodeReviewer

配置环境变量


cp .env.example .env
# 编辑 .env 文件，至少需要配置 VITE_GEMINI_API_KEY

构建并启动


docker-compose build
docker-compose up -d

访问应用

在浏览器中打开 http://localhost:5174

💻 本地开发部署

如果需要进行开发或自定义修改，可以使用本地部署方式。

环境要求

Node.js: 18+
pnpm: 8+ (推荐) 或 npm / yarn
Google Gemini API Key: 用于 AI 代码分析

安装与启动

克隆项目


git clone https://github.com/lintsinghua/XCodeReviewer.git
cd XCodeReviewer

安装依赖


# 使用 pnpm (推荐)
pnpm install

# 或使用 npm
npm install

# 或使用 yarn
yarn install

配置环境变量


# 复制环境变量模板
cp .env.example .env

编辑 .env 文件，配置必要的环境变量：


# Google Gemini AI 配置 (必需)
VITE_GEMINI_API_KEY=your_gemini_api_key_here
VITE_GEMINI_MODEL=gemini-2.5-flash
VITE_GEMINI_TIMEOUT_MS=25000

# Supabase 配置 (可选，用于数据持久化)
VITE_SUPABASE_URL=https://your-project.supabase.co
VITE_SUPABASE_ANON_KEY=your-anon-key-here

# GitHub 集成 (可选，用于仓库分析)
VITE_GITHUB_TOKEN=your_github_token_here

# 应用配置
VITE_APP_ID=xcodereviewer

# 分析配置
VITE_MAX_ANALYZE_FILES=40
VITE_LLM_CONCURRENCY=2
VITE_LLM_GAP_MS=500

启动开发服务器
```
pnpm dev
```
访问应用 在浏览器中打开 http://localhost:5173

🔑 获取 API Key

Google Gemini API Key（预计后续会开放更多主流平台API功能）

访问 Google AI Studio
创建新的 API Key
将 API Key 添加到 .env 文件中的 VITE_GEMINI_API_KEY

Supabase 配置（可选）

访问 Supabase 创建新项目
在项目设置中获取 URL 和匿名密钥

运行数据库迁移脚本：


# 在 Supabase SQL 编辑器中执行
cat supabase/migrations/full_schema.sql

如果不配置 Supabase，系统将以演示模式运行，数据不会持久化

✨ 核心功能

🚀 项目管理

一键集成代码仓库：无缝对接 GitHub、GitLab 等主流平台。
多语言“全家桶”支持：覆盖 JavaScript, TypeScript, Python, Java, Go, Rust 等热门语言。
灵活的分支审计：支持对指定代码分支进行精确分析。

⚡ 即时分析

代码片段“随手贴”：直接在 Web 界面粘贴代码，立即获得分析结果。
10+ 种语言即时支持：满足您多样化的代码分析需求。
毫秒级响应：快速获取代码质量评分和优化建议。

🧠 智能审计

AI 深度代码理解：基于 Google Gemini（预计后续会开放更多主流平台API功能），提供超越关键词匹配的智能分析。
五大核心维度检测：
- 🐛 潜在 Bug：精准捕捉逻辑错误、边界条件和空指针等问题。
- 🔒 安全漏洞：识别 SQL 注入、XSS、敏感信息泄露等安全风险。
- ⚡ 性能瓶颈：发现低效算法、内存泄漏和不合理的异步操作。
- 🎨 代码风格：确保代码遵循行业最佳实践和统一规范。
- 🔧 可维护性：评估代码的可读性、复杂度和模块化程度。

💡 可解释性分析 (What-Why-How)

What (是什么)：清晰地指出代码中存在的问题。
Why (为什么)：详细解释该问题可能带来的潜在风险和影响。
How (如何修复)：提供具体的、可直接使用的代码修复示例。
精准代码定位：快速跳转到问题所在的行和列。

📊 可视化报告

代码质量仪表盘：提供 0-100 分的综合质量评估，让代码健康状况一目了然。
多维度问题统计：按类型和严重程度对问题进行分类统计。
质量趋势分析：通过图表展示代码质量随时间的变化趋势。

🛠️ 技术栈

分类	技术	说明
前端框架	`React 18` `TypeScript` `Vite`	现代化前端开发栈，支持热重载和类型安全
UI 组件	`Tailwind CSS` `Radix UI` `Lucide React`	响应式设计，无障碍访问，丰富的图标库
数据可视化	`Recharts`	专业的图表库，支持多种图表类型
路由管理	`React Router v6`	单页应用路由解决方案
状态管理	`React Hooks` `Sonner`	轻量级状态管理和通知系统
AI 引擎	`Google Gemini 2.5 Flash` （预计后续会开放更多主流平台API功能）	强大的大语言模型，支持代码分析
后端服务	`Supabase` `PostgreSQL`	全栈后端即服务，实时数据库
HTTP 客户端	`Axios` `Ky`	现代化的 HTTP 请求库
代码质量	`Biome` `Ast-grep` `TypeScript`	代码格式化、静态分析和类型检查
构建工具	`Vite` `PostCSS` `Autoprefixer`	快速的构建工具和 CSS 处理

📁 项目结构


XCodeReviewer/
├── src/
│   ├── app/                # 应用配置
│   │   ├── App.tsx         # 主应用组件
│   │   ├── main.tsx        # 应用入口点
│   │   └── routes.tsx      # 路由配置
│   ├── components/         # React 组件
│   │   ├── layout/         # 布局组件 (Header, Footer, PageMeta)
│   │   ├── ui/             # UI 组件库 (基于 Radix UI)
│   │   └── debug/          # 调试组件
│   ├── pages/              # 页面组件
│   │   ├── Dashboard.tsx   # 仪表盘
│   │   ├── Projects.tsx    # 项目管理
│   │   ├── InstantAnalysis.tsx # 即时分析
│   │   ├── AuditTasks.tsx  # 审计任务
│   │   └── AdminDashboard.tsx # 系统管理
│   ├── features/           # 功能模块
│   │   ├── analysis/       # 分析相关服务
│   │   │   └── services/   # AI 代码分析引擎
│   │   └── projects/       # 项目相关服务
│   │       └── services/   # 仓库扫描、ZIP 文件扫描
│   ├── shared/             # 共享工具
│   │   ├── config/         # 配置文件 (数据库、环境变量)
│   │   ├── types/          # TypeScript 类型定义
│   │   ├── hooks/          # 自定义 React Hooks
│   │   ├── utils/          # 工具函数
│   │   └── constants/      # 常量定义
│   └── assets/             # 静态资源
│       └── styles/         # 样式文件
├── supabase/
│   └── migrations/         # 数据库迁移文件
├── public/
│   └── images/             # 图片资源
├── scripts/                # 构建和设置脚本
└── rules/                  # 代码规则配置

🎯 使用指南

即时代码分析

访问 /instant-analysis 页面
选择编程语言（支持 10+ 种语言）
粘贴代码或上传文件
点击"开始分析"获得 AI 分析结果
查看详细的问题报告和修复建议

项目管理

访问 /projects 页面
点击"新建项目"创建项目
配置仓库 URL 和扫描参数
启动代码审计任务
查看审计结果和问题统计

审计任务

在项目详情页创建审计任务
选择扫描分支和排除模式
配置分析深度和范围
监控任务执行状态
查看详细的问题报告

构建和部署


# 开发模式
pnpm dev

# 构建生产版本
pnpm build

# 预览构建结果
pnpm preview

# 代码检查
pnpm lint

环境变量说明

变量名	必需	说明
`VITE_GEMINI_API_KEY`	✅	Google Gemini API 密钥
`VITE_GEMINI_MODEL`	❌	AI 模型名称 (默认: gemini-2.5-flash)
`VITE_GEMINI_TIMEOUT_MS`	❌	请求超时时间 (默认: 25000ms)
`VITE_SUPABASE_URL`	❌	Supabase 项目 URL
`VITE_SUPABASE_ANON_KEY`	❌	Supabase 匿名密钥
`VITE_APP_ID`	❌	应用标识符 (默认: xcodereviewer)

🤝 贡献指南

我们热烈欢迎所有形式的贡献！无论是提交 issue、创建 PR，还是改进文档，您的每一次贡献对我们都至关重要。请联系我们了解详细信息。

开发流程

Fork 本项目
创建您的功能分支 (git checkout -b feature/AmazingFeature)
提交您的更改 (git commit -m 'Add some AmazingFeature')
推送到分支 (git push origin feature/AmazingFeature)
创建一个 Pull Request

🙏 致谢

Google Gemini AI: 提供强大的 AI 分析能力
Supabase: 提供便捷的后端即服务支持
Radix UI: 提供无障碍的 UI 组件
Tailwind CSS: 提供现代化的 CSS 框架
Recharts: 提供专业的图表组件
以及所有本项目所使用的开源软件的作者们！

📞 联系我们

项目链接: https://github.com/lintsinghua/XCodeReviewer
问题反馈: Issues
作者邮箱: tsinghuaiiilove@gmail.com

🎯 未来计划（正在加急中）

目前 XCodeReviewer 定位为快速原型验证阶段，功能需要逐渐完善，根据项目后续发展和大家的建议，未来开发计划如下（尽快实现）：

多平台/本地模型支持: 未来会尽快加入OpenAI、Claude、通义千问等各大国内外主流模型API调用功能，以及对本地大模型调用的功能（满足数据隐私需求）
Multi-Agent Collaboration: 考虑引入多智能体协作架构，会实现Agent+人工对话反馈的功能，包括多轮对话流程展示，人工对话中断干涉等，以获得更清晰、透明、监督性的审计过程，提升审计质量
专业报告文件生成: 根据不同的需求生成相关格式的专业审计报告文件，支持文件报告格式定制等
审计标准自定义: 不同团队有自己的编码规范，不同项目有特定的安全要求，也正是我们这个项目想后续做的东西。当前的版本还属于一个“半黑盒模式”，项目通过 Prompt 工程来引导分析方向和定义审计标准，实际分析效果由强大的预训练AI 模型内置知识决定。后续将结合强化学习、监督学习微调等方法，开发以支持自定义规则配置，通过YAML或者JSON定义团队特定规则，提供常见框架的最佳实践模板等等，以获得更加符合需求和标准的审计结果

⭐ 如果这个项目对您有帮助，请给我们一个 Star！您的支持是我们不断前进的动力！