📝 平台简介

一、功能说明

基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + UniApp 微信小程序，支持 RBAC 动态权限、数据权限、SaaS 多租户、Activiti + Flowable 工作流、三方登录、短信等功能。

• 前端采用 vue-element-admin，正在支持 Vue 3 + ElementUI Plus 最新方案。
• 后端采用 Spring Boot、MySQL + MyBatis Plus、Redis + Redisson。
• 数据库可使用 MySQL、Oracle、PostgreSQL、SQL Server、国产达梦 DM 等等。
• 权限认证使用 Spring Security & Token & Redis，支持多终端、多种用户的认证系统。
• 支持加载动态权限菜单，按钮级别权限控制，本地缓存提升性能。
• 支持 SaaS 多租户系统，可自定义每个租户的权限，提供透明化的多租户底层封装。
• 工作流使用 Flowable，支持动态表单、在线设计流程、多种任务分配方式。
• 高效率开发，使用代码生成器可以一键生成前后端代码 + 单元测试 + Swagger 接口文档 + Validator 参数校验。
• 集成微信小程序、微信公众号、企业微信、钉钉等三方登录。
• 集成阿里云、腾讯云、云片等短信渠道，集成 MinIO、阿里云、腾讯云、七牛云等云存储服务。
• 集成activemq消息订阅/发布服务。

  二、功能列表

  1、系统功能

  | | 功能 | 描述 | | —- | —- | —- | | | 用户管理 | 用户是系统操作者，该功能主要完成系统用户配置 | | ⭐️ | 在线用户 | 当前系统中活跃用户状态监控，支持手动踢下线 | | | 角色管理 | 角色菜单权限分配、设置角色按机构进行数据范围权限划分 | | | 菜单管理 | 配置系统菜单、操作权限、按钮权限标识等，本地缓存提供性能 | | | 部门管理 | 配置系统组织机构（公司、部门、小组），树结构展现支持数据权限 | | | 岗位管理 | 配置系统用户所属担任职务 | | 🚀 | 租户管理 | 配置系统租户，支持 SaaS 场景下的多租户功能 | | 🚀 | 租户套餐 | 配置租户套餐，自定每个租户的菜单、操作、按钮的权限 | | | 字典管理 | 对系统中经常使用的一些较为固定的数据进行维护 | | 🚀 | 短信管理 | 短信渠道、短息模板、短信日志，对接阿里云、云片等主流短信平台 | | 🚀 | 操作日志 | 系统正常操作日志记录和查询，集成 Swagger 生成日志内容 | | ⭐️ | 登录日志 | 系统登录日志记录查询，包含登录异常 | | 🚀 | 错误码管理 | 系统所有错误码的管理，可在线修改错误提示，无需重启服务 | | | 通知公告 | 系统通知公告信息发布维护 |

2、基础设施

3、工作流程

技术选型

👻 后端

系统环境

主框架

存储层

中间件

系统监控

单元测试

其它工具

👾 前端

管理后台

用户 App

项目结构

👻 后端结构

后端采用模块化的架构，按照功能拆分成多个 Maven Module，提升开发与研发的效率，带来更好的可维护性。
一共有四类 Maven Module：

下面，我们来逐个看看。

1. ykkj-dependencies

该模块是一个 Maven Bom，只有一个 pom.xml文件，定义项目中所有 Maven 依赖的版本号，解决依赖冲突问题。

从定位上来说，它和 Spring Boot 的 spring-boot-starter-parent和 Spring Cloud 的 spring-cloud-dependencies是一致的。
实际上，ykkj-springboot 本质上还是个单体项目，直接在根目录 pom.xml管理依赖版本会更加方便，也符合绝大多数程序员的认知。但是要额外考虑一个场景，如果每个 ykkj-module-xxx 模块都维护在一个独立的 Git 仓库，那么 ykkj-dependencies 就可以在多个 ykkj-module-xxx 模块下复用。

2. ykkj-framework

该模块是 com-ykkj.cdp 项目的框架封装，其下的每个 Maven Module 都是一个组件，分成两种类型：
① 技术组件：技术相关的组件封装，例如说 MyBatis、Redis 等等。

② 业务组件：业务相关的组件封装，例如说数据字典、操作日志等等。如果是业务组件，名字会包含 biz 关键字。

每个组件，包含两部分：

1. core 包：组件的核心封装，拓展相关的功能。
2. config 包：组件的 Spring Boot 自动配置。

3. ykkj-module-xxx

该模块是 XXX 功能的 Module 模块，目前内置了 4 个模块。

每个模块包含两个 Maven Module，分别是：

