1. 概述
1.能力扩展SPI,适用于COP平台已完成接入能力的通道扩展。如COP平台已接入短信服务,并已适配华为云通道、腾讯云通道。若系统使用中,需要使用阿里云或其他第三方通道,则可以通过SPI机制快速完成适配接入。
2.因各能力厂商的版本、接口存在差异,可能无法满足某些API接口定义,则无法实现对应能力特征。当前已适配能力的特征及各通道区隔详情,请参看本页面的已接入能力列表。
2. 接入步骤
2.1. 开始开发
需要在代码工程POM文件中引入依赖
<dependency>
<groupId>com.seeyon</groupId>
<artifactId>cip-capability-api</artifactId>
<version>${capability.version}</version>
</dependency>
2.2. SPI适配层API接口定义实现
以“短信发送”API接口为例
需要实现接口:com.seeyon.cip.provider.api.sms.SmsProviderService
覆写以下方法:
com.seeyon.cip.provider.api.ProviderService#getDescription // 获取通道名称
com.seeyon.cip.provider.api.ProviderService#checkConfig // 检查配置开关,固定返回true
com.seeyon.cip.provider.api.ProviderService#getCapabilityEnum // 返回能力枚举
com.seeyon.cip.provider.api.sms.SmsProviderService#sendShortMessage // 实现短信发送逻辑
备注:服务的相关配置,可放在配置文件中。
3. 完成SPI加载配置
3.1. 工程下载
注意事项: 1.pom中的版本号要与项目当前版本保持一致,分别为boot版本、cip-capability-api版本
<parent>
<groupId>com.seeyon</groupId>
<artifactId>boot</artifactId>
<version>3.10.1</version>
</parent>
<properties>
<platform.version>3.10.1</platform.version>
</properties>
<dependencies>
<dependency>
<groupId>com.seeyon</groupId>
<artifactId>cip-capability-api</artifactId>
<version>${cip.version}</version>
</dependency>
</dependencies>
3.2. spi jar 打包并部署
参考 SPI扩展
重启 cip-capability 项目实现扩展支持