RuoYi-Flowable-Plus 工作流框架使用指南

RuoYi-Flowable-Plus 是基于 RuoYi-Vue-Plus 进行二次开发的开源项目，主要扩展了 Flowable 工作流功能。该项目支持在线表单设计和丰富的工作流程设计能力，适用于需要集成工作流功能的 Web 应用开发。

项目概述

RuoYi-Flowable-Plus 采用 Spring Boot 2.7 和 Vue.js 技术栈，集成了 Flowable 工作流引擎，提供了完整的工作流管理解决方案。项目采用 MIT 开源协议，完全免费给个人及企业使用。

环境要求

• JDK 8 或 JDK 11
• Maven 3.6+
• MySQL 5.7+ 或其他支持数据库
• Node.js 14+

快速开始

1. 克隆项目

首先需要克隆项目到本地：

git clone https://gitcode.com/gh_mirrors/ru/RuoYi-Flowable-Plus
cd RuoYi-Flowable-Plus

2. 数据库配置

项目支持多种数据库，包括 MySQL、Oracle、PostgreSQL 和 SQL Server。根据您使用的数据库类型，执行相应的 SQL 脚本：

• MySQL: script/sql/mysql/mysql_ry_v0.8.X.sql
• Oracle: script/sql/oracle/oracle_ry_v0.8.X.sql
• PostgreSQL: script/sql/postgres/postgres_ry_v0.8.X.sql
• SQL Server: script/sql/sqlserver/sqlserver_ry_v0.8.X.sql

3. 修改配置文件

打开 ruoyi-admin/src/main/resources/application.yml 文件，修改数据库连接配置：

spring:
  datasource:
    druid:
      # 主库数据源
      master:
        url: jdbc:mysql://localhost:3306/ry-flowable?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8
        username: root
        password: 123456

4. 启动后端服务

在项目根目录下执行 Maven 命令启动后端服务：

mvn clean install
cd ruoyi-admin
mvn spring-boot:run

5. 启动前端服务

打开新的终端窗口，进入前端目录并启动：

cd ruoyi-ui
npm install
npm run dev

6. 访问系统

打开浏览器访问 http://localhost:80，使用默认账号登录：

• 用户名：admin
• 密码：admin123

核心功能模块

流程设计器

项目内置了强大的流程设计器，支持可视化拖拽方式设计业务流程。设计器位于 ruoyi-ui/src/components/ProcessDesigner 目录。

表单设计

系统支持在线表单设计，可以创建各种类型的表单字段，包括文本框、下拉框、日期选择器等。表单设计功能位于 ruoyi-ui/src/views/workflow/form 目录。

流程管理

提供完整的流程生命周期管理功能：

• 流程定义管理
• 流程实例监控
• 任务分配和处理
• 流程历史记录查询

系统管理

继承 RuoYi 框架的系统管理功能：

• 用户管理
• 角色管理
• 菜单管理
• 部门管理
• 字典管理

常见问题解决

依赖包下载失败

如果遇到 Maven 依赖包下载失败，可以尝试配置国内镜像源。在 Maven 的 settings.xml 文件中添加阿里云镜像：

<mirror>
  <id>aliyunmaven</id>
  <mirrorOf>*</mirrorOf>
  <name>阿里云公共仓库</name>
  <url>https://maven.aliyun.com/repository/public</url>
</mirror>

数据库连接问题

确保数据库服务已启动，并且数据库用户有足够的权限。检查 application.yml 中的数据库连接配置是否正确。

前端编译错误

如果前端编译出现错误，可以尝试清除 node_modules 并重新安装：

cd ruoyi-ui
rm -rf node_modules
npm install

开发建议

1. 学习 Flowable 基础知识：在使用本项目前，建议先了解 Flowable 工作流引擎的基本概念和使用方法。

2. 阅读官方文档：项目提供了详细的开发文档，包含 Flowable 基础知识、项目使用说明、源码解析等内容。

3. 参考示例代码：项目中提供了丰富的示例代码，可以作为开发的参考。

4. 参与社区交流：项目有活跃的技术交流群，遇到问题可以在群里寻求帮助。

项目结构说明

RuoYi-Flowable-Plus/
├── ruoyi-admin/          # 后台管理模块
├── ruoyi-common/         # 公共模块
├── ruoyi-flowable/       # 工作流核心模块
├── ruoyi-framework/      # 框架核心模块
├── ruoyi-generator/      # 代码生成器
├── ruoyi-system/         # 系统模块
├── ruoyi-ui/            # 前端界面
└── script/              # 脚本文件

总结

RuoYi-Flowable-Plus 是一个功能强大的工作流开发框架，集成了 RuoYi 的优秀特性和 Flowable 的工作流能力。通过本指南，您可以快速上手并使用该项目进行开发。如果在使用过程中遇到问题，可以参考项目文档或加入技术交流群寻求帮助。