Skip to content

快速开始

本指南面向新加入的开发者,帮助你在最短时间内成功运行 aant-boot 框架的完整项目(前端:aant-uniapp-base、aant-vben-admin;后端:angryant-* 模块)。内容覆盖环境要求、项目克隆与依赖安装、前后端分别配置、数据库初始化脚本执行、首次运行验证步骤,以及常见问题与故障排除。

项目结构

aant-boot 是一个多模块的全栈项目,包含:

  • 前端
    • aant-uniapp-base:基于 Vue 3 + UniApp 的跨平台应用脚手架
    • aant-vben-admin:基于 Vue 3 + Vite + TypeScript 的后台管理前端
  • 后端
    • angryant-platform:父级聚合模块,管理框架、代码生成、定时任务等子模块
    • angryant-biz-blank:空白业务模块(示例)
    • angryant-customer:客户相关业务模块
    • angryant-oss:对象存储模块
    • angryant-notice:通知模块
    • angryant-push:推送模块
    • angryant-mp:小程序模块
    • angryant-quartz:定时任务模块
    • angryant-generator:代码生成模块
mermaid

核心组件

  • 前端一(aant-uniapp-base)
    • 技术栈:Vue 3、UniApp、Pinia、uView Plus
    • 特性:状态管理、路由、API 请求封装、工具函数
    • 运行方式:HBuilderX 或命令行(uni 命令)
  • 前端二(aant-vben-admin)
    • 技术栈:Vue 3、Vite、TypeScript、多主题
    • 特性:权限体系、国际化、动态路由
    • 运行方式:pnpm dev
  • 后端(angryant-*)
    • 技术栈:Spring Boot 2.7.x、MyBatis-Plus、Druid、Redis
    • 特性:统一配置、安全防护、代码生成、定时任务
    • 运行方式:Maven 启动主应用或模块

架构概览

整体架构由前端应用与后端服务组成,前端通过 HTTP 接口与后端交互,后端连接 MySQL 和 Redis,部分模块提供独立的业务能力。

mermaid

详细组件分析

前端一:aant-uniapp-base(跨平台应用)

  • 环境要求
    • Node.js:建议使用 LTS 版本
    • HBuilderX:推荐使用(可直接运行到 H5、小程序、App)
  • 安装与运行
    • 安装依赖:npm install
    • 运行命令:npm run dev(H5)、npm run build:h5(构建 H5)、npm run build:mp-weixin(构建小程序)
  • 关键配置
    • 应用入口与页面:App.vue、manifest.json、pages.json
    • HTTP 请求封装:utils/http.js
    • 状态管理:store/modules/app.js
    • UI 组件:uView Plus(可选)
mermaid

前端二:aant-vben-admin(后台管理)

  • 环境要求
    • Node.js:≥ 20.10.0
    • 包管理器:pnpm(建议 ≥ 9.12.0)
  • 安装与运行
    • 安装依赖:pnpm install
    • 开发运行:pnpm dev
    • 构建产物:pnpm build
  • 关键特性
    • 多主题、国际化、权限与动态路由
    • Mock 服务(Nitro)支持 CORS
mermaid

后端:angryant-* 模块(Spring Boot)

  • 环境要求
    • Java:1.8(父级 POM 指定)
    • Maven:标准 Maven 仓库可用
    • MySQL:用于业务数据
    • Redis:用于缓存与会话
  • 安装与运行
    • 使用 Maven 启动主应用或具体模块
    • 配置文件:application.yml、application-druid.yml
  • 关键配置
    • 数据源:MySQL(Druid 连接池)
    • 缓存:Redis(host/port/password/timeout)
    • 安全:Token 配置(header、secret、expireTime、singleLogin)
    • XSS:过滤开关与匹配规则
    • 代码生成:生成包路径、页面与 API 路径前缀
mermaid

依赖分析

  • 前端依赖
    • aant-uniapp-base:Vue 3、Pinia、uView Plus、uni-ui
    • aant-vben-admin:Vue 3、Vite、TypeScript、Element Plus 图标等
  • 后端依赖
    • Spring Boot 2.7.x、MyBatis-Plus、Druid、Spring Security、JWT、Hutool、Swagger 等
    • 通过 angryant-platform 父级 POM 管理版本与模块聚合
