阿里云短信验证服务

Created in August 11, 2022

2022   ·   System Design Other

阿里云的用户权限操作

通过个人账户获得授权码(id、密码)，通过这些信息获得服务

阿里云地址

  • 1.登录/注册阿里云
  • 2.点击AccessKey管理
  • 3.创建一个用户
  • 4.为新建的用户添加权限

开通阿里云短信验证服务

  • 1.进入短信服务后台
  • 2.了解计费规则

添加短信模版

添加签名

测试代码

  • 可以查看相关的API Demo，修改即可
  • 1.新建Spring-boot项目
  • 2.引入依赖
	<!--aliyun-->
	<dependency>
		<groupId>com.aliyun</groupId>
		<artifactId>aliyun-java-sdk-core</artifactId>
		<version>4.5.3</version>
	</dependency>
	<!--fastjson-->
	<dependency>
		<groupId>com.alibaba</groupId>
		<artifactId>fastjson</artifactId>
		<version>1.2.73</version>
	</dependency>
	<!--redis-->
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-data-redis</artifactId>
	</dependency>
  • 3.编写测试类，加入刚刚的API Demo的代码进行修改
// 注意这里所有的包都是 aliyuncs 包下的
@Test
void contextLoads() {
	// 这里的 AccessKey ID 、 Secret就是 阿里云用户对于的值，复制过来即可
	DefaultProfile profile = DefaultProfile.getProfile("cn-hangzhou", "<accessKeyId>", "<accessSecret>");
	IAcsClient client = new DefaultAcsClient(profile);

	// 构建请求
	CommonRequest request = new CommonRequest();
	request.setSysMethod(MethodType.POST);
	request.setSysDomain("dysmsapi.aliyuncs.com");
	request.setSysVersion("2017-05-25");
	request.setSysAction("SendSms");
	// 上面不需要改
	// 自定义参数 ：
	// 手机号，这里 Value 就填用户的手机号，实际应用须要从表单获取
	request.putQueryParameter("PhoneNumbers", "138XXXXXXXX");
	// 签名，这里的 Value 就是在阿里云上申请的 签名
	request.putQueryParameter("SignName", "XXXX");
	// 模板，这里的 Value 就是在阿里云上申请的模板的 模版CODE 值
	request.putQueryParameter("TemplateCode", "XXXX");
	// 验证码，真实应用需要自动构建验证码
	HashMap<String, Object> map = new HashMap<>();
	map.put("code", 112233);
	request.putQueryParameter("TemplateParam", JSONObject.toJSONString(map));

	try {
		CommonResponse response = client.getCommonResponse(request);
		System.out.println(response.getData());
	} catch (ServerException e) {
		e.printStackTrace();
	} catch (ClientException e) {
		e.printStackTrace();
	}
}
  • 4.运行后就可以收到短信

注意：

  1. 如果以上的自定义参数名写错，不会成功
  2. 如果模版、签名没有通过审核会报错

实战模版

  • 1.编写接口SendSmsService 
public interface SendSmsService {
    /**
     * 用于发送短信
     * @param phoneNumber ：手机号
     * @param templateCode ：模板编号
     * @param code ：验证码
     * @return 是否发送成功
     */
    public boolean send(String phoneNumber, String templateCode, Map<String, Object> code);
}
  • 2.编写实现类SendSmsServiceImpl 

public class SendSmsServiceImpl implements SendSmsService {
    @Override
    public boolean send(String phoneNumber, String templateCode, Map<String, Object> code) {
        DefaultProfile profile = DefaultProfile.getProfile("cn-hangzhou", "<accessKeyId>", "<accessSecret>");
        IAcsClient client = new DefaultAcsClient(profile);

        // 构建请求
        CommonRequest request = new CommonRequest();
        request.setSysMethod(MethodType.POST);
        request.setSysDomain("dysmsapi.aliyuncs.com");
        request.setSysVersion("2017-05-25");
        request.setSysAction("SendSms");
        // 上面不需要改
        // 自定义参数 ：
        // 手机号，这里 Value 就填用户的手机号，实际应用须要从表单获取
        request.putQueryParameter("PhoneNumbers", phoneNumber);
        // 签名，这里的 Value 就是在阿里云上申请的 签名
        request.putQueryParameter("SignName", "XXXX");
        // 模板，这里的 Value 就是在阿里云上申请的模板的 模版CODE 值
        request.putQueryParameter("TemplateCode", templateCode);
        // 验证码，真实应用需要自动构建验证码
        request.putQueryParameter("TemplateParam", JSONObject.toJSONString(code));

        try {
            CommonResponse response = client.getCommonResponse(request);
            System.out.println(response.getData());
            // 自带的判断是否成功的方法
            return response.getHttpResponse().isSuccess();
        } catch (ServerException e) {
            e.printStackTrace();
        } catch (ClientException e) {
            e.printStackTrace();
        }
        return false;
    }
}
  • 3.编写配置文件，连接Redis：application.yml
server:
  port: 8088
