Java 调用阿里云短信服务

本文参考:https://blog.csdn.net/weixin_44930692/article/details/107124304

使用 Java 调用阿里云短信服务

短信验证码想必大家都不陌生,在很多网站,APP中都有使用到。比如登录,注册,身份校验等场景。不过通常情况下,短信服务都是外包给第三方公司的,接下来向大家分享如何使用阿里的短信服务。

登录阿里云申请短信服务

首先我们登陆阿里云官网,搜索短信服务,注册并开通授权。
这里为了方便小伙伴快速申请也可以点击下方传送门。
阿里云短信服务
在这里插入图片描述

申请签名和模板

根据接收短信的区域选择国内消息或者国际消息,进行相应的签名和模板申请。申请签名没什么注意事项,具体阿里云都有备注提示,

  • 模板名称:就是接收消息的前缀
  • 模板内容:可以自己写,也可以查看模板库自定义修改
  • 申请说明 :个人学习交流(按自己实际情况填写)

这些信息填完之后一般不到半小时左右就通过了
在这里插入图片描述
在这里插入图片描述

申请AccessKey获得阿里云账户的操控权限

在这里插入图片描述
在这里插入图片描述

为了安全考虑这里推荐使用子用户AccessKey,给予最小对应权限即可。
在这里插入图片描述
在这里插入图片描述

请记住申请完子用户AccessKey后不要立即关闭窗口,先将申请的AccessKeySecret进行保存,因为关闭后,再也没办法进行查看AccessKeySecret,只能查看到AccessKeyId。

测试短信发送

准备工作完成后,在短信服务的快速学习栏中,可以使用创建的签名和模板进行发送测试看看效果,没问题后,再进行编码操控。(如余额不足,需要先对账户进行充值)遇到错误代码不要慌,先查看帮助文档;
在这里插入图片描述
在这里插入图片描述

成功事例
在这里插入图片描述

使用Java调用阿里云短信服务
这里尽量使用新的api进行操控,链接: 官方文档
Maven项目架包依赖如下:

<!--阿里云短信sdk-->
 <dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-core</artifactId>
    <version>4.1.0</version>
</dependency>
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-dysmsapi</artifactId>
    <version>2.0.0</version>
</dependency>      

代码如下:

/**
 * 阿里云的参数配置类
 * 短信服务
 */
public class AliYunParameterUtil {
    
    
    /**
     * 这个需要替换自己的AK(在阿里云的Accesskey管理中寻找)
     */
    public static String accessKeyId = "自己的";
    public static String  accessSecret = "自己的";

    /**
     * 签名名称(需要替换以及只有审核后才能使用)在阿里云控制台中找到签名管理中的签名名称
     */
    public static String signName ="自己的";

    /**
     * 模板code (需要替换 以及只有审核后才能使用) 在阿里云控制台中找到模板管理中的模板code
     */
    public static String TemplateCode ="自己的";

    /**
     * 产品名称:云通信短信API产品,开发者无需替换
     */
    public static final String PRODUCT = "Dysmsapi";
    /**
     * 产品域名,开发者无需替换
     */
    public static final String DOMAIN = "dysmsapi.aliyuncs.com";

    /**
     * 验证码
     */
    private static int captcha;

    public static String specialUrlEncode(String value) throws Exception {
    
    
        return java.net.URLEncoder.encode(value, "UTF-8").replace("+", "%20").replace("*", "%2A").replace("%7E", "~");
    }
    public static String sign(String accessSecret, String stringToSign) throws Exception {
    
    
        javax.crypto.Mac mac = javax.crypto.Mac.getInstance("HmacSHA1");
        mac.init(new javax.crypto.spec.SecretKeySpec(accessSecret.getBytes("UTF-8"), "HmacSHA1"));
        byte[] signData = mac.doFinal(stringToSign.getBytes("UTF-8"));
        return new sun.misc.BASE64Encoder().encode(signData);
    }


    public static int getCaptcha() {
    
    
        return captcha;
    }

    public static void setCaptcha() {
    
    
        captcha = (int) (Math.random() * 9999) + 100;  //每次调用生成一位四位数的随机数;
    }
}

