@alanwang-merit/meritdata-platform-skill-package 1.0.0

package/skills/meritdata-dev-docs-file-finder/references/dev-docs/.bak//345/272/224/347/224/250/345/274/200/345/217/221/345/271/263/345/217/260-/346/265/201/347/250/213/347/256/241/347/220/206-/344/275/277/347/224/250/346/224/273/347/225/245/357/274/210/344/270/211/357/274/211/357/274/232/347/233/221/345/220/254/350/241/250/350/276/276/345/274/217/345/274/200/345/217/221.md

@@ -0,0 +1,463 @@
+---
+title: 应用开发平台流程管理使用攻略（三）：监听表达式开发
+date: 2025.05.27
+categories:
+  - 开发攻略
+  - 6.13.2
+---
+
+# 应用开发平台流程管理使用攻略（三）：监听表达式开发
+
+​        流程设计器中原生支持配置监听表达式参数，流程流转时能够按照事件自动触发配置类中重写的方法，执行表达式完成业务逻辑的执行。由于各项目的业务不同，应用开发平台无法提供统一的监听表达式，因此提供二次开发文档来指导各项目开发自己的监听表达式。
+
+# 1. 实现策略
+
+开发一个 jar 包放入 cloud-system-bpm 工程中，jar 包中的方法使用 feign 方式来调用自己业务的接口。
+
+![image-20210628111844355](.\imgs\监听二次开发\image-20210628111844355.png)
+
+## 1.1 需要开发一个 jar 包和一个包含业务接口的微服务（若有微服务可以不用创建）
+
+jar 包中包含两部分：
+
+ 1.定义监听的实现类用于触发事件。
+
+ 2.定义一个应用开发平台调用类，用于调用自己开发的应用开发平台业务方法。
+
+应用开发平台包中定义了业务具体实现的接口。
+
+## 1.2 jar 包移入 cloud-systme-bpm 工程
+
+6.10版本之前需要将打包好的jar包放入BPM服务的lib目录中，6.10版本之后需要将jar包放到server/bpm-dev-lib下，并且修改META-INF下的MANIFEST.MF指向文件，最后重启bpm服务，使jar中定义的实现类注入容器，监听器上配置监听事件触发时能够找到对应的Bean,实现类可以通过定义的微服务调用类来调用自己业务服务接口。
+
+## 1.3 这种方式可以扩展监听器的配置的监听表达式,开发人员自定义业务的灵活性更高。
+
+# 2. 自定义 jar 包的实现流程
+
+## 2.1 创建一个 maven 项目
+
+### 2.1.1 目录结构
+
+1.在 IntelliJ IDEA 窗口中点击左上角 选择 "File->New-> Project"，创建一个新的工程
+
+![image-20210401093623690](.\imgs\监听二次开发\image-20210401093623690.png)
+
+2.在"New Project "页面选择"Maven"，然后配置工程所需要的 JDK,如果微服务版本未升级到6.13.2时，jdk选择1.8即可，否则jdk则需要选择21版本，在 run 文件夹下的 merit_cloud 文件夹中存放了一个 正确版本的jdk 可以选择使用，点击 下一步
+
+![image-20210401093655891](.\imgs\监听二次开发\image-20210401093655891.png)
+
+3.配置参数
+
+| 名称       | 参数值                | 说明                   |
+| ---------- | --------------------- | ---------------------- |
+| GroupId    | com.meritdata.cloud   | 可以自定义             |
+| artifactId | project-listener-demo | 项目名称, 可自定义名称 |
+
+![image-20210401094011877](.\imgs\监听二次开发\image-20210401094011877.png)
+
+4.点击 java 文件夹-》右击鼠标-》选择 Mark Directory as -》Resources Root 设置 Java 文件为 root 文件
+
+逐级新建文件结构如下
+
+![](.\imgs\监听二次开发\image-20210311155149811.png)
+
+### 2.1.2 修改 pom 文件
+
+需要引入流程的相关依赖包及 Spring Boot，springCloud 相关依赖
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    // springboot项目
+    <parent>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-starter-parent</artifactId>
+        <version>2.1.8.RELEASE</version> <!-- lookup parent from repository -->
+    </parent>
+    <groupId>com.meritdata.cloud</groupId>
+    <artifactId>project-listener-demo</artifactId>
+    <version>1.0-SNAPSHOT</version>
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+        //6.13.2以下版本用1.8版本的jdk即可
+        <java.version>1.8</java.version>
+        //6.13.2版本需要21版本的jdk
+        <java.version>21</java.version>
+        <spring-cloud.version>Greenwich.SR3</spring-cloud.version>
+        <meritdata-cloud.version>${meritdata-cloud.version}</meritdata-cloud.version>
+    </properties>
+    <dependencies>
+    // 应用开发平台的依赖
+        <dependency>
+            <groupId>com.meritdata.cloud</groupId>
+            <artifactId>cloud-starter-core</artifactId>
+            <version>${meritdata-cloud.version}</version>
+        </dependency>
+        // camunda依赖
+        <dependency>
+            <groupId>org.camunda.bpm.springboot</groupId>
+            <artifactId>camunda-bpm-spring-boot-starter-rest</artifactId>
+            <version>3.4.0</version>
+        </dependency>
+    </dependencies>
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>org.springframework.cloud</groupId>
+                <artifactId>spring-cloud-dependencies</artifactId>
+                <version>${spring-cloud.version}</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+    <build>
+        <!--使配置文件可以直接读取pom中的系统参数 -->
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>true</filtering>
+            </resource>
+        </resources>
+        <plugins>
+            <plugin>
+                <groupId>com.google.code.maven-replacer-plugin</groupId>
+                <artifactId>replacer</artifactId>
+                <version>1.5.3</version>
+                <executions>
+                    <execution>
+                        <phase>prepare-package</phase>
+                        <goals>
+                            <goal>replace</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+</project>
+```
+
+### 2.1.3 类定义示例及说明
+
+UserCustomTaskListener.java ---
+
+目的用于监听用户事件(UserTask) ，需要 implements TaskListener
+
+```java
+package com.meritdata.cloud.listener;
+
+import com.meritdata.cloud.fegin.IUserTaskListener;
+import org.camunda.bpm.engine.delegate.DelegateTask;
+import org.camunda.bpm.engine.delegate.TaskListener;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Service;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.logging.Logger;
+
+/**
+ * 监听用户任务事件
+ *
+ */
+@Service("userCustomTaskListener")
+public class UserCustomTaskListener implements TaskListener {
+
+    @Autowired
+    IUserTaskListener iUserTaskListener;
+
+    private final static Logger LOGGER = Logger.getLogger(UserCustomTaskListener.class.getName());
+
+    @Override
+    public void notify(DelegateTask delegateTask) {
+        LOGGER.info("开始监听服务");
+        LOGGER.info("活动ID: " + delegateTask.getExecution().getCurrentActivityId() +
+                ", 事件类型：" + delegateTask.getEventName());
+        Map<String,Object> params = new HashMap<>();
+        params.put("eventName" , delegateTask.getEventName());
+        params.put("variables", delegateTask.getVariables());
+        params.put("currentActivityId", delegateTask.getExecution().getCurrentActivityId());
+        params.put("assignee", delegateTask.getAssignee());
+        params.put("processDefinitionId", delegateTask.getProcessDefinitionId());
+        String result= iUserTaskListener.listenerService(params);
+        Map<String, Object> variables = delegateTask.getVariables();
+        LOGGER.info("完成监听服务");
+    }
+}
+```
+
+// 获取一些参数的方法
+
+```
+// 获取businessId
+String businessId = (String) delegateTask.getVariable("businessId");
+// 获取节点处理人
+  String assignee = delegateTask.getAssignee();
+// 获取某个变量值
+String xx = (String) delegateTask.getVariable("xx")
+// 获取流程实例
+ String processInstanceId = delegateTask.getProcessInstanceId();
+```
+
+IUserTaskListener.java ---用于定义调用应用开发平台接口
+
+```java
+package com.meritdata.cloud.fegin;
+
+import com.meritdata.cloud.config.CloudFeignConfiguration;
+import io.swagger.annotations.ApiOperation;
+import org.springframework.cloud.openfeign.FeignClient;
+import org.springframework.stereotype.Service;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+import java.util.Map;
+
+@RestController
+@FeignClient(value = "${meritdata.cloud.custom-listener-name}",contextId = "lisetenerUserCustomServiceClient",configuration = CloudFeignConfiguration.class)
+@Service("iUserTaskListener")
+public interface IUserTaskListener {
+        @ApiOperation(value = "调用三方自定义监听服务")
+        @RequestMapping(value = "${meritdata.cloud.listener-controller-name}/${meritdata.cloud.listener-method-name}",method = RequestMethod.POST)
+        public String  listenerService(@RequestParam Map<String, Object> params);
+
+}
+```
+
+### 2.1.4 打成 jar 包
+
+以 idea 工具为例
+
+依次点击打出 jar 包--并在 target 文件夹下找到 jar 包
+
+![image-20210311160429487](.\imgs\监听二次开发\image-20210311160429487.png)
+
+![image-20210311160606017](.\imgs\监听二次开发\image-20210311160606017.png)
+
+### 2.1.5 将 jar 包复制到/opt/merit_cloud/apps/system/server/bpm/WEB-INF/lib 目录下
+
+如下图
+
+![image-20210311161044426](.\imgs\监听二次开发\image-20210311161044426.png)
+
+微服务版本大于等于6.10以后，将jar包放置在/opt/merit_cloud/apps/system/server/bpm-dev-lib/目录下，同时要给此目录授权，同时修改/server/bpm/下cloud-system-bpm-engine.war，war包中的MF文件，添加监听包路径
+
+### 2.1.6 重启 cloud-system-bpm 服务
+
+# 3. 自定义服务搭建（若已存在工程和接口，此步骤可省略）
+
+## 3.1 搭建工程
+
+根据《应用开发平台使用攻略(一)：系统环境搭建》 的后端工程创建，进行后端工程搭建。
+
+具体示例代码
+
+- 选中 com.meritdata.cloud ——>鼠标右键——> 点击 New ——> 选择 Package
+
+- ![image-20210309100531855](.\imgs\监听二次开发\image-20210309100531855.png)
+
+- 添加包目录,按照下图，分别添加 controller 包,entity 包,repository 包,service 包
+
+  ![image-20210309100626984](.\imgs\监听二次开发\image-20210309100626984.png)
+
+  添加 java 文件,按照下图,分别添加:
+
+  - 服务层
+
+    - 服务层接口
+      
+      - IBpmUserCustomService.java
+    - 服务层接口实现
+    
+      - BpmUserCustomServiceImpl.java
+    
+        
+  
+  - 控制层
+  
+    UserCustomController.java
+    
+    持久层 ：示例项目无，二次开发根据自己业务需求编写
+    
+    ### 控制层
+    
+    | 类名                 | 类型  |
+    | -------------------- | ----- |
+    | UserCustomController | class |
+    
+    ```java
+    
+    package com.meritdata.cloud.controller;
+    
+    import com.alibaba.fastjson.JSONObject;
+    import com.meritdata.cloud.service.IBpmUserCustomService;
+    import io.swagger.annotations.ApiOperation;
+    import org.springframework.beans.factory.annotation.Autowired;
+    import org.springframework.web.bind.annotation.RequestMapping;
+    import org.springframework.web.bind.annotation.RequestMethod;
+    import org.springframework.web.bind.annotation.RequestParam;
+    import org.springframework.web.bind.annotation.RestController;
+    
+    import java.util.HashMap;
+    import java.util.Map;
+    
+    @RestController
+    @RequestMapping(value = "/api/bpmlistener/demo")
+    public class UserCustomController {
+        @Autowired
+        private IBpmUserCustomService procUserCustomService;
+    
+        @ApiOperation(value = "扩展监听器事件接口")
+        @RequestMapping(value = "/doListenerEvent", method = RequestMethod.POST)
+        public String doListenerEvent(@RequestParam  Map<String,Object> params){
+            /**
+             * currentActivityId 活动ID
+             * eventName 事件名称 create(开始),complete(结束)
+             * variables 变量
+             */
+            procUserCustomService.sendEmil();
+            Map<String, Object> map = new HashMap<>();
+            map.put("variables", variables);
+            String result = JSONObject.toJSONString(map);
+            return result;
+        }
+    }
+    ```
+  
+    | 类名                  | 类型      | 父类 |
+    | :-------------------- | --------- | ---- |
+    | IBpmUserCustomService | interface |      |
+
+```java
+package com.meritdata.cloud.service;
+
+public interface IBpmUserCustomService {
+	// 具体业务实现，自定义
+    void sendEmil();
+}
+```
+
+服务层接口实现
+
+| 类名                     | 类型  | 父类                          |
+| ------------------------ | ----- | ----------------------------- |
+| BpmUserCustomServiceImpl | class | 实现 IBpmUserCustomService 类 |
+
+```java
+package com.meritdata.cloud.service.impl;
+
+import com.meritdata.cloud.service.IBpmUserCustomService;
+import org.springframework.stereotype.Service;
+
+@Service("procUserCustomService")
+public class BpmUserCustomServiceImpl implements IBpmUserCustomService {
+
+    @Override
+    public void sendEmil() {
+        System.out.println("发送了邮件");
+    }
+
+}
+```
+
+## 3.2 服务启动
+
+启动完毕后可在 nacos 中的服务列表页面查看，该应用已注册至 nacos
+
+![image-20210309102321752](.\imgs\监听二次开发\image-20210309102321752.png)
+
+## 3.3 设置参数
+
+meritdata.cloud.custom-listener-name=应用开发平台名称
+
+![image-20210309104250874](.\imgs\监听二次开发\image-20210309104250874.png)
+
+![image-20210309153526242](.\imgs\监听二次开发\image-20210309153526242.png)
+
+meritdata.cloud.listener-controller-name=controller 地址
+
+示例：
+
+![image-20210309104203506](.\imgs\监听二次开发\image-20210309104203506.png)
+
+meritdata.cloud.listener-method-name = 接口地址
+
+![image-20210311161814985](.\imgs\监听二次开发\image-20210311161814985.png)
+
+若存在多个应用开发平台则 nacos 中配置多个参数即可，每个 feign 接口与之对应即可。
+
+# 4. 流程设计中设置 listener 参数
+
+## 4.1 维护监听类
+
+登录账户-进入流程服务菜单添加已经配置好的监听类
+
+![image-20210628102718558](.\imgs\监听二次开发\image-20210628102718558.png)
+
+## 4.2 流程节点配置监听参数
+
+点击流程编辑按钮-进入编辑状态-双击用户任务--选择监听参数配置框
+
+![](.\imgs\监听二次开发\image-20210309103008443.png)
+
+![image-20210309103223849](.\imgs\监听二次开发\image-20210309103223849.png)
+
+### 4.2.1 添加表达式
+
+![image-20210628103121555](.\imgs\监听二次开发\image-20210628103121555.png)
+
+在表达式菜单中添加 userCustomTaskListener 表达式内容
+
+![image-20210628110631669](.\imgs\监听二次开发\image-20210628110631669.png)
+
+![image-20210628102918606](.\imgs\监听二次开发\image-20210628102918606.png)
+
+![image-20210628105151150](.\imgs\监听二次开发\image-20210628105151150.png)
+
+表达式 userCustomTaskListener 来自于之前在自定义 jar 中的 bean 名称
+
+![image-20210311161951475](.\imgs\监听二次开发\image-20210311161951475.png)
+
+事件类型目前支持开始和结束， 开始对应 ---create 结束对应--- complete
+
+### 4.2.2 添加完监听事件后-发布流程
+
+# 5. 测试触发流程监听事件是否生效
+
+## 5.1 创建测试流程测试
+
+![image-20210309135918804](.\imgs\监听二次开发\image-20210309135918804.png)
+
+## 5.2 查看自定义业务是否生效
+
+![image-20210311164704675](.\imgs\监听二次开发\image-20210311164704675.png)
+
+![image-20210311201142536](.\imgs\监听二次开发\image-20210311201142536.png)
+
+由图可看到触发了自定义事件
+
+
+
+# 备注：
+
+## 1.表达式需要扩展，则仿照上面过程继续添加。
+
+示例：![image-20210311162530715](.\imgs\监听二次开发\image-20210311162530715.png)
+
+## 2.本例是以 UserTask 流程节点为例创建监听任务类，若添加线监听实现类过程与之类似，实现类需要改成 implements JavaDelegate 接口重写 execute 方法。
+
+服务任务节点配置的监听类也是要 implements JavaDelegate 接口重写 execute 方法。
+
+![image-20210401095619223](.\imgs\监听二次开发\image-20210401095619223.png)
+
+![image-20210311194204225](.\imgs\监听二次开发\image-20210311194204225.png)
+
+## 3.在监听类维护时，为线创建的监听类维护时监听类型选择线任务监听，为流程服务和用户服务创建的选择用户任务监听（否则选择不到）。
+
+## 4.给服务任务节点选择表达式时一定不能选错，不能选择给 UserTask 节点配置的表达式否则流程流转时会报错。意思就是给服务节点上配置的监听类是必须 implements JavaDelegate 接口。