# 配置 Redis
spring:
  redis:
    host: 192.168.142.120
    port: 6379
    password: 123456
  • 4.编写接口调用类
@RestController
@CrossOrigin // 跨域的支持
public class SmsApiController {
    @Autowired
    private SendSmsService sendSmsService;

    @Autowired
    private RedisTemplate redisTemplate;

    @GetMapping("send/{phone}")
    public String sendSms(@PathVariable("phone") String phoneNumber){
        // 调用发送发放（模拟真实业务，整合 Redis）

        // 判断当前手机号是否存储在 Redis 中
        // 如果没有则发送短信
        // 如果有表示上一个验证码还未过期，不用发送
        String code = (String) redisTemplate.opsForValue().get(phoneNumber);
        if (!StringUtils.isEmpty(code)){
            return "[手机号: "+phoneNumber + "],[验证码: " + code +"],还未过期";
        }

        // 生成验证码
        code = UUID.randomUUID().toString().substring(0,6);
        HashMap<String, Object> map = new HashMap<>();
        map.put("code",code);

        sendSmsService.send(phoneNumber,"XXXX",map);

		// 如果发送成功，就放入 Redis
        if (isSend){
            redisTemplate.opsForValue().set(phoneNumber,code,5, TimeUnit.MINUTES);
            return "[手机号: "+phoneNumber + "],[验证码: " + code +"],发送成功";
        }else {
            return "[手机号: "+phoneNumber + "],[验证码: " + code +"],发送失败";
        }
    }
    
}

二. 阿里云发短信验证码

1. 申请

  • 4.进入到 “管理控制台”
  • 5.进入到控制台后，使用之前，必须先配置两个内容： 签名管理：用户收到短信时，显示公司的名称（收到的短信验证码如下图）

添加完一条签名后，会出现如下提示，则表示签名添加成功，等待阿里后台审核通过。

  • 6.在模板管理 添加模板。按提示进行信息的配置，提交 后，出现如下提示，则表示 模板配置完成，等待审核。
  • 7.创建 AccessKeyId及 AccessKeySecret

2.开始 接口的集成

  • 1.选择“应用开发”——–》 接口调用 ———-》 选择 JAVA 语言

下载SDK

  • 2.找到 接口调试的API，然后找到 短信发送的 案例

下面是本人封装后的方法：

参数1：telPhone: 待接收的手机号码（可接收多个手机号）

参数2：paramJson : 要传递的参数列表(注意是 json的格式）

eg: {“code”:”2018”,”name”:”张三”}

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.exceptions.ClientException;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.profile.IClientProfile;
 
public class SmsUtils {
 
    // 产品名称:云通信短信API产品,开发者无需替换
    static final String product = "Dysmsapi";
    // 产品域名,开发者无需替换
    static final String domain = "dysmsapi.aliyuncs.com";
 
    // TODO 此处需要替换成开发者自己的AK(在阿里云访问控制台寻找)
    static final String accessKeyId = "11111111";   //改这里
    static final String accessKeySecret = "22222"; //改这里
 
    public static SendSmsResponse sendSms(String telephone, 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(telephone);
        // 必填:短信签名-可在短信控制台中找到
        request.setSignName("辉哥物流");  //改这里
        // 必填:短信模板-可在短信控制台中找到
        request.setTemplateCode("SMS_121906373");  //改这里
        // 可选:模板中的变量替换JSON串,如模板内容为"亲爱的用户,您的验证码为${code}"时,此处的值为
        request.setTemplateParam("{\"code\":\"" + code + "\"}");
 
        // 选填-上行短信扩展码(无特殊需求用户请忽略此字段)
        // request.setSmsUpExtendCode("90997");
 
        // 可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
        request.setOutId("yourOutId");
 
        // hint 此处可能会抛出异常，注意catch
        SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
 
        return sendSmsResponse;
    }
    public static void main(String[] args) throws Exception {
        //验证码可以用随机生成
        SendSmsResponse sendSms = sendSms("13612345678","6666");
        System.out.println("短信接口返回的数据----------------");
        System.out.println("Code=" + sendSms.getCode());
        System.out.println("Message=" + sendSms.getMessage());
        System.out.println("RequestId=" + sendSms.getRequestId());
        System.out.println("BizId=" + sendSms.getBizId());
 
    }
}

封装的类如下：

demo1:

package cn.itcast.bos.utils;

import org.apache.commons.lang3.StringUtils;
import org.apache.cxf.jaxrs.client.WebClient;

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.http.MethodType;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.profile.IClientProfile;

public class SMS_AlYun_High_Test {
	/** 连接超时的时间设置 **/
	private static final String CONN_TIME_OUT = "10000";
	/** 读取超时时间 */
	private static final String READ_TIME_OUT = "10000";
	/** 在控制台申请的 access_key */
	private static final String ACCESS_KEY_ID = "";
	/** 在控制台申请的 access_key_secret */
	private static final String ACCESS_KEY_SECRET = "";
	/** 短信签名的名称,在“管理控制台”中，“签名管理”界面中的列表界面里 签名名称  */
	private static final String SIGN_NAME = "BOS物流";
	/** 短信模板的 模版CODE */
	private static final String TEMPLATE_CODE = "SMS_82180012";
	/** 生成短信完整信息时，传递的变量名 */
	private static final String RANDOM_CODE = "code";
	
	public static boolean sendSms(String telPhone,String code) throws Exception{
		return sendSms(new String[]{telPhone}, "{"+RANDOM_CODE+":'"+code+"'}");//{code:'123456'}
	}
	public static boolean sendSms(String[] telPhone,String paramJson) throws Exception {
		// 设置超时时间-可自行调整
		System.setProperty("sun.net.client.defaultConnectTimeout", CONN_TIME_OUT);
		System.setProperty("sun.net.client.defaultReadTimeout", READ_TIME_OUT);
		// 初始化ascClient需要的几个参数
		final String product = "Dysmsapi";// 短信API产品名称（短信产品名固定，无需修改）
		final String domain = "dysmsapi.aliyuncs.com";// 短信API产品域名（接口地址固定，无需修改）
		// 替换成你的AK
		// 初始化ascClient,暂时不支持多region（请勿修改）
		IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", ACCESS_KEY_ID, ACCESS_KEY_SECRET);
		DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
		IAcsClient acsClient = new DefaultAcsClient(profile);
		// 组装请求对象
		SendSmsRequest request = new SendSmsRequest();
		// 使用post提交
		request.setMethod(MethodType.POST);
		// 必填:待发送手机号。支持以逗号分隔的形式进行批量调用，批量上限为1000个手机号码,批量调用相对于单条调用及时性稍有延迟,验证码类型的短信推荐使用单条调用的方式
		request.setPhoneNumbers(StringUtils.join(telPhone, ","));
		// 必填:短信签名-可在短信控制台中找到
		request.setSignName(SIGN_NAME);
		// 必填:短信模板-可在短信控制台中找到
		request.setTemplateCode(TEMPLATE_CODE);
		// 可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
		// 友情提示:如果JSON中需要带换行符,请参照标准的JSON协议对换行符的要求,比如短信内容中包含\r\n的情况在JSON中需要表示成\\r\\n,否则会导致JSON在服务端解析失败
		request.setTemplateParam(paramJson);
		// 请求失败这里会抛ClientException异常
		SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
//		System.out.println(sendSmsResponse.getMessage());
		if (sendSmsResponse.getCode() != null && sendSmsResponse.getCode().equals("OK")) {
			// 请求成功
			return true;
		}
		return false;
	}
	
	
	public static void main(String[] args) throws Exception {
		sendSms("18666666666","123456");
	}
}

demo2:

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.exceptions.ClientException;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.profile.IClientProfile;

public class SmsUtils {

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

	// TODO 此处需要替换成开发者自己的AK(在阿里云访问控制台寻找)
	static final String accessKeyId = "11111111";   //改这里
	static final String accessKeySecret = "22222"; //改这里

	public static SendSmsResponse sendSms(String telephone, 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(telephone);
		// 必填:短信签名-可在短信控制台中找到
		request.setSignName("辉哥物流");  //改这里
		// 必填:短信模板-可在短信控制台中找到
		request.setTemplateCode("SMS_121906373");  //改这里
		// 可选:模板中的变量替换JSON串,如模板内容为"亲爱的用户,您的验证码为${code}"时,此处的值为
		request.setTemplateParam("{\"code\":\"" + code + "\"}");

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

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

		// hint 此处可能会抛出异常，注意catch
		SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);

		return sendSmsResponse;
	}
	public static void main(String[] args) throws Exception {
		//验证码可以用随机生成
		SendSmsResponse sendSms = sendSms("13612345678","6666");
		System.out.println("短信接口返回的数据----------------"); 
		System.out.println("Code=" + sendSms.getCode());
		System.out.println("Message=" + sendSms.getMessage());
		System.out.println("RequestId=" + sendSms.getRequestId());
		System.out.println("BizId=" + sendSms.getBizId());

	}
}

注意: 普通java项目需要导入的jar包如下(sdk中有):

aliyun-java-sdk-core-3.3.1.jar

aliyun-java-sdk-dysmsapi-1.0.0.jar

maven项目需要如下pom坐标:

 <!-- 阿里云短信  -->
		<dependency>
			<groupId>com.aliyun</groupId>
			<artifactId>aliyun-java-sdk-dysmsapi</artifactId>
			<version>1.0.0</version>
		</dependency>
		<dependency>
			<groupId>com.aliyun</groupId>
			<artifactId>aliyun-java-sdk-core</artifactId>
			<version>3.2.3</version>
			<scope>compile</scope>
		</dependency>


Enjoy Reading This Article?

Here are some more articles you might like to read next:

  • 2379. Minimum Recolors to Get K Consecutive Black Blocks
  • 2471. Minimum Number of Operations to Sort a Binary Tree by Level
  • 1387. Sort Integers by The Power Value
  • 2090. K Radius Subarray Averages
  • 2545. Sort the Students by Their Kth Score