# yx-admin

**Repository Path**: weigeapp/yx-admin

## Basic Information

- **Project Name**: yx-admin
- **Description**: 低代码流程管理系统.......
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-03-25
- **Last Updated**: 2026-07-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# YX-Admin 微服务管理系统

> **版本**: 3.6.7 | **语言**: Java 17 / TypeScript | **许可**: MIT

YX-Admin 是一套基于 Spring Cloud 微服务架构的企业级管理系统，集成工作流引擎（Flowable）、表单引擎、代码生成、定时任务、文件存储、监控中心等功能。前端采用 Vue 3 + Vite + Element Plus 构建，提供现代化的管理界面。

## 项目结构

```
yx-admin/
├── yx-gateway/              # API 网关模块
├── yx-auth/                 # 认证授权中心
├── yx-system/               # 系统管理模块（含代码生成、定时任务、文件管理、监控）
├── yx-common/               # 通用模块（整合 core/redis/security/datasource/swagger/seata）
├── yx-flowable-engine/      # 工作流引擎模块（Flowable 7.1.0）
├── yx-flowable-design/      # 流程设计器模块（Flowable 6.8 Modeler）
├── yx-form-engine/          # 表单引擎模块
├── yx-cloud-ui/             # 前端 UI（Vue 3 + Vite）
├── config/                  # 各模块配置文件
├── sql/                     # 数据库脚本
├── tools/gen/               # 代码生成工具（Python）
├── 流程接口/                 # 流程接口示例（Controller/Service/Domain）
└── pom.xml                  # 父 POM（依赖管理）
```

## 技术栈

### 后端

| 类别 | 技术 | 版本 |
|------|------|------|
| 基础框架 | Spring Boot | 4.0.3 / 3.4.1 / 2.7.18 |
| 微服务 | Spring Cloud + Alibaba | 2025.1.0 / 2024.0.0 / 2021.0.9 |
| 注册/配置中心 | Nacos | — |
| 网关 | Spring Cloud Gateway | WebFlux |
| 熔断限流 | Sentinel | — |
| 持久层 | MyBatis | 4.0.1 / 3.0.4 |
| 数据库连接池 | Druid | 1.2.28 |
| 多数据源 | Dynamic Datasource | 4.5.0 / 3.6.1 |
| 缓存 | Redis | — |
| 工作流引擎 | Flowable | 7.1.0 (engine) / 6.8.1 (design) |
| 定时任务 | Quartz | — |
| 文件存储 | MinIO | 8.2.2 |
| 接口文档 | SpringDoc (OpenAPI 3) | 3.0.2 |
| 分布式事务 | Seata | — |
| 监控 | Spring Boot Admin | 4.0.2 |
| JSON | Fastjson2 | 2.0.61 |
| 认证 | JWT (jjwt) | 0.9.1 |

### 前端

| 类别 | 技术 | 版本 |
|------|------|------|
| 框架 | Vue 3 | 3.5.26 |
| 构建工具 | Vite | 6.4.1 |
| 语言 | TypeScript | 5.6.3 |
| UI 库 | Element Plus | 2.13.1 |
| 状态管理 | Pinia | 3.0.4 |
| 路由 | Vue Router | 4.6.4 |
| HTTP 客户端 | Axios | 1.13.2 |
| 流程图 | BPMN.js | 17.11.1 |
| 图表 | ECharts | 5.6.0 |
| 富文本编辑器 | Vue Quill | 1.2.0 |

## 模块说明

### yx-gateway — API 网关

基于 Spring Cloud Gateway（WebFlux）构建的统一入口网关，集成 Nacos 服务发现、Sentinel 网关限流、JWT 鉴权、验证码生成等功能。

### yx-auth — 认证授权中心

负责系统登录认证、Token 签发与校验、权限验证，依赖 yx-common 模块。

### yx-system — 系统管理模块

整合了系统管理、代码生成（Velocity）、定时任务（Quartz）、文件存储（MinIO）、监控中心（Spring Boot Admin）、WebSocket 消息推送等能力，是系统的核心业务模块。

### yx-common — 通用模块

整合了以下子模块公共代码：
- **common-core**: 基础工具类、异常处理、通用注解
- **common-redis**: Redis 缓存配置与服务
- **common-security**: 安全认证拦截器
- **common-datasource**: Druid + Dynamic Datasource 多数据源支持
- **common-swagger**: SpringDoc OpenAPI 接口文档
- **common-seata**: 分布式事务支持

