# code-review-ai

**Repository Path**: mjb/code-review-ai

## Basic Information

- **Project Name**: code-review-ai
- **Description**: springboot为基础使用spring ai 实现的代码review
基于gitlab mr做review, 大量修改会循环单个文件进行review, 使用javaparser尝试对diff的相关上下文纳入审核范围
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-08-14
- **Last Updated**: 2025-08-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# code-review-ai

## 介绍
code-review-ai 是一个基于Spring AI和GitLab集成的智能代码审查助手。它利用先进的AI技术和抽象语法树(AST)分析来提供自动化的代码审查服务，帮助开发团队提高代码质量和开发效率。


## 软件架构
项目采用现代化的多模块Maven架构，集成了多个强大的技术组件：

### 核心技术栈
- **Java 17**: 利用最新的Java特性提供强大的开发基础
- **Spring Boot 3.2.5**: 提供稳定可靠的应用框架
- **Spring AI 1.0.0**: 集成AI能力，支持智能代码分析
- **Spring WebFlux**: 采用响应式编程模型，提供高性能的异步处理能力
- **GitLab4J API**: 实现与GitLab的无缝集成
- **JavaParser**: 提供强大的Java代码AST分析能力

### 项目结构
```
code-review-ai/
├── mcp-server/    # MCP服务器模块
│   └── src/       # 源代码目录
└── pom.xml        # 主项目配置文件
```

## 安装教程

### 1. 环境要求
- JDK 17 或更高版本
- Maven 3.6 或更高版本
- GitLab 实例（用于代码审查集成）

### 2. 基础配置
1. 克隆项目到本地：
```bash
git clone [项目地址]
```

2. 安装依赖：
```bash
mvn clean install
```

### 3. MCP Server配置
1. 添加以下配置：
```json
{
    "mcpServers": {
        "code-review-ai-MCP": {
            "url": "http://127.0.0.1:8089/review/sse"
        }
    }
}
```

2. 配置GitLab访问令牌：
- 访问GitLab个人设置
- 生成访问令牌（需要api权限）
- 将令牌配置到环境变量或配置文件中

## 使用说明

### 1. 启动服务
```bash
mvn spring-boot:run -pl mcp-server
```

### 2. 代码审查功能
- **自动审查**: 当创建新的合并请求时，系统会自动触发代码审查
- **手动触发**: 通过API接口手动触发代码审查
- **审查报告**: 系统会生成详细的代码审查报告，包括：
  - 代码质量分析
  - 潜在问题识别
  - 最佳实践建议
  - 性能优化建议

### 3. API使用
- 获取审查报告：
```bash
curl -X GET http://localhost:8080/api/review/{merge-request-id}
```

- 触发手动审查：
```bash
curl -X POST http://localhost:8080/api/review/trigger/{merge-request-id}
```

## 参与贡献

1. Fork 本仓库
2. 新建 feature_xxx 分支
3. 提交代码
4. 新建 Pull Request

## 特技

1. 基于Spring AI的智能代码分析
2. 实时AST解析和代码结构分析
3. GitLab深度集成
4. 响应式架构设计
5. 自定义规则引擎支持