docs: 更新README.md - 根据项目实际内容重新撰写文档
This commit is contained in:
lintsinghua
parent
7478f6f14f
commit
49a957905f
262
README.md
262
README.md
|
|
@ -1,56 +1,242 @@
|
||||||
# XCodeReviewer - 基于XAI增强与LLM驱动的代码审查系统
|
# XCodeReviewer - 智能代码审计系统
|
||||||
|
|
||||||
[](https://github.com/your-username/your-repo)
|
[](https://github.com/lintsinghua/XCodeReviewer)
|
||||||
[](https://opensource.org/licenses/MIT)
|
[](https://opensource.org/licenses/MIT)
|
||||||
|
[](https://reactjs.org/)
|
||||||
|
[](https://www.typescriptlang.org/)
|
||||||
|
[](https://vitejs.dev/)
|
||||||
|
|
||||||
**一个由大语言模型（LLM）驱动、并由可解释人工智能（XAI）增强的现代化代码审计平台，旨在为整个代码仓库和单个代码片段提供深度、智能且易于理解的审查反馈。**
|
**一个基于大语言模型（LLM）驱动的现代化代码审计平台，为开发者提供智能、全面的代码质量分析和审查服务。**
|
||||||
|
|
||||||
## 📖 项目简介 (About The Project)
|
## 📖 项目简介
|
||||||
|
|
||||||
告别耗时且标准不一的人工代码审计！本项目利用前沿的LLM技术，将专家级的代码审查能力自动化。与传统静态分析工具不同，我们不仅能“发现问题”，更能通过XAI技术清晰地解释“为什么这是个问题”以及“如何优雅地解决它”。
|
XCodeReviewer 是一个智能代码审计系统，利用 Google Gemini AI 的强大能力，为代码仓库和代码片段提供深度的质量分析。系统不仅能够发现代码中的问题，还能提供详细的解释和修复建议，帮助开发者提升代码质量。
|
||||||
|
|
||||||
本系统提供两种核心审查模式：
|
### 🎯 核心价值
|
||||||
1. **代码仓库全面审计：** 对您的整个项目代码库进行深度扫描，生成一份全面的健康报告，帮助您识别技术债务、发现潜在风险并规划重构路径。
|
|
||||||
2. **即时代码分析 (Code Sandbox)：** 为开发者提供一个便捷的“沙箱”环境，可以随时粘贴代码片段或上传文件，立即获得智能审查反馈，是日常编码和学习的强大助手。
|
|
||||||
|
|
||||||
## ✨ 核心功能 (Core Features)
|
- **AI 驱动分析**：基于 Google Gemini 的智能代码分析引擎
|
||||||
|
- **多维度评估**：覆盖安全性、性能、可维护性、代码风格等多个维度
|
||||||
|
- **可解释性**：提供 What-Why-How 模式的详细解释
|
||||||
|
- **实时分析**：支持即时代码片段分析和仓库级审计
|
||||||
|
- **现代化界面**：基于 React + TypeScript 的响应式 Web 界面
|
||||||
|
|
||||||
* **🚀 全面的代码仓库审计**
|
## ✨ 核心功能
|
||||||
* 与 GitHub / GitLab 等主流代码托管平台无缝集成。
|
|
||||||
* 支持对指定分支进行**手动触发**或**定时周期性**的全面扫描。
|
|
||||||
* 生成多维度可视化报告，包含代码质量评分、问题趋势分析、高风险模块定位等。
|
|
||||||
|
|
||||||
* **⚡ 即时代码片段分析 (Code Sandbox)**
|
### 🚀 项目管理
|
||||||
* 无需关联代码库，直接在网页编辑器中粘贴代码或上传文件即可分析。
|
- **项目创建与管理**：支持 GitHub、GitLab 等代码仓库集成
|
||||||
* 支持多种主流编程语言，是验证代码质量、学习最佳实践的利器。
|
- **多语言支持**：支持 JavaScript、TypeScript、Python、Java、Go、Rust 等主流编程语言
|
||||||
|
- **分支管理**：支持指定分支的代码审计
|
||||||
|
|
||||||
* **🧠 LLM 驱动的深度分析**
|
### ⚡ 即时分析
|
||||||
* **多维度审查：** 覆盖潜在Bug、安全漏洞、性能瓶颈、代码可维护性、编码规范和最佳实践等多个层面。
|
- **代码片段分析**：直接在 Web 界面中粘贴代码进行即时分析
|
||||||
* **上下文理解：** 借助LLM的强大理解能力，能发现传统工具难以识别的复杂逻辑问题。
|
- **多语言支持**：支持 10+ 种编程语言的代码分析
|
||||||
|
- **实时反馈**：快速获得代码质量评分和问题建议
|
||||||
|
|
||||||
* **💡 XAI 增强的可解释性**
|
### 🧠 智能审计
|
||||||
* **清晰的解释：** 每条建议都遵循“**What-Why-How**”模式：
|
- **AI 驱动分析**：基于 Google Gemini 的深度代码理解
|
||||||
* **What (是什么):** 精准定位问题代码，并用简洁的语言描述问题。
|
- **多维度检测**：
|
||||||
* **Why (为什么):** 详细解释该问题可能导致的潜在风险和负面影响。
|
- 🐛 **潜在 Bug**：发现逻辑错误和边界条件问题
|
||||||
* **How (怎么做):** 提供具体的、高质量的代码修复建议和示例。
|
- 🔒 **安全漏洞**：识别安全风险和漏洞
|
||||||
* **知识链接：** 附带相关文档或最佳实践文章链接，促进开发者深入学习。
|
- ⚡ **性能问题**：检测性能瓶颈和优化点
|
||||||
|
- 🎨 **代码风格**：确保代码符合最佳实践
|
||||||
|
- 🔧 **可维护性**：评估代码的可读性和可维护性
|
||||||
|
|
||||||
* **🖥️ 现代化的 Web 交互界面**
|
### 💡 可解释性分析
|
||||||
* 提供内置的代码浏览器，可在代码原文中**精确定位并高亮**问题片段。
|
- **What-Why-How 模式**：
|
||||||
* 直观的仪表盘和报告视图，让代码质量状况一目了然。
|
- **What**：问题是什么
|
||||||
|
- **Why**：为什么是问题
|
||||||
|
- **How**：如何修复
|
||||||
|
- **代码定位**：精确定位问题代码行和列
|
||||||
|
- **修复建议**：提供具体的代码修复示例
|
||||||
|
|
||||||
## 🛠️ 技术栈 (Technology Stack)
|
### 📊 可视化报告
|
||||||
|
- **质量评分**：0-100 分的综合质量评估
|
||||||
|
- **问题统计**：按类型和严重程度分类的问题统计
|
||||||
|
- **趋势分析**：代码质量变化趋势图表
|
||||||
|
- **性能指标**：系统性能监控和报告
|
||||||
|
|
||||||
* **前端:** React / Vue.js (with TypeScript)
|
## 🛠️ 技术栈
|
||||||
* **后端:** Python (FastAPI) / Node.js (NestJS)
|
|
||||||
* **数据库:** PostgreSQL, Redis
|
|
||||||
* **AI 核心:** OpenAI GPT-4 / Google Gemini / Anthropic Claude API, Celery / BullMQ
|
|
||||||
* **部署:** Docker, Kubernetes
|
|
||||||
|
|
||||||
## 🚀 快速开始 (Getting Started)
|
### 前端技术
|
||||||
|
- **React 18** - 现代化的用户界面框架
|
||||||
|
- **TypeScript** - 类型安全的 JavaScript 超集
|
||||||
|
- **Vite** - 快速的构建工具和开发服务器
|
||||||
|
- **Tailwind CSS** - 实用优先的 CSS 框架
|
||||||
|
- **Radix UI** - 无样式的 UI 组件库
|
||||||
|
- **Recharts** - 基于 React 的图表库
|
||||||
|
- **React Router** - 客户端路由管理
|
||||||
|
|
||||||
(此处将是项目的安装和启动指南)
|
### AI 与后端
|
||||||
|
- **Google Gemini AI** - 大语言模型驱动的代码分析
|
||||||
|
- **Supabase** - 后端即服务（BaaS）平台
|
||||||
|
- **PostgreSQL** - 关系型数据库
|
||||||
|
- **Axios** - HTTP 客户端
|
||||||
|
|
||||||
|
### 开发工具
|
||||||
|
- **Biome** - 快速的代码格式化和检查工具
|
||||||
|
- **Ast-grep** - 基于 AST 的代码搜索工具
|
||||||
|
- **ESLint** - JavaScript 代码检查工具
|
||||||
|
|
||||||
|
## 🚀 快速开始
|
||||||
|
|
||||||
|
### 环境要求
|
||||||
|
|
||||||
|
- Node.js 18+
|
||||||
|
- pnpm 8+ (推荐) 或 npm/yarn
|
||||||
|
- Google Gemini API Key
|
||||||
|
|
||||||
|
### 安装步骤
|
||||||
|
|
||||||
|
1. **克隆项目**
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/lintsinghua/XCodeReviewer.git
|
||||||
|
cd XCodeReviewer
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **安装依赖**
|
||||||
|
```bash
|
||||||
|
pnpm install
|
||||||
|
# 或
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **环境配置**
|
||||||
|
```bash
|
||||||
|
# 复制环境变量模板
|
||||||
|
cp .env.example .env
|
||||||
|
|
||||||
|
# 编辑 .env 文件，添加必要的环境变量
|
||||||
|
VITE_GEMINI_API_KEY=your_gemini_api_key_here
|
||||||
|
VITE_GEMINI_MODEL=gemini-2.5-flash
|
||||||
|
VITE_GEMINI_TIMEOUT_MS=25000
|
||||||
|
```
|
||||||
|
|
||||||
|
4. **启动开发服务器**
|
||||||
|
```bash
|
||||||
|
pnpm dev
|
||||||
|
# 或
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
5. **访问应用**
|
||||||
|
打开浏览器访问 [http://localhost:5173](http://localhost:5173)
|
||||||
|
|
||||||
|
### 构建生产版本
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# 克隆项目
|
pnpm build
|
||||||
git clone [https://github.com/lintsinghua/XCodeReviewer.git](https://github.com/lintsinghua/XCodeReviewer.git)
|
# 或
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
### 预览生产版本
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm preview
|
||||||
|
# 或
|
||||||
|
npm run preview
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📁 项目结构
|
||||||
|
|
||||||
|
```
|
||||||
|
XCodeReviewer/
|
||||||
|
├── src/
|
||||||
|
│ ├── components/ # React 组件
|
||||||
|
│ │ ├── common/ # 通用组件
|
||||||
|
│ │ ├── ui/ # UI 组件库
|
||||||
|
│ │ └── debug/ # 调试组件
|
||||||
|
│ ├── pages/ # 页面组件
|
||||||
|
│ ├── services/ # 服务层
|
||||||
|
│ ├── types/ # TypeScript 类型定义
|
||||||
|
│ ├── hooks/ # 自定义 React Hooks
|
||||||
|
│ ├── lib/ # 工具函数
|
||||||
|
│ └── db/ # 数据库配置
|
||||||
|
├── public/ # 静态资源
|
||||||
|
├── supabase/ # Supabase 配置
|
||||||
|
└── docs/ # 文档
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🔧 配置说明
|
||||||
|
|
||||||
|
### 环境变量
|
||||||
|
|
||||||
|
| 变量名 | 描述 | 默认值 |
|
||||||
|
|--------|------|--------|
|
||||||
|
| `VITE_GEMINI_API_KEY` | Google Gemini API 密钥 | 必填 |
|
||||||
|
| `VITE_GEMINI_MODEL` | 使用的 Gemini 模型 | `gemini-2.5-flash` |
|
||||||
|
| `VITE_GEMINI_TIMEOUT_MS` | API 请求超时时间 | `25000` |
|
||||||
|
|
||||||
|
### 支持的编程语言
|
||||||
|
|
||||||
|
- JavaScript
|
||||||
|
- TypeScript
|
||||||
|
- Python
|
||||||
|
- Java
|
||||||
|
- Go
|
||||||
|
- Rust
|
||||||
|
- C++
|
||||||
|
- C#
|
||||||
|
- PHP
|
||||||
|
- Ruby
|
||||||
|
|
||||||
|
## 📊 功能特性
|
||||||
|
|
||||||
|
### 代码分析维度
|
||||||
|
|
||||||
|
1. **安全性分析**
|
||||||
|
- SQL 注入检测
|
||||||
|
- XSS 漏洞识别
|
||||||
|
- 敏感信息泄露
|
||||||
|
- 权限控制问题
|
||||||
|
|
||||||
|
2. **性能优化**
|
||||||
|
- 算法复杂度分析
|
||||||
|
- 内存泄漏检测
|
||||||
|
- 异步操作优化
|
||||||
|
- 资源使用效率
|
||||||
|
|
||||||
|
3. **代码质量**
|
||||||
|
- 代码重复检测
|
||||||
|
- 复杂度评估
|
||||||
|
- 命名规范检查
|
||||||
|
- 注释完整性
|
||||||
|
|
||||||
|
4. **最佳实践**
|
||||||
|
- 设计模式应用
|
||||||
|
- 错误处理规范
|
||||||
|
- 测试覆盖率
|
||||||
|
- 文档完整性
|
||||||
|
|
||||||
|
## 🤝 贡献指南
|
||||||
|
|
||||||
|
我们欢迎所有形式的贡献！请查看 [CONTRIBUTING.md](CONTRIBUTING.md) 了解详细信息。
|
||||||
|
|
||||||
|
### 开发流程
|
||||||
|
|
||||||
|
1. Fork 项目
|
||||||
|
2. 创建功能分支 (`git checkout -b feature/AmazingFeature`)
|
||||||
|
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
|
||||||
|
4. 推送到分支 (`git push origin feature/AmazingFeature`)
|
||||||
|
5. 创建 Pull Request
|
||||||
|
|
||||||
|
## 📝 许可证
|
||||||
|
|
||||||
|
本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详细信息。
|
||||||
|
|
||||||
|
## 🙏 致谢
|
||||||
|
|
||||||
|
- [Google Gemini AI](https://ai.google.dev/) - 提供强大的 AI 分析能力
|
||||||
|
- [Supabase](https://supabase.com/) - 提供后端服务支持
|
||||||
|
- [React](https://reactjs.org/) - 前端框架
|
||||||
|
- [Tailwind CSS](https://tailwindcss.com/) - CSS 框架
|
||||||
|
- [Radix UI](https://www.radix-ui.com/) - UI 组件库
|
||||||
|
|
||||||
|
## 📞 联系我们
|
||||||
|
|
||||||
|
- 项目链接：[https://github.com/lintsinghua/XCodeReviewer](https://github.com/lintsinghua/XCodeReviewer)
|
||||||
|
- 问题反馈：[Issues](https://github.com/lintsinghua/XCodeReviewer/issues)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
⭐ 如果这个项目对您有帮助，请给我们一个 Star！
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue