2. 程式人生 > >【Java】阿里雲簡訊傳送功能實現

【Java】阿里雲簡訊傳送功能實現

阿新 • • 發佈：2018-12-11

前言

在移動端，我們除了使用賬號密碼、第三方社交平臺賬號(例如：微信、QQ、微博等)這幾種登入方式以外，也會通過手機簡訊驗證碼的方式來做登入。
博主最近正在做移動端的手機簡訊驗證登入。原本為了簡單起見，選用的是某個不知名科技公司的簡訊服務，但是收費貴，服務也不太穩定等一系列問題的出現，導致博主開始另尋他路。

簡訊服務選擇

博主挑選了幾家大公司的簡訊服務，以下為各服務官網的產品價格：

在參考了各個服務的費用以及公司系統使用者量等具體情況以後，博主最終選擇了 阿里雲簡訊服務 。

阿里雲簡訊配置

在我們實現 阿里雲簡訊傳送API 之前，其實在阿里雲平臺上還有一系列的操作需要我們去申請、配置等(例如：開通簡訊服務、獲取AccessKey、建立簡訊的簽名和模板等等)。但是這些並不是本文的重點，所以博主這裡不做詳細的敘述。
大家可以自行參考阿里雲提供的 簡訊服務文件使用指引，根據步驟操作。

API所需配置提取

假設上述配置操作大家已完成，博主這裡用公司已註冊好的模板舉個例子。我們需要提取記錄的配置有以下幾種：

  • AccessKeyID和AccessKeySecret： 關於這個內容大家自行參考官方文件 如何獲取AccessKeyID和AccessKeySecret，步驟寫的也比較詳細，博主在這裡就不做過多的敘述。
  • 簽名名稱： 開啟阿里簡訊服務管理控制檯，按順序點開：國內訊息->簽名管理，我這裡選用阿里贈送的簽名 阿里雲簡訊測試專用 。
圖1 獲取簽名名稱
  • 模板CODE和內容： 開啟阿里簡訊服務管理控制檯，按順序點開：國內訊息->模板管理->點選對應模板操作中的詳情，我這裡選用阿里贈送的 身份驗證驗證碼 模板。
圖2 獲取模板CODE和內容

對以上的內容先做記錄，因為後續在程式碼中我們相應會用到。

程式碼實現

基本的工作已經做完了，下面我們來看下具體程式碼的實現

1.新增依賴

	<!-- 阿里雲簡訊服務sdk -->
	<dependency>
	    <groupId>com.aliyun</groupId>
	    <artifactId>aliyun-java-sdk-core</artifactId>
	    <version>3.3.1</version>
	</dependency>
	<dependency>
	    <groupId>com.aliyun</groupId>
	    <artifactId>aliyun-java-sdk-dysmsapi</artifactId>
	    <version>1.1.0</version>
	</dependency>

2.阿里雲簡訊構造類

博主這裡採用鏈式的寫法，程式碼中的accessKeyId 和 accessKeySecret 需要替換成我們從雲平臺提取的對應值。

/**
 * 阿里雲簡訊構造類
 * Created by Hilox on 2018/11/22 0022.
 */
public class AliSmsBuilder implements Serializable {

    private static final long serialVersionUID = -8277819898310935813L;

    /**
     * 阿里雲簡訊服務accessKeyId
     */
    private String accessKeyId;

    /**
     * 阿里雲簡訊服務accessKeySecret
     */
    private String accessKeySecret;

    /**
     * 必填:待發送手機號
     */
    private String phoneNum;

    /**
     * 必填:簡訊簽名-可在簡訊控制檯中找到
     */
    private String signName;

    /**
     * 必填:簡訊模板-可在簡訊控制檯中找到
     */
    private String templateCode;

    /**
     * 可選:驗證碼
     */
    private String verifyCode;

    /**
     * 可選:上行簡訊擴充套件碼(無特殊需求使用者請忽略此欄位)
     */
    private String smsUpExtendCode;

