主数据数据订阅API接口开发示例

主数据订阅配置

在[主数据管理/主数据维护]页面中，点击表名链接，进入主数据维护页面，选择<订阅配置>页签后，单击<新增>按钮，如下图所示。

图-1

配置参数，各参数的说明如下：

订阅者：即业务系统，在<工程配置><标签管理>中创建。

状态：分为“启用”和“停用”，状态为启用时，此订阅配置才能生效。

失败重试次数：如果接口调用失败，则会重试，此处配置为重试的次数。

重试时间间隔：接口调用失败后，下次重试调用的时间间隔。

接口URL：有效的http url，具体接口详情在下面的接口开发中详细说明。

接口用户名：http url的访问用户。

接口密码：http url的访问用户的密码。

接口描述：描述信息。

日志保留时长：调用接口的日志信息保留的时间，默认30天，调用接口日志在<主数据管理><订阅日志>菜单中查看。

以上信息配置完成后，可以通过单击<测试接口>按钮，测试接口连通性。

单击<确定>按钮后，配置完成。

之后当对主数据表进行增删改时，设置的http接口就会接收到数据的变更信息，调用接口的成功与失败，也可以在[主数据管理/订阅日志]页面中查看，如下图所示。

图-2 查看主数据变更

接口开发

订阅接口是一个标准的Rest接口，其中参数和返回值是固定的，本节将介绍各参数的示例。

请求类型

必须是Post请求。

参数

1. Body传参

参数格式如下所示：

{

"data": "[{\"id\":4,\"name\":\"eeee\",\"age\":\"22\",\"salary\":20000}]",

"message": "数据源:master_mysql 模式:test3 表:master_data_source 新增1条数据 ",

"operation": "INSERT",

"record": 1,

"tableId": 1612326702435098600

}

其中参数说明如下：

data：变更的数据，json字符串类型

operation：数据变更类型INSERT,UPDATE,DELETE

message：变更数据的表信息描述

参数类如下所示：

import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
import lombok.Data;
@Data
public class MasterdataNoticeBody {
    @JsonSerialize(using = ToStringSerializer.class)
    private Long tableId;
    private String operation;
    private Long record;
    private String remark;
    private String message;
    private String data;
}

2. 返回值

DataassetResponse

返回值java类：

import lombok.Data;
@Data
public class DataassetResponse {
    private String code;
    private String msg;
    private Object data;
    private String level;

    public DataassetResponse(String level) {
        if(null == level || "".equals(level)){
            this.code = "";
            this.msg = "SUCCESS";
            this.level = "success";
            this.data = null;
        }else {
            this.code = "";
            this.msg = level.toUpperCase();
            this.level = level;
            this.data = null;
        }
    }
}

示例

以下是使用spring开发的接口示例：

@PostMapping("/testForLog")
public DataassetResponse testForLog(@RequestBody MasterdataNoticeBody masterdataNoticeBody) {
    //打印参数信息
    String jsonString = JSON.toJSONString(masterdataNoticeBody);
    log.info("masterdataNoticeBody is: {}", jsonString);
    /*
    接收到数据后的具体业务逻辑
     */
    return new DataassetResponse("success");
}