# AdminPro

**Repository Path**: zhanggj3/admin-pro

## Basic Information

- **Project Name**: AdminPro
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-21
- **Last Updated**: 2026-03-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Admin Pro - 轻量级 Java 后台项目

## 1. 项目简介
这是一个基于 Spring Boot 3 + MyBatis-Plus + MySQL + Redis 构建的轻量级后台管理系统模板。项目结构清晰，注释详细，旨在帮助新手快速上手 Java 后端开发。

## 2. 技术栈
- **语言**: Java 17+
- **核心框架**: Spring Boot 3.2.x
- **ORM 框架**: MyBatis-Plus 3.5.x (简化数据库增删改查)
- **数据库**: MySQL 8.0
- **缓存**: Redis (提升查询速度)
- **构建工具**: Maven

## 3. 快速开始 (Mac 环境)

### 步骤 1: 准备环境
确保电脑上安装了 Docker Desktop 和 JDK 17。
如果你不想安装本地 MySQL/Redis，我们提供了 Docker Compose 一键启动方案。

### 步骤 2: 启动中间件 (MySQL & Redis)
在项目根目录下打开终端，运行：
```bash
docker compose up -d
```
> 这会自动下载并启动 MySQL(端口3306) 和 Redis(端口6379)。数据库初始密码见 `compose.yaml`。

### 步骤 3: 运行项目
1. 使用 IntelliJ IDEA 打开本项目。
2. 等待 Maven 依赖下载完成。
3. 找到 `src/main/java/com/adminpro/AdminProApplication.java`，点击运行。
4. 访问测试接口：[http://localhost:8080/api/user/list](http://localhost:8080/api/user/list)

## 4. 相关文档
为了方便维护，我们将详细说明拆分成了几个文档：

- **[API 开发指南](docs/api_guide.md)**:教你怎么写 Controller, Service 和 Entity，怎么增加新功能。
- **[数据库与 Redis 指南](docs/db_redis_guide.md)**: 教你怎么设计表，怎么查数据库，以及缓存怎么用。
- **[部署指南](docs/deploy_guide.md)**: 教你怎么打包项目，怎么放到服务器上运行。

## 5. 目录结构说明
```
com.adminpro
├── common      # 通用工具（如统一返回结果 Result）
├── config      # 配置类（如 Redis 配置）
├── controller  # 接口层（Web API 入口）
├── entity      # 实体类（对应数据库表）
├── mapper      # 数据访问层（SQL 操作）
├── service     # 业务逻辑层
└── AdminProApplication.java # 启动入口
```