# flowable-jet
**Repository Path**: bitcarton/flowable-jet
## Basic Information
- **Project Name**: flowable-jet
- **Description**: a flowable jet
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-10-20
- **Last Updated**: 2026-11-15
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# flowable-jet
> **跑示例工程 / 公网部署请看 [docs/STARTUP.md](docs/STARTUP.md)** —— 三件套(服务端 9040 + 业务端 9770 + 前端 5300)的建表、启动、登录、Nginx 配置和上线前检查都在那里。
基于 **Flowable 7** 的审批流程业务封装。服务端一个 starter 里跑引擎、模型、任务、分组、业务绑定和 REST 接口;客户端一个 starter 负责**可靠地**接收审批状态变更事件。
目标是让接入方不再重写「建模型 → 设计表单 → 部署 → 发起 → 审批 → 通知业务系统」这套样板代码。
## 特性
- **双端 starter**:服务端 `flowable-jet-spring-boot3-starter`,业务方 `flowable-jet-spring-boot3-client-starter`,两边都自动装配,接入成本是「引一个依赖 + 实现一个接口」。
- **审批事件不丢**(核心):状态变更先落本地消息表,再投递;投递失败按退避策略重投,超过次数进死信;消费端幂等去重。全程可查询、可补偿。
- **模型 / 表单 / 分组 / 业务绑定**:一个流程模型绑定一份 `formJson`(form-create 规则),业务类型绑定一个流程定义版本。
- **审批动作不止通过/驳回**:转办、前加签、发起人撤回、打回到指定节点开箱可用,边界规则(并行分支、加签未回签、伪造目标节点)在服务层拦截。
- **鉴权三件套**:请求头身份透传(`X-User-*`)、数据权限(一条流程只对关系人可见)、服务间 HMAC 签名,三者可独立开关。
- **不侵入事务边界**:`JdbcHelper` 用 `TransactionAwareDataSourceProxy` 包装数据源,调用方加 `@Transactional` 就自动参与,不加则各自提交。
- **前端配套**:`flowable-jet-web`(Vue 3 + Element Plus + bpmn-js),含设计器、审批中心、表单设计。
## 模块
| 模块 | 说明 |
|---|---|
| `flowable-jet-common` | `JdbcHelper`(极简 JDBC 封装)、`ParamHelper`、分页结果、Feign 客户端 |
| `flowable-jet-core` | 业务核心:模型、任务、配置、分组、消息表。**不依赖 Spring** |
| `flowable-jet-spring-boot3-starter` | 服务端自动装配 + 42 个 REST 接口 + 重试扫描任务 + 鉴权过滤器 |
| `flowable-jet-spring-boot3-client-starter` | 客户端自动装配:事件接收、死信接收、幂等、回调 SPI |
| `flowable-jet-test` / `flowable-jet-test-client` | 服务端 / 客户端示例应用 |
技术栈:Java 17、Spring Boot 3.4.2、Flowable 7.1.0、MySQL 8.0。
## 架构
```mermaid
flowchart LR
subgraph 服务端
R[/flow_jet/**] --> SF[X-App-Id 验签
FlowJetSignFilter]
SF --> AF[X-User-* 身份
FlowJetAuthFilter]
AF --> B[BizFlowModelService
BizFlowTaskService]
A[Flowable 引擎] <--> B
B --> C[(biz_flow_business
biz_flow_tasker)]
B --> D[(biz_flow_message_log
本地消息表)]
B -.数据权限 FlowJetAccessGuard.-> C
D --> E{FlowMessageSender}
E -->|event-type=kafka| F[[Kafka]]
E -->|event-type=default| G[Spring 进程内事件]
H[FlowMsgRetryTask
30s 扫描重投] --> D
end
subgraph 客户端
F --> I[KafkaProcessEventReceiver]
I --> J[(幂等表)]
I --> K[ApprovalStatusNotify
业务方实现]
I -.失败重试耗尽.-> L[[DLT 死信队列]]
L --> M[KafkaDeadEventReceiver]
M --> N[(biz_flow_dead_letter)]
end
```
## 快速开始
### 1. 建表
```bash
mysql -uroot -p < sql/flowable-jet.sql
```
只建 `biz_*` 业务表;Flowable 引擎表(`ACT_*` / `FLW_*`)由引擎首次启动自动创建,**不要手工建**。
### 2. 引依赖
```xml
com.bitcarton
flowable-jet-spring-boot3-starter
1.0.0
```
### 3. 配置
```yaml
spring:
datasource:
url: jdbc:mysql://localhost:3306/flowable_jet?useSSL=false&serverTimezone=UTC
username: root
password: your-password
flowable-jet:
web-enabled: true # 是否暴露 /flow_jet/** REST 接口
event-type: kafka # kafka | default(default 走 Feign 直连业务系统)
topic: flow_jet_msg
```
### 4. 注册当前用户(必做)
引擎不知道「谁在操作」,接入方必须提供一个 `Supplier`:
```java
@Bean
public Supplier currentUser() {
return () -> FlowUser.builder().id(120001L).realName("张三").build();
}
```
未注册该 Bean 且 `auth.enabled=false`(默认)时,接口在**首次取人时**抛 `FlowOaException("未提供当前用户:请注册一个 Supplier 类型的 Bean")` —— 不是启动时抛,读接口同样会触发。接入登录体系后,把它换成「从当前请求上下文取人」即可。若想改用请求头透传,必须**同时**设 `auth.enabled=true`,此时框架自动回退到 `FlowUserContext::get`,可以不注册该 Bean(见 [鉴权](#鉴权));既想保留 Bean 又想用请求头,把 Bean 写成 `return FlowUserContext::get` 即可。
### 5. 发起第一个流程
```bash
# 建模型
curl -X POST localhost:9040/flow_jet/def/create \
-H 'Content-Type: application/json' \
-d '{"key":"leave","name":"请假流程","category":"人事","isForm":1}'
# 取模型(拿 modelId 去设计器画图)—— 注意参数在 URL 上
curl -X POST 'localhost:9040/flow_jet/def/get_flow?modelId='
# 部署(bpmn + svg 必须同时提交,Flowable 不产图)
curl -X POST localhost:9040/flow_jet/def/deploy \
-H 'Content-Type: application/json' \
-d '{"modelId":"","bpmn":"","svg":"