    /**
     * 可選:outId為提供給業務方擴充套件欄位,最終在簡訊回執訊息中將此值帶回給呼叫者
     */
    private String outId;

    private String defaultConnectTimeout;

    private String defaultReadTimeout;

    public AliSmsBuilder() {
        // 預設初始化
        accessKeyId = "***";   // 替換成自己的阿里雲簡訊accessKeyId
        accessKeySecret = "***";   // 替換成自己的阿里雲簡訊accessKeySecret
        this.defaultConnectTimeout = "10000";
        this.defaultReadTimeout = "10000";
    }

    public AliSmsBuilder(String accessKeyId, String accessKeySecret) {
        // 自定義初始化
        this.accessKeyId = accessKeyId;
        this.accessKeySecret = accessKeySecret;
    }

    public AliSmsBuilder setAccessKeyId(String accessKeyId) {
        this.accessKeyId = accessKeyId;
        return this;
    }

    public String getAccessKeyId() {
        return accessKeyId;
    }

    public AliSmsBuilder setAccessKeySecret(String accessKeySecret) {
        this.accessKeySecret = accessKeySecret;
        return this;
    }

    public String getDefaultConnectTimeout() {
        return defaultConnectTimeout;
    }

    public AliSmsBuilder setDefaultConnectTimeout(String defaultConnectTimeout) {
        this.defaultConnectTimeout = defaultConnectTimeout;
        return this;
    }

    public String getDefaultReadTimeout() {
        return defaultReadTimeout;
    }

    public AliSmsBuilder setDefaultReadTimeout(String defaultReadTimeout) {
        this.defaultReadTimeout = defaultReadTimeout;
        return this;
    }

    public String getAccessKeySecret() {
        return accessKeySecret;
    }

    public AliSmsBuilder setPhoneNum(String phoneNum) {
        this.phoneNum = phoneNum;
        return this;
    }

    public String getPhoneNum() {
        return phoneNum;
    }

    public AliSmsBuilder setSignName(String signName) {
        this.signName = signName;
        return this;
    }

    public String getSignName() {
        return signName;
    }

    public AliSmsBuilder setTemplateCode(String templateCode) {
        this.templateCode = templateCode;
        return this;
    }

    public String getTemplateCode() {
        return templateCode;
    }

    public AliSmsBuilder setVerifyCode(String verifyCode) {
        this.verifyCode = verifyCode;
        return this;
    }

    public String getVerifyCode() {
        return verifyCode;
    }

    public AliSmsBuilder setSmsUpExtendCode(String smsUpExtendCode) {
        this.smsUpExtendCode = smsUpExtendCode;
        return this;
    }

    public String getSmsUpExtendCode() {
        return smsUpExtendCode;
    }

    public AliSmsBuilder setOutId(String outId) {
        this.outId = outId;
        return this;
    }

    public String getOutId() {
        return outId;
    }

    @Override
    public String toString() {
        return "AliSmsBuilder{" +
                "accessKeyId='" + accessKeyId + '\'' +
                ", accessKeySecret='" + accessKeySecret + '\'' +
                ", phoneNum='" + phoneNum + '\'' +
                ", signName='" + signName + '\'' +
                ", templateCode='" + templateCode + '\'' +
                ", verifyCode='" + verifyCode + '\'' +
                ", smsUpExtendCode='" + smsUpExtendCode + '\'' +
                ", outId='" + outId + '\'' +
                ", defaultConnectTimeout='" + defaultConnectTimeout + '\'' +
                ", defaultReadTimeout='" + defaultReadTimeout + '\'' +
                '}';
    }

    /**
     * 傳送簡訊訊息
     * @return
     * @throws ClientException
     */
    public String send() throws ClientException {
        return AliSmsSDK.getInstance().sendSmsAli(this);
    }
}

3.阿里雲簡訊SDK

