SMS--短信服务

/ 架构设计语言 / 没有评论 / 151浏览

短信服务介绍

短信服务(Short Message Service)是阿里云为用户提供的一种通信服务的能力。

截屏2021-08-29 下午1.03.56

短信服务使用

接下来,我们使用短信验证码功能来演示短信服务的使用。流程如下:

截屏2021-08-29 下午1.04.52

准备工作

实名认证

https://help.aliyun.com/document_detail/48263.html?spm=5176.11533457.J_1089570.9.15da5333ZUkUdR

开通短信服务

https://www.aliyun.com/product/sms?spm=5176.11533457.J_1089570.9.15da5333ZUkUdR

截屏2021-08-29 下午1.12.51

申请认证秘钥

https://ram.console.aliyun.com/manage/ak

截屏2021-08-29 下午1.29.37

申请短信签名

截屏2021-08-29 下午1.32.48

申请短信模板

截屏2021-08-29 下午1.33.03

短信服务 API 介绍

短信发送

调用SendSms发送短信。

请求参数

名称**类型 **是否必选**示例值 **描述
PhoneNumbersString15900000000接收短信的手机号码。
SignNameString阿里云短信签名名称。
TemplateCodeStringSMS_153055065短信模板ID。
TemplateParamString{"code":"1111"}短信模板变量的值,JSON格式

返回数据

名称类型示例值描述
BizIdString900619746936498440发送回执ID,可根据它查询具体的发 送
CodeStringOK请求状态码。返回OK代表请求成功。
MessageStringOK状态码的描述。
RequestIdStringF655A8D5-B967-440B- 8683请求ID。

短信查询

调用QuerySendDetails接口查看短信发送记录和发送状态。

请求参数

名称类型是否必选示例值描述
CurrentPageLong1分页查看发送记录,指定发送记录的当前页码。
PageSizeLong10分页查看发送记录,指定每页显示的短信记录数量。取值范围为1~50。
PhoneNumberString1590000****接收短信的手机号码。格式:国内短信:11位手机号码,例如1590000****。国际/港澳台消息:国际区号+号码,例如8520000****。
SendDateString20181228短信发送日期,支持查询最近30天的记录。格式为yyyyMMdd,例如20181225。
BizIdString134523^4351232发送回执ID,即发送流水号。调用发送接口SendSms或SendBatchSms发送短信时,返回值中的BizId字段。

返回数据

名称类型示例值描述
CodeStringOK请求状态码。返回OK代表请求成功。其他错误码,请参见错误码列表
MessageStringOK状态码的描述。
RequestIdString819BE656-D2E0-4858-8B21-B2E477085AAF请求ID。
SmsSendDetailDTOsArray of SmsSendDetailDTO短信发送明细。
TotalCountString1短信发送总条数。

功能测试

第1步: 引入阿里云服务依赖

<!--短信发送-->
<dependency>
  <groupId>com.alibaba.cloud</groupId> 
  <artifactId>spring-cloud-alicloud-sms</artifactId> 
</dependency>

第2步: 使用阿里云提供的Demo测试短信发送

import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.dysmsapi.model.v20170525.QuerySendDetailsRequest;
import com.aliyuncs.dysmsapi.model.v20170525.QuerySendDetailsResponse;
import com.aliyuncs.dysmsapi.model.v20170525.SendSmsRequest;
import com.aliyuncs.dysmsapi.model.v20170525.SendSmsResponse;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.profile.IClientProfile;

import java.text.SimpleDateFormat;
import java.util.Date;

public class SmsDemo {
    //产品名称:云通信短信API产品,开发者无需替换
    static final String product = "Dysmsapi"; //产品域名,开发者无需替换
    static final String domain = "dysmsapi.aliyuncs.com";
    // TODO 此处需要替换成开发者自己的AK(在阿里云访问控制台寻找)
    static final String accessKeyId = "yourAccessKeyId";
    static final String accessKeySecret = "yourAccessKeySecret"; //短信发送

