SpringBoot接入華為云短信SDK的流程步驟
華為云短信服務簡介
華為云消息&短信服務(MSG&SMS)為企業(yè)提供了穩(wěn)定、合規(guī)的全球短信發(fā)送能力。它主要有以下特點:
- 核心功能:支持發(fā)送驗證碼短信(用于登錄、注冊)和通知短信(用于物流、消費通知)。
- 核心概念:要發(fā)送短信,你必須在控制臺提前創(chuàng)建短信應用、申請并審核通過短信簽名和短信模板。簽名是發(fā)送方標識(如“【華為云】”),模板是包含變量的固定內(nèi)容。
SpringBoot接入華為云短信SDK步驟
以下是使用華為云官方Java SDK進行集成的詳細步驟。
第一步:開通服務與前期準備
- 注冊與實名:使用企業(yè)主體注冊華為云賬號,并完成企業(yè)實名認證。
- 開通服務:在控制臺搜索并開通“消息&短信 MSGSMS”服務。
- 準備密鑰:進入“我的憑證 > 訪問密鑰”,獲取用于API調(diào)用的Access Key (AK) 和Secret Key (SK)。
第二步:控制臺配置(關鍵步驟)
這是發(fā)送短信的前提,所有配置均需審核。
- 創(chuàng)建應用:在“應用管理”中創(chuàng)建短信應用,獲取
app_id和app_key。 - 申請簽名:在“簽名管理”中,根據(jù)你的企業(yè)身份申請短信簽名。簽名需要審核,且推廣類簽名需證明與接收方有會員或訂 購關系。
- 申請模板:在“模板管理”中創(chuàng)建模板。模板內(nèi)容需符合規(guī)范,例如驗證碼模板:“您的驗證碼為:{1},請在{2}分鐘內(nèi)填寫。” 提交后等待審核。
第三步:SpringBoot項目集成與代碼實現(xiàn)
添加Maven依賴
在pom.xml中添加官方SDK依賴。
<dependency>
<groupId>com.huaweicloud.sdk</groupId>
<artifactId>huaweicloud-sdk-smsapi</artifactId>
<!-- 請前往華為云官網(wǎng)SDK中心查詢并使用最新版本 -->
<version>{latest-version}</version>
</dependency>
配置AK/SK和應用信息
在application.yml中配置你的密鑰和應用信息。
huaweicloud:
sms:
ak: your-access-key # 替換為你的AK
sk: your-secret-key # 替換為你的SK
project-id: your-project-id # 在“我的憑證-項目列表”中查找
sender: 10690xxxxxxxx # 通道號,在創(chuàng)建的應用詳情中查看
signature: 華為云測試 # 已審核通過的簽名名稱
template-id: xxxxxxxx # 已審核通過的模板ID
region: cn-north-4 # 短信服務區(qū)域,如華北-北京四
創(chuàng)建配置類讀取屬性
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;
}
編寫短信發(fā)送服務類
這是最核心的業(yè)務類,用于組裝和發(fā)送請求。
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. 構建認證信息
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. 構造發(fā)送請求
SendSmsRequest request = new SendSmsRequest()
.withFrom(smsConfig.getSender()) // 發(fā)送號碼(通道號)
.withTo(Arrays.asList(mobile)) // 接收方號碼列表
.withTemplateId(smsConfig.getTemplateId()) // 模板ID
.withTemplateParas(templateParams) // 模板變量值列表
.withSignature(smsConfig.getSignature()); // 簽名名稱
// 4. 發(fā)送請求并處理響應
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è)務層調(diào)用
@RestController
@RequestMapping("/api/sms")
public class SmsController {
@Autowired
private HuaweiSmsService smsService;
@PostMapping("/send-verification")
public String sendVerificationCode(@RequestParam String phone) {
// 生成隨機驗證碼
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ā)送成功,驗證碼:" + code; // 生產(chǎn)環(huán)境不應返回驗證碼
} else {
return "短信發(fā)送失敗";
}
}
}
重要補充與總結
將以上步驟串聯(lián)起來,整個接入流程和注意事項如下:
總結與核心建議
- 官方SDK是首選:華為云提供了官方的Java SDK,直接集成是最穩(wěn)妥的方式。
- 配置先于代碼:務必理解“應用-簽名-模板”的依賴關系。所有配置必須先在控制臺 完成并通過審核,代碼才能成功調(diào)用。
- 嚴格遵循內(nèi)容規(guī)范:這是成功送達的關鍵。特別是面向國內(nèi)用戶時,務必遵守最新的合規(guī)要求。
- 關注錯誤碼:發(fā)送失敗時,華為云會返回明確的API錯誤碼(如
E200028表示模板變量錯誤)或狀態(tài)回執(zhí)錯誤碼。根據(jù)這些代碼在官方文檔中排查,是最高效的調(diào)試方法。
以上就是SpringBoot接入華為云短信SDK的流程步驟的詳細內(nèi)容,更多關于SpringBoot接入華為云短信SDK的資料請關注腳本之家其它相關文章!
相關文章
SpringMVC實戰(zhàn)案例RESTFul實現(xiàn)添加功能
這篇文章主要為大家介紹了SpringMVC實戰(zhàn)案例RESTFul實現(xiàn)添加功能詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2022-05-05
java后臺調(diào)用HttpURLConnection類模擬瀏覽器請求實例(可用于接口調(diào)用)
這篇文章主要介紹了java后臺調(diào)用HttpURLConnection類模擬瀏覽器請求實例,該實例可用于接口調(diào)用,具有一定的實用價值,需要的朋友可以參考下2014-10-10
springboot如何使用redis的incr創(chuàng)建分布式自增id
這篇文章主要介紹了springboot如何使用redis的incr創(chuàng)建分布式自增id,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-11-11
Mybatis中SqlSession接口中selectList方法詳解
這篇文章主要給大家介紹了關于Mybatis中SqlSession接口中selectList方法的相關資料,文中通過實例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2023-03-03
Java中注解@Async實現(xiàn)異步及導致失效原因分析
Async注解用于聲明一個方法是異步的,當在方法上加上這個注解時將會在一個新的線程中執(zhí)行該方法,而不會阻塞原始線程,這篇文章主要給大家介紹了關于Java中注解@Async實現(xiàn)異步及導致失效原因分析的相關資料,需要的朋友可以參考下2024-07-07

