Skip to content

事件中指令扩展开发

构建表单配置扩展指令

配置表单打开事件扩展指令 setCtrlValue ,并传递相应参数。

示例:籍贯、血型、列表控件赋值

20250226113635

新建项目

pom.xml 中引入 co-service-macro-sdk-x.x.x.jar

xml
<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>

  <groupId>com.kanq</groupId>
  <artifactId>co-service-ext</artifactId>
  <version>1.0.1</version>
  <packaging>jar</packaging>

  <name>co_service_web_ext_demo</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <dependencies>

    <dependency>
        <groupId>com.kanq</groupId>
        <artifactId>co-service-macro-sdk</artifactId>
        <version>1.x.x</version>
    </dependency>

  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </build>
</project>
<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>

  <groupId>com.kanq</groupId>
  <artifactId>co-service-ext</artifactId>
  <version>1.0.1</version>
  <packaging>jar</packaging>

  <name>co_service_web_ext_demo</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <dependencies>

    <dependency>
        <groupId>com.kanq</groupId>
        <artifactId>co-service-macro-sdk</artifactId>
        <version>1.x.x</version>
    </dependency>

  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </build>
</project>

扩展接口实现

  • 创建 java 类 com.kanq.FormDemo
  • 增加 public static byte[] setCtrlValue(byte[] macroHead, byte[][] argv); 方法
  • 增加指令注册注解 @Macro(name = "setCtrlValue", describe = "事件中指令")

注意

  • 入参说明:
    • macroHead 请求头,参数不定,格式: form:2\r\nuser:1
    • argv 入参参数
  • 出参说明:
    • 字符串:json 格式
    • 文件: 字节流
  • 注解说明:
    • name 指令名称
    • describe 接口描述 :::

macroHead 参数说明

  • addr 当前用户 IP
  • client f: 函数,m:移动动
  • busi 当前业务编号
  • role 当前角色
  • user 当前用户编号
  • stat 当前流程状态
  • tach 当前流程环节
  • flow 当前打开流程
  • form 当前打开表单
  • prev 父级表单
  • tent 指定租户编号
  • trace 链路日志
  • ticket 票据
  • FormDemo.java
java
package com.kanq;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.JsonNodeFactory;
import com.kanq.sdk.config.Macro;
import java.nio.charset.StandardCharsets;

public class FormDemo {

    @Macro(name = "setCtrlValue", describe = "事件中指令")
    public static byte[] setCtrlValue(byte[] macroHead, byte[][] argv) throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        ArrayNode args = mapper.createArrayNode();
        for (byte[] bytes : argv) {
            args.add(new String(bytes, StandardCharsets.UTF_8));
        }
        System.out.println("argv:" + mapper.writeValueAsString(args));

        // 参数一
        String parm1 = args.get(0).asText();
        // 参数二
        String parm2 = args.get(1).asText();

        ArrayNode arrayNode = mapper.createArrayNode();
        // 第一个控件赋值
        arrayNode.insert(0,parm1);
        // 第二个控件赋值
        arrayNode.insert(1,parm2);

        ArrayNode rootNode = JsonNodeFactory.instance.arrayNode();
        ArrayNode innerJsonNode = JsonNodeFactory.instance.arrayNode();
        innerJsonNode.add("张三");
        innerJsonNode.add("入职申请");
        innerJsonNode.add("同意");
        rootNode.add(innerJsonNode);

        // 第三个表格控件赋值
        arrayNode.insert(2,rootNode);
        System.out.println("parmImpl:"+mapper.writeValueAsString(arrayNode));
        return mapper.writeValueAsString(arrayNode).getBytes(StandardCharsets.UTF_8);
    }

}

package com.kanq;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.JsonNodeFactory;
import com.kanq.sdk.config.Macro;
import java.nio.charset.StandardCharsets;

public class FormDemo {

    @Macro(name = "setCtrlValue", describe = "事件中指令")
    public static byte[] setCtrlValue(byte[] macroHead, byte[][] argv) throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        ArrayNode args = mapper.createArrayNode();
        for (byte[] bytes : argv) {
            args.add(new String(bytes, StandardCharsets.UTF_8));
        }
        System.out.println("argv:" + mapper.writeValueAsString(args));