    public static SendSmsResponse sendSms() throws ClientException {

        //可自助调整超时时间
        System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
        System.setProperty("sun.net.client.defaultReadTimeout", "10000");

        //初始化acsClient,暂不支持region化
        IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou",accessKeyId, accessKeySecret);
        
        DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product,
                domain);
        IAcsClient acsClient = new DefaultAcsClient(profile);
        //组装请求对象-具体描述见控制台-文档部分内容
        SendSmsRequest request = new SendSmsRequest();
        //必填:待发送手机号
        request.setPhoneNumbers("15000000000");
        //必填:短信签名-可在短信控制台中找到
        request.setSignName("中古盲盒");
        //必填:短信模板-可在短信控制台中找到 
        request.setTemplateCode("SMS_1000000");
        // 可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
        request.setTemplateParam("{"name":"Tom", "code":"123"}");
        /**
         *  选填-上行短信扩展码(无特殊需求用户请忽略此字段)
         *   request.setSmsUpExtendCode("90997")
         */

        // 可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
         request.setOutId("yourOutId");
        // hint 此处可能会抛出异常,注意catch
        SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
        return sendSmsResponse;
    }

    //短信查询
    public static QuerySendDetailsResponse querySendDetails(String bizId) throws ClientException {

        //可自助调整超时时间
        System.setProperty("sun.net.client.defaultReadTimeout", "10000");
        System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
        //初始化acsClient,暂不支持region化
        IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou",accessKeyId, accessKeySecret);
        DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product,domain);
        IAcsClient acsClient = new DefaultAcsClient(profile); //组装请求对象
        QuerySendDetailsRequest request = new QuerySendDetailsRequest(); //必填-号码
        request.setPhoneNumber("15000000000");
        //可选-流水号
        request.setBizId(bizId);
        //必填-发送日期 支持30天内记录查询,格式yyyyMMdd
        SimpleDateFormat ft = new SimpleDateFormat("yyyyMMdd");
        request.setSendDate(ft.format(new Date()));
        //必填-页大小
        request.setPageSize(10L);
        //必填-当前页码从1开始计数
        request.setCurrentPage(1L);
        //hint 此处可能会抛出异常,注意catch
        QuerySendDetailsResponse querySendDetailsResponse =acsClient.getAcsResponse(request);
        return querySendDetailsResponse;
    }

    public static void main(String[] args) throws ClientException, InterruptedException {

        //发短信
        SendSmsResponse response = sendSms();
        System.out.println("短信接口返回的数据----------------");
        System.out.println("Code=" + response.getCode());
        System.out.println("Message=" + response.getMessage());
        System.out.println("RequestId=" + response.getRequestId());
        System.out.println("BizId=" + response.getBizId());
        Thread.sleep(3000L);
        //查明细
        if (response.getCode() != null && response.getCode().equals("OK")) {
            QuerySendDetailsResponse querySendDetailsResponse = querySendDetails(response.getBizId());
            System.out.println("短信明细查询接口返回数据----------------");
            System.out.println("Code=" + querySendDetailsResponse.getCode());
            System.out.println("Message=" + querySendDetailsResponse.getMessage());
            int i = 0;
            for (QuerySendDetailsResponse.SmsSendDetailDTO smsSendDetailDTO : querySendDetailsResponse.getSmsSendDetailDTOs()) {
                System.out.println("SmsSendDetailDTO[" + i + "]:");
                System.out.println("Content=" + smsSendDetailDTO.getContent());
                System.out.println("ErrCode=" + smsSendDetailDTO.getErrCode());
                System.out.println("OutId=" + smsSendDetailDTO.getOutId());
                System.out.println("PhoneNum=" + smsSendDetailDTO.getPhoneNum());
                System.out.println("ReceiveDate=" + smsSendDetailDTO.getReceiveDate());
                System.out.println("SendDate=" + smsSendDetailDTO.getSendDate());
                System.out.println("SendStatus=" + smsSendDetailDTO.getSendStatus());
                System.out.println("Template=" + smsSendDetailDTO.getTemplateCode());
            }
            System.out.println("TotalCount=" + querySendDetailsResponse.getTotalCount());
            System.out.println("RequestId=" + querySendDetailsResponse.getRequestId());
        }
    }
}

