前言
短信服务在用户注册、登录、找回密码等相关操作中,可以让用户使用更加便捷,越来越多的公司都采用短信验证的方式让用户进行操作,从而提高用户的实用性。
Spring Boot Starter
由于 Spring boot 的约定大于配置的理念,使得在使用 Spring 变得更加方便。Spring Boot 项目组提供了很多 Starter,让我们在使用 Spring 的时候变得非常容易。对于官方提供的 Starter 采用 spring-boot-starter-xxx 开头,对于非官方提供的 Spring Boot Starter , 官方建议采用 xxxx-spring-boot-starter 命名。
短信服务 Starter
- 开发工具及编译
IntelliJ IDEA 2018.2.5
Maven 3.5+
JDK 1.8
- 如何使用 sms-spring-boot-starter
(1). 在 pom 文件中引入
<dependency>
<groupId>com.github.jackieonway.sms</groupId>
<artifactId>sms-spring-boot-starter</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
在 pom.xml 中配置 maven 中央仓库 Snapshots 地址
<repositories>
<repository>
<id>mavenRepoCenter</id>
<name>Maven Development Snapshot Repository</name>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
(2). 在 application.yml 中加入
spring:
jackieonway:
sms:
sms-type: tentcent # 短信服务商 暂目前只有 腾讯和阿里的短信服务,默认为 ali
security-key: your security-key # 短信的私钥
appid: your appid # 短信的应用 id
sign: your sign # 短信的签名
(3). 在 Springboot 主程序中 加入
@EnabledSmsAutoConfiguration
(4). 创建发送短信程序
- 可以采用排除相关依赖的方式注入 Service
- 可以采用加 @Qualifier(“tencentSmsService”)的方式注入 Service ,
- value 的可选值目前只有 tencentSmsService 和 aliSmsService 两种,
- 可以采用 @Autowired privateSmsService tencentSmsService; 注入,
- 方式与方法 2 类似
- 采用方式 1,最终的 jar 包将会比方式 2 和方法 3 小,但是最终只有一种短信模式
- 生效,即只能使用一个短信运营商的服务,方式 2,3 能快速切换短信运营商
@RestController
public class HelloController {
/**
-
- 可以采用排除相关依赖的方式注入 Service
-
- 可以采用加 @Qualifier(“tencentSmsService”)的方式注入 Service ,
- value 的可选值目前只有 tencentSmsService 和 aliSmsService 两种,
-
- 可以采用
- @Autowired
- private SmsService tencentSmsService;
- 注入,方式与方法 2 类似
- 采用方式 1,最终的 jar 包将会比方式 2 和方法 3 小,但是最终只有一种短信模式
- 生效,即只能使用一个短信运营商的服务,方式 2,3 能快速切换短信运营商
*/
@Autowired
private SmsService tencentSmsService;
// @Autowired
// private SmsService aliSmsService;
@GetMapping(“/tencent”)
public Object tencent() {
// 具体配置请参照具体运营商
// your template params
String[] paramst = {“5678″,”5”};
TencentSmsRequest tencentSmsRequest = new TencentSmsRequest();
tencentSmsRequest.setPhoneNumber(new String[]{“your cellphone”});
tencentSmsRequest.setParams(paramst);
return tencentSmsService.sendTemplateSms(“328921”, tencentSmsRequest);
}
/* @GetMapping(“/ali”)
public Object ali() {
// 具体配置请参照具体运营商
AliSmsRequest aliSmsRequest = new AliSmsRequest();
aliSmsRequest.setOutId(“420”);
aliSmsRequest.setPhoneNumbers(new String[]{“your cellphone”});
aliSmsRequest.setTemplateParam(“{“code”:”asdsads”}”);
aliSmsRequest.setSignName(“123”);
return aliSmsService.sendTemplateSms(“328921”,aliSmsRequest);
}*/
}
(5). 发送
访问 localhost:8080/tencent
一个简单易上手的短信服务 Spring Boot Starter
发送结果
-
SmsService 接口
/**
- 单个发送短信
- @param params 根据对应的短信服务商所需信息填写
*/
public Object sendSms(Integer type,Object params) throws SmsException;
/**
* 单个发送模板短信
* @param tempalteId 短信模板 id
* @param params 根据对应的短信服务商所需信息填写
*/
public Object sendTemplateSms(String tempalteId, Object params) throws SmsException;
/**
* 批量发送短信
* @param params 根据对应的短信服务商所需信息填写
*/
public Object sendBatchSms(int type,Object params) throws SmsException;
/**
* 批量发送模板短信
* @param tempalteId 短信模板 id
* @param params 根据对应的短信服务商所需信息填写
*/
public Object sendBatchTemplateSms(String tempalteId, Object params) throws SmsException;
该接口提供了单个和群发短信与模板短信,注意目前只提供了同步发送方法,异步发送方法,请结合线程池进行。
总结
只是针对腾讯短信服务进行了试验,阿里的短信服务并未真正验证,希望各位小伙伴能合作完成验证,共同完善该 starter,觉得有用请 starter 该项目。如果只想使用而腾讯云短信业务的话,按照 Demo 使用即可。
github 地址:sms-spring-boot-project