sms4j:Springboot一行代码集成各大厂商的短信发送

9 阅读3分钟

sms4j:Springboot一行代码集成各大厂商的短信发送

在开发过程中,我们往往会用到短信发送的功能。但是市面上第三方短信服务商众多, 各家都有不同的方式和标准阅读起来太费劲

SMS4J 这个工具的目的就是为了统一下各个厂商的短信发送工具的标准,甚至于更换短信厂商只需要更改yml配置文件即可。

image.png

第三方厂商清单

  • 亿美软通国内短信
  • 阿里云国内短信
  • 腾讯云国内短信
  • 华为云国内短信
  • 京东云国内短信
  • 容联云国内短信(原云通讯)
  • 网易云信短信
  • 天翼云短信
  • 七牛云短信
  • 合一短信
  • 云片短信
  • 助通短信
  • 联麓短信
  • 鼎众短信

使用

在SpringBoot环境集成

<dependency>
 <groupId>org.dromara.sms4j</groupId>
 <artifactId>sms4j-spring-boot-starter</artifactId>
 <version>3.3.3</version>
</dependency>

yml中设置

sms:
   config-type: yaml
   blends:
       自定义标识1:
         #阿里云的accessKey
         accessKeyId: 您的accessKey
         #阿里云的accessKeySecret
         accessKeySecret: 您的accessKeySecret
         #短信签名
         signature: 测试签名
         #模板ID 用于发送固定模板短信使用
         templateId: SMS_215125134
         #模板变量 上述模板的变量
         templateName: code
         #请求地址 默认为dysmsapi.aliyuncs.com 如无特殊改变可以不用设置
         requestUrl: dysmsapi.aliyuncs.com
       自定义标识2:
         #华为短信appKey
         appKey: 5N6fvXXXX920HaWhVXXXXXX7fYa
         #华为短信appSecret
         app-secret: Wujt7EYzZTBXXXXXXEhSP6XXXX
         #短信签名
         signature: 华为短信测试
          #通道号
         sender: 8823040504797
         #模板ID 如果使用自定义模板发送方法可不设定
         template-id: acXXXXXXXXc274b2a8263479b954c1ab5
         #华为回调地址,如不需要可不设置或为空
         statusCallBack:
         #华为分配的app请求地址
         url: https://XXXXX.cn-north-4.XXXXXXXX.com:443
       自定义标识3:
         #助通短信
         #助通终端用户管理的用户名 username 必填;非登录账号密码,请登录后台管理地址进行查看:https://mix2.zthysms.com/login
         accessKeyId: tusxxxxxxXXX
         #助通终端用户管理的用户名 passwrod 必填;
         accessKeySecret: UbXXXxxx
         #短信签名,可选;可选的时候,只能使用自定义短信不能使用模板短信; 具体在这里查看审核过的短信签名:https://mix2.zthysms.com/index.html#/SignatureManagement
         signature: 上海千XXXX

使用示例

@RestController
@RequestMapping("/test/")
public class DemoController {

   // 测试发送固定模板短信
   @RequestMapping("/")
   public void send() {
        //阿里云向此手机号发送短信
       SmsFactory.getSmsBlend("自定义标识1").sendMessage("18888888888","123456");
       //华为短信向此手机号发送短信
       SmsFactory.getSmsBlend("自定义标识2").sendMessage("16666666666","000000");
   }
}

配置详解

sms:
  #核心线程池大小
  corePoolSize: 10
  #最大线程数
  maxPoolSize: 30
  #队列容量
  queueCapacity: 50
  #活跃时间
  keepAliveSeconds: 60
  # 线程名字前缀
  threadNamePrefix: sms-executor-
  #设置线程池关闭的时候等待所有任务都完成再继续销毁其他的Bean
  shutdownStrategy: true

以上线程池为默认的配置,如果有需要可以跟随自己的需求在yml文件进行配置

项目地址

🚀传送门:

https://github.com/dromara/SMS4J

⭐官方网站:

https://sms4j.com/doc3/delay.html

👀示例:

https://gitee.com/MR-wind/sms4f_demo