下单之后发送短信

在 shop-user 模块中加入sms依赖

<!--短信发送-->
<dependency>
  <groupId>com.alibaba.cloud</groupId> 
  <artifactId>spring-cloud-alicloud-sms</artifactId> 
</dependency>

将阿里短信给出的demo封装成工具类

import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.dysmsapi.model.v20170525.SendSmsRequest;
import com.aliyuncs.dysmsapi.model.v20170525.SendSmsResponse;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.profile.IClientProfile;

public class SmsUtil {
    //替换成自己申请的accessKeyId
    private static String accessKeyId = "LTAIMLlf8NKYXn1M"; //替换成自己申请的accessKeySecret
    private static String accessKeySecret = "hqyW0zTNzeSIFnZhMEkOaZXVVcr3Gj";
    static final String product = "Dysmsapi";
    static final String domain = "dysmsapi.aliyuncs.com";

    /**
     * \* 发送短信 *
     * \* @param phoneNumbers 要发送短信到哪个手机号
     * \* @param signName 短信签名[必须使用前面申请的]
     * \* @param templateCode 短信短信模板ID[必须使用前面申请的]
     * \* @param param 模板中${code}位置传递的内容
     */
    public static void sendSms(String phoneNumbers, String signName, String
            templateCode, String param) {
        try {
            System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
            System.setProperty("sun.net.client.defaultReadTimeout", "10000"); //初始化acsClient,暂不支持region化
            IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou",
                    accessKeyId, accessKeySecret);
            DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product,
                    domain);
            IAcsClient acsClient = new DefaultAcsClient(profile);
            SendSmsRequest request = new SendSmsRequest();
            request.setPhoneNumbers(phoneNumbers);
            request.setSignName(signName);
            request.setTemplateCode(templateCode);
            request.setTemplateParam(param);
            request.setOutId("yourOutId");
            
            SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
            if (!"OK".equals(sendSmsResponse.getCode())) {
                throw new RuntimeException(sendSmsResponse.getMessage());
            }
        } catch (Exception e) {
            e.printStackTrace();
            throw new RuntimeException("发送短信失败");
        }

    }
}

修改短信发送的服务

/* 发送短信的服务 */
@Slf4j
@Service( "shopSmsService" )
@RocketMQMessageListener(
        consumerGroup = "shop-user", /* 消费组名 */
        topic = "order-topic",     /* 消费主题 */
        consumeMode = ConsumeMode.CONCURRENTLY, /* 消费模式 */
        messageModel = MessageModel.CLUSTERING /* 消息模式 */
)
public class SmsService implements RocketMQListener<Order> {

    @Autowired
    private UserDao userDao;

    @Override
    public void onMessage(Order message) {
        log.info("接收到了一个订单信息{},接下来就可以发送短信通知了", message);
        //  根据uid 获取手机号
        User user = userDao.findById(message.getUid()).get();
        //  生成验证码
        StringBuilder builder = new StringBuilder();
        for (int i = 0; i < 6; i++) {
            builder.append(new Random().nextInt(9) + 1);
        }
        String smsCode = builder.toString();
        Param param = new Param(smsCode);
        try {
            // 发送短信 {"code":"123456"}
            SmsUtil.sendSms(user.getTelephone(), "黑马旅游网", "SMS_170836451", JSON.toJSONString(param));
            log.info("短信发送成功");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    @Data
    @AllArgsConstructor
    @NoArgsConstructor
    class Param {
        private String code;
    }
}