短信验证笔记(狂神说)
1. 了解阿里云用户权限操作
狂神说视频 :https://space.bilibili.com/95256449/channel/detail?cid=146244
笔记来源:https://blog.csdn.net/weixin_44449838/article/details/109325198
需要通过个人账户获得 授权码(id、密码),再通过这些信息获得服务
阿里云网址 : https://www.aliyun.com/
- 登录 / 注册 阿里云
- 点击 AccessKey 管理
- 创建一个用户
- 为新建的用户添加权限
2. 开通阿里云短信服务
- 进入短信服务后台
- 了解计费规则
3. 添加短信模板
- 看到每条短信是需要短信费用的,所以如果需要使用该功能,需要充点钱备用。
4. 添加签名
这可太烦了啊
5. 编写测试代码
- 可以查看 API Demo ,修改即可
- 新建一个 Spring-boot 项目 sms-verification
- 引入依赖
<!--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>
- 编写一个测试类,就把刚刚的 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();
}
}
- 最后就可以得到短信了
-
注意:
如果上面自定义的参数名写错,不会成功
如果 模板、签名 没有通过审核会报错
6. 模板
-
新建几个文件夹
-
编写接口 SendSmsService
public interface SendSmsService {
/**
* 用于发送短信
* @param phoneNumber :手机号
* @param templateCode :模板编号
* @param code :验证码
* @return 是否发送成功
*/
public boolean send(String phoneNumber, String templateCode, Map<String, Object> code);
}
- 编写实现类 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;
}
}
- 编写配置文件,连接 Redis :application.yml
server:
port: 8088
# 配置 Redis
spring:
redis:
host: 192.168.142.120
port: 6379
password: 123456
- 编写调用接口
@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 +"],发送失败";
}
}
}