Springboot整合腾讯云短信服务

腾讯云发送短信

1进入腾讯云搜索“短信”,进入短信控制页面

image-20220620093330363

2、点击签名管理创建签名

此步骤需要提前备案域名直到工信部审核通过

image-20220620093309195

3、点击正文模板管理,创建几个合适的短信模板

image-20220620093554771

4、点击就应用管理->应用列表,创建一个应用,应用中的SDK AppID和App Key都是后面需要用到的

image-20220620093657541

在线测试发送腾讯云短信

https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms&SignVersion=

参数请看下面详解

image-20220621175036696

SmsSdkAppid

对应值如图所示

image-20220621174316504

Templateld

对应值如图所示

image-20220621174736896

SignName

这里在线测试的时候有个坑,虽然为选填项,但是在中国的电话号码,此项为必填项

对应值如图所示

image-20220621174428742

TemplateParamSet.N(选填)

这里的参数要和你申请短信,正文模板里面的参数对应,模板里有几个参数这里就填写几个参数

在我们发送成功后—>点击代码生成就可以整合到我们Springboot里面了

image-20220621181928979

Springboot整合阿里云短信

1:springboot项目中 pom.xml添加依赖项

       <!-- 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>

2:编写Application.properties

image-20220622105215176

Unicode在线转换工具:https://tools.ijkxs.com/tools/unicode

3:编写读取读取配置文件的工具类

package com.bzovo.msmservice.utils;

import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class MsmConstantUtils implements InitializingBean {

    /** 腾讯云账户密钥对secretKey(在访问管理中配置) */
    @Value("${tencent.sms.secretId}")
    private String secretID ;
    /** 腾讯云账户密钥对secretKey(在访问管理中配置) */
    @Value("${tencent.sms.keysecret}")
    private String secretKey ;
    @Value("${tencent.sms.smsSdkAppId}")
    private String smsSdkAppID ;
    @Value("${tencent.sms.signName}")
    private String signName ;
    @Value("${tencent.sms.templateId}")
    private String templateID ;

    public static String SECRET_ID;
    public static String SECRET_KEY;
    public static String SMSSDKAPP_ID;
    public static String SIGN_NAME;
    public static String TEMPLATE_ID;


    @Override
    public void afterPropertiesSet() throws Exception {
        SECRET_ID = secretID;
        SECRET_KEY = secretKey;
        SMSSDKAPP_ID = smsSdkAppID;
        SIGN_NAME = signName;
        TEMPLATE_ID = templateID;
    }
}

4:编写业务层代码

   //发送6位数字验证码到手机
    @Override
    public boolean sendPhone(String sixBitRandom, String phone) {
        //判断手机号是否为空
        if (StringUtils.isEmpty(phone)) {
            return false;
        }
        try{
            // 实例化一个认证对象,入参需要传入腾讯云账户secretId,secretKey,此处还需注意密钥对的保密
            // 密钥可前往https://console.cloud.tencent.com/cam/capi网站进行获取
            Credential cred = new Credential(MsmConstantUtils.SECRET_ID, MsmConstantUtils.SECRET_KEY);
            // 实例化一个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-nanjing", clientProfile);
            // 实例化一个请求对象,每个接口都会对应一个request对象
            SendSmsRequest req = new SendSmsRequest();

            //设置发送相关的参数
            String[] phoneNumberSet1 = {"86"+phone};
            req.setPhoneNumberSet(phoneNumberSet1);//发送的手机号
            //设置固定的参数
            req.setSmsSdkAppid(MsmConstantUtils.SMSSDKAPP_ID);// 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId
            req.setSign(MsmConstantUtils.SIGN_NAME);//短信签名内容: 使用 UTF-8 编码,必须填写已审核通过的签名
            req.setTemplateID(MsmConstantUtils.TEMPLATE_ID);//模板 ID: 必须填写已审核通过的模板 ID
            //发送的验证码
            String[] templateParamSet1 = {sixBitRandom};//模板的参数 第一个是验证码,第二个是过期时间
            req.setTemplateParamSet(templateParamSet1);//发送验证码

            //发送短信
            // 返回的resp是一个SendSmsResponse的实例,与请求对象对应
            SendSmsResponse resp = client.SendSms(req);
            System.out.println("resp"+resp);
            // 输出json格式的字符串回包
            System.out.println(SendSmsResponse.toJsonString(resp));
            return true;
        } catch (TencentCloudSDKException e) {
            e.printStackTrace();
            return false;
        }
    }

