这篇文章是半封装接口中先查询标准接口后再推送给外系统的开发手册。主要用于项目二开开发人员可以根据已封装代码开发完整的推送接口。 ![image.png](http://tmpbbs.ztc.ztccloud.com.cn:6875/developers-server/rest/file/group1/2024/07/03/9F46917F0934E366C718B1B7B2AE14A3.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) 根据第三方的条件，获取短信消息数据，然后推送到第三方的接口三、执行短信信息推送定时任务，执行后调用 cn.ztessc.service.api.sync.AbsSyncService#syncData 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; } } ``` 1 cn.ztessc.service.api.sync.AbsSyncService#getQueryParams，这个方法组装查询支付指令信息 ``` protected PaymentInstructionSyncDTO getQueryParams(IpcJobParamDto ipcJobParamDto) { String params = ipcJobParamDto.getParams(); JSONObject paramsJson = new JSONObject(); if (JSONUtil.isJsonObj(params)) { try { //Project Development Point 项目根据实际需要对接口进行传参不需要的参数删除 paramsJson = JSONUtil.parseObj(params); } catch (Exception ignored) { log.error("转换json异常，params:{},e:{}",params,ignored); } } paramsJson.set("createDate_START","2024-06-01"); paramsJson.set("createDate_END","2024-07-01"); paramsJson.set("paymentStatus_IN","10"); paramsJson.set("limit","1000"); paramsJson.set("page","1"); PaymentInstructionSyncDTO dto = ObjUtil.newInstance(PaymentInstructionSyncDTO.class); PaymentInstructionSyncItemDTO itemDTO = ObjUtil.newInstance(PaymentInstructionSyncItemDTO.class); itemDTO.setSobCode_EQ(Optional.ofNullable(paramsJson.getStr("sobCode_EQ")).orElse("")); itemDTO.setPaymentModeCode_IN(Optional.ofNullable(paramsJson.getStr("paymentModeCode_IN")).orElse("")); itemDTO.setPayerBankAccountName_IN(Optional.ofNullable(paramsJson.getStr("payerBankAccountName_IN")).orElse("")); itemDTO.setPaymentAmount_DTR(Optional.ofNullable(paramsJson.getStr("paymentAmount_DTR")).orElse("")); itemDTO.setCreateDate_START(Optional.ofNullable(paramsJson.getStr("createDate_START")).orElse("")); itemDTO.setPaymentStatus_IN(Optional.ofNullable(paramsJson.getStr("paymentStatus_IN")).orElse("")); itemDTO.setPaymentAmount_DTL(Optional.ofNullable(paramsJson.getStr("paymentAmount_DTL")).orElse("")); itemDTO.setVendorCode_IN(Optional.ofNullable(paramsJson.getStr("vendorCode_IN")).orElse("")); itemDTO.setOnOffLine_EQ(Optional.ofNullable(paramsJson.getStr("onOffLine_EQ")).orElse("")); itemDTO.setPayerBankAccountNum_IN(Optional.ofNullable(paramsJson.getStr("payerBankAccountNum_IN")).orElse("")); itemDTO.setPaymentNo_IN(Optional.ofNullable(paramsJson.getStr("paymentNo_IN")).orElse("")); itemDTO.setBoeNo_IN(Optional.ofNullable(paramsJson.getStr("boeNo_IN")).orElse("")); itemDTO.setBoeTypeCode_IN(Optional.ofNullable(paramsJson.getStr("boeTypeCode_IN")).orElse("")); itemDTO.setLeCode_EQ(Optional.ofNullable(paramsJson.getStr("leCode_EQ")).orElse("")); itemDTO.setSourceSysCode_EQ(Optional.ofNullable(paramsJson.getStr("sourceSysCode_EQ")).orElse("")); itemDTO.setGatherBankAccountNum_IN(Optional.ofNullable(paramsJson.getStr("gatherBankAccountNum_IN")).orElse("")); itemDTO.setCurrencyCode_EQ(Optional.ofNullable(paramsJson.getStr("currencyCode_EQ")).orElse("")); itemDTO.setLimit(Optional.ofNullable(paramsJson.getStr("limit")).orElse("")); itemDTO.setCreateDate_END(Optional.ofNullable(paramsJson.getStr("createDate_END")).orElse("")); itemDTO.setPage(Optional.ofNullable(paramsJson.getStr("page")).orElse("")); itemDTO.setEmployeeCode_IN(Optional.ofNullable(paramsJson.getStr("employeeCode_IN")).orElse("")); itemDTO.setGroupCode(Optional.ofNullable(paramsJson.getStr("groupCode")).orElse("")); dto.setData(itemDTO); return dto; } ``` 2 cn.ztessc.service.api.query.AbsQueryApi#queryData 根据之前的配置组装参数调用支付指令查询接口 ``` public R queryData(T t) { // 第一步，先获取配置的接口参数 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); } ``` 2.1 cn.ztessc.service.api.query.AbsQueryApi#transRequestParam 调用部分标准接口需要用到集团编码，可以再接口参数中添加集团编码 ``` protected PaymentInstructionSyncDTO transRequestParam(PaymentInstructionSyncDTO syncDTO, Map headers, IpcInterfaceDTO interfaceInfo) { String groupCode = getGroupCodeFromInterfaceInfo(interfaceInfo); PaymentInstructionSyncItemDTO itemDTO = syncDTO.getData(); itemDTO.setGroupCode(groupCode); syncDTO.setData(itemDTO); return syncDTO; } ``` 3 cn.ztessc.service.api.sync.AbsSyncService#filterQueryResponse 过滤部分不需要同步的数据（二开根据需求可以重写这个方法） 4 cn.ztessc.service.api.sync.AbsSyncService#transSyncParamsFromQueryResponse 将第三方系统请求的结果转成标准接口的入参(二开可以在此处调试入参) 5 cn.ztessc.service.api.sync.AbsSyncService#beforeSyncData 支付指令推送前更新支付指令状态 ``` public void beforeSyncData(Object pushData, Object queryResponse) { PaymentInstructionResDTO responseDTO = (PaymentInstructionResDTO) queryResponse; SyncPaymentStatusPushDTO pushDTO = ObjUtil.newInstance(SyncPaymentStatusPushDTO.class); List pushList = new ArrayList<>(); if(IpcInterfaceClientEnums.Status.SUCCESS.getCode().equals(responseDTO.getCode())){ PaymentInstructionResItemDTO itemDTO = responseDTO.getData(); if(Objects.nonNull(itemDTO)) { List resDataItem = itemDTO.getData(); Integer rowNum = 1; if (CollUtil.isNotEmpty(resDataItem)) { for (PaymentInstructionResDataItemDTO paymentInstructionResDataItemDTO : resDataItem) { SyncPaymentStatusPushItemDTO syncPaymentStatusPushItemDTO = ObjUtil.newInstance(SyncPaymentStatusPushItemDTO.class); syncPaymentStatusPushItemDTO.setPaymentStatus(PAYMENT_STATUS_SENDING); syncPaymentStatusPushItemDTO.setPaymentNo(paymentInstructionResDataItemDTO.getPaymentNo()); syncPaymentStatusPushItemDTO.setRowNum(String.valueOf(rowNum)); rowNum++; pushList.add(syncPaymentStatusPushItemDTO); } } } } pushDTO.setData(pushList); //调用支付指令更新接口更新指令状态为"推送中" paymentInstructionStatusPushApi.pushData(pushDTO); } ``` 6 cn.ztessc.service.api.sync.AbsSyncService#getPushApi 获取推送支付指令的Api 包含了tokenService(二开修改) 、接口编码、响应处理(二开修改) 6.1cn.ztessc.service.api.token.AbsTokenApi 二开需要实现这个类，处理调用外系统的请求token信息。 ![image.png](http://tmpbbs.ztc.ztccloud.com.cn:6875/developers-server/rest/file/group1/2024/07/09/9F46917FFFFFFF18D543C998B1B7B2AE1549.png) 7 cn.ztessc.service.api.push.IPushApi#pushData 根据组装的参数调用短信信息推送 ``` // 第一步，先获取配置的接口参数 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); ``` 8 cn.ztessc.service.api.sync.AbsSyncService#afterSyncData 调用短信状态更新接口 ``` public class AbsSMSMessagePushSyncService extends AbsSyncService{ private static final Logger log = LoggerFactory.getLogger(AbsSMSMessagePushSyncService.class); /** * 0-待发送，1-发送成功，2-发送失败，3-发送中。推送状态只能从0更新为3，或者从3更新为1或2 */ private String STATUS_1 = "1"; private String STATUS_2 = "2"; private String STATUS_3 = "3"; @Resource private SMSMessageQueryApi sMSMessageQueryApi; @Resource private SMSMessagePushApi sMSMessagePushApi; @Resource private SMSMessageStatusPushApi sMSMessageStatusPushApi; @Override protected IQueryApi getQueryApi() { return sMSMessageQueryApi; } @Override protected IPushApi getPushApi() { return sMSMessagePushApi; } // Project Development Point 项目开发点 // 这里是请求产品的接口平台数据，组装参数下面有写例子，可以参考， // ipcJobParamDto 里面的 params 参数需要在定时器的接口参数内自行配置 @Override protected Object getQueryParams(IpcJobParamDto ipcJobParamDto) { String params = ipcJobParamDto.getParams(); JSONObject paramsJson = new JSONObject(); if (JSONUtil.isJsonObj(params)) { try { //todo 项目根据实际需要进行传参不需要的参数删除 paramsJson = JSONUtil.parseObj(params); } catch (Exception ignored) { log.error("转换json异常，params:{},e:{}",params,ignored); } } SMSMessageSyncDTO dto = ObjUtil.newInstance(SMSMessageSyncDTO.class); SMSMessageItemSyncDTO itemDTO = ObjUtil.newInstance(SMSMessageItemSyncDTO.class); itemDTO.setCreateDateEnd(Optional.ofNullable(paramsJson.getStr("createDateEnd")).orElse("")); itemDTO.setCreateDateStart(Optional.ofNullable(paramsJson.getStr("createDateStart")).orElse("")); itemDTO.setStatus(Optional.ofNullable(paramsJson.getStr("status")).orElse("")); itemDTO.setTemplateCode(Optional.ofNullable(paramsJson.getStr("templateCode")).orElse("")); itemDTO.setType(Optional.ofNullable(paramsJson.getStr("type")).orElse("")); itemDTO.setLimit(Optional.ofNullable(paramsJson.getStr("limit")).orElse("")); itemDTO.setPage(Optional.ofNullable(paramsJson.getStr("page")).orElse("")); dto.setData(itemDTO); return dto; } @Override protected Object transSyncParamsFromQueryResponse(Object queryResponse) { return queryResponse; } @Override public void beforeSyncData(Object pushData, Object queryResponse) { SMSMessageResDTO responseDTO = (SMSMessageResDTO) queryResponse; SMSMessageStatusPushDTO pushDTO = ObjUtil.newInstance(SMSMessageStatusPushDTO.class); List pushList = new ArrayList<>(); if(IpcInterfaceClientEnums.Status.SUCCESS.getCode().equals(responseDTO.getCode())){ SMSMessageResItemDTO itemDTO = responseDTO.getData(); if(Objects.nonNull(itemDTO)) { List resDataItem = itemDTO.getData(); Integer rowNum = 1; if (CollUtil.isNotEmpty(resDataItem)) { for (SMSMessageResDataItemDTO SMSMessageResDataItemDTO : resDataItem) { SMSMessageStatusPushItemDTO syncPaymentStatusPushItemDTO = ObjUtil.newInstance(SMSMessageStatusPushItemDTO.class); syncPaymentStatusPushItemDTO.setId(SMSMessageResDataItemDTO.getId()); // 发送中 syncPaymentStatusPushItemDTO.setStatus(STATUS_3); syncPaymentStatusPushItemDTO.setRowNum(String.valueOf(rowNum)); rowNum++; pushList.add(syncPaymentStatusPushItemDTO); } } } } pushDTO.setData(pushList); //调用消息推送状态更新接口修改为"发送中" sMSMessageStatusPushApi.pushData(pushDTO); } // Project Development Point 项目开发点 // 数据传递到第三方平台后，根据对方返回的状态修改是发送成功还是发送失败，可以仿照上门写法，更改状态 } ```

半封装接口-短信消息推送接口推送接口开发文档

半封装接口-短信消息推送接口推送接口开发文档

关于作者

目录