import com.alibaba.fastjson.JSONObject;
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 com.ruoyi.common.annotation.Log;
import com.ruoyi.common.constant.HttpStatus;
import com.ruoyi.common.exception.CustomException;

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

/**
 *
 * 阿里云的短信通知发送功能
 *
 */
public class AliYunSmsUtils {
    
    

    public static void main(String[] args) throws ClientException{
    
    
        String phoneNumber = "号码";
        AliYunParameterUtil.setCaptcha();
        String code = Integer.toString(AliYunParameterUtil.getCaptcha());
        System.out.println("发送的验证码为:" + code);
        //发短信
        SendSmsResponse sendSms = sendSms(phoneNumber, code);
        System.out.println("调用SendSms发送短信-----------------------------");
        System.out.println("Code=" + sendSms.getCode());
        System.out.println("Message=" + sendSms.getMessage());
        System.out.println("RequestId=" + sendSms.getRequestId());
        System.out.println("BizId=" + sendSms.getBizId());
    }


    /**
     * @param phoneNumber 手机号
     * @param code        验证码
     * @desc :1.发送短信
     */
    @Log(title = "发送短信")
    public static SendSmsResponse sendSms(String phoneNumber, String code){
    
    
        SendSmsResponse sendSmsResponse = null;
        try{
    
    
            //1.准备好短信模板变量——验证码code
            JSONObject jsonObject = new JSONObject();
            jsonObject.put("code", code);
            String TemplateParam = jsonObject.toJSONString();

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

            //3.初始化acsClient,暂不支持region化
            IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", AliYunParameterUtil.accessKeyId, AliYunParameterUtil.accessSecret);
            DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", AliYunParameterUtil.PRODUCT, AliYunParameterUtil.DOMAIN);
            IAcsClient acsClient = new DefaultAcsClient(profile);

            //4.组装请求对象-具体描述见控制台-文档部分内容
            SendSmsRequest request = new SendSmsRequest();
            //必填:待发送手机号
            request.setPhoneNumbers(phoneNumber);
            //必填:短信签名-可在短信控制台中找到
            request.setSignName(AliYunParameterUtil.signName);
            //必填:短信模板-可在短信控制台中找到
            request.setTemplateCode(AliYunParameterUtil.TemplateCode);
            //可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
            request.setTemplateParam(TemplateParam);

            //选填-上行短信扩展码(无特殊需求用户请忽略此字段)
            //request.setSmsUpExtendCode("90997");

            //可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
            //request.setOutId("sgaet2020168");

            //5.hint 此处可能会抛出异常,注意catch
            sendSmsResponse = acsClient.getAcsResponse(request);
        }catch (Exception e){
    
    
            System.out.println("引起异常的原因------>"+e);
            System.out.println("异常信息------>"+e.getMessage());
            System.out.println("短信发送失败!");
            throw new CustomException("手机号码不能为空", HttpStatus.BAD_REQUEST);
        }
        return sendSmsResponse;
    }



    /**
     * @param bizId
     * @param phoneNumber
     * @desc :2.短信发送记录查询接口
     * 用于查询短信发送的状态,是否成功到达终端用户手机
     */
    @Log(title = "短信查询")
    public static QuerySendDetailsResponse querySendDetails(String bizId, String phoneNumber){
    
    
        QuerySendDetailsResponse querySendDetailsResponse = null;
        try {
    
    
            //可自助调整超时时间
            System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
            System.setProperty("sun.net.client.defaultReadTimeout", "10000");

            //初始化acsClient,暂不支持region化
            IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", AliYunParameterUtil.accessKeyId, AliYunParameterUtil.accessSecret);
            DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", AliYunParameterUtil.PRODUCT, AliYunParameterUtil.DOMAIN);
            IAcsClient acsClient = new DefaultAcsClient(profile);

            //组装请求对象
            QuerySendDetailsRequest request = new QuerySendDetailsRequest();
            //必填-号码
            request.setPhoneNumber(phoneNumber);
            //可选-流水号
            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 = acsClient.getAcsResponse(request);
        } catch (Exception e) {
    
    
            System.out.println("引起异常的原因------>"+e);
            System.out.println("异常信息------>"+e.getMessage());
        }
        return querySendDetailsResponse;
    }
}


猜你喜欢

转载自blog.csdn.net/xiejnpeng/article/details/111400601