在這裡有一點要強調下，我們從平臺提取的簡訊模板內容為 驗證碼${code}，您正在進行身份驗證，打死不要告訴別人哦！，所以在以下程式碼當中我們設定模板引數的JSON串的程式碼為 request.setTemplateParam("{\"code\":\"" + 變數替換值 + "\"}"); 同理，如果你的模板內容是 親愛的${name},您的驗證碼為${code} 那麼在程式碼當中我們設定模板引數的JSON串的程式碼應該是 request.setTemplateParam("{\"name\":\"" + 變數替換值 + "\", \"code\":\"" + 變數替換值 + "\"}"); 。阿里雲對於變數替換值也是有要求的：變數替換值<=6位數字或字母。
換句話說以上JSON串該如何寫，主要還是看你的模板內容如何配置。當然 request.setTemplateParam("{\"code\":\"" + 變數替換值 + "\"}"); 這段程式碼也可以忽略(只要對應的模板內容不配置佔位符)，因為這並不是必須的。

/**
 * 阿里雲簡訊SDK
 * Created by Hilox on 2018/11/22 0022.
 */
@Slf4j
public class AliSmsSDK {

    // 產品名稱:雲通訊簡訊API產品,開發者無需替換
    private static final String product = "Dysmsapi";
    // 產品域名,開發者無需替換
    private static final String domain = "dysmsapi.aliyuncs.com";

    /**
     * 私有化構造
     */
    private AliSmsSDK() {}

    /**
     * 靜態內部類
     */
    private static class AliSmsSDKHolder {
        private static final AliSmsSDK INSTANCE = new AliSmsSDK();
    }

    /**
     * 選用靜態內部類實現單例：
     *     1.防止懶漢式單例多執行緒額外開銷
     *     2.防止餓漢式單例記憶體資源浪費
     * @return
     */
    public static final AliSmsSDK getInstance() {
        return AliSmsSDKHolder.INSTANCE;
    }

    /**
     * 傳送簡訊驗證碼(阿里雲簡訊平臺)
     * @param aliSmsBuilder
     * @return
     */
    public String sendSmsAli(AliSmsBuilder aliSmsBuilder) throws ClientException {

        log.info("==== 開始傳送簡訊驗證碼訊息體: {} =====", aliSmsBuilder.toString());

        // 設定超時時間-可自行調整
        System.setProperty("sun.net.client.defaultConnectTimeout", aliSmsBuilder.getDefaultConnectTimeout());
        System.setProperty("sun.net.client.defaultReadTimeout", aliSmsBuilder.getDefaultReadTimeout());

        // 初始化acsClient, 暫不支援region化
        IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", aliSmsBuilder.getAccessKeyId(), aliSmsBuilder.getAccessKeySecret());
        DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
        IAcsClient acsClient = new DefaultAcsClient(profile);
        // 組裝請求物件-具體描述見控制檯-文件部分內容
        SendSmsRequest request = new SendSmsRequest();
        // 必填:待發送手機號
        request.setPhoneNumbers(aliSmsBuilder.getPhoneNum());
        // 必填:簡訊簽名-可在簡訊控制檯中找到
        request.setSignName(aliSmsBuilder.getSignName());
        // 必填:簡訊模板-可在簡訊控制檯中找到
        request.setTemplateCode(aliSmsBuilder.getTemplateCode());

        String verifyCode = aliSmsBuilder.getVerifyCode();
        // 可選:模板中的變數替換JSON串,如模板內容為"親愛的${name},您的驗證碼為${code}"時,此處的值為 request.setTemplateParam("{\"name\":\"Tom\", \"code\":\"123\"}");
        if (!StringUtils.isEmpty(verifyCode)) {
            request.setTemplateParam("{\"code\":\"" + verifyCode + "\"}");
        }

        String smsUpExtendCode = aliSmsBuilder.getSmsUpExtendCode();
        // 選填-上行簡訊擴充套件碼(無特殊需求使用者請忽略此欄位)
        if (!StringUtils.isEmpty(smsUpExtendCode)) {
            request.setSmsUpExtendCode(smsUpExtendCode);
        }

        String outId = aliSmsBuilder.getOutId();
        // 可選:outId為提供給業務方擴充套件欄位,最終在簡訊回執訊息中將此值帶回給呼叫者
        if (!StringUtils.isEmpty(outId)) {
            request.setOutId(outId);
        }

        //hint 此處可能會丟擲異常，注意catch
        SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
        String code = sendSmsResponse.getCode();

        log.info("==== 傳送簡訊驗證碼成功, 返回code: {} =====", code);
        return code;
    }
}

