# fkl-admin-back
**Repository Path**: feng-kailong/fkl-admin-back
## Basic Information
- **Project Name**: fkl-admin-back
- **Description**: fkl-admin企业级后台管理系统-后端代码
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 2
- **Forks**: 0
- **Created**: 2025-12-02
- **Last Updated**: 2025-12-02
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# fkl-admin 后台管理系统
fkl-admin
基于 Spring Boot 3.2.0 + Flowable 7.1.0 的企业级后台管理系统
## 📖 项目简介
**fkl-admin** 是一个功能完善的企业级后台管理系统,集成了工作流引擎(Flowable),支持审批流程的创建、管理和执行。系统采用前后端分离架构,提供完整的用户权限管理、审批流管理、消息通知、文件管理等核心功能。
### ✨ 核心特性
- 🔐 **完善的权限体系**:基于 Sa-Token 的权限认证,支持用户、角色、权限、菜单的灵活配置
- 🔄 **强大的工作流引擎**:集成 Flowable 7.1.0,支持内置审批流程和自定义审批流程的动态生成
- 📨 **实时消息通知**:基于 WebSocket 的实时消息推送,支持待办事项、系统通知、站内信
- 📁 **文件存储管理**:集成 MinIO 对象存储,支持多存储桶管理
- 🔍 **全文搜索**:集成 Elasticsearch,支持文件内容搜索
- 🚀 **DevOps 流水线**:支持 CI/CD 流水线的创建、执行和监控
- 📊 **完善的日志系统**:操作日志、登录日志、注册日志等全方位记录
## 🛠️ 技术栈
### 后端技术
| 技术 | 版本 | 说明 |
|------|------|------|
| Spring Boot | 3.2.0 | 核心框架 |
| Java | 17 | 开发语言 |
| MyBatis-Flex | 1.10.9 | ORM 框架 |
| Sa-Token | 1.44.0 | 权限认证框架 |
| Flowable | 7.1.0 | 工作流引擎 |
| MySQL | 8.0.33 | 关系型数据库 |
| MongoDB | - | 文档数据库 |
| Redis | - | 缓存数据库 |
| RabbitMQ | - | 消息队列 |
| MinIO | 8.5.14 | 对象存储 |
| Elasticsearch | 8.10.4 | 搜索引擎 |
| EasyExcel | 4.0.3 | Excel 处理 |
| Hutool | 5.8.39 | Java 工具类库 |
### 其他技术
- **WebSocket**:实时通信
- **Swagger**:API 文档生成
- **Lombok**:简化代码
- **FastJSON2**:JSON 处理
## 📋 功能模块
### 1. 基础权限管理
- ✅ 用户管理:用户信息维护、密码管理、状态控制
- ✅ 角色管理:角色创建、权限分配、角色类型(内置/自定义)
- ✅ 权限管理:权限点配置、权限标识管理
- ✅ 菜单管理:菜单树结构、菜单权限配置
### 2. 审批流系统(核心功能)
#### 内置请假流程
- 支持完整的请假审批流程
- 流程节点:用户申请 → 排他网关(按请假时长分流)→ 组长审核/经理审核 → 人事审批 → 绩效专员审批 → 用户销假
- 支持流程监听器(创建、完成、删除事件)
- 支持流程图可视化展示
#### 自定义审批流
- 动态生成 BPMN XML 流程定义文件
- 支持多种网关类型:
- 顺序流程
- 并行网关(Parallel Gateway)
- 排他网关(Exclusive Gateway)
- 包容网关(Inclusive Gateway)
- 流程可视化配置
- 流程实例管理和任务处理
- 支持流程图的生成和展示
### 3. 消息与通知
- ✅ **消息通知**:系统通知消息,支持 WebSocket 实时推送
- ✅ **待办事项**:待办任务管理,支持定时提醒(基于 RabbitMQ 延迟消息)
- ✅ **站内信**:用户间站内信功能,支持 WebSocket 实时通信
### 4. 文件管理
- ✅ 文件上传/下载
- ✅ 共享空间:文件共享功能
- ✅ 多存储桶管理:
- 静态资源桶(fkl-admin-static)
- 共享空间桶(fkl-admin-share-space)
- DevOps 桶(fkl-admin-devops)
### 5. DevOps 流水线
- ✅ 流水线管理:创建、编辑、删除流水线
- ✅ 流水线执行:支持流水线执行和监控
- ✅ 流水线日志:执行日志记录和查询
- ✅ 模板管理:流水线模板配置
- ✅ WebSocket 实时推送执行状态
### 6. 其他功能
- ✅ 签到日志:员工签到记录
- ✅ 操作日志:系统操作记录
- ✅ 登录日志:用户登录记录
- ✅ 注册日志:用户注册记录
- ✅ 通用配置:系统参数配置
- ✅ 用户设置:个人设置管理
## 🚀 快速开始
### 环境要求
- JDK 17+
- Maven 3.6+
- MySQL 8.0+
- Redis 6.0+
- MongoDB 4.0+
- RabbitMQ 3.8+
- MinIO(可选)
- Elasticsearch 8.0+(可选)
### 安装步骤
1. **克隆项目**
```bash
git clone [项目地址]
cd fkl-admin/back
```
2. **数据库初始化**
- 创建数据库 `fkl_admin`
- 执行 `fkl_admin.sql` 初始化数据库表结构
3. **配置文件修改**
修改 `src/main/resources/application.yml` 中的配置信息:
```yaml
spring:
datasource:
username: your_username
password: your_password
url: jdbc:mysql://your_host:3306/fkl_admin?useSSL=false&serverTimezone=UTC&allowPublicKeyRetrieval=true
data:
redis:
host: your_redis_host
port: 6379
mongodb:
host: your_mongodb_host
port: 27017
database: fkl_admin
rabbitmq:
host: your_rabbitmq_host
port: 5672
```
4. **启动项目**
```bash
# Maven 方式
mvn spring-boot:run
# 或者打包后运行
mvn clean package
java -jar target/back-1.0-SNAPSHOT.jar
```
5. **访问系统**
- 应用地址:http://localhost:8000/api/v1
- API 文档:http://localhost:8000/api/v1/doc
## ⚙️ 配置说明
### 核心配置
#### Flowable 配置
```yaml
flowable:
async-executor-activate: true # 开启异步执行器
database-schema-update: true # 自动更新数据库表结构
leave:
classPath: flowable/fkl-admin-leave.bpmn20.xml
name: 请假流程
key: fkl-admin-leave
longTime: 27 # 27小时请假算较长请假
notice: true
noticeTime: 1 # 待办提醒时间
```
#### Sa-Token 配置
```yaml
sa-token:
token-name: fklAdmin
timeout: 86400 # Token 有效期(秒),默认24小时
active-timeout: 7200 # Token 活跃超时时间(秒)
is-concurrent: true # 允许同一账号多地同时登录
is-share: false # 多人登录不共用 token
token-style: uuid
```
#### MinIO 配置
```yaml
minio:
endpoint: http://your_minio_host:9000
accessKey: your_access_key
secretKey: your_secret_key
bucketName: fkl-admin
static-bucketName: fkl-admin-static
share-space-bucketName: fkl-admin-share-space
devops-bucketName: fkl-admin-devops
```
### 其他配置
- **注册配置**:默认角色、注册开关、尝试次数、锁定时间
- **验证码配置**:验证码类型、长度、有效时间
- **文件上传**:最大文件大小 1024MB
- **钉钉集成**:支持钉钉回调配置
## 📁 项目结构
```
fkl-admin/back
├── src/main/java/com/admin/
│ ├── AdminApplication.java # 启动类
│ ├── commons/ # 公共模块
│ │ ├── constants/ # 常量定义
│ │ ├── enums/ # 枚举类
│ │ ├── exception/ # 异常处理
│ │ ├── response/ # 响应封装
│ │ └── utils/ # 工具类
│ ├── controller/ # 控制器层(27个)
│ ├── service/ # 服务层(60个)
│ │ └── impl/ # 服务实现类
│ ├── mapper/ # 数据访问层(26个)
│ ├── pojo/ # 实体类(26个)
│ ├── dto/ # 数据传输对象
│ ├── request/ # 请求对象
│ ├── response/ # 响应对象
│ ├── flowable/ # 工作流模块
│ │ ├── leave/ # 请假流程
│ │ ├── approvalCustom/ # 自定义审批流
│ │ └── test/ # 测试示例
│ ├── websocket/ # WebSocket 模块
│ │ ├── messageNotice/ # 消息通知
│ │ ├── messageLetter/ # 站内信
│ │ └── devops/ # DevOps 推送
│ ├── rabbiqMq/ # RabbitMQ 消息队列
│ ├── elasticSearch/ # Elasticsearch 搜索
│ ├── minio/ # MinIO 文件存储
│ ├── mongodb/ # MongoDB 相关
│ ├── redis/ # Redis 相关
│ └── security/ # 安全配置
├── src/main/resources/
│ ├── application.yml # 配置文件
│ ├── flowable/ # 流程定义文件
│ │ └── fkl-admin-leave.bpmn20.xml # 请假流程定义
│ └── mapper/ # MyBatis XML 映射文件
├── pom.xml # Maven 配置
└── README.md # 项目说明文档
```
## 📚 API 文档
系统集成了 Swagger,启动项目后访问:
**Swagger UI**: http://localhost:8000/api/v1/doc
API 文档包含所有接口的详细说明,包括:
- 接口路径
- 请求参数
- 响应格式
- 示例代码
## 🔄 审批流使用说明
### 内置请假流程
1. **创建请假申请**
- 调用 `LeaveApplicationController` 创建请假申请
- 系统自动创建流程实例并分配第一个任务
2. **流程节点**
- 用户申请 → 排他网关判断请假时长
- 短假:组长审核 → 人事审批 → 绩效专员审批 → 用户销假
- 长假:经理审核 → 人事审批 → 绩效专员审批 → 用户销假
3. **审批操作**
- 通过 `LeaveApprovalController` 进行审批操作
- 支持通过、拒绝、转办等操作
### 自定义审批流
1. **创建审批流**
- 通过 `ApprovalCustomController` 创建自定义审批流
- 配置审批节点、网关、连接线等
2. **生成流程定义**
- 系统自动生成 BPMN XML 文件
- 保存到 `flowable/` 目录
3. **启动流程实例**
- 通过 `ApprovalCustomApplicationController` 启动流程
- 系统自动部署流程定义并创建实例
4. **处理审批任务**
- 通过 `ApprovalCustomApprovalController` 处理审批任务
- 支持查看流程图、审批历史等
## 🔧 开发指南
### 代码规范
- 使用 Lombok 简化代码
- 统一使用 `ResponseResult` 封装响应
- 异常统一使用 `BizException`
- 使用 MyBatis-Flex 进行数据库操作
### 数据库设计
- 使用逻辑删除(`delFlag` 字段)
- 统一使用 `LocalDateTime` 作为时间类型
- 支持乐观锁(`version` 字段)
### 日志规范
- 使用 SLF4J + Logback
- 关键操作记录操作日志
- 异常信息记录到异常日志
## 📝 更新日志
### v1.0-SNAPSHOT
- ✅ 基础权限管理功能
- ✅ Flowable 工作流引擎集成
- ✅ 请假流程实现
- ✅ 自定义审批流功能
- ✅ 消息通知系统
- ✅ 文件管理功能
- ✅ DevOps 流水线功能
## 🤝 贡献指南
欢迎提交 Issue 和 Pull Request!
## 📄 许可证
本项目采用 [MIT License](LICENSE) 许可证。
## 👥 作者
- **fkl** - 项目创建者
## 🙏 致谢
- [Spring Boot](https://spring.io/projects/spring-boot)
- [Flowable](https://www.flowable.com/)
- [Sa-Token](https://sa-token.cc/)
- [MyBatis-Flex](https://mybatis-flex.com/)
---
如果这个项目对你有帮助,请给个 ⭐️ Star 支持一下!