[
  {
    "name": "name1",
    "label": "名称1",
    "type": "string",
    "required": true,
    "value": "1"
  },
  {
    "name": "number1",
    "label": "数量1",
    "type": "number",
    "value": 904,
    "disabled": true
  },
  {
    "name": "numberChange",
    "label": "数量加减",
    "type": "number",
    "value": 0,
    "description": "正数为增加，负数为扣减"
  }
]

{
 
    "channelVersion":"20230608.1"
    "tenantId": 12,
    "batchId": "sms-1234",
    "campaignUuid": "123123123123",
    "audienceInfo": {
        "listId": 123,
        "objId": "c_car",
        "audienceFilter": {},
        "sendIdentity": "customer",
        "audienceIdType": "mobile"
    },
    "channelPluginInstanceInfo": {
        "channelType": "sms",
        "pluginVersionId": 123123,
        "messagingType": "sending_sms",
        "accountInfo": {
            "channelTunnelInfo": {
                "tunnelId": 12312312,
                "additional": {
                    "quotaPoolId": 123123
                }
            },
            "channelInstanceInfo": {
                "channelInstanceId": 12312312,
 
                "additional": {
                    "quotaPoolId": 123123
                }
            }
        }
    },
    "templateInfo": {
        "templateId": 1234
    },
    "predicateInfo": {
        "isMock": false,
        "skipDnd": true,
        "pipl": []
    },
    "task": {},
    "additionalInfo": {
        "wechatAppUrlId": 1231
    },
    "date": "(UTC)"
}

├── Dockerfile    # Docker Image 构建文件

├── README

├── build.gradle    # Gradle 项目构建配置文件

├── gradle    # Gradle Wrapper 项目工具

│     └── wrapper

├── gradlew    # Gradle Wrapper 本地脚本

├── gradlew.bat   # Gradle Wrapper 本地批处理脚本

├── settings.gradle    # Gradle 项目构建多模块配置文件

└── src    # 代码工作空间目录

      ├── main

      │    ├── java

      │    │    └── com

      │    │     └── convertlab

      │    │            └── application

      │    │               └── scaffold

      │    │                   ├── ScaffoldApplication.java

      │    │                   ├── client

      │    │                   ├── config

      │    │                   ├── consts

      │    │                   ├── controller

      │    │                   ├── job

      │    │                   ├── mapper

      │    │                   ├── model

      │    │                   └── service

      │    └── resources

      │        ├── application.yml    # Spring 项目配置文件

      │        ├── db    # 数据库初始化及升级相关

      │        │    ├── changelog-master.yml # Liquibase 数据库 changelog 配置

      │        │    └── default-init.sql    # 项目数据库初始化脚本，被 changelog-master.yml 所引用

      │        ├── env\_vars.conf    # 项目环境变量配置，被 reference.conf 所引用

      │        ├── logback-spring.xml    # logback 配置文件

      │        └── reference.conf    # 支持 HOCON 方式的项目配置

      └── test    # 项目测试工作目录

spring:

    application:

      # 服务名，根据应用进行重写命令

      name: sms-scaffold

    main:

      allow-bean-definition-overriding: true

    # springboot kafka 配置

    kafka:

      bootstrap-servers: ${kafkaServer\_bootstrap\_servers:localhost:9092}

...

    # springboot redis 配置

    redis:

      host: ${redis\_host:localhost}

      port: ${redis\_port:6379}

     password: ${redis\_password:}

      ssl: ${redis\_enableSsl:false}

