【代码模板】阿里云接口实现短信发送

• 前言
  阿里云接口实现短信发送。

• 更新

24.05.24 初始记录

依赖

<!--sms验证服务-->  
<dependency>  
    <groupId>com.alibaba.cloud</groupId>  
    <artifactId>spring-cloud-alicloud-sms</artifactId>  
    <version>2.2.0.RELEASE</version>  
</dependency>

代码

1. Service 中要添加的代码

@Override  
public Boolean sendCode(String phone) {  
    //非空校验  
    if (Strings.isNullOrEmpty(phone)) {  
        throw new LogicException("手机号为空");  
    }  
  
    StringBuilder sbCode = new StringBuilder();  
    // 6位随机密码
    Stream.generate(() -> new Random().nextInt(10))  
            .limit(6)  
            .forEach(sbCode::append);  
    //将验证码放入redis, 5分钟过期  
    redisTemplate.opsForValue().set(phone, sbCode.toString(), Duration.ofMinutes(5));  
    log.info("短信验证码：" + sbCode.toString());  
    return smsSender.sendMsg(phone, sbCode.toString());  
}   

2. SmsConfig.java

@Configuration  
@RefreshScope  
public class SmsConfig {  
    @Value("${sms.operator.signName}")  
    private String signName;  
    @Value("${sms.operator.templateCode}")  
    private String templateCode;  
  
    public String getSignName() {  
        return signName;  
    }  
  
    public String getTemplateCode() {  
        return templateCode;  
    }  
}

3. 配置文件中添加

sms:
  operator:
    signName: 你的signName
    templateCode: 你的templateCode  

4. SmsSender.java

@Component  
@Slf4j  
public class SmsSender {  
    @Autowired  
    private SmsConfig smsConfig;  
    @Autowired  
    private ISmsService smsService;  
  
    /**  
     * 发送验证码短信  
     *  
     * @param telephone 手机号  
     * @param code     手机验证码  
     */  
    public boolean sendMsg(String telephone, String code) {  
        SendSmsRequest request = new SendSmsRequest();  
  
        request.setPhoneNumbers(telephone);  
        request.setSignName(smsConfig.getSignName());  
        request.setTemplateCode(smsConfig.getTemplateCode());  
        ObjectMapper mapper = new ObjectMapper();  
        JsonNode rootNode = mapper.createObjectNode();  
        // 存入验证码  
        ((ObjectNode) rootNode).put("code", code);  
  
        try {  
            request.setTemplateParam(mapper.writeValueAsString(rootNode));  
            val sendSmsResponse = smsService.sendSmsRequest(request);  
            log.info("短信发送接收：" + JSONUtil.toJsonPrettyStr(sendSmsResponse));  
            if (sendSmsResponse.getCode() != null && "OK".equals(sendSmsResponse.getCode())) {  
                return true;  
            } else {  
                throw new LogicException("验证码发送失败：" + sendSmsResponse.getMessage());  
            }  
        } catch (Exception e) {  
            log.error("send sms error." + e.getMessage());  
            val operLog = OperLog.builder().title("发送验证码")  
                    .businessType(BusinessType.OTHER.ordinal())  
                    .operParam(JSONUtil.toJsonPrettyStr(request))  
                    .status(BusinessStatus.FAIL.ordinal())  
                    .errorMsg(e.getMessage())  
                    .build();  
            AsyncManager.me().execute(AsyncFactory.recordOper(operLog));  
            throw new LogicException("验证码发送失败");  
        }  
    }  
}