Spring Boot 整合 Camunda 实现工作流

清疚 2024-02-06 00:18 121阅读 0赞

工作流是我们开发企业应用几乎必备的一项功能，工作流引擎发展至今已经有非常多的产品。最近正好在接触`Camunda`，所以来做个简单的入门整合介绍。如果您也刚好在调研或者刚开始计划接入，希望本文对您有所帮助。如果您是一名Java开发或Spring框架爱好者，欢迎关注我[程序猿DD][DD]，持续非常技术干货。

### Camunda简介 ###

![daca20acf1af4b09987f9defcd3b571f.png][]

Camunda是一个灵活的工作流和流程自动化框架。其核心是一个运行在Java虚拟机内部的原生BPMN 2.0流程引擎。它可以嵌入到任何Java应用程序和任何运行时容器中。

*  官网网站: [https://www.camunda.org/][https_www.camunda.org]
 *  入门文档: [https://docs.camunda.org/get-started/][https_docs.camunda.org_get-started]

### 动手整合Camunda ###

下面就来一步步动手尝试一下吧。

#### 准备工作 ####

1.  使用Camunda提供的项目初始化工具[Camunda Automation Platform 7 Initializr][]

![708dc732046c4561bae384ff6a865d84.png][]

如上图，包名之类的根据自己需要做好配置，最后输入管理账号和密码，点击`Generate Project`按钮，自动下载工程。

1.  解压下载后的工程，使用[IntelliJ IDEA][]打开，其项目结构

![3a887ce4ac5c4ce1b2db28dd7b8d4497.png][]

1.  打开`pom.xml`文件，添加camunda依赖：

<dependency>
        <groupId>org.camunda.connect</groupId>
        <artifactId>camunda-connect-core</artifactId>
    </dependency>
    
    <dependency>
        <groupId>org.camunda.bpm</groupId>
        <artifactId>camunda-engine-plugin-connect</artifactId>
    </dependency>

由于Camunda Automation Platform 7 Initializr默认的Spring Boot版本已经是3.1了，所以如果要做一些降级调整，可以手工修改`pom.xml`中`dependencyManagement`配置，比如下面这样：

<dependencyManagement>
        <dependencies>
          <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>2.6.4</version>
            <type>pom</type>
            <scope>import</scope>
          </dependency>
    
          <dependency>
            <groupId>org.camunda.bpm</groupId>
            <artifactId>camunda-bom</artifactId>
            <version>7.15.0</version>
            <scope>import</scope>
            <type>pom</type>
          </dependency>
        </dependencies>
    </dependencyManagement>

1.  打开配置文件`application.yaml`，可以看到类似下面的内容

spring.datasource.url: jdbc:h2:file:./camunda-h2-database
    
    camunda.bpm.admin-user:
      id: transduck
      password: 111111

*  `spring.datasource.url`：工作流引擎使用的数据库配置，您也可以根据官网文档去调整到其他数据库中（尤其生产环境）。
 *  `camunda.bpm.admin-user`：管理员账户配置，可以在这里修改用户名和密码

#### 创建一个简单的工作流 ####

下面我们尝试创建一个简单的工作流：

第一步，我们将请求用户提供两个输入：name和message 第二步，我们将这些输入传递给我们的服务以创建消息输出

开始编码：

1.  创建第一步提到的数据模型

public class model {
    
        private String message;
        private String name;
    
        public model() { }
    
        public String getMessage() {
            return message;
        }
    
        public void setMessage(String message) {
            this.message = message;
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        @Override
        public String toString() {
            return "" + message + ", " + name;
        }
    }

1.  根据第二步，创建接收消息的接口

@RequestMapping("/")
    @RestController
    public class controller {
    
        Logger logger = Logger.getLogger(this.getClass().getName());
    
        @PostMapping("/message")
        public model createMessage(@RequestBody model model) {
            logger.info("-------Message Creator Initialized-------");
    
            model m = new model();
            m.setMessage(model.getMessage());
            m.setName(model.getName());
    
            logger.info("Message created --> " + m.toString());
            return m;
        }
    }

1.  下面我们可以开始创建工作流程图。在[Camunda Modeler][]中打开我们项目的`resources`下的`process.bpmn`，我们将看到类似下面的流程图：

![9451c36b21cd453197250b7559d59c1a.png][]

图中带有小人的框称为`User Tasks`，是执行与用户相关的操作的步骤。如前面部分所述，在工作流程的第一步中，我们将请求用户输入两个输入：姓名和消息。无需添加新任务，更新现有的`User Tasks`即可解决问题。单击`User Tasks`，打开属性面板，在打开的面板中定义适合我们案例内容。

![db6c1e48a6614a45a171e85ad1bf9848.png][]

1.  完成基本信息填写后，转到`Form`选项卡。

![f11a6852b56c46ffb6c1e1e06cf63968.png][]

这是定义呈现给用户的表单选项卡。由于我们需要用户输入姓名和消息，因此我们定义两个名为“name”和“message”的表单字段。要定义表单字段，请单击“表单字段”旁边的加号图标。在打开的表单中，相应地填写 ID、类型和标签字段。对每个表单字段重复相同的步骤。

1.  开始配置第二步，调用我们的接口。添加`Service Task`。

具体操作方法：单击左侧菜单中的`Create Task`图标，然后将任务拖放到随机位置。单击任务后，单击`Change Type`图标，然后从菜单中选择`Service Task`。

![222eadd80aac47d6ad780813edf371f9.png][]

1.  填写基本信息

![a41cc57c8d9349e996c828bff1f67a95.png][]

1.  切换到`Connector`选项卡。这是定义 HTTP 信息和有关服务的数据的选项卡，在这里配置刚才定义的接口，具体如下图所示：

![117bafc434e945ad926fbbded038f6b3.png][]

1.  将`Service Task`连接到工作流程中。先删除`User Tasks`和`End Event`之间的箭头。然后，单击`User Tasks`并从菜单中选择箭头图标。将箭头连接到`Service Task`。最后，再连接`Service Task`和`End Event`。

![fdff515e5f544c3f9e7042d935a7a2ba.png][]

#### 启动测试 ####

在完成了上面的编码和工作流程配置后，我们就可以在调试模式下运行项目了。

启动完成后，在浏览器上访问地址`http://localhost:8080/`，您将看到 Camunda 登录页面：

![a214f9eba41c42faa7cbfd74298c0c59.png][]

输入您在`application.yaml`中配置的管理员配置信息，进入后台：

![b29da8467a7240e89eeed4f9a256c44c.png][]

从应用程序主页中选择`Tasklist`，可看到如下界面：

![ab62fd1473b94039a80118a120194731.png][]

然后在任务列表页面上单击`Add a simple filter`选项。单击后，您将看到名为`All Tasks (0)`的过滤器已添加到列表中，继续单击`Start process`选项来运行我们准备好的工作流程。

选择您的工作流进程，然后单击`Start button`，无需提供任何其他信息。

![6b37f35486754f6faf2e675f53488eef.png][]

最后，单击`Created`下列出的`Get Input`任务。如果您没有看到该任务，请刷新页面。

![81ffbe5d88c84d3d85385e27b617e732.png][]

您将看到我们在第一步中定义的表单。要填写表格，请单击右上角`Claim`选项。然后，根据您的喜好填写表格并单击`Complete`按钮。

![6e1a637eb4c043b19693f89caca97962.png][]

当工作流执行`Service Task`并且服务运行时，您将看到列表再次变空。如果工作流成功执行了第二步，我们应该能够在控制台中看到输出。

### 小结 ###

本文介绍了使用Spring Boot和Camunda创建一个简单工作流的完整步骤，希望对您有所帮助。如果您学习过程中如遇困难？可以加入我们超高质量的[Spring技术交流群][Spring]，参与交流与讨论，更好的学习与进步！更多[Spring Boot教程可以点击直达！][Spring Boot]，欢迎收藏与转发支持！

> 欢迎关注我的公众号：程序猿DD。前沿技术早知道，弯道超车有希望！积累超车资本，从关注DD开始！

[DD]: https://www.didispace.com/
[daca20acf1af4b09987f9defcd3b571f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/b4ea569475ef44ea80ea546835441f3c.png
[https_www.camunda.org]: https://www.camunda.org/
[https_docs.camunda.org_get-started]: https://docs.camunda.org/get-started/
[Camunda Automation Platform 7 Initializr]: https://start.camunda.com/
[708dc732046c4561bae384ff6a865d84.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/866b6b4b3a3f4b24b7d7886f060985a4.png
[IntelliJ IDEA]: https://www.didispace.com/idea-tips/performance/m1-performance.html
[3a887ce4ac5c4ce1b2db28dd7b8d4497.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/d01ced92a4ef44199490926056f7222f.png
[Camunda Modeler]: https://camunda.com/download/modeler/
[9451c36b21cd453197250b7559d59c1a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/bd137bc5af1548baa749f43e213867cf.png
[db6c1e48a6614a45a171e85ad1bf9848.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/e1a3a44fecfa40f4bce830a4e285173c.png
[f11a6852b56c46ffb6c1e1e06cf63968.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/09f82e1316174e29b7460882633d5194.png
[222eadd80aac47d6ad780813edf371f9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/d68492c2e73d465ab03e048689a69f3b.png
[a41cc57c8d9349e996c828bff1f67a95.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/cc2733b5e77244d4b1faa8e30577633c.png
[117bafc434e945ad926fbbded038f6b3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/d1a373fd912b4838bd1d64b4e90164d0.png
[fdff515e5f544c3f9e7042d935a7a2ba.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/a30267f76f50430ea0e8df6a3cf28f8e.png
[a214f9eba41c42faa7cbfd74298c0c59.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/d6e1f301c99f44cc8f4cfc9235d5c9fb.png
[b29da8467a7240e89eeed4f9a256c44c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/bb374c280f7341a9832b7c13fe1f92ba.png
[ab62fd1473b94039a80118a120194731.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/35820890de6a429faeb85f240294be0d.png
[6b37f35486754f6faf2e675f53488eef.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/25928f8a4aac42e2a337ff3c6cbfc226.png
[81ffbe5d88c84d3d85385e27b617e732.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/9b18092da5ff4a9082102afe720e4522.png
[6e1a637eb4c043b19693f89caca97962.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/f20d304df3fe4178add4415c6743e103.png
[Spring]: https://www.didispace.com/jiaqun.html
[Spring Boot]: https://www.didispace.com/spring-boot-2/