4.阿里簡訊驗證碼返回code列舉

/**
 * 阿里簡訊驗證碼返回code列表
 * Created by Hilox on 2018/11/13 0013.
 */
public enum AliSmsCodeEnum {

    OK("OK", "請求成功"),
    RAM_PERMISSION_DENY("isp.RAM_PERMISSION_DENY", "RAM許可權DENY"),
    OUT_OF_SERVICE("isv.OUT_OF_SERVICE", "業務停機"),
    PRODUCT_UN_SUBSCRIPT("isv.PRODUCT_UN_SUBSCRIPT", "未開通雲通訊產品的阿里雲客戶"),
    PRODUCT_UNSUBSCRIBE("isv.PRODUCT_UNSUBSCRIBE", "產品未開通"),
    ACCOUNT_NOT_EXISTS("isv.ACCOUNT_NOT_EXISTS", "賬戶不存在"),
    ACCOUNT_ABNORMAL("isv.ACCOUNT_ABNORMAL", "賬戶異常"),
    SMS_TEMPLATE_ILLEGAL("isv.SMS_TEMPLATE_ILLEGAL", "簡訊模板不合法"),
    SMS_SIGNATURE_ILLEGAL("isv.SMS_SIGNATURE_ILLEGAL", "簡訊簽名不合法"),
    INVALID_PARAMETERS("isv.INVALID_PARAMETERS", "引數異常"),
    SYSTEM_ERROR("isp.SYSTEM_ERROR", "系統錯誤"),
    MOBILE_NUMBER_ILLEGAL("isv.MOBILE_NUMBER_ILLEGAL", "非法手機號"),
    MOBILE_COUNT_OVER_LIMIT("isv.MOBILE_COUNT_OVER_LIMIT", "手機號碼數量超過限制"),
    TEMPLATE_MISSING_PARAMETERS("isv.TEMPLATE_MISSING_PARAMETERS", "模板缺少變數"),
    BUSINESS_LIMIT_CONTROL("isv.BUSINESS_LIMIT_CONTROL", "業務限流"),
    INVALID_JSON_PARAM("isv.INVALID_JSON_PARAM", "JSON引數不合法，只接受字串值"),
    BLACK_KEY_CONTROL_LIMIT("isv.BLACK_KEY_CONTROL_LIMIT", "黑名單管控"),
    PARAM_LENGTH_LIMIT("isv.PARAM_LENGTH_LIMIT", "引數超出長度限制"),
    PARAM_NOT_SUPPORT_URL("isv.PARAM_NOT_SUPPORT_URL", "不支援URL"),
    AMOUNT_NOT_ENOUGH("isv.AMOUNT_NOT_ENOUGH", "賬戶餘額不足"),
    ;

    private String code;

    private String msg;

    AliSmsCodeEnum(String code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    public String getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }

    /**
     * 根據code獲取msg
     * @param code
     * @return
     */
    public static String getMsgByCode(String code) {
        if (StringUtils.isEmpty(code)) {
            return null;
        }
        AliSmsCodeEnum[] values = AliSmsCodeEnum.values();
        for (AliSmsCodeEnum aliSmsCodeEnum : values) {
            if (aliSmsCodeEnum.getCode().equals(code)) {
                return aliSmsCodeEnum.getMsg();
            }
        }
        return null;
    }
}

5.測試用例

博主在這裡簡單的寫了個測試用例，後續呼叫方式大家可以從這裡做參考。
對應的值需要替換成從雲平臺提取出來的相應值。

/**
 * 測試用例模板
 * Created by Hilox on 2018/11/22 0022.
 */
public class AliSmsSDKTest {