        // 参数一
        String parm1 = args.get(0).asText();
        // 参数二
        String parm2 = args.get(1).asText();

        ArrayNode arrayNode = mapper.createArrayNode();
        // 第一个控件赋值
        arrayNode.insert(0,parm1);
        // 第二个控件赋值
        arrayNode.insert(1,parm2);

        ArrayNode rootNode = JsonNodeFactory.instance.arrayNode();
        ArrayNode innerJsonNode = JsonNodeFactory.instance.arrayNode();
        innerJsonNode.add("张三");
        innerJsonNode.add("入职申请");
        innerJsonNode.add("同意");
        rootNode.add(innerJsonNode);

        // 第三个表格控件赋值
        arrayNode.insert(2,rootNode);
        System.out.println("parmImpl:"+mapper.writeValueAsString(arrayNode));
        return mapper.writeValueAsString(arrayNode).getBytes(StandardCharsets.UTF_8);
    }

}

打包

将程序和依赖 jar 分离打包

  • 程序保存 ./jar/co/ 目录下
  • 依赖保存 ./jar/lib/ 目录下
xml
<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>

  <groupId>com.kanq</groupId>
  <artifactId>co-service-ext</artifactId>
  <version>1.0.1</version>
  <packaging>jar</packaging>

  <name>co_service_web_ext_demo</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <!-- 打包不含依赖jar -->
  <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

  <!-- 依赖包导出lib文件夹下 -->
  <build>
        <finalName>Ext</finalName>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>2.1.2.RELEASE</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <!--<fork>true</fork>-->
                    <layout>ZIP</layout>
                    <includes>
                        <include>
                            <!-- 排除所有Jar -->
                            <groupId>nothing</groupId>
                            <artifactId>nothing</artifactId>
                        </include>
                    </includes>
                </configuration>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-dependency-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>copy-dependencies</goal>
                        </goals>
                        <configuration>
                            <!-- ${project.build.directory}是maven变量,内置的,表示target目录,如果不写,将在跟目录下创建/lib -->
                            <outputDirectory>${project.build.directory}/lib</outputDirectory>
                            <!-- excludeTransitive:是否不包含间接依赖包,比如我们依赖A,但是A又依赖了B,我们是否也要把B打进去 默认不打-->
                            <excludeTransitive>false</excludeTransitive>
                            <!-- 复制的jar文件去掉版本信息 true去掉 false 不去-->
                            <stripVersion>false</stripVersion>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>
<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>

  <groupId>com.kanq</groupId>
  <artifactId>co-service-ext</artifactId>
  <version>1.0.1</version>
  <packaging>jar</packaging>

  <name>co_service_web_ext_demo</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <!-- 打包不含依赖jar -->
  <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

  <!-- 依赖包导出lib文件夹下 -->
  <build>
        <finalName>Ext</finalName>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>2.1.2.RELEASE</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <!--<fork>true</fork>-->
                    <layout>ZIP</layout>
                    <includes>
                        <include>
                            <!-- 排除所有Jar -->
                            <groupId>nothing</groupId>
                            <artifactId>nothing</artifactId>
                        </include>
                    </includes>
                </configuration>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-dependency-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>copy-dependencies</goal>
                        </goals>
                        <configuration>
                            <!-- ${project.build.directory}是maven变量,内置的,表示target目录,如果不写,将在跟目录下创建/lib -->
                            <outputDirectory>${project.build.directory}/lib</outputDirectory>
                            <!-- excludeTransitive:是否不包含间接依赖包,比如我们依赖A,但是A又依赖了B,我们是否也要把B打进去 默认不打-->
                            <excludeTransitive>false</excludeTransitive>
                            <!-- 复制的jar文件去掉版本信息 true去掉 false 不去-->
                            <stripVersion>false</stripVersion>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

注意

  • 新接口需重启 co-service 后才能生效

启动服务

扩展开发注册成功如下:

20250226112928

注意

  • co-service 日志级别为 调试
  • 测试表单扩展指令

设置扩展指令前显示

20250226111926

设置扩展指令后显示

20250226112516

DEMO 代码下载

本示例代码在 com.kanq.FormDemo 类中的 setCtrlValue 方法

Powerd by Vitepress.