快速开始

5 分钟上手

不依赖容器:只用本机 JDK 21 与一个 MySQL 实例,跑起来、登录、生成一个模块。

目标是五分钟内完成三件事:跑起来、登录后台、生成一个模块。全程不需要容器化环境,也不需要手工建表。

1 · 准备

java -version # 需要 21
mysql --version # 需要 8.0+
./gradlew --version # 用仓库自带的 wrapper,不装本机 Gradle
依赖版本说明
JDK21build.gradle 用 toolchain 锁定,版本不对会直接报错
MySQL8.0+唯一支持的数据库;表结构由 Liquibase 自动创建
Gradle9.5.0用仓库内 gradlew,不要依赖本机 Gradle

说明:邮箱验证码所需 SMTP 属于可选项:不配置时,验证码只写入日志,登录流程仍可走完。

2 · 获取代码并配置

git clone <仓库地址> minimao
cd minimao
cp .env.example .env

编辑 .env 填入下列变量(真实凭据只存在本机,不进仓库):

变量用途示例
MINIMAO_DB_URL数据库连接地址jdbc:mysql://127.0.0.1:3306/minimao?useUnicode=true&characterEncoding=utf8mb4
MINIMAO_DB_USERNAME数据库账号minimao
MINIMAO_DB_PASSWORD数据库密码(本机自定,不入库)
MINIMAO_BOOTSTRAP_ADMIN_PASSWORD_HASH初始管理员密码的 BCrypt 哈希仅首次初始化时写入
MAIL_HOST / MAIL_USERNAME / MAIL_PASSWORD邮箱验证码发信凭据不配则验证码只能从日志读取

注意:仓库内不含任何内网地址与真实凭据;application.yml 与 .env.example 双向登记,缺一处构建即失败。

3 · 启动

./gradlew bootRun
# Windows:gradlew.bat bootRun

首次启动会由 Liquibase 执行全部迁移脚本完成建表,并写入种子数据与初始管理员账号。看到 Started MiniMaoApplication in Xs 即启动成功。

注意:初始管理员密码取自 MINIMAO_BOOTSTRAP_ADMIN_PASSWORD_HASH(BCrypt 哈希),不要使用弱哈希,也不要把明文写进配置文件。

4 · 登录后台

open http://localhost:8080

用初始管理员登录后,可以直接看到用户、角色、菜单、字典与操作日志等页面,并用不同角色的账号观察按钮级差异。

5 · 生成一个模块

./gradlew generateModule -Pname=demo
./gradlew build

骨架生成器会产出目录、迁移脚本与测试骨架,并自动登记模块、权限码与菜单。生成物自带测试,构建必须一次通过——这是硬性判据,不是建议。

下一步

最后更新 2026-10-09编辑此页 →