    @Test
    public void sendSmsAli() {
        AliSmsBuilder aliSmsBuilder = new AliSmsBuilder();
        String code;
        try {
            code = aliSmsBuilder.setPhoneNum("150****8879")    // 替換成自己的手機號
                    .setSignName("阿里雲簡訊測試專用")  // 替換成自己的阿里雲簡訊服務簽名
                    .setTemplateCode("SMS_108565014") // 替換成自己的阿里雲簡訊模板編號
                    .setVerifyCode("Hilox") // 替換成自己隨機生成的驗證碼
                    .send();
        } catch (ClientException e) {
            e.printStackTrace();
            // 簡訊傳送異常提示
            return;
        }

        // 簡訊異常碼處理
        if (code == null || !"OK".equals(code)) {
            String errorMsg = AliSmsCodeEnum.getMsgByCode(code);
            if (!StringUtils.isEmpty(errorMsg)) {
                // 對應簡訊異常錯誤提示
                return;
            }
            // 簡訊傳送異常提示
        }
    }
}

原始碼傳送門

【原始碼地址】：sms-ali

測試效果展示

圖3 測試效果展示

相關推薦

【Java】阿里雲簡訊傳送功能實現

前言 在移動端，我們除了使用賬號密碼、第三方社交平臺賬號(例如：微信、QQ、微博等)這幾種登入方式以外，也會通過手機簡訊驗證碼的方式來做登入。 博主最近正在做移動端的手機簡訊驗證登入。原本為了簡單起見，選用的是某個不知名科技公司的簡訊服務，但是收費貴，服務也不太穩定等一系列問題的出現

java呼叫阿里雲簡訊伺服器-傳送簡訊

首先註冊購買阿里雲簡訊伺服器,具體步驟自行百度程式碼maven依賴<!-- 阿里簡訊平臺依賴 --> <dependency> <groupId>com.aliyun</groupId> <

阿里雲簡訊傳送驗證碼-Java

匯入相關包 import com.aliyuncs.DefaultAcsClient; import com.aliyuncs.IAcsClient; import com.aliyuncs.dysmsapi.model.v20170525.SendSmsRequest;

Java呼叫阿里雲簡訊通道服務

這裡我們使用SpringBoot 來呼叫阿里通訊的服務。 (用哪個框架無所謂，即便是統Java工程也能實現，但需要連網) 阿里通訊，雙11.收到簡訊,日傳送達6億條。保障力度非常高。 使用的步驟： 第一步：需要開通賬戶 第二步：閱讀介面文件 祕鑰管理 簡訊簽名 簡訊模板

【轉】阿里雲Ubuntu系統搭建SVN伺服器

##SVN伺服器相關軟體安裝 1、使用SSH遠端伺服器 （1）對於MAC OS/Liunx的使用者直接開啟終端輸入 ssh  使用者名稱@例項名，例如 ssh [email protected] 執行上面的命令後終端會提示輸入密碼，驗證通過後會出現如下資訊： We

【轉】阿里雲祝順民（江鶴）：開放性雲網絡生態加速行業發展

轉載自SDNLab，原文連結https://www.sdnlab.com/22587.html。 剛才很多專家介紹到雲網協同，我想從雲的視角來跟大家介紹一下我們阿里雲怎麼看SD-WAN，以及我們做了哪些工作來配合SD-WAN的發展。 阿里雲的網路技術是飛天作業系統的重要組成部分。具體來看，包括雲上網

【Linux】阿里雲ECS提示RHSA-2017:3263: curl security update（CentOS 7 更新 curl 為最新版本）

1、前言 　　由於 CentOS 7 內建的 curl 和 libcurl 源為較舊的 7.29.0，不支援一些新特性且有安全性問題，所以需要更新一下。 2、開始 　　1、更新ca-bundle 　　　　· 首先備份一下  　　　　　　cp /etc/pki/tls/certs/ca-bu

【轉載】阿里雲這群瘋子

