前言
在日常的开发过程中,短信的发送经常使用(尤其是中小型的外包公司),毕竟不是每个公司都有阿里腾讯一样的实力, 也不是每个都像银行联通等公司一样有内部的短信规程。第三方的短信往往是最常见的解决方案,但是市面上第三方短信服务商众多, 各家都有不同的方式和标准,每次需要使用时候,都需要花费时间去阅读文档和编写相应的工具,为一个短信浪费了太多的精力和时间。 这个工具的目的就是为了统一下各个厂商的短信发送工具的标准,甚至于更换短信厂商只需要更改yml配置文件即可,官网地址:https://sms4j.com/
项目gitee地址:https://gitee.com/dromara/sms4j
项目github地址:https://github.com/dromara/SMS4J
maven安装
<dependency>
<groupId>org.dromara.sms4j</groupId>
<artifactId>sms4j-spring-boot-starter</artifactId>
<version>{version}</version>
</dependency>
sms:
# 标注从yml读取配置
config-type: yaml
blends:
# 自定义的标识,也就是configId这里可以是任意值(最好不要是中文)
tx1:
#厂商标识,标定此配置是哪个厂商,详细请看厂商标识介绍部分
supplier: tencent
#您的accessKey
access-key-id: 您的accessKey
#您的accessKeySecret
access-key-secret: 您的accessKeySecret
#您的短信签名
signature: 您的短信签名
#模板ID 非必须配置,如果使用sendMessage的快速发送需此配置
template-id: xxxxxxxx
#您的sdkAppId
sdk-app-id: 您的sdkAppId
# 代理
proxy:
# 是否启用代理 默认关闭 需手动开启
enable: false
host: 127.0.0.1
port: 8080
# 自定义的标识,也就是configId这里可以是任意值(最好不要是中文)
tx2:
#厂商标识,标定此配置是哪个厂商,详细请看厂商标识介绍部分
supplier: tencent
#您的accessKey
access-key-id: 您的accessKey
#您的accessKeySecret
access-key-secret: 您的accessKeySecret
#您的短信签名
signature: 您的短信签名
#模板ID 非必须配置,如果使用sendMessage的快速发送需此配置
template-id: xxxxxxxx
#您的sdkAppId
sdk-app-id: 您的sdkAppId
# 代理
proxy:
# 是否启用代理 默认关闭 需手动开启
enable: false
host: 127.0.0.1
port: 8080
使用
@RestController
public class TestController {
@GetMapping("/test")
public void testSend(){
//在创建完SmsBlend实例后,再未手动调用注销的情况下框架会持有该实例,可以直接通过指定configId来获取想要的配置,如果你想使用
//负载均衡形式获取实例,只要使用getSmsBlend的无参重载方法即可,如果你仅有一个配置,也可以使用该方法
SmsBlend smsBlend = SmsFactory.getSmsBlend("在配置中定义的configId:tx1");
SmsResponse smsResponse = smsBlend.sendMessage("13666666666","666666");
}
}
线程池配置
每一家厂商都对于异步短信有不同的支持,有些甚至没有,为了统一存在一个异步短信,我们配置了一个线程池用于执行异步短信任务,线程池默认配置如下:
sms:
#核心线程池大小
corePoolSize: 10
#最大线程数
maxPoolSize: 30
#队列容量
queueCapacity: 50
#活跃时间
keepAliveSeconds: 60
# 线程名字前缀
threadNamePrefix: sms-executor-
#设置线程池关闭的时候等待所有任务都完成再继续销毁其他的Bean
shutdownStrategy: true
以上线程池为默认的配置,如果有需要可以跟随自己的需求在yml文件进行配置