例如说，ykkj-module-infra 想要访问 ykkj-module-system 的用户、部门等数据，需要引入 ykkj-module-system-api 子模块。示例如下：

疑问：为什么设计 ykkj-module-xxx-api 模块呢？

1. 明确需要提供给其它模块的 API 定义，方便未来迁移微服务架构。
2. 模块之间可能会存在相互引用的情况，虽然说从系统设计上要尽量避免，但是有时在快速迭代的情况下，可能会出现。此时，通过只引用对方模块的 API 子模块，解决相互引用导致 Maven 无法打包的问题。

ykkj-module-xxx-api 子模块的项目结构如下：

ykkj-module-xxx-biz 子模块的项目结构如下：

疑问：为什么 Controller 分成 Admin 和 App 两种？
提供给 Admin 和 App 的 RESTful API 接口是不同的，拆分后更加清晰。
疑问：为什么 VO 分成 Admin 和 App 两种？
相同功能的 RESTful API 接口，对于 Admin 和 App 传入的参数、返回的结果都可能是不同的。例如说，Admin 查询某个用户的基本信息时，可以返回全部字段；而 App 查询时，不会返回 mobile 手机等敏感字段。
疑问：为什么 DO 不作为 Controller 的出入参？

1. 明确每个 RESTful API 接口的出入参。例如说，创建部门时，只需要传入 name、parentId 字段，使用 DO 接参就会导致 type、createTime、creator 等字段可以被传入，导致前端同学一脸懵逼。
2. 每个 RESTful API 有自己独立的 VO，可以更好的设置 Swagger 注解、Validator 校验规则，而让 DO 保持整洁，专注映射好数据库表。

疑问：为什么操作 Redis 需要通过 RedisDAO？
Service 直接使用 RedisTemplate 操作 Redis，导致大量 Redis 的操作细节和业务逻辑杂糅在一起，导致代码不够整洁。通过 RedisDAO 类，将每个 Redis Key 像一个数据表一样对待，清晰易维护。
总结来说，每个模块采用三层架构 + 非严格分层，如下图所示：

4. ykkj-server

该模块是后端 Server 的主项目，通过引入需要 ykkj-module-xxx 业务模块，从而实现提供 RESTful API 给 ykkj-ui-admin、ykkj-ui-user 等前端项目。
本质上来说，它就是个空壳（容器）！如下图所示：

👾 前端结构

前端一共有两个项目，分别是：

1. ykkj-admin-ui

├── bin                        // 执行脚本
├── build                      // 构建相关  
├── public                     // 公共文件
│   ├── favicon.ico            // favicon 图标
│   └── index.html             // html 模板
│   └── robots.txt             // 反爬虫
├── src                        // 源代码
│   ├── api                    // 所有请求【重要】
│   ├── assets                 // 主题、字体等静态资源
│   ├── components             // 全局公用组件
│   ├── directive              // 全局指令
│   ├── icons                  // 图标
│   ├── layout                 // 布局
│   ├── plugins                // 插件
│   ├── router                 // 路由
│   ├── store                  // 全局 store 管理
│   ├── utils                  // 全局公用方法
│   ├── views                  // 视图【重要】
│   ├── App.vue                // 入口页面
│   ├── main.js                // 入口 JS，加载组件、初始化等
│   ├── permission.js          // 权限管理
│   └── settings.js            // 系统配置
├── .editorconfig              // 编码格式
├── .env.dev                   // 开发环境配置
├── .env.prod                  // 生产环境配置
├── .env.staging               // 测试环境配置
├── .eslintignore              // 忽略语法检查
├── .eslintrc.js               // eslint 配置项
├── .gitignore                 // git 忽略项
├── babel.config.js            // babel.config.js
├── package.json               // package.json
└── vue.config.js              // vue.config.js

2. ykkj-user-ui

建设中，基于 uniapp 实现…

已改造

结构上

1、精简结构，去掉商城和acitiviti工作流模块
2、增加授权，授权方式与老cdp平台保持一致

功能上

1、去掉登录时的机构选择，配置验证码可不选择
2、部门增加组织机构类型：公司、部门、班组。
3、增加角色分配用户
4、字典属性明细修改成弹窗
5、密码复杂度设置，需要包含大小写字母、数字、特殊字符
6、密码传输加密，采用国密2 ：
7、开发通用人员选择控件、单选和多选
8、用户管理时部门改成不能为空

下一步改造

工作流

1、增加工作流退回和委派功能
2、完善审批节点可以为多人。
3、流程表单审批节点的表单元素的权限控制。
4、业务表单审批节点的表单修改功能。
5、会签功能。
6、全部流程实例管理，可对所有流程进行终止、变更节点等操作。