这篇文章是半封装接口中拉取外系统数据后再推送回新云标准接口的开发手册. 主要用于项目二开开发人员可以根据已封装代码开发完整的拉取数据 ![image.png](http://tmpbbs.ztc.ztccloud.com.cn:6875/developers-server/rest/file/group1/2024/07/02/9F46917FFFFFD4AF2B927000B1B7B2AE1495.png) 根据图示拉取接口半封装主要做了以下工作：一、定时任务预制预制的定时任务作为拉取接口入口。 ![image.png](http://tmpbbs.ztc.ztccloud.com.cn:6875/developers-server/rest/file/group1/2024/07/09/9F46917FFFFFF6D034AFEF74B1B7B2AE1526.png) 二、接口预制 1 预制所有需要拉取的接口，拉取外系统的需要在接口参数中自行配置拉取信息地址 2 预制了产品的推送信息接口，根据外系统查到的数据推送到该接口。 3 需要根据实际情况配置获取外系统查询接口所需的token查询接口。 4 产品配置了查询产品token的接口 ![image.png](http://tmpbbs.ztc.ztccloud.com.cn:6875/developers-server/rest/file/group1/2024/07/09/9F46917FFFFFFA4A6790203AB1B7B2AE1533.png) ![image.png](http://tmpbbs.ztc.ztccloud.com.cn:6875/developers-server/rest/file/group1/2024/07/09/9F46917FFFFFFA3E7F1C35A9B1B7B2AE1532.png) 5 根据预制的查询接口，二开需要在页面编辑或者通过liquibase配置请求外系统的url。 ![image.png](http://tmpbbs.ztc.ztccloud.com.cn:6875/developers-server/rest/file/group1/2024/07/02/9F46917FFFFFD5D58E94BF28B1B7B2AE1498.png) 6、如需要同步外系统数据到产品中，需要在接口管理的授权管理中进行配置，根据接口客户端中推送接口的URL，授权对应的产品接口 ![image.png](http://tmpbbs.ztc.ztccloud.com.cn:6875/developers-server/rest/file/group1/2024/09/11/1830A2CEFFFF892E484F977BB1B7B2AE0424.png) 三、自定义维度明细同步接口调用流程梳理自定义维度明细同步，需要查询外系统的客商消息，之后再推送产品标准同步接口。此时执行定时任务，执行后调用syncData方法 cn.ztessc.service.api.sync.AbsSyncService#syncData ``` public Integer syncData(IpcJobParamDto ipcJobParamDto) { // 第一步，获取请求参数 QT queryParams = getQueryParams(ipcJobParamDto); // 第二步，开始查询数据 QR queryResponse = getQueryApi().queryData(queryParams); if (ObjectUtil.isEmpty(queryResponse)) { return 0; } // 第三步，过滤数据 queryResponse = filterQueryResponse(queryResponse); if (ObjectUtil.isEmpty(queryResponse)) { if (queryResponse instanceof Collection) { return ((Collection) queryResponse).size(); } else { return 1; } } // 第三步，将查询到的数据转化成需要同步的数据 PT pushData = transSyncParamsFromQueryResponse(queryResponse); if (ObjectUtil.isEmpty(pushData)) { if (queryResponse instanceof Collection) { return ((Collection) queryResponse).size(); } else { return 1; } } // 这里判断是否是集合，如果是集合需要判断是否超过同步条数 int limitSize = getPushApi().limitSize(); if (pushData instanceof List && ((List) pushData).size() > limitSize) { List split = (List) CollUtil.split((List) pushData, limitSize); for (PT splitData : split) { // 第四步，执行同步前处理 beforeSyncData(splitData, queryResponse); // 第五步，开始同步数据 PR pushResponse = getPushApi().pushData(splitData); // 第六步，执行同步后处理 afterSyncData(pushResponse, splitData, queryResponse); } } else { // 第四步，执行同步前处理 beforeSyncData(pushData, queryResponse); // 第五步，开始同步数据 PR pushResponse = getPushApi().pushData(pushData); // 第六步，执行同步后处理 afterSyncData(pushResponse, pushData, queryResponse); } if (queryResponse instanceof Collection) { return ((Collection) queryResponse).size(); } else { return 1; } } ``` syncData方法是整个调用过程中的主方法，现在对各个步骤的主要方法做出说明其中标注了Project Development Point 表明是二开改造点 1 cn.ztessc.service.api.sync.AbsCustomDimensionSyncService#getQueryParams，这个方法组装查询外系统入参 2 getQueryApi() 获取当前任务的查询api ![image.png](http://tmpbbs.ztc.ztccloud.com.cn:6875/developers-server/rest/file/group1/2024/07/09/9F46917FFFFFF85BB1E441E3B1B7B2AE152C.png) 2.1 CustomDimensionQueryApi包含了tokenService(二开修改) 、接口编码、响应处理(二开修改) ![image.png](http://tmpbbs.ztc.ztccloud.com.cn:6875/developers-server/rest/file/group1/2024/10/24/1830A2CEFFFFC9A08D4EC1F1B1B7B2AE0833.png) 2.2 cn.ztessc.service.api.token.AbsTokenApi 二开需要实现这个类，处理调用外系统的请求token信息。 ![image.png](http://tmpbbs.ztc.ztccloud.com.cn:6875/developers-server/rest/file/group1/2024/07/09/9F46917FFFFFFB308A3363DBB1B7B2AE1536.png) 2.3 此处实现具体的封装请求头逻辑 ![image.png](http://tmpbbs.ztc.ztccloud.com.cn:6875/developers-server/rest/file/group1/2024/07/09/9F46917FFFFFF92BAF333FEAB1B7B2AE1531.png) 3 cn.ztessc.service.api.query.AbsQueryApi#queryData 根据之前的配置组装参数查询第三方系统的逻辑 ``` // 第一步，先获取配置的接口参数 IpcInterfaceDTO interfaceInfo = getInterfaceInfo(); // 第二步，获取token Map headers = getTokenApi().getHeaders(); // 第三步，转换请求参数 T requestParam = transRequestParam(t, headers, interfaceInfo); // 第四步，解析url String url = getUrlFromInterfaceInfo(interfaceInfo); // 第五步，请求url，并保存日志 return queryDataFromUrl(interfaceInfo, url, requestParam, headers); ``` 4 cn.ztessc.service.api.sync.AbsSyncService#filterQueryResponse 过滤部分不需要同步的数据（二开根据需求可以重写这个方法） 5 cn.ztessc.service.api.sync.AbsCustomDimensionSyncService#transSyncParamsFromQueryResponse 将第三方系统请求的结果转成标准接口的入参(**此处定义的PushDTO对象为产品标准接口需要的入参，二开可根据实际情况将查询接口返回的数据，转换为产品标准接口需要的数据**) 6 cn.ztessc.service.api.sync.AbsSyncService#beforeSyncData 同步接口前置操作，可以根据实际情况进行处理 7 cn.ztessc.service.api.sync.AbsSyncService#getPushApi 获取当前任务的推送api 8 cn.ztessc.service.api.push.AbsPushApi#pushData 根据配置的参数调用调用推送接口 ``` public R pushData(T params) { // 第一步，先获取配置的接口参数 IpcInterfaceDTO interfaceInfo = getInterfaceInfo(); // 第二步，获取token Map headers = getTokenApi().getHeaders(); // 第三步，转换推送参数 T pushParam = transPushParam(params, headers, interfaceInfo); // 第四步，解析url String url = getUrlFromInterfaceInfo(interfaceInfo); // 第五步，请求url，并保存日志 return queryDataFromUrl(interfaceInfo, url, pushParam, headers); } ``` 9 cn.ztessc.service.api.sync.AbsSyncService#afterSyncData 同步接口后置操作，可以根据实际情况进行处理

自定义维度明细同步接口拉取接口开发文档

自定义维度明细同步接口拉取接口开发文档

关于作者

目录