5:通过Swagger-ui.html测试或其他模拟请求的工具

image-20220622110300298

6:测试结果

image-20220622110216282

Tips:在第五步

腾讯云Api诊断工具,复制请求腾讯云失败时候的Request.id即可 https://console.cloud.tencent.com/api/diagnosis

常见错误分析

1:使用腾讯云短信服务技术出现FailedOperation.TemplateIncorrectOrUnapproved

image-20220622110604304

以上是测试短信发送响应结果

其中的message的值可以看出:原因是模板未批准或请求内容与批准的模板内容不匹配

image-20220622110728785

由于我们模板申请通过了,此时我们可以发现模板内容中有一个{1}参数,也就是我们必须要设置该参数的值,否者就会报该错误

这里的参数要和代码中的参数数量要对应.否则会报错

image-20220622110901610

由于我们的模板内容只有一个参数,所以只需要填入一个值即可,
这个上面这个参数就是验证码,只不过是我用RandomUtil随机生成的(这个类需要自己编写),我是在Controller生成作为参数传递过来的

再次测试,即可成功(记得手机号前要加入86)

image-20220622110928050

2:腾讯云短信出现there are both domestic mobile phone numbers and international mobile phone numbers in the…

以上是短信发送响应结果

可以看出原因是:请求中既有国内手机号码,也有国际手机号码

我们在使用国内手机号码时候,记得在手机号前面加上86

手机号前加入86,再次测试即可成功

image-20220622110216282

随机生成6位数字工具类

package com.bzovo.commonutils;

import java.text.DecimalFormat;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Random;


public class RandomUtil {

	private static final Random random = new Random();
	private static final DecimalFormat fourdf = new DecimalFormat("0000");
	private static final DecimalFormat sixdf = new DecimalFormat("000000");
	public static String getFourBitRandom() {
		return fourdf.format(random.nextInt(10000));
	}
	public static String getSixBitRandom() {
		return sixdf.format(random.nextInt(1000000));
	}

	/**
	 * 给定数组,抽取n个数据
	 * @param list
	 * @param n
	 * @return
	 */
	public static ArrayList getRandom(List list, int n) {

		Random random = new Random();
		HashMap<Object, Object> hashMap = new HashMap<Object, Object>();

		// 生成随机数字并存入HashMap
		for (int i = 0; i < list.size(); i++) {
			int number = random.nextInt(100) + 1;
			hashMap.put(number, i);
		}

		// 从HashMap导入数组
		Object[] robjs = hashMap.values().toArray();
		ArrayList r = new ArrayList();
        
		// 遍历数组并打印数据
		for (int i = 0; i < n; i++) {
			r.add(list.get((int) robjs[i]));
			System.out.print(list.get((int) robjs[i]) + "\t");
		}
		System.out.print("\n");
		return r;
	}
}

腾讯云发送短信

1进入腾讯云搜索“短信”,进入短信控制页面

image-20220620093330363

2、点击签名管理创建签名

此步骤需要提前备案域名直到工信部审核通过

image-20220620093309195

3、点击正文模板管理,创建几个合适的短信模板

image-20220620093554771

4、点击就应用管理->应用列表,创建一个应用,应用中的SDK AppID和App Key都是后面需要用到的

image-20220620093657541

在线测试发送腾讯云短信

https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms&SignVersion=

参数请看下面详解

image-20220621175036696

SmsSdkAppid

对应值如图所示

image-20220621174316504

Templateld

对应值如图所示

image-20220621174736896

SignName

这里在线测试的时候有个坑,虽然为选填项,但是在中国的电话号码,此项为必填项

对应值如图所示

image-20220621174428742

TemplateParamSet.N(选填)

这里的参数要和你申请短信,正文模板里面的参数对应,模板里有几个参数这里就填写几个参数

