SpringBoot整合阿里云短信服务详细过程（保证初学者也能实现）

前言

网上关于实操性的文章普遍大部分都记录不全，要么只记录重点部分，对于刚学习的小伙伴来说看起来是比较困难的

所以，基于这一点。

该文章会详细介绍使用SpringBoot整合阿里云短信服务的每一步过程，同时会将验证码存放到Redis中并设置过期时间，尽量保证实战的同时也让没做过的同学也能实现发短信的功能~

文章目录

关于阿里云短信服务介绍就不多说了，我们只要知道他能够帮我们实现短信发送就够了，直接上步骤~

1、开通阿里云短信服务

1、去到阿里云官方网址：https://www.aliyun.com/ 选择短信服务
在这里插入图片描述
2、点击开通即可

3、开通好后这里是需要申请：自己的模板和签名的，但现在申请的话需要有自己的域名和网站，对于刚学习的同学来说这些肯定是没有的，但好在阿里云也考虑到了这个问题，就给我们提供了一个专门测试的签名和模板

4、找到测试的签名和模板，开通短信服务成功之后，会进入到该页面，我们点击快速学习，再往下滑，找到调用API发短信。
在这里插入图片描述
找不到的小伙伴可以直接点击这个链接：阿里云短信服务测试的签名和模板地址

到了这里，阿里云短信服务基本就搞定了，接下来我们整合到项目中。（对了，记得充点钱在里面，不然发送不了哦，几毛就够了，一条短信0.045）

2、整合短信服务到项目中

1、创建一个SpringBoot项目
在这里插入图片描述
2、导入依赖（为了让大家看的更清楚，我这里就写完整依赖了）

<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency><dependency><groupId>com.alibaba</groupId><artifactId>fastjson</artifactId><version>1.2.28</version></dependency><dependency><groupId>com.aliyun</groupId><artifactId>aliyun-java-sdk-core</artifactId><version>4.3.3</version></dependency><!-- redis --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-redis</artifactId></dependency><!--spring2.X集成redis所需common-pool2--><dependency><groupId>org.apache.commons</groupId><artifactId>commons-pool2</artifactId><version>2.6.0</version></dependency><!--swagger--><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.7.0</version></dependency><!--swagger ui--><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.7.0</version></dependency></dependencies>

注意：记得将SpringBoot版本修改为2.2.1.RELEASE（因为高版本的有可能不匹配）

在这里插入图片描述

3、配合application.properties文件

# 服务端口
server.port=8100

#Redis配置 这里填写的是装了redis的ip地址，我的redis装在虚拟机中
spring.redis.host=192.168.1.8
spring.redis.port=6379
spring.redis.database=0
spring.redis.timeout=1800000

spring.redis.lettuce.pool.max-active=20
spring.redis.lettuce.pool.max-wait=-1
#最大阻塞等待时间(负数表示没限制)
spring.redis.lettuce.pool.max-idle=5
spring.redis.lettuce.pool.min-idle=0
#最小空闲

4、在启动类上加上对应注解

@EnableSwagger2@ComponentScan({"com.gx"})@SpringBootApplication(exclude =DataSourceAutoConfiguration.class)//取消数据源自动配置publicclassBootMsmApplication{publicstaticvoidmain(String[] args){SpringApplication.run(BootMsmApplication.class, args);}}

5、创建service，编写业务
（1）接口

