很多业务场景里,我们都需要发送短信,比如登陆验证码、告警、营销通知、节日祝福等等。
这篇文章,我们聊聊 Java 应用中如何优雅的发送短信。
图片
一客户端/服务端两种模式
Java 应用中发送短信通常需要使用短信服务提供商提供的短信 API 。
我们经常使用的短信渠道有:阿里云、腾讯云、华为云、亿美等。
发送短信模式分为两种:
1、客户端模式
客户端模式是指应用系统直接调用短信服务提供商提供的短信 API 发送短信。
图片
2、服务端模式
服务端模式是独立创建一个短信平台服务,应用系统直接使用短信平台服务提供的 SDK 发送短信。
图片
核心流程如下:
- 前端调用应用服务接口发送短信 ;
- 应用服务收到短信请求后,调用 SDK 方法根据模版发送短信;
- 短信平台服务收到请求,根据路由算法选择配置的渠道(比如阿里云、腾讯云)发送短信;
- 短信成功发送到用户手机 。
二客户端模式
1、使用三方短信渠道 SDK
客户端模式是非常简单的模式,很多短信服务提供商会提供成熟的 SDK ,业务系统只需要添加 SDK 依赖以及相关配置,就可以调用 SDK 提供的方法发送短信。
我们以阿里云短信服务为例, 调用 API 发送短信的全流程如下所示:
图片
使用 SDK 示例如下:
图片
国内云厂商阿里云、腾讯云、华为云的短信服务,都需要依次申请签名,申请模版,审核通过之后才能发送短信。
2、封装多个三方渠道接口
虽然使用三方短信渠道 SDK 非常简单,但是在实际项目中,可能会存在多个三方渠道,也就是说:可能有的短信是通过腾讯云发送,有的是通过阿里云发送。这样就需要在工程中配置不同渠道的 SDK 依赖。
但这种方式会有两个明显的问题 :
- 不同渠道的发送短信代码不一致,业务代码偏混乱。
- 工程中引入到 SDK 包比较多,不同的 SDK 依赖并不相同,可能存在冲突问题 。
为了解决这个问题,有一种方法是摈弃三方渠道 SDK ,自己实现 SDK 的发送短信方法,这样可以统一发送短信代码,易于管理。
笔者发现一个开源项目 SMS4J,该项目为短信聚合框架,旨在集成多家短信服务,解决接入多个短信 SDK 的繁琐流程。
下面我们展示在 SpringBoot 环境如何集成。
- maven 引入
<dependency>
<groupId>org.dromara.sms4j</groupId>
<artifactId>sms4j-spring-boot-starter</artifactId>
<version>3.0.2</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
zhutong:
#助通短信
#助通终端用户管理的用户名 username 必填;非登录账号密码,请登录后台管理地址进行查看:http://mix2.zthysms.com/login
accessKeyId: tushu1122XXX
#助通终端用户管理的用户名 passwrod 必填;
accessKeySecret: UbXXX4SL
#短信签名,可选;可选的时候,只能使用自定义短信不能使用模板短信; 具体在这里查看审核过的短信签名:https://mix2.zthysms.com/index.html#/SignatureManagement
signature: 上海千XXXX
- 方法使用
@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");
}
}
客户端模式是简单实用的模式,我们可以直接引入三方渠道的 SDK 发送短信,但当存在多种渠道短信时,可能代码会比较混乱。
虽然我们可以封装多个三方渠道接口来解决问题,但研发成本还是比较高的。
另外,当研发小组分散,发送短信各自自成体系时,当某一个渠道由于某种原因被弃用时,大部分研发小组都可能会受影响。
三服务端模式
服务端模式是独立创建一个短信平台服务,应用服务直接使用短信平台提供的 SDK 发送短信。
短信平台的设计有如下要点:
1、应用管理
短信平台为每一个接入的应用分配单独的 appKey 和 appSecret ,每一个应用可以配置独立的限流策略。
2、精简的 SDK 提供按照模版单发/群发的功能
public SmsSenderResult sendSmsByTemplateId(
String mobile,
String templateId,
Map<String, String> templateParam);
3、签名、模版管理
每个应用服务涉及到的签名、模版的管理都中心化 ,我们可以让一个模板绑定多个渠道。
当某条短信通过渠道 A 发送失败时,可以通过另一个渠道 B 发送,如此可以达到高可用的效果。
4、多渠道适配
服务端要加载多个渠道的 SDK ,那么可能导致依赖冲突,可以采取 SPI 机制加载渠道插件。
5、扩展功能
我们可以根据业务需求灵活定制短信平台的功能,比如批量发送、延迟发送、路由策略、灵活的接口限流等。
服务端的设计可以非常灵活,笔者曾经重构过一个短信平台服务,架构图如下:
图片
- 模仿腾讯云的 SDK 设计,提供简单易用的短信接口;
- 设计短信服务 API 端,接收发短信请求,发送短信信息到消息队列;
- worker 服务消费消息,按照负载均衡的算法,调用不同渠道商的短信接口;
- Dashboard 可以配置渠道、管理应用、查看短信发送记录等。