### yx-flowable-engine — 工作流引擎

独立部署的工作流引擎模块，基于 **Flowable 7.1.0** + Spring Boot 3.4.x 构建。提供流程启动、任务推进、自由跳转、委派、转办、多实例加签/减签、驳回、撤回等完整流程 API。

### yx-flowable-design — 流程设计器

独立部署的流程设计器模块，基于 **Flowable 6.8.1 Modeler** + Spring Boot 2.7.x 构建，提供可视化的 BPMN 流程模型设计功能。

### yx-form-engine — 表单引擎

独立部署的表单引擎模块，基于 Spring Boot 3.4.x 构建，提供动态表单配置、数据存储、审批状态管理等功能。

### yx-cloud-ui — 前端界面

基于 Vue 3 + Vite + TypeScript + Element Plus 构建的现代化 SPA 管理界面，集成 BPMN.js 流程设计器、ECharts 图表、消息通知等组件。

## 流程接口

`流程接口/` 目录提供了 Flowable 工作流引擎的核心 API 接口定义，包括：

| 接口 | 功能 |
|------|------|
| `/flow/startProcess` | 启动流程实例 |
| `/flow/advanceTask` | 推进任务 |
| `/flow/flowFreeJump` | 流程自由跳转 |
| `/flow/delegateTask` | 任务委派 |
| `/flow/transfer` | 任务转办 |
| `/flow/deleteMultiInstance` | 多实例减签 |
| `/flow/addMultiInstance` | 多实例加签 |
| `/flow/getDeleteTask` | 获取删除任务信息 |
| `/flow/getBackNodesByTaskId` | 获取可驳回节点 |
| `/flow/deleteFlow` | 删除流程实例 |

## 环境要求

| 依赖 | 版本/说明 |
|------|-----------|
| JDK | 17+ |
| Maven | 3.8+ |
| Node.js | 18+ (前端构建) |
| MySQL | 8.0+ |
| Redis | 6.0+ |
| Nacos | 2.x（注册中心 + 配置中心） |
| MinIO | 可选（文件存储） |

## 快速开始

### 1. 克隆项目

```bash
git clone https://gitee.com/weigeapp/yx-admin.git
cd yx-admin
```

### 2. 初始化数据库

执行 `sql/` 目录下的 SQL 脚本创建数据库及初始化数据。

### 3. 配置 Nacos

修改 `config/` 目录下各模块的配置文件（`*-dev.yml`），确保 Nacos、MySQL、Redis 连接信息正确，然后导入 Nacos 配置中心。

### 4. 启动后端服务

按顺序启动各模块：

```bash
# yx-flowable-design（Spring Boot 2.7，需要先启动，提供模型设计功能）
cd yx-flowable-design && mvn spring-boot:run

# yx-flowable-engine（Spring Boot 3.4.x）
cd yx-flowable-engine && mvn spring-boot:run

# yx-form-engine（Spring Boot 3.4.x）
cd yx-form-engine && mvn spring-boot:run

# yx-auth
cd yx-auth && mvn spring-boot:run

# yx-system
cd yx-system && mvn spring-boot:run

# yx-gateway
cd yx-gateway && mvn spring-boot:run
```

### 5. 启动前端

```bash
cd yx-cloud-ui
npm install
npm run dev
```

### 6. 访问系统

- 前端管理界面: `http://localhost:80`
- 接口文档: `http://localhost:8080/doc.html`
- 监控中心: `http://localhost:8081/monitor`

## 代码生成

项目提供 Python 代码生成工具：

```bash
cd tools/gen
python gen.py
```

配置文件: `tools/gen/example.yml`

## 配置文件说明

| 配置文件 | 对应模块 |
|----------|----------|
| `config/yx-gateway-dev.yml` | 网关配置 |
| `config/yx-auth-dev.yml` | 认证中心配置 |
| `config/yx-system-dev.yml` | 系统管理配置 |
| `config/yx-flowable-engine-dev.yml` | 工作流引擎配置 |
| `config/yx-flowable-design-dev.yml` | 流程设计器配置 |
| `config/yx-form-engine-dev.yml` | 表单引擎配置 |
| `config/application-dev.yml` | 公共配置 |
| `config/sentinel-yx-gateway.json` | Sentinel 网关规则 |

## 许可

本项目基于 [MIT License](LICENSE) 开源。