...

    # mysql 配置

    datasource:

      driver-class-name: com.mysql.cj.jdbc.Driver

      url: ${dataSource\_url:jdbc:mysql://localhost:3306/xiaoshu?useunicode=true&characterencoding=utf8&servertimezone=utc}

      username: ${dataSource\_username:root}

      password: ${dataSource\_password:root}

    # liquibase yml路径配置

    liquibase:

      change-log: classpath:db/changelog-master.yml

## Scaffold 里面使用到的 openFeign 配置

feign:

    client:

      config:

        default:

          # 根据环境需要调整日志等级，目前为全日志

          loggerLevel: full

    # 默认启用 okhttp 作为 http client, 可根据需要调整 client 实现

    okhttp:

      enabled: true

    # 请求代理配置，调整该配置，可改变 SDK 请求代理

    proxyConfig:

      host:

      port:

      username:

      password:

dmHubOpenApi:

    serverUrl: "https://master-api.dmhub.cn"

    appId: ""

    secret: ""

# internal 服务的地址配置

## 私有部署需要配置如果用了这个：InternalCustomerFeignClient，需要配置 customer 服务的地址

customerService:

    serverUrl: ${customer\_internal\_url:http://127.0.0.1:8009}

channelServer:

    serverUrl: ${engage-channel\_internal\_url:localhost:9189}

# internal 服务的地址配置

internalService:

    serverUrl: ${internalapi\_internal\_url:http://internalapi.dmhub.cn}

pluginManagement {

      repositories {

          gradlePluginPortal()

          // xsio 仓库为 convertlab 私有仓库，SDK Gradle 插件相关 maven 依赖位于该仓库下

          maven {

              def branch = System.getProperty("branch") ?: "master"

              def repo = branch == "master" ? "xsio-test" : "xsio-jar"

              url "http://nexus.xsio.cn/repository/${repo}"

              allowInsecureProtocol true

              credentials {

                  username mavenUser

                  password mavenPassword

              }

          }

      }

}

// 重命名自己的项目名

rootProject.name = "sms-scaffold"

...

plugins {

      id 'org.springframework.boot' version "${springBootVersion}"

      id 'io.spring.dependency-management' version "1.0.11.RELEASE"

      // convertlab 插件工具，引入该工具会自动进行maven 仓库和基础依赖管理

      id 'com.convertlab.convention.repositories-declaration' version "${convertlabGradleConventionVersion}"

      // convertlab 插件工具，引入该工具会自动进行maven 仓库和基础依赖管理

      id 'com.convertlab.convention.application' version "${convertlabGradleConventionVersion}"

      id "com.github.shalousun.smart-doc" version "2.4.2"

      id 'java'

}

...
bootJar {

      // 更改该产物包名，该产物包名，会在 Dockerfile 中被使用

      archiveBaseName = 'engage-sms'

      archiveVersion = 'latest'

}

...

#目前项目基于 jdk8 环境，如有特殊运行环境要求，根据实际需要调整base image

FROM registry.cn-hangzhou.aliyuncs.com/clab-docker/alpine-oraclejdk8:latest

WORKDIR /opt/

# WAR 为 build.gradle 构建产物包名，需和gradle构建产物配置 bootJar.archiveBaeName (-latest 为 archiveVersion 后缀版本)保持一致

ENV WAR=sms-scaffold-latest.jar \

      ENV=test \

# SERVICE\_NAME 为运行时所使用微服务名

      SERVICE\_NAME=sms-scaffold \

# 运行环境的动态库PATH基础路径，如未有特殊引入其他动态库路径，不需要进行调整

      LD\_LIBRARY\_PATH=/lib:/usr/lib/gcc/x86\_64-alpine-linux-musl/6.4.0

COPY build/libs/${WAR} /opt/

RUN apk --no-cache add libstdc++6

CMD ["./start.sh"]

@EnableCaching

@EnableFeignClients(

          basePackages = {

                  "com.convertlab.channel.*", // Scaffold-Sdk 路径

                  "com.convertlab.application.*", // 渠道应用自身路径

          }

)

@EnableEncryptableProperties

@SpringBootApplication

@ComponentScan(basePackages = {

          "com.convertlab.application.*",// 渠道应用自身路径

          "com.convertlab.channel.scaffold.sdk.*",// Scaffold-Sdk 路径

          "com.convertlab.spring.akka"// Message-Engine-Sdk 需要的配置

})

@MapperScan(value = {

          "com.convertlab.application.sms.mapper",

          "com.convertlab.channel.scaffold.sdk.mapper",// Scaffold-Sdk 路径

})

public class Application {

      public static void main(String[] args) {

          SpringApplication.run(Application.class, args);

      }

}

@RestController

public class ExtChannelTemplateController implements ExtChannelTemplateApi {

      // 创建模板行为

      // POST  /{channelType}/ext/templates

      @Override

      public ChannelTemplateDTO create(String channelType, String tunnelKey, ChannelTemplateDTO req) {

...

      }

      // 删除模板行为

      // DEL  /{channelType}/ext/templates/{id}

      @Override

      public Boolean delete(String channelType, String tunnelKey, Long id) {

...

      }

      // 更新模板行为

      // PUT /{channelType}/ext/templates/{id}

      @Override

      public Boolean update(String channelType, String tunnelKey, Long id, ChannelTemplateDTO req)  {

...

      }

}

@Component
public class EMaySMSChannelSender extends AbstractHttpChannelSender {
    @Resource
    private SMSEventService smsEventService;
    ...
    // 提供匹配的渠道应用事件记录事件服务，AbstractEventService 提供了几种渠道的基础实现 SMSEventService
    // MMSEventService 等，也可根据事件记录需要实现 AbstractEventService
    @Override
    public AbstractEventService<?> getEventService() {
        return this.smsEventService;
    }
 
    ...
    /**
     * 初始化ScaffoldConfig PluginCode、VendorCode配置
     */
    @Override
    public ScaffoldConfigPayload initScaffoldConfigPayload() {
        ScaffoldConfigPayload scaffoldConfigPayload = super.initScaffoldConfigPayload();
        // 设置 ScaffoldConfig 信息
        scaffoldConfigPayload.setPluginCode("engage-sms");
        scaffoldConfigPayload.setConfigMapVendorCode("emay-sms");
        return scaffoldConfigPayload;
    }
...
    // 实现供应商请求体构建逻辑，该逻辑中主要实现  ScaffoldChannelMessageDTO 请求信息验证，并生成新的请求信息 ValidVendorRequestDTO。
    @Override
    public ValidVendorRequestDTO<ChannelHttpRequest> buildRequest(ScaffoldChannelMessageDTO scaffoldChannelMessage) {
       ....
       // scaffoldChannelMessage rows 需要维护
       // 更新有效 row，只放有效的 row
       scaffoldChannelMessage.setRows(validRowsDataList);
       return new ValidVendorRequestDTO<>(
                        // 通过 ChannelHttpRequest 构建请求信息
                        ChannelHttpRequest.POST(endpoint + "/vms/message/send").withUrlEncodedForm(queryMap).withHeaders(headerMap),
                        //  scaffoldChannelMessage 中验证失败导致无法作为 ChannelHttpRequest 合法请求的数据
                        invalidRowsDataList,
                        null
           );
     }
    ...
    // 实现对发送后Response的响应处理，如响应信息被供应商所加密，需要通过该接口进行解密，返回正确的response
    @Override
    @SneakyThrows
    public String buildResponseData(ScaffoldChannelMessageDTO scaffoldChannelMessage, ChannelHttpResponse response) {
       ...
       // 处理reponse 可能的结果校验、解密、解压等内容，断言返回res
       return res;
    }
    ...
 
    // 对 buildResponseData  结果进行校验，如果当前结果视为成功应该返回 true，否则 false，事件将根据该状态判断是否发送成功
    @Override
    public boolean predicateResponse(String response, ScaffoldChannelMessageDTO scaffoldChannelMessage) {
       ...
    }
    
}

@Service
public class AliYunSDKChannelSender extends AbstractScaffoldChannelSender<SendBatchSmsRequest, SendBatchSmsResponse>{
    ...
    // 供应商提供的 Http Client 工具
    @Resource
    private com.aliyun.dysmsapi20170525.Client client;
 
    @Resource
    private SMSEventService smsEventService;
    ...
    /**
     * 初始化ScaffoldConfig PluginCode、VendorCode配置
     */
    @Override
    public ScaffoldConfigPayload initScaffoldConfigPayload() {
        ScaffoldConfigPayload scaffoldConfigPayload = super.initScaffoldConfigPayload();
        scaffoldConfigPayload.setPluginCode(ScaffoldConsts.SMSPlugin.CODE);
        scaffoldConfigPayload.setConfigMapVendorCode(ScaffoldConsts.SMSPlugin.VendorCode.ALI_YUN);
        return scaffoldConfigPayload;
    }
    ...
    // 提供匹配的渠道应用事件记录事件服务，AbstractEventService 提供了几种渠道的基础实现 SMSEventService
    // MMSEventService 等，也可根据事件记录需要实现 AbstractEventService
    @Override
    public AbstractEventService<?> getEventService() {
        return this.smsEventService;
    }
    ...
 
    // 根据 ScaffoldChannelMessageDTO 所提供的 rows 期望发送的数据，对有效数据进行过滤，返回对应请求体的构造
    // 到ValidVendorRequestDTO 中
    @Override
    public ValidVendorRequestDTO<SendBatchSmsRequest> buildRequest(ScaffoldChannelMessageDTO scaffoldChannelMessage){
        ...
        // scaffoldChannelMessage rows 需要维护
        // 更新有效 row，只放有效的 row
        scaffoldChannelMessage.setRows(validRowsDataList);
        // SendBatchSmsRequest 为自定义封装的请求信息，将必要的请求信息进行设置，并设置到 ValidVendorRequestDTO 中，进行传递。
        return new ValidVendorRequestDTO<>(new SendBatchSmsRequest()
                .setTemplateCode(templateCode)
                .setSignNameJson(JacksonUtils.toJSONString(signNameList))
                .setPhoneNumberJson(JacksonUtils.toJSONString(phoneNumberList))
                .setTemplateParamJson(JacksonUtils.toJSONString(templateParamList)),
                //  scaffoldChannelMessage 中验证失败导致无法作为 ChannelHttpRequest 合法请求的数据
                invalidRowsDataList,
                null);        
    }
 
    ...
     
    // 由于 Request、Response 为自定义数据体，需要开发者自己根据上下文参数，包装 PartialEventResultDTO 事件对象，用于客户事件
    // 跟踪
    @Override
    public PartialEventResultDTO responseToEvents(SendBatchSmsResponse providerRes,
                                                  SendBatchSmsRequest providerReq,
                                                  ScaffoldChannelMessageDTO scaffoldChannelMessage) {
        ...
        List<Map<String, Object>> successDataList = new ArrayList<>();
        // 遍历 scaffoldChannelMessage.getRows() 每条数据，根据客户产生对每个发送对象对应的 Map<String, Object> 事件对象，
        // 添加到对应成功或失败集合对象中
        for (Map<String, Object> row : scaffoldChannelMessage.getRows()) {
            row.put(TRACK_KEY, bizId);
            Map<String, Object> tmpStoreData = getEventService().buildEventMap(acquireScaffoldConfig(), SingleScaffoldChannelMessageDTO.from(scaffoldChannelMessage,
                    SimpleScaffoldChannelMessageRowDTO.build(scaffoldChannelMessage.getBatchId(),mobile,row)
            ), acquireEventConfig().getEventMeta().getSent());
 
            successDataList.add(tmpStoreData);
        }
        ...
        // 返回事件包装
        return new PartialEventResultDTO(
                // 成功事件集合
                successDataList, 
                // 失败事件集合 
                new ArrayList<>(),
                null
    }
 
    ...
    // 实现使用供应商自己 Http Client 发送 request 信息，并返回自定义实现的 response（SendBatchSmsResponse）
    @Override
    public SendBatchSmsResponse realRequest(SendBatchSmsRequest providerReq) {
         return client.sendBatchSms(providerReq);
    }
    ...
}

@RestController
public class HttpReportCallbackController extends BaseHttpCallbackController {
    // {域名}/nc/{服务名}/callback/{渠道类型}/{供应商编码}
    @Override
    public String httpCallbackHandleBeanName(HttpServletRequest request, String channelType, String vendorKey) {
      ...
      // 返回具体实现该回执处理的Reporter 组件名
      return "eMaySMSPushModelHttpMethodReporter"
    }
 
 
    // {域名}/nc/{服务名}/e-callback/{渠道类型}/{供应商编码}
    // 该方法和 {@link  HttpReportCallbackController#httpCallbackHandleBeanName(HttpServletRequest, String, String)} 的区别仅仅在于供应商回执
    // 有时候会区分加密和非加密的情况，通过额外的路径配置来支持响应。
    @Override
    public String httpEncryptionCallbackHandleBeanName(HttpServletRequest request, String channelType, String vendorKey) {
      ...
      // 返回具体实现该回执处理的Reporter 组件名
       return "beanName"
    }
 
    // {域名}/nc/{服务名}/callback/{渠道类型}/{供应商编码}/{资源编码}
    // 相较于之前两个方法，额外提供了资源编码响应
    @Override
    public String httpCallbackHandleBeanName(HttpServletRequest request, String channelType, String vendorKey, String resourceType) {              
      ...
      // 返回具体实现该回执处理的Reporter 组件名
       return "beanName" 
    }
}

@Component(value = "eMaySMSPushModelHttpMethodReporter")
public class EMaySMSPushModelHttpMethodReporter extends AbstractPushModeReporter<HttpServletRequest, ReportDTO, Object, SingleScaffoldChannelMessageDTO> {
    ...
    @Value("${scaffold.globalConfig.kafkaConfig.peakClippingTopic.demoSmsSendReport}")
    private String eMaySendReportPeakClippingTopic;
    ...
     // 与 Sender一样，需要声明 ScaffoldConfig 配置信息
    @Override
    public ScaffoldConfigPayload initScaffoldConfigPayload() {
      ...
    }
    ...
 
    // 解析供应商回调数据为 ReportDTO，ReportDTO 将做渠道回调数据返回
    @Override
    public List<ReportDTO> parse(HttpServletRequest request) {
     ...
    }
 
    ...
    // 无论是否开启削峰，都需要实现 Kafka 消息数据反序列化
    @Override
    public List<List<ReportDTO>> deserializationForPeakClippingConsume(ConsumerRecord<String, String> consumerRecord)      {
        ...
    }
 
    ...
    // 根据回执数据，为每个客户单独创建对应客户事件（BaseEventDTO）
    // 事件对象基于 BaseEventDTO 实现，该例中 SMSMoEventDTO 为 BaseEventDTO 的短信相关事件子类
    @Override
    public Object singleWrap(SingleScaffoldChannelMessageDTO tempStoreData, ReportDTO targetData) {
            ...
            // 通过内部接口，根据租户和手机号查询对应客户id
            Long customerId = customerInternalApiServiceImpl.getCustomerId(tenantId, mobile);
            ...
            // 事件元数据获取
            ScaffoldConfig scaffoldConfig = acquireScaffoldConfig();
            String eventGroup = scaffoldConfig.getEventConfig().getEventGroup();
            EventMeta event = scaffoldConfig.getEventConfig().getEventMeta();
 
            // 当前为短信回执，当触发成功，为该客户创建短信回复事件
            SMSMoEventDTO moEventDTO = new SMSMoEventDTO();
            moEventDTO.setTenantId(tenantId);
            moEventDTO.setChannelType(ChannelTypeEnum.SMS.getCode());
            moEventDTO.setEvent(event.getReply());
            moEventDTO.setEventGroup(eventGroup);
            moEventDTO.setCustomerId(customerId);
            ...
            return moEventDTO;
    }
 
    // 回执调用，该方法需要根据callBackResultDTO 检索出之前 SingleScaffoldChannelMessageDTO 并返回，该返回值将提供给 singleWrap 接收处理。
    Override
    public SingleScaffoldChannelMessageDTO realExecute(ReportDTO callBackResultDTO) {
        ...
    }
  
    // 返回削峰 topic ，如果需要开启，则和 peakClippingConsume KafkaListener所声明的 topic 一致，否则为空，关闭削峰
    @Override
    public String getPeakClippingTopic() {
        return eMaySendReportPeakClippingTopic;
    }
 
    // peakClippingConsume 为实际削峰方法，需要通过 @KafkaListener 静态注册kafka消费者
    // 注意：所声明削峰topic需要和已启用的 getPeakClippingTopic 保持一致，该处引用yml声明的变量
    @Override
    @KafkaListener(groupId = "${spring.application.name}", topics = "${scaffold.globalConfig.kafkaConfig.peakClippingTopic.demoSmsSendReport}")
    public void peakClippingConsume(ConsumerRecord<String, String> consumerRecord) {
        super.peakClippingConsume(consumerRecord);
    }
}