SpringBoot整合阿里云短信验证服务的使用示例

亦凉 2022-11-22 05:27 91阅读 0赞

**SpringBoot整合阿里云短信验证服务的使用示例**

1.  **添加 RAM 用户并赋予权限：AliyunDysmsFullAccess（管理短信服务（SMS）的权限）**
2.  **添加短信模板并等待审核通过，记录下模板CODE：SMS\_205403229**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JMVV8xMTE_size_16_color_FFFFFF_t_70_pic_left]  
3. **添加签名，适用场景选择验证码，等待审核通过，记录下签名名称：BLU的java自学网站**

--------------------

1.  **SpringBoot项目导入依赖：**

<dependency>
        <groupId>com.aliyun</groupId>
        <artifactId>aliyun-java-sdk-core</artifactId>
        <version>4.5.3</version>
    </dependency>
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>fastjson</artifactId>
        <version>1.2.62</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-redis</artifactId>
    </dependency>

*  测试类：

@Test
    void contextLoads() { 
        //连接阿里云
        DefaultProfile profile = DefaultProfile.getProfile("cn-hangzhou", "你的AccessKey ID", "你的AccessKey Secret");
        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");
        //自定义的参数（手机号、签名和模版CODE）
        request.putQueryParameter("PhoneNumbers", "测试的手机号码");
        request.putQueryParameter("SignName", "你的签名名称");
        request.putQueryParameter("TemplateCode", "你的模版CODE");
    
        //构建一个短信验证码
        HashMap<String, Object> map = new HashMap<>();
        map.put("code", 2333);
        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();
        }
        
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JMVV8xMTE_size_16_color_FFFFFF_t_70_pic_left 1]

*  配置文件：

server.port=9090
    spring.redis.host=127.0.0.1
    spring.redis.port=6379

*  Service接口：

package com.blu.service;
    
    import java.util.Map;
    
    public interface SendSms { 
    	public boolean send(String phoneNum,String trmplateCode,Map<String,Object> code);
    }

*  Service实现类：

package com.blu.service.Impl;
    
    import java.util.Map;
    import org.springframework.stereotype.Service;
    
    import com.alibaba.fastjson.JSONObject;
    import com.aliyuncs.CommonRequest;
    import com.aliyuncs.CommonResponse;
    import com.aliyuncs.DefaultAcsClient;
    import com.aliyuncs.IAcsClient;
    import com.aliyuncs.exceptions.ClientException;
    import com.aliyuncs.exceptions.ServerException;
    import com.aliyuncs.http.MethodType;
    import com.aliyuncs.profile.DefaultProfile;
    import com.blu.service.SendSms;
    
    @Service
    public class SendSmsImpl implements SendSms { 
    
    	@Override
    	public boolean send(String phoneNum, String trmplateCode, Map<String, Object> code) { 
    		// 连接阿里云
    		DefaultProfile profile = DefaultProfile.getProfile("cn-hangzhou", "你的AccessKey ID",
    				"你的AccessKey Secret");
    		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");
    		// 自定义的参数（手机号，验证码，签名，模板）
    		request.putQueryParameter("PhoneNumbers", phoneNum);
    		request.putQueryParameter("SignName", "BLU的java自学网站");
    		request.putQueryParameter("TemplateCode", trmplateCode);
    		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;
    	}
    
    }

*  Controller接口：

package com.blu.controller;
    
    import java.util.HashMap;
    import java.util.UUID;
    import java.util.concurrent.TimeUnit;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.data.redis.core.RedisTemplate;
    import org.springframework.web.bind.annotation.CrossOrigin;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.RestController;
    
    import com.aliyuncs.utils.StringUtils;
    import com.blu.service.SendSms;
    
    @RestController
    @CrossOrigin
    public class SmsApiController { 
    	
    	@Autowired
    	private SendSms sendSms;
    	@Autowired
    	private RedisTemplate<String,String> redisTemplate;
    	
    	@GetMapping("send/{phone}")
    	public String code(@PathVariable("phone") String phone) { 
    		String code = redisTemplate.opsForValue().get(phone);
    		if(!StringUtils.isEmpty(code)) { 
    			return phone + ':' + code + "还没有过期";
    		}else { 
    			//生成4位验证码并存储到 redis 中
    			code = UUID.randomUUID().toString().substring(0,4);
    			HashMap<String, Object> map = new HashMap<>();
    			map.put("code", code);
    			boolean isSend = sendSms.send(phone, "SMS_205403229", map);
    			if(isSend) { 
                    //将验证码存入redis，并设置1分钟过期时间
    				redisTemplate.opsForValue().set(phone, code,1,TimeUnit.MINUTES);
    				return phone + ':' + code + "发送成功！";
    			}else { 
    				return "发送失败!";
    			}
    		}
    	}
    
    }

*  测试请求：**http://localhost:9090/send/1565177xxxx**  
    ![在这里插入图片描述][20201103193816320.png_pic_left]  
    ![在这里插入图片描述][20201103193850850.png_pic_left]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JMVV8xMTE_size_16_color_FFFFFF_t_70_pic_left]: /images/20221120/af408706e7bb4483b3ea4c1c7f51d19a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JMVV8xMTE_size_16_color_FFFFFF_t_70_pic_left 1]: https://img-blog.csdnimg.cn/20201103193341190.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JMVV8xMTE=,size_16,color_FFFFFF,t_70#pic_left
[20201103193816320.png_pic_left]: https://img-blog.csdnimg.cn/20201103193816320.png#pic_left
[20201103193850850.png_pic_left]: https://img-blog.csdnimg.cn/20201103193850850.png#pic_left