/**
 * @author Eric
 * @create 2022-05-22 15:08
 */publicinterfaceMsmService{//发送验证码booleansend(Map<String,Object> param,String phone);}

（2）实现类

packagecom.gx.bootmsm.service;importcom.alibaba.fastjson.JSONObject;importcom.aliyuncs.CommonRequest;importcom.aliyuncs.CommonResponse;importcom.aliyuncs.DefaultAcsClient;importcom.aliyuncs.IAcsClient;importcom.aliyuncs.http.MethodType;importcom.aliyuncs.profile.DefaultProfile;importorg.springframework.stereotype.Service;importorg.springframework.util.StringUtils;importjava.util.Map;/**
 * @author Eric
 * @create  2022-05-22 15:09
 */@ServicepublicclassMsmServiceImplimplementsMsmService{/**
     * 发送验证码
     * @param param     验证码
     * @param phone     手机号
     * @return
     */@Overridepublicbooleansend(Map<String,Object> param,String phone){if(StringUtils.isEmpty(phone))returnfalse;//default 地域节点，默认就好  后面是 阿里云的 id和秘钥（这里记得去阿里云复制自己的id和秘钥哦）DefaultProfile profile =DefaultProfile.getProfile("default","Q2AtKVxX1N3tOh3AWHHzXyx","ZgmmX3vSlMF9GnxliXZrLxoD7053Hx");IAcsClient client =newDefaultAcsClient(profile);//这里不能修改CommonRequest request =newCommonRequest();//request.setProtocol(ProtocolType.HTTPS);
        request.setMethod(MethodType.POST);
        request.setDomain("dysmsapi.aliyuncs.com");
        request.setVersion("2017-05-25");
        request.setAction("SendSms");

        request.putQueryParameter("PhoneNumbers", phone);//手机号
        request.putQueryParameter("SignName","阿里云短信测试");//申请阿里云 签名名称（暂时用阿里云测试的，自己还不能注册签名）
        request.putQueryParameter("TemplateCode","SMS_154950909");//申请阿里云 模板code（用的也是阿里云测试的）
        request.putQueryParameter("TemplateParam",JSONObject.toJSONString(param));try{CommonResponse response = client.getCommonResponse(request);System.out.println(response.getData());return response.getHttpResponse().isSuccess();}catch(Exception e){
            e.printStackTrace();}returnfalse;}}

6、创建一个生成随机验证码的工具类：RandomUtil

packagecom.gx.bootmsm.utils;importjava.text.DecimalFormat;importjava.util.ArrayList;importjava.util.HashMap;importjava.util.List;importjava.util.Random;/**
 * 获取随机数
 *
 * @author qianyi
 *
 */publicclassRandomUtil{privatestaticfinalRandom random =newRandom();privatestaticfinalDecimalFormat fourdf =newDecimalFormat("0000");privatestaticfinalDecimalFormat sixdf =newDecimalFormat("000000");publicstaticStringgetFourBitRandom(){return fourdf.format(random.nextInt(10000));}publicstaticStringgetSixBitRandom(){return sixdf.format(random.nextInt(1000000));}/**
     * 给定数组，抽取n个数据
     * @param list
     * @param n
     * @return
     */publicstaticArrayListgetRandom(List list,int n){Random random =newRandom();HashMap<Object,Object> hashMap =newHashMap<Object,Object>();// 生成随机数字并存入HashMapfor(int i =0; i < list.size(); i++){int number = random.nextInt(100)+1;

            hashMap.put(number, i);}// 从HashMap导入数组Object[] robjs = hashMap.values().toArray();ArrayList r =newArrayList();// 遍历数组并打印数据for(int i =0; i < n; i++){
            r.add(list.get((int) robjs[i]));System.out.print(list.get((int) robjs[i])+"\t");}System.out.print("\n");return r;}}

7、创建controller

packagecom.gx.bootmsm.controller;importcom.gx.bootmsm.service.MsmService;importcom.gx.bootmsm.utils.RandomUtil;importio.swagger.annotations.Api;importio.swagger.annotations.ApiOperation;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.data.redis.core.RedisTemplate;importorg.springframework.util.StringUtils;importorg.springframework.web.bind.annotation.GetMapping;importorg.springframework.web.bind.annotation.PathVariable;importorg.springframework.web.bind.annotation.RequestMapping;importorg.springframework.web.bind.annotation.RestController;importjava.util.HashMap;importjava.util.Map;importjava.util.concurrent.TimeUnit;/**
 * @author Eric
 * @create  2022-05-22 15:12
 */@Api(tags ="阿里云短信服务")@RestController@RequestMapping("/api/msm")publicclassMsmApiController{@AutowiredprivateMsmService msmService;@AutowiredprivateRedisTemplate<String,String> redisTemplate;//注入redis//发送短信验证码@ApiOperation(value ="发送短信验证码")@GetMapping(value ="/send/{phone}")publicBooleancode(@PathVariableString phone){//1、从redis中获取验证码，如果获取到就直接返回String code = redisTemplate.opsForValue().get(phone);if(!StringUtils.isEmpty(code))returnfalse;//2、如果获取不到，就进行阿里云发送
        code =RandomUtil.getFourBitRandom();//生成验证码的随机值Map<String,Object> param =newHashMap<>();
        param.put("code", code);//调用方法boolean isSend = msmService.send(param,phone);if(isSend){//往redis中设置数据：key、value、过期值、过期时间单位  MINUTES代表分钟
            redisTemplate.opsForValue().set(phone, code,5,TimeUnit.MINUTES);returntrue;}else{returnfalse;}}}

3、测试

1、启动项目
2、访问swagger地址：http://localhost:8100/swagger-ui.html
3、输入手机号，点击发送
在这里插入图片描述
返回结果为true，说明发送成功

这是手机收到的短信

因为我们用的是阿里云的模板，所以模板显示我们也就不能自定义啦~