SMS4J-让发送短信变的更简单

SMS4J-让发送短信变的更简单

简介

SMS4J为短信聚合组件,帮您轻松集成多家短信服务,解决接入多个短信SDK的繁琐流程。 SMS4J采用了Apache-2.0 license开源协议。在日常的开发过程中,短信的发送经常使用(尤其是中小型的外包公司),毕竟不是每个公司都有阿里腾讯一样的实力, 也不是每个都像银行联通等公司一样有内部的短信规程。第三方的短信往往是最常见的解决方案,但是市面上第三方短信服务商众多, 各家都有不同的方式和标准,每次需要使用时候,都需要花费时间去阅读文档和编写相应的工具,为一个短信浪费了太多的精力和时间。 这个工具的目的就是为了统一下各个厂商的短信发送工具的标准,甚至于更换短信厂商只需要更改yml配置文件即可。

语言:java

开源协议:Apache-2.0

官网:https://wind.kim

文档:https://apidoc.gitee.com/dromara/sms4j

️特性

✅ 开箱即用,简单方便

✅ 兼容SpringBoot3,升级无障碍

✅ 支持多厂商配置,轻松便捷

✅ 支持异步短信延迟短信等诸多额外功能

✅ 使用方便,新手友好

✅ 最小化依赖,最大化降低依赖冲突风险

✅ 配置灵活,支持多种配置方式

SMS4J-让发送短信变的更简单

maven安装

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

️基础配置

 sms:
    alibaba:
      #阿里云的accessKey
      accessKeyId: 您的accessKey
      #阿里云的accessKeySecret
      accessKeySecret: 您的accessKeySecret
      #短信签名
      signature: 测试签名
      #模板ID 用于发送固定模板短信使用
      templateId: SMS_215125134
      #模板变量 上述模板的变量
      templateName: code
      #请求地址 默认为dysmsapi.aliyuncs.com 如无特殊改变可以不用设置
      requestUrl: dysmsapi.aliyuncs.com
    huawei:
      #华为短信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

使用

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

    // 测试发送固定模板短信
    @RequestMapping("/")
    public void doLogin(String username, String password) {
         //阿里云向此手机号发送短信
        SmsFactory.createSmsBlend(SupplierType.ALIBABA).sendMessage("18888888888","123456");
        //华为短信向此手机号发送短信
        SmsFactory.createSmsBlend(SupplierType.HUAWEI).sendMessage("16666666666","000000");
    }
}

支持厂商一览

  • 阿里云国内短信
  • 腾讯云国内短信
  • 华为云国内短信
  • 京东云国内短信
  • 容联云国内短信
  • 亿美软通国内短信
  • 合一短信
  • 云片短信

在SpringBoot环境集成

  1. maven引入
  2. <dependency> <groupId> org.dromara.sms4j </groupId> <artifactId> sms4j-spring-boot-starter </artifactId> <version> version </version> </dependency>
  3. 设置配置文件
sms:
   alibaba:
      #阿里云的accessKey
      accessKeyId: 您的accessKey
      #阿里云的accessKeySecret
      accessKeySecret: 您的accessKeySecret
      #短信签名
      signature: 测试签名
      #模板ID 用于发送固定模板短信使用
      templateId: SMS_215125134
      #模板变量 上述模板的变量
      templateName: code
      #请求地址 默认为dysmsapi.aliyuncs.com 如无特殊改变可以不用设置
      requestUrl: dysmsapi.aliyuncs.com
   huawei:
      #华为短信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
  1. 方法使用
@RestController
@RequestMapping("/test/")
public class DemoController {

    // 测试发送固定模板短信
    @RequestMapping("/")
    public void doLogin(String username, String password) {
         //阿里云向此手机号发送短信
        SmsFactory.createSmsBlend(SupplierType.ALIBABA).sendMessage("18888888888","123456");
        //华为短信向此手机号发送短信
        SmsFactory.createSmsBlend(SupplierType.HUAWEI).sendMessage("16666666666","000000");
    }
}

配置详解

线程池配置

每一家厂商都对于异步短信有不同的支持,有些甚至没有,为了统一存在一个异步短信,我们配置了一个线程池用于执行异步短信任务,线程池默认配置如下:

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

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

结束语

还在百度搜索短信集成的各种方法吗,以后不用了,本开源短信组件满足你的需求,代码质量良好,可作为中小型项目使用,对快速集成短信很有帮助哦!

开源分享不易,感谢大家的支持,多关注,点赞。后续也会分享更多的干货和技术资讯,您的阅读就是对小编的支持,再次感谢各位老铁!