在我们发送成功后—>点击代码生成就可以整合到我们Springboot里面了

image-20220621181928979

Springboot整合阿里云短信

1:springboot项目中 pom.xml添加依赖项

       <!-- 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>

2:编写Application.properties

image-20220622105215176

Unicode在线转换工具:https://tools.ijkxs.com/tools/unicode

3:编写读取读取配置文件的工具类

package com.bzovo.msmservice.utils;

import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class MsmConstantUtils implements InitializingBean {

    /** 腾讯云账户密钥对secretKey(在访问管理中配置) */
    @Value("${tencent.sms.secretId}")
    private String secretID ;
    /** 腾讯云账户密钥对secretKey(在访问管理中配置) */
    @Value("${tencent.sms.keysecret}")
    private String secretKey ;
    @Value("${tencent.sms.smsSdkAppId}")
    private String smsSdkAppID ;
    @Value("${tencent.sms.signName}")
    private String signName ;
    @Value("${tencent.sms.templateId}")
    private String templateID ;

    public static String SECRET_ID;
    public static String SECRET_KEY;
    public static String SMSSDKAPP_ID;
    public static String SIGN_NAME;
    public static String TEMPLATE_ID;


    @Override
    public void afterPropertiesSet() throws Exception {
        SECRET_ID = secretID;
        SECRET_KEY = secretKey;
        SMSSDKAPP_ID = smsSdkAppID;
        SIGN_NAME = signName;
        TEMPLATE_ID = templateID;
    }
}

4:编写业务层代码

   //发送6位数字验证码到手机
    @Override
    public boolean sendPhone(String sixBitRandom, String phone) {
        //判断手机号是否为空
        if (StringUtils.isEmpty(phone)) {
            return false;
        }
        try{
            // 实例化一个认证对象,入参需要传入腾讯云账户secretId,secretKey,此处还需注意密钥对的保密
            // 密钥可前往https://console.cloud.tencent.com/cam/capi网站进行获取
            Credential cred = new Credential(MsmConstantUtils.SECRET_ID, MsmConstantUtils.SECRET_KEY);
            // 实例化一个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-nanjing", clientProfile);
            // 实例化一个请求对象,每个接口都会对应一个request对象
            SendSmsRequest req = new SendSmsRequest();

            //设置发送相关的参数
            String[] phoneNumberSet1 = {"86"+phone};
            req.setPhoneNumberSet(phoneNumberSet1);//发送的手机号
            //设置固定的参数
            req.setSmsSdkAppid(MsmConstantUtils.SMSSDKAPP_ID);// 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId
            req.setSign(MsmConstantUtils.SIGN_NAME);//短信签名内容: 使用 UTF-8 编码,必须填写已审核通过的签名
            req.setTemplateID(MsmConstantUtils.TEMPLATE_ID);//模板 ID: 必须填写已审核通过的模板 ID
            //发送的验证码
            String[] templateParamSet1 = {sixBitRandom};//模板的参数 第一个是验证码,第二个是过期时间
            req.setTemplateParamSet(templateParamSet1);//发送验证码

            //发送短信
            // 返回的resp是一个SendSmsResponse的实例,与请求对象对应
            SendSmsResponse resp = client.SendSms(req);
            System.out.println("resp"+resp);
            // 输出json格式的字符串回包
            System.out.println(SendSmsResponse.toJsonString(resp));
            return true;
        } catch (TencentCloudSDKException e) {
            e.printStackTrace();
            return false;
        }
    }

5:通过Swagger-ui.html测试或其他模拟请求的工具

image-20220622110300298

6:测试结果

image-20220622110216282

Tips:在第五步

腾讯云Api诊断工具,复制请求腾讯云失败时候的Request.id即可 https://console.cloud.tencent.com/api/diagnosis

常见错误分析

1:使用腾讯云短信服务技术出现FailedOperation.TemplateIncorrectOrUnapproved

image-20220622110604304

以上是测试短信发送响应结果

其中的message的值可以看出:原因是模板未批准或请求内容与批准的模板内容不匹配

image-20220622110728785

由于我们模板申请通过了,此时我们可以发现模板内容中有一个{1}参数,也就是我们必须要设置该参数的值,否者就会报该错误

