自定义一个腾讯云短信验证码接口spring-starter

1. 首先注册一个腾讯云的短信服务

在腾讯云官网搜索短信即可直接开通,第一次开通有100条国内免费短信
然后在控制台快速入门设置短信签名和模板,审核通过就可以用了(审核很快,我的几分钟就ok了)

申请签名需要上传资料,签名类型处,如果没有自己的网站或者app,可以申请一个自己的公众号(公众号申请也相当简单),上传公众号后台设置截图即可

接着在应用管理里创建一个专用的应用,也可以使用默认的应用,这里的SmsSdkAppId,后面调用短信服务api时要用

2.在腾讯云访问管理设置一个用户组和用户

先建一个用户组,将短信api权限添加进去,也可以添加其他的功能

然后新建一个用户或者用主账户加入到用户组中,完成后,保存密钥id和key,后面会用到

3.开始自定义我们的starter

首先创建一个空的maven项目sms-spring-boot-starter作为starter启动器,里面不需要写代码
然后创建一个springbooot项目sms-spring-boot-starter-autoconfigure配置starter

在sms-spring-boot-starter里把sms-spring-boot-starter-autoconfigure引入进来

    <dependency><groupId>com.fzh</groupId><artifactId>sms-spring-boot-starter-autoconfigure</artifactId><version>0.0.1-SNAPSHOT</version></dependency>
</dependencies>

然后开始在sms-spring-boot-starter-autoconfigure里实现短信发送功能

首先引入腾讯云最新的依赖

<!-- https://mvnrepository.com/artifact/com.tencentcloudapi/tencentcloud-sdk-java --><dependency><groupId>com.tencentcloudapi</groupId><artifactId>tencentcloud-sdk-java</artifactId><version>4.0.11</version></dependency>

根据官方api文档实现方法

public class SendSms {@Autowiredprivate SmsConfigProperties smsConfigProperties;public SendSmsResponse SendSmsClient(String phoneNumber, String TemplateParam) {// 实例化一个认证对象，入参需要传入腾讯云账户secretId，secretKey,此处还需注意密钥对的保密// 密钥可前往https://console.cloud.tencent.com/cam/capi网站进行获取Credential cred = new Credential(smsConfigProperties.getSecretId(),smsConfigProperties.getSecretKey());// 实例化一个http选项，可选的，没有特殊需求可以跳过HttpProfile httpProfile = new HttpProfile();httpProfile.setEndpoint("sms.tencentcloudapi.com");// 实例化一个client选项，可选的，没有特殊需求可以跳过ClientProfile clientProfile = new ClientProfile();clientProfile.setHttpProfile(httpProfile);// 实例化要请求产品的client对象,clientProfile是可选的SmsClient client = new SmsClient(cred, "ap-beijing", clientProfile);// 实例化一个请求对象,每个接口都会对应一个request对象SendSmsRequest req = new SendSmsRequest();//拼接号码phoneNumber = "+86" + phoneNumber;//需要发送短信的号码String[] phoneNumberSet = {phoneNumber};req.setPhoneNumberSet(phoneNumberSet);//应用idreq.setSmsSdkAppid(smsConfigProperties.getSmsSdkAppid());//签名req.setSign(smsConfigProperties.getSign());//模板idreq.setTemplateID(smsConfigProperties.getTemplateID());//传输的参数,一般就是验证码String[] TemplateParamSet = {TemplateParam};req.setTemplateParamSet(TemplateParamSet);try {// 返回的resp是一个SendSmsResponse的实例，与请求对象对应SendSmsResponse resp = client.SendSms(req);// 输出json格式的字符串回包System.out.println(SendSmsResponse.toJsonString(resp));return resp;} catch (TencentCloudSDKException e) {throw new RuntimeException(e);}}
}

将需要传递的参数写到自动配置类里

@ConfigurationProperties("tencent.sms")
public class SmsConfigProperties {private String secretId;private String secretKey;private String smsSdkAppid;//签名用的是名字,不是idprivate String sign;private String templateID;public String getSecretId() {return secretId;}public void setSecretId(String secretId) {this.secretId = secretId;}public String getSecretKey() {return secretKey;}public void setSecretKey(String secretKey) {this.secretKey = secretKey;}public String getSmsSdkAppid() {return smsSdkAppid;}public void setSmsSdkAppid(String smsSdkAppid) {this.smsSdkAppid = smsSdkAppid;}public String getSign() {return sign;}public void setSign(String sign) {this.sign = sign;}public String getTemplateID() {return templateID;}public void setTemplateID(String templateID) {this.templateID = templateID;}
}

最后设置配置类

@Configuration
@ConditionalOnMissingBean(SendSms.class)
@EnableConfigurationProperties(SmsConfigProperties.class)
public class AutoConfiguration {@Beanpublic SendSms sendSms() {SendSms sendSms = new SendSms();return sendSms;}
}

到这里还有最重要的一步!!!

在sms-spring-boot-starter-autoconfigure的resources通过spring.factories文件加载配置类,在resources下创建META-INF目录，创建spring.factories文件

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.sms.config.AutoConfiguration

4.将两个模块install到本地,调用的时候直接将下面的sms-spring-boot-starter的依赖引入即可,写个springboot测试一下:

 <!--在新项目里导入启动器的依赖--><dependency><groupId>com.fzh</groupId><artifactId>sms-spring-boot-starter-autoconfigure</artifactId><version>0.0.1-SNAPSHOT</version></dependency>

在配置文件里写需要的参数,sign直接写签名的名字即可

controller传入手机号和验证码,注意腾讯云国内短信验证码不能超过六位

@RestController
public class DemoController {@Autowiredprivate SendSms sendSms;@GetMapping("/send/{phoneNumber}")public void onMessage(@PathVariable String phoneNumber) {//随机生成六位验证码String TemplateParam3 = String.format("%040d",new BigInteger(UUID.randomUUID().toString().replace("-", ""), 16)).substring(0, 6);//发送短信sendSms.SendSmsClient(phoneNumber, TemplateParam3);}
}

最后测试一下,会显示发送结果,大功告成!!!