一飞开源
阅读787

[开源]短信聚合组件轻松集成多家短信服务,让发送短信变的更简单

一飞开源,介绍创意、新奇、有趣、实用的开源应用、系统、软件、硬件及技术,一个探索、发现、分享、使用与互动交流的开源技术社区平台。致力于打造活力开源社区,共建开源新生态!

一、开源项目简介

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

SMS4J为短信聚合组件,帮您轻松集成多家短信服务,解决接入多个短信SDK的繁琐流程。SMS4J采用了Apache-2.0 license开源协议,方便志同道合的朋友一起为开源贡献力量。

目前已接入数家常见的短信服务商,后续将会继续集成。后续的版本中我们还将推出更多的相关功能。

sms-aggregation 正式改名 sms4j

sms-aggregation 自开源以来受到的众多的反馈,其中很多人在吐槽名字又丑又长不容易记,经过社区内投票之后,成功更定新名称 sms4j,新名称将伴随新的包名,groupId,新的特性,新的文档,在周六进行发布,这次的更新是跨越性的更新,也是全新的起航,在后续将会新版本的迭代计划和维护计划,在作者的有生之年,这个项目将长久的维护下去。

二、开源协议

使用Apache-2.0开源协议

三、界面展示

四、功能概述

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

支持厂商一览

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

开箱即用

极简单的配置,方便的使用,三分钟即可完成发送短信的功能

简单优雅

统一各个厂商的发送方式和功能,省去学习不同短信厂商的差异化方法,做到极简使用

切换灵活

只需要通过配置文件即可立即切换不同的服务商,省去查阅文档和ctrl c v,发送短信,有手就行

功能丰富

对于短信中常见的限制和规则,不需要编写额外的功能方法和模块,只需要开启配置即可,后续还将集成更多功能方便使用

️特性

✅ 开箱即用,简单方便

✅ 兼容SpringBoot3,升级无障碍

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

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

✅ 使用方便,新手友好

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

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

五、技术选型

在SpringBoot环境集成

1、maven引入


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

2、设置配置文件


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

3、方法使用


@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文件进行配置

六、源码地址

源码下载

关注下面的标签,发现更多相似文章

一飞开源
发布了 篇专栏 · 获取点赞 · 获取阅读

评论

查看更多
相关推荐
关于作者
一飞开源
获得点赞 100
文章被阅读 1000
相关文章