这里的参数要和代码中的参数数量要对应.否则会报错

image-20220622110901610

由于我们的模板内容只有一个参数,所以只需要填入一个值即可,
这个上面这个参数就是验证码,只不过是我用RandomUtil随机生成的(这个类需要自己编写),我是在Controller生成作为参数传递过来的

再次测试,即可成功(记得手机号前要加入86)

image-20220622110928050

2:腾讯云短信出现there are both domestic mobile phone numbers and international mobile phone numbers in the…

以上是短信发送响应结果

可以看出原因是:请求中既有国内手机号码,也有国际手机号码

我们在使用国内手机号码时候,记得在手机号前面加上86

手机号前加入86,再次测试即可成功

image-20220622110216282

随机生成6位数字工具类

package com.bzovo.commonutils;

import java.text.DecimalFormat;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Random;


public class RandomUtil {

	private static final Random random = new Random();
	private static final DecimalFormat fourdf = new DecimalFormat("0000");
	private static final DecimalFormat sixdf = new DecimalFormat("000000");
	public static String getFourBitRandom() {
		return fourdf.format(random.nextInt(10000));
	}
	public static String getSixBitRandom() {
		return sixdf.format(random.nextInt(1000000));
	}

	/**
	 * 给定数组,抽取n个数据
	 * @param list
	 * @param n
	 * @return
	 */
	public static ArrayList getRandom(List list, int n) {

		Random random = new Random();
		HashMap<Object, Object> hashMap = new HashMap<Object, Object>();

		// 生成随机数字并存入HashMap
		for (int i = 0; i < list.size(); i++) {
			int number = random.nextInt(100) + 1;
			hashMap.put(number, i);
		}

		// 从HashMap导入数组
		Object[] robjs = hashMap.values().toArray();
		ArrayList r = new ArrayList();
        
		// 遍历数组并打印数据
		for (int i = 0; i < n; i++) {
			r.add(list.get((int) robjs[i]));
			System.out.print(list.get((int) robjs[i]) + "\t");
		}
		System.out.print("\n");
		return r;
	}
}

  • 3
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 5
    评论
好的,以下是Springboot整合腾讯云短信服务的示例代码: 1. 首先在腾讯云短信服务控制台中创建 SMS 应用,并获取 APP ID、APP KEY 和 APP SECRET。 2. 接下来,添加依赖: ```xml <dependency> <groupId>com.github.qcloudsms</groupId> <artifactId>qcloudsms</artifactId> <version>1.0.6</version> </dependency> ``` 3. 在 Springboot 配置文件中添加腾讯云短信服务的配置: ```yaml tencent: sms: app-id: <your app id> app-key: <your app key> app-secret: <your app secret> sign-name: <your sign name> ``` 4. 创建短信发送工具类 SmsUtils: ```java import com.github.qcloudsms.SmsSingleSender; import com.github.qcloudsms.SmsSingleSenderResult; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Value; import org.springframework.stereotype.Component; @Component public class SmsUtils { @Value("${tencent.sms.app-id}") private int appId; @Value("${tencent.sms.app-key}") private String appKey; @Value("${tencent.sms.sign-name}") private String signName; @Autowired private SmsSingleSender sender; public void send(String phoneNumber, String templateId, String[] params) throws Exception { SmsSingleSenderResult result = sender.sendWithParam("86", phoneNumber, templateId, params, signName, "", ""); if (result.result != 0) { throw new RuntimeException(result.errMsg); } } public SmsSingleSender getSender() { return new SmsSingleSender(appId, appKey); } } ``` 5. 在 Controller 中调用短信发送工具类: ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RestController; @RestController public class SmsController { @Autowired private SmsUtils sms; @PostMapping("/sendSms") public void sendSms(@RequestBody SmsPayload smsPayload) throws Exception { String phoneNumber = smsPayload.getPhoneNumber(); String templateId = smsPayload.getTemplateId(); String[] params = smsPayload.getParams(); sms.send(phoneNumber, templateId, params); } } ``` 以上就是 Springboot 整合腾讯云短信服务的示例代码,希望能对你有所帮助!
评论 5
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值