一个简单易上手的短信服务Spring Boot Starter

前言

短信服务在用户注册、登录、找回密码等相关操作中,可以让用户使用更加便捷,越来越多的公司都采用短信验证的方式让用户进行操作,从而提高用户的实用性。

Spring Boot Starter

由于 Spring boot 的约定大于配置的理念,使得在使用Spring变得更加方便。Spring Boot 项目组提供了很多Starter ,让我们在使用 Spring 的时候变得非常容易。对于官方提供的Starter 采用 spring-boot-starter-xxx开头,对于非官方提供的Spring Boot Starter ,官方建议采用 xxxx-spring-boot-starter命名。

短信服务Starter

  1. 开发工具及编译

    IntelliJ IDEA 2018.2.5

    Maven 3.5+

    JDK 1.8

  2. 如何使用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). 创建发送短信程序

  1. 可以采用排除相关依赖的方式注入Service
  2. 可以采用加@Qualifier("tencentSmsService")的方式注入Service ,
  3. value的可选值目前只有tencentSmsService 和aliSmsService两种,
  4. 可以采用 @Autowired privateSmsService tencentSmsService; 注入,
  5. 方式与方法2类似
  6. 采用方式1,最终的jar包将会比方式2和方法3小,但是最终只有一种短信模式
  7. 生效,即只能使用一个短信运营商的服务,方式2,3能快速切换短信运营商

@RestController

public class HelloController {

/**

    1. 可以采用排除相关依赖的方式注入Service
    1. 可以采用加 @Qualifier("tencentSmsService")的方式注入Service ,
  • value的可选值目前只有 tencentSmsService 和aliSmsService两种,
    1. 可以采用
  • @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

一个简单易上手的短信服务Spring Boot Starter

一个简单易上手的短信服务Spring Boot Starter

发送结果

  1. 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

原文 

https://segmentfault.com/a/1190000020009120

本站部分文章源于互联网,本着传播知识、有益学习和研究的目的进行的转载,为网友免费提供。如有著作权人或出版方提出异议,本站将立即删除。如果您对文章转载有任何疑问请告之我们,以便我们及时纠正。

PS:推荐一个微信公众号: askHarries 或者qq群:474807195,里面会分享一些资深架构师录制的视频录像:有Spring,MyBatis,Netty源码分析,高并发、高性能、分布式、微服务架构的原理,JVM性能优化这些成为架构师必备的知识体系。还能领取免费的学习资源,目前受益良多

转载请注明原文出处:Harries Blog™ » 一个简单易上手的短信服务Spring Boot Starter

赞 (0)
分享到:更多 ()

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址