Agileboot 1.6.0 发布啦 - 一款致力于规范/精简/可维护 的 Springboot + Vue3 的快速开发脚手架

平台简介

AgileBoot 是一套开源的全栈精简快速开发平台，毫无保留给个人及企业免费使用。本项目的目标是做一款精简可靠，代码风格优良，项目规范的小型开发脚手架。 适合个人开发者的小型项目或者公司内部项目使用。也可作为供初学者学习使用的模板项目。

• 前端采用 Vue3 、Element UI 。对应前端仓库 AgileBoot-Front-End ，保持同步更新。
• 后端采用 Spring Boot 、Spring Security 、Redis & Jwt 、Mybatis Plus 、MySql 。
• 权限认证使用 Jwt ，支持多终端认证系统。
• 支持加载动态权限菜单，多方式轻松权限控制。
• 有大量的单元测试，集成测试覆盖确保业务逻辑正确。

有任何问题或者建议，可以在 Issues 中提给作者。 也可以发 PR 。

您的 Issue 比 Star 更重要

如果觉得项目对您有帮助，可以来个 Star

在线体验

演示地址：

• www.agileboot.vip
• www.agileboot.cc

账号密码：admin/admin123

项目地址：

• https://github.com/valarchie/AgileBoot-Back-End
• https://github.com/valarchie/AgileBoot-Front-End
• 码云 gitee 有对应地址进行同步

项目背景

本项目基于 Ruoyi 项目进行完全重构改造。
首先非常感谢 Ruoyi 作者。但是 Ruoyi 项目存在太多缺陷。

• 命名比较乱七八糟（很多很糟糕的命名，包括机翻英语乱用）
• 项目分包以及模块比较乱
• 比较原始的 Controller > Service > DAO 的开发模式。过于面向过程。
• 一大堆自己造的轮子，并且没有 UT 覆盖。
• 大量逻辑嵌套在 if else 块当中
• 值的前后不统一，比如有的地方 1 代表是，有的地方 1 代表否
• 很多很奇怪的代码写法（比如 return result > 0 ? true:false.. 一言难尽）
• 业务逻辑不集中，代码可读性较差。

很多人直接使用开源项目二开，但是代码不规范，可维护性不高，导致使用者的二开的成本比较高。

于是我做了大量的重构工作。

重构内容

• 规范：
  • 切分不同环境的启动文件
  • 统一设计异常类
  • 统一设计错误码并集中处理异常
  • 统一系统内的变量并集中管理
  • 统一返回模型
  • 引入 Google 代码格式化模板
  • 后端代码的命名基本都整改 OK
  • 前端代码的命名也非常混乱，进行了整改
  • 规范系统内的常量
• 整改：
  • 引入 hutool 包以及 guava 包去掉大量自己造的轮子，尽可能使用现成的轮子
  • 去除代码中大量的 warning
  • 引入 lombok 去除大量 getter setter 代码
  • 调整日志级别
  • 字典类型数据完全用 Enum 进行代替
  • 移除 SQL 注入的 Filter ，因为迁移到 Mybatis Plus 就不会有这个注入的问题
  • XSS 直接通过 JSON 序列化进行转义。
  • 替换掉很多 Deprecated 的类以及配置
  • 替换 fastJson 为 Jackson
  • 数据库的整体重构设计，缩减至 10 张表。
  • 重新设计异步代码
  • 前后端密码加密传输（更严谨的话，还是需要 HTTPS ）
  • 重构权限校验和数据权限校验（直接都通过注解的形式）
• 优化：
  • 优化异步服务
  • 优化 Redis 缓存类，封装各个业务缓存，提供多级缓存实现
  • 权限判断使用多级缓存
  • IP 地址查询引入离线包
  • 前端优化字典数据缓存
  • 启动优化
  • i18n 支持
  • 优化 excel 工具类，代码更加简洁
  • 将所有逻辑集中于 Domain 模块中
  • 切面记录修改者和创建者
  • 统一设置事务

使用

技术栈

系统内置功能

大部分功能，均有通过 单元测试 集成测试 保证质量。

目前版本是 V1.6 ，将在 2.0 版本后陆续新增新功能。

工程结构

agileboot ├── agileboot-admin -- 管理后台接口模块（供后台调用） │ ├── agileboot-api -- 开放接口模块（供客户端调用） │ ├── agileboot-common -- 精简基础工具模块 │ ├── agileboot-infrastructure -- 基础设施模块（主要是配置和集成） │ ├── agileboot-domain -- 业务模块 ├ ├── user -- 用户模块（举例） ├ ├── command -- 命令参数接收模型（命令） ├ ├── dto -- 返回数据类 ├ ├── model -- 领域模型类 ├ ├── query -- 查询参数模型（查询） │ ├────── UserApplicationService -- 应用服务（事务层，操作领域模型类完成业务逻辑） │ ├── agileboot-integration-test -- 集成测试模块 │ ├── agileboot-orm -- 数据映射模块（仅包含数据相关逻辑） ├ ├── entiy -- 实体类 ├ ├── enums -- 数据相关枚举 ├ ├── mapper -- DAO ├ ├── query -- 封装查询对象 ├ ├── result -- 封装多表查询对象 └── └── service -- 服务层 

代码流转

请求分为两类：一类是查询，一类是操作（即对数据有进行更新）。

查询：Controller > xxxQuery > xxxApplicationService > xxxService(Db) > xxxMapper
操作：Controller > xxxCommand > xxxApplicationService > xxxModel(处理逻辑) > save 或者 update (本项目直接采用 JPA 的方式进行插入已经更新数据)

技术文档

• AgileBoot - 基于 SpringBoot + Vue3 的前后端快速开发脚手架
• AgileBoot - 手把手一步一步带你 Run 起全栈项目(SpringBoot+Vue3)
• AgileBoot - 项目内统一的错误码设计
• AgileBoot - 如何集成内置数据库 H2 和内置 Redis
• 持续输出中

最后

本项目的目标是做一款精简可靠，代码风格优良，项目规范的小型开发脚手架。 适合个人开发者的小型项目或者公司内部项目使用。也可作为供初学者学习使用的案例。

希望大佬们有兴趣的话~ 可以一起来完善这个项目，让这个项目更规范，代码更好维护，真正成为一款能作为生产直接使用的开源项目。

PS: 鄙人前端小白，仅在对应的 ruoyi 原版前端项目上做了大概 50%的重构。能力有限，有没有前端大佬一起来重构一下前端项目呀~~ 目前打算改成 TS 。

全栈技术交流群：1398880