SpringBoot接入華為云短信SDK的流程步驟
華為云短信服務(wù)簡(jiǎn)介
華為云消息&短信服務(wù)(MSG&SMS)為企業(yè)提供了穩(wěn)定、合規(guī)的全球短信發(fā)送能力。它主要有以下特點(diǎn):
- 核心功能:支持發(fā)送驗(yàn)證碼短信(用于登錄、注冊(cè))和通知短信(用于物流、消費(fèi)通知)。
- 核心概念:要發(fā)送短信,你必須在控制臺(tái)提前創(chuàng)建短信應(yīng)用、申請(qǐng)并審核通過(guò)短信簽名和短信模板。簽名是發(fā)送方標(biāo)識(shí)(如“【華為云】”),模板是包含變量的固定內(nèi)容。
SpringBoot接入華為云短信SDK步驟
以下是使用華為云官方Java SDK進(jìn)行集成的詳細(xì)步驟。
第一步:開(kāi)通服務(wù)與前期準(zhǔn)備
- 注冊(cè)與實(shí)名:使用企業(yè)主體注冊(cè)華為云賬號(hào),并完成企業(yè)實(shí)名認(rèn)證。
- 開(kāi)通服務(wù):在控制臺(tái)搜索并開(kāi)通“消息&短信 MSGSMS”服務(wù)。
- 準(zhǔn)備密鑰:進(jìn)入“我的憑證 > 訪問(wèn)密鑰”,獲取用于API調(diào)用的Access Key (AK) 和Secret Key (SK)。
第二步:控制臺(tái)配置(關(guān)鍵步驟)
這是發(fā)送短信的前提,所有配置均需審核。
- 創(chuàng)建應(yīng)用:在“應(yīng)用管理”中創(chuàng)建短信應(yīng)用,獲取
app_id和app_key。 - 申請(qǐng)簽名:在“簽名管理”中,根據(jù)你的企業(yè)身份申請(qǐng)短信簽名。簽名需要審核,且推廣類(lèi)簽名需證明與接收方有會(huì)員或訂 購(gòu)關(guān)系。
- 申請(qǐng)模板:在“模板管理”中創(chuàng)建模板。模板內(nèi)容需符合規(guī)范,例如驗(yàn)證碼模板:“您的驗(yàn)證碼為:{1},請(qǐng)?jiān)趝2}分鐘內(nèi)填寫(xiě)。” 提交后等待審核。
第三步:SpringBoot項(xiàng)目集成與代碼實(shí)現(xiàn)
添加Maven依賴(lài)
在pom.xml中添加官方SDK依賴(lài)。
<dependency>
<groupId>com.huaweicloud.sdk</groupId>
<artifactId>huaweicloud-sdk-smsapi</artifactId>
<!-- 請(qǐng)前往華為云官網(wǎng)SDK中心查詢并使用最新版本 -->
<version>{latest-version}</version>
</dependency>
配置AK/SK和應(yīng)用信息
在application.yml中配置你的密鑰和應(yīng)用信息。
huaweicloud:
sms:
ak: your-access-key # 替換為你的AK
sk: your-secret-key # 替換為你的SK
project-id: your-project-id # 在“我的憑證-項(xiàng)目列表”中查找
sender: 10690xxxxxxxx # 通道號(hào),在創(chuàng)建的應(yīng)用詳情中查看
signature: 華為云測(cè)試 # 已審核通過(guò)的簽名名稱(chēng)
template-id: xxxxxxxx # 已審核通過(guò)的模板ID
region: cn-north-4 # 短信服務(wù)區(qū)域,如華北-北京四
創(chuàng)建配置類(lèi)讀取屬性
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import lombok.Data;
@Component
@ConfigurationProperties(prefix = "huaweicloud.sms")
@Data
public class SmsConfig {
private String ak;
private String sk;
private String projectId;
private String sender;
private String signature;
private String templateId;
private String region;
}
編寫(xiě)短信發(fā)送服務(wù)類(lèi)
這是最核心的業(yè)務(wù)類(lèi),用于組裝和發(fā)送請(qǐng)求。
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.sms.v2.SmsClient;
import com.huaweicloud.sdk.sms.v2.model.*;
import com.huaweicloud.sdk.sms.v2.region.SmsRegion;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.Arrays;
import java.util.List;
@Service
public class HuaweiSmsService {
@Autowired
private SmsConfig smsConfig;
public Boolean sendSingleMessage(String mobile, List<String> templateParams) {
// 1. 構(gòu)建認(rèn)證信息
BasicCredentials auth = new BasicCredentials()
.withAk(smsConfig.getAk())
.withSk(smsConfig.getSk())
.withProjectId(smsConfig.getProjectId());
// 2. 初始化客戶端 (注意Region枚舉可能隨SDK版本變化)
SmsClient client = SmsClient.newBuilder()
.withCredential(auth)
.withRegion(SmsRegion.valueOf(smsConfig.getRegion().toUpperCase().replace("-", "_")))
.build();
// 3. 構(gòu)造發(fā)送請(qǐng)求
SendSmsRequest request = new SendSmsRequest()
.withFrom(smsConfig.getSender()) // 發(fā)送號(hào)碼(通道號(hào))
.withTo(Arrays.asList(mobile)) // 接收方號(hào)碼列表
.withTemplateId(smsConfig.getTemplateId()) // 模板ID
.withTemplateParas(templateParams) // 模板變量值列表
.withSignature(smsConfig.getSignature()); // 簽名名稱(chēng)
// 4. 發(fā)送請(qǐng)求并處理響應(yīng)
try {
SendSmsResponse response = client.sendSms(request);
// 根據(jù)SDK版本,成功判斷可能是 response.getHttpStatusCode() == 200 或解析body中的code
System.out.println("Request ID: " + response.getRequestId());
return true;
} catch (Exception e) {
e.printStackTrace();
return false;
}
}
}
在Controller或業(yè)務(wù)層調(diào)用
@RestController
@RequestMapping("/api/sms")
public class SmsController {
@Autowired
private HuaweiSmsService smsService;
@PostMapping("/send-verification")
public String sendVerificationCode(@RequestParam String phone) {
// 生成隨機(jī)驗(yàn)證碼
String code = String.valueOf((int)((Math.random() * 9 + 1) * 100000));
// 組裝模板參數(shù),順序需與模板中變量定義一致
List<String> params = Arrays.asList(code, "5");
boolean isSuccess = smsService.sendSingleMessage(phone, params);
if(isSuccess) {
return "短信發(fā)送成功,驗(yàn)證碼:" + code; // 生產(chǎn)環(huán)境不應(yīng)返回驗(yàn)證碼
} else {
return "短信發(fā)送失敗";
}
}
}
重要補(bǔ)充與總結(jié)
將以上步驟串聯(lián)起來(lái),整個(gè)接入流程和注意事項(xiàng)如下:
總結(jié)與核心建議
- 官方SDK是首選:華為云提供了官方的Java SDK,直接集成是最穩(wěn)妥的方式。
- 配置先于代碼:務(wù)必理解“應(yīng)用-簽名-模板”的依賴(lài)關(guān)系。所有配置必須先在控制臺(tái) 完成并通過(guò)審核,代碼才能成功調(diào)用。
- 嚴(yán)格遵循內(nèi)容規(guī)范:這是成功送達(dá)的關(guān)鍵。特別是面向國(guó)內(nèi)用戶時(shí),務(wù)必遵守最新的合規(guī)要求。
- 關(guān)注錯(cuò)誤碼:發(fā)送失敗時(shí),華為云會(huì)返回明確的API錯(cuò)誤碼(如
E200028表示模板變量錯(cuò)誤)或狀態(tài)回執(zhí)錯(cuò)誤碼。根據(jù)這些代碼在官方文檔中排查,是最高效的調(diào)試方法。
以上就是SpringBoot接入華為云短信SDK的流程步驟的詳細(xì)內(nèi)容,更多關(guān)于SpringBoot接入華為云短信SDK的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
Springboot?JPA如何使用distinct返回對(duì)象
這篇文章主要介紹了Springboot?JPA如何使用distinct返回對(duì)象,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-02-02
使用Java對(duì)Hbase操作總結(jié)及示例代碼
這篇文章主要介紹了使用Java對(duì)Hbase進(jìn)行操作總結(jié),本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-07-07
解決feign微服務(wù)間的文件上傳報(bào)錯(cuò)問(wèn)題
這篇文章主要介紹了解決feign微服務(wù)間的文件上傳報(bào)錯(cuò)問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-06-06
一文詳解Spring中ResponseEntity包裝器的使用
在?Spring?中,ResponseEntity?是?HTTP?響應(yīng)的包裝器,這篇文章主要為大家詳細(xì)介紹了ResponseEntity包裝器的使用,感興趣的可以了解一下2025-02-02
spring 定時(shí)任務(wù)@Scheduled詳解
這篇文章主要介紹了spring 定時(shí)任務(wù)@Scheduled的相關(guān)資料,文中通過(guò)示例代碼介紹的很詳細(xì),相信對(duì)大家的理解和學(xué)習(xí)具有一定的參考借鑒價(jià)值,有需要的朋友們下面來(lái)一起看看吧。2017-01-01
logback的LevelFilter日志過(guò)濾器源碼解讀
這篇文章主要為大家介紹了logback的LevelFilter日志過(guò)濾器源碼解讀,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-11-11
使用jekins自動(dòng)構(gòu)建部署java maven項(xiàng)目的方法步驟
這篇文章主要介紹了使用jekins自動(dòng)構(gòu)建部署java maven項(xiàng)目的方法步驟,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2021-01-01
Mybatis的類(lèi)型轉(zhuǎn)換接口TypeHandler
這篇文章主要介紹了Mybatis的類(lèi)型轉(zhuǎn)換接口TypeHandler,文章圍繞主題展開(kāi)詳細(xì)的內(nèi)容介紹,具有一定的參考價(jià)值,需要的朋友可以參考一下2022-08-08

