# millet-base-boot

**Repository Path**: millet-framework/millet-base-boot

## Basic Information

- **Project Name**: millet-base-boot
- **Description**: 基于spring boot框架的单体应用脚手架
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-04
- **Last Updated**: 2026-05-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Millet Base Boot - 企业级 Spring Boot 脚手架

## 项目简介

Millet Base Boot 是一个基于 Spring Boot 4.x 构建的企业级脚手架项目，采用多模块架构设计，集成了 Spring Security、JWT Token、MyBatis 等技术栈，提供了完整的用户认证、授权和管理功能。

本项目采用模块化设计，包含基础框架层、系统业务层和管理应用层，便于扩展和维护。

## 📚 文档导航

- **[快速开始](#快速开始)** - 环境要求和安装步骤
- **[JWT 认证机制](./docs/jwt-auth.md)** - Token 机制、前端集成、安全配置
- **[数据库设计与配置](./docs/database.md)** - 表结构、SQL 初始化策略、连接配置
- **[API 接口文档](./docs/api.md)** - Swagger UI、接口列表、测试指南
- **[开发指南](./docs/development.md)** - 项目结构、添加新功能、前端集成
- **[部署指南](./docs/deployment.md)** - 本地部署、生产部署、安全建议
- **[Git Hooks 配置](./docs/git-hooks-setup.md)** - Git 提交时自动执行 Spotless 代码格式化
- **[IDEA 配置指南](./docs/idea-spotless-config.md)** - IDEA 与 Git Hooks 协同配置

## 技术栈

- **后端框架**: Spring Boot 4.0.6
- **安全框架**: Spring Security 7.x + OAuth2 Resource Server
- **认证方式**: JWT (JSON Web Token)
- **持久层**: MyBatis 4.0.1
- **数据库**: MySQL 8.0+
- **前端技术**: 原生 HTML5/CSS3/JavaScript
- **构建工具**: Maven
- **Java 版本**: Java 26
- **API 文档**: SpringDoc OpenAPI 3.0.3

## 主要功能

### 1. JWT Token 认证与授权

- 用户注册与登录（返回 JWT Token）
- Access Token 和 Refresh Token 双令牌机制
- Token 自动刷新功能
- 基于角色的访问控制（RBAC）
- 密码加密存储（BCrypt）

详细文档：[JWT 认证机制](./docs/jwt-auth.md)

### 2. 用户管理

- 用户信息查看与管理
- 用户编辑与删除
- 密码修改功能
- 最后登录时间记录

### 3. 前端页面

- 响应式登录/注册页面
- 用户管理界面
- HTTP 请求封装工具

### 4. 模块化架构

- 基础框架模块（安全、MyBatis、Redis 等）
- 系统业务模块（用户、角色、菜单、部门、字典等）
- 管理后台应用模块

详细架构说明：[开发指南](./docs/development.md#项目结构说明)

## 项目结构

详细项目结构说明请参考：[开发指南 - 项目结构说明](./docs/development.md#项目结构说明)

**核心模块：**

- **millet-admin**: 管理后台应用模块（启动入口）
- **millet-framework**: 基础框架模块（安全、MyBatis、Redis、Swagger）
- **millet-system**: 系统业务模块（用户、角色、菜单、部门、字典）

## 快速开始

### 环境要求

- JDK 26+
- Maven 3.6+
- Git
- MySQL 8.0+

### 安装步骤

详细安装步骤请参考：[部署指南](./docs/deployment.md#本地部署)

**简要步骤：**

1. 克隆项目
2. 创建数据库并手动执行 SQL 脚本：`mysql -u root -p millet_base_boot_dev < scripts/sql/millet.sql`（参考 [数据库文档](./docs/database.md)）
3. 编译项目：`mvn clean install`
4. 运行应用：`cd millet-admin && mvn spring-boot:run`
5. 访问应用：http://localhost:8080/index.html

### 代码格式化配置

本项目使用 Spotless 进行代码格式化，确保代码风格统一。

**安装 Git 钩子（自动格式化）：**

```bash
# Windows PowerShell
.\install-git-hooks.ps1

# Linux/Mac/Git Bash
./install-git-hooks.sh
```

安装后，每次 `git commit` 时会自动运行 `mvnw spotless:apply` 格式化代码。

**手动格式化：**

```bash
# Linux/Mac/Git Bash
./mvnw spotless:apply

# Windows PowerShell
.\mvnw.cmd spotless:apply
```

详细说明：[Git Hooks 配置指南](./docs/git-hooks-setup.md)

### 默认账户

**管理员账户:**

- 用户名: admin
- 密码: admin123

**普通用户账户:**

- 用户名: user
- 密码: user123

## API 接口文档

本项目已集成 SpringDoc OpenAPI，提供交互式 API 文档。

**访问地址：** http://localhost:8080/swagger-ui.html

详细文档：[API 接口文档](./docs/api.md)

## 安全特性

1. **JWT Token 认证**: 无状态认证，适合前后端分离架构
2. **双令牌机制**: Access Token（短效）+ Refresh Token（长效）
3. **密码加密**: 使用 BCrypt 算法对密码进行加密存储
4. **角色权限**: 基于 Spring Security 的角色访问控制
5. **HTTPS 建议**: 生产环境建议使用 HTTPS 传输 Token

详细安全配置：[JWT 认证机制](./docs/jwt-auth.md#安全特性)

## 贡献

欢迎提交 Issue 和 Pull Request 来改进这个项目！

## 许可证

本项目采用 MIT 许可证。