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

最新推荐文章于 2024-09-03 18:05:02 发布

diaojin6880

最新推荐文章于 2024-09-03 18:05:02 发布

阅读量157

点赞数

文章标签： java 开发工具

原文链接：http://www.cnblogs.com/xiang--liu/p/11412666.html

版权

https://www.jianshu.com/p/4a3fff5cb2d6

前言

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

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). 创建发送短信程序

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

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

发送结果

3. 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;