【项目杂记】阿里云短信服务，及短信验证码使用实例

不念不忘少年蓝@ 2022-10-29 15:24 257阅读 0赞

### 依赖 ###

<dependency>
        <groupId>com.aliyun</groupId>
        <artifactId>aliyun-java-sdk-core</artifactId>
        <version>3.3.1</version>
    </dependency>
    <dependency>
        <groupId>com.aliyun</groupId>
        <artifactId>aliyun-java-sdk-dysmsapi</artifactId>
        <version>1.0.0</version>
    </dependency>

### 用到的工具类 ###

说明两点：

1.  @EnableConfigurationProperties(SmsProperties.class) 是我把短信配置信息写到了 application.yml 中（见下）
2.  注意根据短信模板中的参数名去 setTemplateParam

@Component
    @EnableConfigurationProperties(SmsProperties.class)
    public class SmsUtils {
        
    
        @Resource
        private SmsProperties prop;
    
        // 产品名称:云通信短信API产品,开发者无需替换
        static final String product = "Dysmsapi";
        // 产品域名,开发者无需替换
        static final String domain = "dysmsapi.aliyuncs.com";
    
        static final Logger logger = LoggerFactory.getLogger(SmsUtils.class);
    
        public SendSmsResponse sendSms(String phone, 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", prop.getAccessKeyId(), prop.getAccessKeySecret());
            DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
            IAcsClient acsClient = new DefaultAcsClient(profile);
    
            // 组装请求对象-具体描述见控制台-文档部分内容
            SendSmsRequest request = new SendSmsRequest();
            request.setMethod(MethodType.POST);
            // 必填:待发送手机号
            request.setPhoneNumbers(phone);
            // 必填:短信签名-可在短信控制台中找到
            request.setSignName(prop.getSignName());
            // 必填:短信模板-可在短信控制台中找到
            request.setTemplateCode(prop.getVerifyCodeTemplate());
            // 可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
            request.setTemplateParam("{\"code\":\"" + code + "\"}");
    
            // 选填-上行短信扩展码(无特殊需求用户请忽略此字段)
            //request.setSmsUpExtendCode("90997");
    
            // 可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
            request.setOutId("123456");
    
            // hint 此处可能会抛出异常，注意catch
            SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
    
            logger.info("发送短信状态：{}", sendSmsResponse.getCode());
            logger.info("发送短信消息：{}", sendSmsResponse.getMessage());
    
            return sendSmsResponse;
        }
    }

### 1.发送短信逻辑 ###

1）开通短信服务，配置 accessKey 及模板

sms:
      accessKeyId: LT4J4Fi5GKr5ZsCoGXhb # 短信服务的 accessKeyId（在阿里云控制台可以看到）
      accessKeySecret: hgHiquXMdFVTkU6Kttv38dqLui # 短信服务的秘钥（在阿里云控制台可以看到）
      signName: 短信测试 # 
      verifyCodeTemplate: SMS_179612241 # 模板编号

2）读取 yml 中配置的内容

@ConfigurationProperties(prefix = "sms")
    public class SmsProperties {
        
    
        String accessKeyId;
        String accessKeySecret;
        String signName;
        String verifyCodeTemplate;
    
    	// getter/setter
    }

3）提供发送短信接口

@PostMapping("/send")
    public ResponseEntity<Void> sendCode(@RequestParam("phone") String phone){
        
        if(codeService.sendCode(phone)){
        
            return ResponseEntity.ok().build();
        }
    
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build();
    }

4）通过工具类发送短信

@Autowired
    private StringRedisTemplate redisTemplate; // redis
    static final String KEY_PREFIX = "code:phone:";
    
    public Boolean sendCode(String phone) {
        
        // 随机生成验证码
        String code = generateCode(6);
        // 将验证码保存到 redis，key 为 code:phone:phoneNumber，5 分钟后过期
        this.redisTemplate.opsForValue().set(KEY_PREFIX+phone,code,5, TimeUnit.MINUTES);
        try {
        
            this.smsUtils.sendSms(phone,code);
        } catch (ClientException e) {
        
            LOGGER.error("发送短信失败：" + phone + "," + code);
            return false;
        }
    
        return true;
    }
    
    /**
     * 生成指定位数的随机数
     */
    public String generateCode(int len){
        
            len = Math.min(len, 8);
            int min = Double.valueOf(Math.pow(10, len - 1)).intValue();
            int num = new Random().nextInt(Double.valueOf(Math.pow(10, len + 1)).intValue() - 1) + min;
            return String.valueOf(num).substring(0,len);
        }

### 2.验证逻辑 ###

1）提供验证码校验接口

@GetMapping("/check")
    public ResponseEntity<Void> check(@RequestParam("phone")String phone,@RequestParam("code")String code){
        
        if(!this.codeService.checkCacheCode(phone,code)){
        
            return ResponseEntity.badRequest().build();
        }
        return ResponseEntity.ok().build();
    }

2）与 redis 中保存的验证码比对

@Autowired
    private StringRedisTemplate redisTemplate; // redis
    static final String KEY_PREFIX = "code:phone:";
    
    public Boolean checkCacheCode(String phone,String code){
        
        // code:phone:phoenNumber
        String cacheCode = this.redisTemplate.opsForValue().get(KEY_PREFIX + phone);
        // 比对
        // 注：验证码为空则可能过期或者手机号错误
        if(StringUtils.equals(code,cacheCode)){
        
            this.redisTemplate.delete(KEY_PREFIX + phone);
            return true;
        }
        return false;
    }