1. 项目介绍
1.1 项目简介
vben-java是一个基于SpringBoot3+Vue3的通用后台管理开发平台。
后端基于 RuoYi-Vue-Plus 改造，集成业界一流技术栈，针对企业痛点，具有组件化、模块化、轻耦合、高扩展等特色。 应用层可自由选择ORM框架（Mybatis Plus，JPA）
前端基于 Vben Admin 改造，使用最新前端技术栈，提供丰富的组件和模板以及N种偏好设置组合方案， 应用层可自由选择UI框架（Element Plus，Ant Design Vue，Native UI）
移动端基于 unibest 改造，开箱即用，uniapp + Vue3 + Vite5 + Pnpm + setup 语法糖 + TypeScript 最强组合，飞一般的编码体验。 开发工具可自由选择（VS Code，Webstorm）
1.2 主要特色
- 后端项目中抽离并拆分了公共功能，以插件化与扩展包的方式组织，结构解耦且易于扩展。
- 后端项目业务模块以多基础模块与多应用方式组织，可实现多个应用共用相同基础模块，方便实现基础模块共享
- 后端项目基础业务模块采用JdbcTemplate实现，上层应用可采用mybatis-plus或者jpa，选择留给用户
- 工作流模块不依赖其他工作流引擎，全部自行实现，易于扩展，实现复杂工作流
- 统一的命名风格，数据库表主键统一用ID命名，表字段采用SAP风格
1.3 技术选型
后端框架基于RuoYi-Vue-Plus，因此包含了RuoYi-Vue-Plus框架的几乎所有技术栈， 采用Mybatis Plus方式可保留原有框架所有功能，采用JPA方式可实现更强大的ORM功能。 RuoYi-Vue-Plus框架对分布式支持比较好，vben-java框架在支持分布式的同时可更方便的实现单机模式
| 功能模块 | RuoYi-Vue-Plus | vben-java |
|---|---|---|
| Web容器 | 采用 Undertow 基于 XNIO 的高性能容器 | √ |
| 权限认证 | 采用 Sa-Token、Jwt 静态使用功能齐全 低耦合 高扩展 | √ |
| 权限注解 | 采用 Sa-Token 支持注解 登录校验、角色校验、权限校验、二级认证校验、HttpBasic校验、忽略校验角色与权限校验支持多种条件 如 AND OR 或 权限 OR 角色 等复杂表达式 | √ |
| 三方鉴权 | 采用 JustAuth 第三方登录组件 支持微信、钉钉等数十种三方认证 | √ |
| 关系数据库支持 | 原生支持 MySQL、Oracle、PostgreSQL、SQLServer可同时使用异构切换(支持其他 mybatis-plus 支持的所有数据库 只需要增加jdbc依赖即可使用 达梦金仓等均有成功案例) | √ 基础与核心业务模块采用JdbcTemplate实现，上层应用可采用mybatis-plus或者jpa |
| 缓存数据库 | 支持 Redis 5-7 支持大部分新功能特性 如 分布式限流、分布式队列 | √ |
| Redis客户端 | 采用 Redisson Redis官方推荐 基于Netty的客户端工具支持Redis 90%以上的命令 底层优化规避很多不正确的用法 例如: keys被转换为scan支持单机、哨兵、单主集群、多主集群等模式 | √ |
| 缓存注解 | 采用 Spring-Cache 注解 对其扩展了实现支持了更多功能 例如过期时间 最大空闲时间 组最大长度等 只需一个注解即可完成数据自动缓存 | √ |
| ORM框架 | 采用 Mybatis-Plus 基于对象几乎不用写SQL全java操作 功能强大插件众多 例如多租户插件 分页插件 乐观锁插件等等 | √ JPA方式可实现功能更全的ORM功能，比如自动生成表结构 |
| SQL监控 | 采用 p6spy 可输出完整SQL与执行时间监控 | √ |
| 数据分页 | 采用 Mybatis-Plus 分页插件 框架对其进行了扩展 对象化分页对象 支持多种方式传参 支持前端多排序 复杂排序 | √ JdbcTemplate Mybatis JPA 三种方式都可轻松实现数据分页 |
| 数据权限 | 采用 Mybatis-Plus 插件 自行分析拼接SQL 无感式过滤只需为Mapper设置好注解条件 支持多种自定义 不限于部门角色 | √ 可采用此方式，另外组织架构模块增加了群组模块，可实现更灵活的数据权限控制 |
| 数据脱敏 | 采用 注解 + jackson 序列化期间脱敏 支持不同模块不同的脱敏条件支持多种策略 如身份证、手机号、地址、邮箱、银行卡等 可自行扩展 | √ |
| 数据加解密 | 采用 注解 + mybatis 拦截器 对存取数据期间自动加解密支持多种策略 如BASE64、AES、RSA、SM2、SM4等 | √ |
| 接口传输加密 | 采用 动态 AES + RSA 加密请求 body 每一次请求秘钥都不同大幅度降低可破解性 | √ |
| 数据翻译 | 采用 注解 + jackson 序列化期间动态修改数据 数据进行翻译，支持多种模式: 映射翻译 直接翻译 其他扩展条件翻译 接口化两步即可完成自定义扩展 内置多种翻译实现 | √ |
| 多数据源框架 | 采用 dynamic-datasource 支持市面大部分数据库，通过yml配置即可动态管理异构不同种类的数据库 也可通过前端页面添加数据源，支持spel表达式从请求头参数等条件切换数据源 | √ mybatis-plus方式支持动态数据源， × jpa方式不支持动态数据源，需要单独配置引入多数据源 |
| 多数据源事务 | 采用 dynamic-datasource 支持多数据源不同种类的数据库事务回滚 | √ mybatis-plus方式多数据源事务， × jpa方式不支多数据源事务 |
| 数据库连接池 | 采用 HikariCP Spring官方内置连接池 配置简单 以性能与稳定性闻名天下 | √ |
| 数据库主键 | 采用 雪花ID 基于时间戳的 有序增长 唯一ID 再也不用为分库分表 数据合并主键冲突重复而发愁 | √ 支持雪花ID，为了兼容性支持，特别是需要与其他业务系统关联的基础组织架构模块，采用的是32位字符串UUID方式 |
| WebSocket协议 | 基于 Spring 封装的 WebSocket 协议 扩展了Token鉴权与分布式会话同步 不再只是基于单机的废物 | √ |
| SSE推送 | 采用 Spring SSE 实现 扩展了Token鉴权与分布式会话同步 | √ |
| 序列化 | 采用 Jackson Spring官方内置序列化 靠谱!!! | √ |
| 分布式幂等 | 参考美团GTIS防重系统简化实现 | √ |
| 分布式任务调度 | 采用 SnailJob 天生支持分布式 统一的管理中心 支持多种数据库 支持分片重试DAG任务流等 | √ 支持SnailJob分布式方式，另外项目也集成了Quartz，对于不需要分布式的项目可以更便捷地使用定时调度 |
| 文件存储 | 采用 Minio 分布式文件存储 天生支持多机、多硬盘、多分片、多副本存储，支持权限管理 安全可靠 文件可加密存储 | √ 支持Minio方式，另外项目也实现了本地文件存储方式供用户选择 |
| 云存储 | 采用 AWS S3 协议客户端 支持 七牛、阿里、腾讯 等一切支持S3协议的厂家 | √ |
| 短信 | 采用 sms4j 短信融合包 支持数十种短信厂家 只需在yml配置好厂家密钥即可使用 可多厂家共用 | √ |
| 邮件 | 采用 mail-api 通用协议支持大部分邮件厂商 | √ |
| 接口文档 | 采用 SpringDoc、javadoc 无注解零入侵基于java注释只需把注释写好 无需再写一大堆的文档注解了 | √ |
| 校验框架 | 采用 Validation 支持注解与工具类校验 注解支持国际化 | √ |
| Excel框架 | 采用 Alibaba EasyExcel 基于插件化，框架对其增加了很多功能 例如 自动合并相同内容 自动排列布局 字典翻译等 | √ |
| 工具类框架 | 采用 Hutool、Lombok 上百种工具覆盖90%的使用需求 基于注解自动生成 get set 等简化框架大量代码 | √ |
| 监控框架 | 采用 SpringBoot-Admin 基于SpringBoot官方 actuator 探针机制，实时监控服务状态 框架还为其扩展了在线日志查看监控 | √ 支持SpringBoot-Admin方式，另外项目也集成了oshi，可方便的实现单机服务器监控 |
| 链路追踪 | 采用 Apache SkyWalking 还在为请求不知道去哪了 到哪出了问题而烦恼吗，用了它即可实时查看请求经过的每一处每一个节点 | √ |
| 代码生成器 | 只需设计好表结构 一键生成所有crud代码与页面，降低80%的开发量 把精力都投入到业务设计上，框架为其适配MP、SpringDoc规范化代码 同时支持动态多数据源代码生成 | √ |
| 部署方式 | 支持 Docker 编排 一键搭建所有环境 让开发人员从此不再为搭建环境而烦恼 | √ |
1.4 内置功能
后端框架基于RuoYi-Vue-Plus，表结构重新定义了，但是业务功能基本都有保留，比较遗憾的是放弃了对多租户的支持。
| 业务模块 | RuoYi-Vue-Plus | vben-java |
|---|---|---|
| 租户管理 | 系统内租户的管理 如:租户套餐、过期时间、用户数量、企业信息等 | × |
| 租户套餐管理 | 系统内租户所能使用的套餐管理 如:套餐内所包含的菜单等 | × |
| 客户端管理 | 系统内对接的所有客户端管理 如: pc端、小程序端等，支持动态授权登录方式 如: 短信登录、密码登录等 支持动态控制token时效 | √ |
| 用户管理 | 用户的管理配置 如:新增用户、分配用户所属部门、角色、岗位等 | √ |
| 部门管理 | 配置系统组织机构（公司、部门、小组） 树结构展现支持数据权限 | √ |
| 岗位管理 | 配置系统用户所属担任职务 | √ |
| 菜单管理 | 配置系统菜单、操作权限、按钮权限标识等 | √ 菜单管理分离为菜单管理（对应原目录与菜单）与接口管理（对应原按钮） |
| 角色管理 | 角色菜单权限分配、设置角色按机构进行数据范围权限划分 | √ 角色成员支持部门、用户、岗位、群组 |
| 字典管理 | 对系统中经常使用的一些较为固定的数据进行维护 | √ |
| 参数管理 | 对系统动态配置常用参数 | √ |
| 通知公告 | 系统通知公告信息发布维护 | √ |
| 操作日志 | 系统正常操作日志记录和查询 系统异常信息日志记录和查询 | √ |
| 登录日志 | 系统登录日志记录查询包含登录异常 | √ |
| 文件管理 | 系统文件展示、上传、下载、删除等管理 | √ |
| 文件配置管理 | 系统文件上传、下载所需要的配置信息动态添加、修改、删除等管理 | √ 在支持分布式的同时可更方便的实现单机模式 |
| 在线用户管理 | 已登录系统的在线用户信息监控与强制踢出操作 | √ |
| 定时任务 | 运行报表、任务管理(添加、修改、删除)、日志管理、执行器管理等 | √ 在支持分布式的同时可更方便的实现单机模式 |
| 代码生成 | 多数据源前后端代码的生成（java、html、xml、sql）支持CRUD下载 | √ |
| 系统接口 | 根据业务代码自动生成相关的api接口文档 | √ |
| 服务监控 | 监视集群系统CPU、内存、磁盘、堆栈、在线日志、Spring相关配置等 | √ 在支持分布式的同时可更方便的实现单机模式 |
| 缓存监控 | 对系统的缓存信息查询，命令统计等 | √ |
| 在线构建器 | 拖动表单元素生成相应的HTML代码 | √ |
| 使用案例 | 系统的一些功能案例 | √ |
| 工作流 | 采用Warm-Flow工作流 | √ 前端流程图采用BPMN.js，表单采用FromCreate（FormDesigner），后端自行实现流程引擎 |