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 ⭐

在线体验

演示地址:

账号密码:admin/admin123

项目地址:

项目背景

本项目基于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模块中
    • 切面记录修改者和创建者
    • 统一设置事务

使用

技术栈

技术说明版本
springbootJava项目必备框架2.7
druidalibaba数据库连接池1.2.8
swagger文档生成3.0.0
mybatis-plus数据库框架3.5.2
hutool国产工具包(简单易用)3.5.2
mockito单元测试模拟1.10.19
guava谷歌工具包(提供简易缓存实现)31.0.1-jre
junit单元测试1.10.19
h2内存数据库1.10.19
jackson比较安全的Json框架follow springboot

系统内置功能

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

功能描述
用户管理用户是系统操作者,该功能主要完成系统用户配置
部门管理配置系统组织机构(公司、部门、小组),树结构展现支持数据权限
岗位管理配置系统用户所属担任职务
菜单管理配置系统菜单、操作权限、按钮权限标识等,本地缓存提供性能
角色管理角色菜单权限分配、设置角色按机构进行数据范围权限划分
参数管理对系统动态配置常用参数
通知公告系统通知公告信息发布维护
操作日志系统正常操作日志记录和查询;系统异常信息日志记录和查询
登录日志系统登录日志记录查询包含登录异常
在线用户当前系统中活跃用户状态监控
系统接口根据业务代码自动生成相关的api接口文档
服务监控监视当前系统CPU、内存、磁盘、堆栈等相关信息
缓存监控对系统的缓存信息查询,命令统计等
连接池监视监视当前系统数据库连接池状态,可进行分析SQL找出系统性能瓶颈

目前版本是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的方式进行插入已经更新数据)

技术文档

最后

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

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

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

全栈技术交流群:1398880

    原文作者:CoderV的进阶笔记
    原文地址: https://www.cnblogs.com/valarchie/p/16964400.html
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