mermaid

性能考虑

  • 前端
    • aant-vben-admin 使用 Vite 构建,具备快速冷启动与热更新优势;按需加载与 Tree Shaking 可减少包体积
    • aant-uniapp-base 使用 Pinia,轻量状态管理,适合中小型项目
  • 后端
    • Druid 连接池参数(初始连接、最大活跃、空闲、等待时间)可根据并发场景调整
    • Redis 连接池大小与超时时间应结合业务峰值评估
    • MyBatis-Plus 分页插件与逻辑删除配置有助于提升查询效率与数据一致性

故障排除指南

  • 前端一(aant-uniapp-base)
    • 无法运行到 H5/小程序:确认 HBuilderX 版本与平台插件安装;检查 manifest.json 中的 vueVersion 与平台配置
    • 请求失败:检查 utils/http.js 中的 baseURL 与拦截器配置;确认后端 CORS 与接口路径
  • 前端二(aant-vben-admin)
    • Node 版本不满足:升级 Node.js 至 ≥ 20.10.0;使用 pnpm ≥ 9.12.0
    • Mock 服务跨域问题:检查 nitro.config.ts 中的 CORS 配置
  • 后端(angryant-*)
    • 数据库连接异常:核对 application-druid.yml 中的 MySQL 地址、用户名、密码
    • Redis 连接异常:核对 application.yml 中的 Redis host/port/password/timeout
    • Token 校验失败:核对 application.yml 中的 token.header、token.secret、token.expireTime
    • 初始化配置校验:使用 check_config.sql 查询 sys_config 中的 oss_v2_local 配置值

结论

通过本指南,你可以完成 aant-boot 框架的环境准备、项目克隆、依赖安装、前后端分别配置、数据库初始化与首次运行验证。遇到问题时,可依据"故障排除指南"快速定位并解决。建议在本地搭建完成后,先运行后端服务与数据库,再启动前端,最后进行联调测试。

附录

环境要求清单

  • 前端一(aant-uniapp-base)
    • Node.js:任意 LTS 版本
    • HBuilderX:推荐(可直接运行到 H5、小程序、App)
  • 前端二(aant-vben-admin)
    • Node.js:≥ 20.10.0
    • pnpm:≥ 9.12.0
  • 后端
    • Java:1.8
    • Maven:标准仓库可用
    • MySQL:用于业务数据
    • Redis:用于缓存与会话

项目克隆与依赖安装步骤

  • 克隆仓库:使用 git clone 获取全部模块
  • 前端一(aant-uniapp-base)
    • 进入目录:cd aant-uniapp-base
    • 安装依赖:npm install
    • 运行:npm run dev(H5)、npm run build:h5(构建 H5)、npm run build:mp-weixin(构建小程序)
  • 前端二(aant-vben-admin)
    • 进入目录:cd aant-vben-admin
    • 安装依赖:pnpm install
    • 运行:pnpm dev
    • 构建:pnpm build
  • 后端
    • 进入父级目录:cd angryant-platform
    • 安装依赖:mvn -U clean install -DskipTests
    • 启动模块:根据需要启动具体模块或主应用

数据库初始化脚本执行

  • angryant-biz-blank:检查配置与初始化(如需)
    • 使用 check_config.sql 校验 sys_config 中的 oss_v2_local 配置
  • angryant-customer:执行 ddl.sql 增量脚本
  • angryant-oss:执行 create.sql 建表脚本
  • 平台公共脚本:angryant-platform/angryant-framework/doc/sql/...(按需执行)

首次运行验证步骤

  • 启动后端服务:确保 MySQL 与 Redis 正常,查看日志无连接异常
  • 启动前端一(aant-uniapp-base):H5 运行,打开浏览器控制台,确认网络请求成功
  • 启动前端二(aant-vben-admin):访问管理端,登录测试账号(如有),验证权限与页面加载
  • Mock 服务:确认 Nitro Mock 的 CORS 与接口返回正常

贡献者

The avatar of contributor named as lgx lgx

页面历史

基于 MIT 许可发布.