世事安穩，歲月靜好。 電影裡才有瘋子。麥克墨菲在瘋人院裡帶領一群精神病人揭竿而起，懟天懟地；餓了三天的黑皮為了搶一口麵包被店主追上高架橋，末路狂奔；傑克和泰勒在午夜的搏擊俱樂部裡揮拳相向，鮮血淋漓。螢幕對面，我們把爆米花塞進嘴裡，哭成狗或者笑成狗。電影散場，各自回家。 真正的瘋子，從來不看電影。

【伺服器】阿里雲伺服器的初步瞭解

前言   阿里雲伺服器是隨著歷史的演進和發展，一種先進的伺服器部署方式，與傳統的IDC機房託管方式相比有很大的進步。 ECS與IDC   1.ECS   (1)阿里雲伺服器（Elastic Compu

阿里雲簡訊傳送服務SDK-Python3

本文提供阿里雲的簡訊傳送服務SDK，使用Python3實現。 # -*- coding: utf-8 -*- # pip install requests import requests import urllib.request import time import uuid impor

阿里雲簡訊傳送示例

之前一直用的是雲片的簡訊，最近簡訊有需求，經過選擇更改為阿里雲通訊， 阿里簡訊傳送官方API https://api.alidayu.com/docs/api.htm?spm=a3142.7

【評論】阿里雲os，到底是不是android OS

很久以前，因為要買手機，並且是要買千元的智慧機，所以關注國內手機各大生產商很久。當然，首當其衝是小米，當時小米的價效比無線高，可以秒殺國內各大品牌手機。正當自己要入手的時候，突然發現有更多的選擇，什麼大黃蜂小黃蜂，再後來就是特供機，再再後來就有了小辣椒之類的，價錢甚至是小米

【轉】阿里雲+wordpress搭建個人部落格網站【小白專用的圖文教程】

簡介 對於初次接觸雲伺服器的童鞋，想要搭建一個屬於自己的個人部落格是非常裝比的事情，那麼這裡有一個非常好的框架wordpress可以使用。 這裡主要分享一篇文章基於阿里雲伺服器以及WordPress從頭到尾搭建一個屬於自己的個人部落格 相信看完這篇博文

java接入阿里雲簡訊sdk 程式碼

前言 程式碼 兩種傳送方式:getAcsResponse和doAction介面，這裡演示最簡單的getAcsResponse。 /** * * @param toPhon

阿里雲簡訊傳送模組api及demo

安裝方法：$ npm install @alicloud/sms-sdk --save 程式碼： /**  * 雲通訊基礎能力業務簡訊傳送、查詢詳情以及消費訊息示例，供參考。  * Created on 2017-07-31  */ const SMS

【轉】Verilog學習筆記簡單功能實現（八）...............異步FIFO

另一個 gif 多個 可靠 基本原理 drs bar next 不同 基本原理： 1.讀寫指針的工作原理 　　寫指針：總是指向下一個將要被寫入的單元，復位時，指向第1個單元(編號為0)。 　　讀指針：總是指向當前要被讀出的數據，復位時，指向第1個單元(編號為0)

【TP】ThinkPHP3.1使用者登陸功能實現-核心程式碼

ThinkPHP3.1使用者登陸功能實現-核心程式碼 建立User管理類並寫入以下程式碼: 程式碼如下: <?php // 使用者管理類 class UserAction extends Action { public function index(){

【Java】Iterator底層原理，自己實現Iterator

package test; import java.util.Iterator; public class MyIterator implements java.lang.Iterable<String> { private String[] eleme

【Java】ArrayList 底層原理，自己實現ArrayList

實現的功能有  elementData物件陣列用來存放物件 size 計算容器大小 ArrayList空構造器，帶初始大小的構造器 ensureCapacity進行物件陣列擴容 rangeCheck進行檢查輸入值是否在範圍內 get方法返回某一位置物件 set方

【Java】Java8 HashMap工作原理及實現

1 、概述 從本文你可以學到 什麼時候會使用HashMap？他有什麼特點？ 你知道HashMap的工作原理嗎？ 你知道get和put的原理嗎？equals()和hashCode()的都有什麼作用？ 你知道hash的實現嗎？