SpringBoot实现短信发送

开发工具：IDEA、Gradle

1.由于笔者使用阿里云的短信接口，所以需要去阿里云获取相关服务支持，每个新用户都有免费的初始条数，之后需要简单的配置签名与信息模版和AccessKey；

2.导入相关jar包，在build.gradle文件内加入如下坐标：

    // 短信支持
    implementation('com.aliyun:aliyun-java-sdk-core:3.7.1')
    implementation('com.aliyun:aliyun-java-sdk-dysmsapi:1.1.0')

3.在application.properties配置文件内加入短信相关配置：

# 阿里云短信接口
accessKeyId=你的AccessKeyId
accessKeySecret=你的accessKeySecret

4.实现发送功能：

package xyz.lsm1998.me.utils;

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 org.springframework.util.ResourceUtils;

import java.io.File;
import java.io.FileInputStream;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Properties;

/**
 * 作者：刘时明
 * 日期：2018/10/30
 * 时间：16:42
 * 说明：
 */
public class SmsUtils
{
    //产品名称:云通信短信API产品,开发者无需替换
    static final String product = "Dysmsapi";
    //产品域名,开发者无需替换
    static final String domain = "dysmsapi.aliyuncs.com";

    private static String accessKeyId;
    private static String accessKeySecret;

    static
    {
        Properties properties=new Properties();
        try
        {
            File file= ResourceUtils.getFile("classpath:application.properties");
            properties.load(new FileInputStream(file));
        }catch (Exception e)
        {
            e.printStackTrace();
        }
        accessKeyId=properties.getProperty("accessKeyId");
        accessKeySecret=properties.getProperty("accessKeySecret");
    }

    public static void main(String[] args) throws Exception
    {
        SendSmsResponse response = sendSms("17774582000","456789");
        System.out.println(response.getCode());
        System.out.println(response.getMessage());
        QuerySendDetailsResponse qr=querySendDetails("17774582000");
        System.out.println("该用户收到的短信条数："+qr.getTotalCount());
        for (QuerySendDetailsResponse.SmsSendDetailDTO o:qr.getSmsSendDetailDTOs())
        {
            System.out.println("发送时间："+o.getSendDate());
        }
        
    }

    // 发送方法
    public static SendSmsResponse sendSms(String phoneNumbers, String code) 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(phoneNumbers);
        //必填:短信签名-可在短信控制台中找到
        request.setSignName("你的短信签名");
        //必填:短信模板-可在短信控制台中找到     
        request.setTemplateCode("你的模板Id");
        //设置参数
        request.setTemplateParam("{\"code\":" + code + "}");
        //可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
        //request.setOutId("123");
        //hint 此处可能会抛出异常，注意catch
        SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
        return sendSmsResponse;
    }

    // 查询方法
    public static QuerySendDetailsResponse querySendDetails(String phoneNumber) 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);

        //组装请求对象
        QuerySendDetailsRequest request = new QuerySendDetailsRequest();
        //必填-号码
        request.setPhoneNumber(phoneNumber);
        //必填-发送日期 支持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;
    }
}

PS：如果读者在测试发送功能过程中出现如下错误：

java.lang.NoClassDefFoundError: javax/xml/bind/DatatypeConverter

则改变build.gradle文件：

    // 短信支持
    //implementation('com.aliyun:aliyun-java-sdk-core:3.7.1')
    implementation('com.aliyun:aliyun-java-sdk-core:3.3.1')
    implementation('com.aliyun:aliyun-java-sdk-dysmsapi:1.1.0')

将sdk-core改为3.3.1版本即可，具体原因笔者暂时不详。

SpringBoot实现短信发送

猜你喜欢