022-从零搭建微服务-短信服务（二）

写在最前

如果这个项目让你有所收获，记得 Star 关注哦，这对我是非常不错的鼓励与支持。

源码地址（后端）：gitee.com/csps/mingyu...

源码地址（前端）：gitee.com/csps/mingyu...

文档地址：gitee.com/csps/mingyu...

阿里云短信

需要注册一个阿里云账号，进入阿里云短信服务的控制台，选择快速学习和测试 ：dysms.console.aliyun.com/quickstart

发送验证码

引入依赖

xml 复制代码

<!-- 短信工具 -->
<dependency>
    <groupId>com.csp.mingyue</groupId>
    <artifactId>mingyue-common-sms</artifactId>
</dependency>
<!-- 阿里云短信依赖 -->
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>dysmsapi20170525</artifactId>
</dependency>

Nacos 短信配置

accessKeyId：阿里云 AccessKey ID

accessKeySecret：阿里云 AccessKey Secret

signName：阿里云签名名称

yaml 复制代码

sms:
  enabled: true
  endpoint: "dysmsapi.aliyuncs.com"
  accessKeyId: xxx
  accessKeySecret: xxx
  signName: 阿里云短信测试

短信配置类

arduino 复制代码

@Data
@ConfigurationProperties(prefix = "sms")
public class SmsProperties {

  private Boolean enabled;

  /**
   * 配置节点 阿里云 dysmsapi.aliyuncs.com
   */
  private String endpoint;

  /**
   * key
   */
  private String accessKeyId;

  /**
   * 密匙
   */
  private String accessKeySecret;

  /*
   * 短信签名
   */
  private String signName;

}

注册配置类

less 复制代码

/**
 * 短信配置类
 *
 * @author Strive
 * @date 2023/8/25 10:04
 */
@AutoConfiguration
@EnableConfigurationProperties(SmsProperties.class)
public class SmsAutoConfiguration {

  @Configuration
  @ConditionalOnProperty(value = "sms.enabled", havingValue = "true")
  @ConditionalOnClass(com.aliyun.dysmsapi20170525.Client.class)
  static class AliyunSmsConfiguration {

    @Bean
    public SmsTemplate aliyunSmsTemplate(SmsProperties smsProperties) {
      return new AliyunSmsTemplate(smsProperties);
    }

  }

}

短信接口

String templateId = "";

templateId：阿里云模版Code，例如：SMS_154950909

less 复制代码

/**
   * 短信验证码
   * @param phone 用户手机号
   */
  @GetMapping("/code")
  @Operation(summary = "短信验证码", parameters = { @Parameter(name = "phone", description = "手机号", required = true) })
  public R<Void> smsCaptcha(@NotBlank(message = "手机号不能为空") String phone) {
    if (!smsProperties.getEnabled()) {
      return R.fail("当前系统没有开启短信功能！");
    }
    String key = CacheConstants.CAPTCHA_CODE_KEY + phone;
    String code = RandomUtil.randomNumbers(4);
    redisTemplate.opsForValue().set(key, code, Constants.CAPTCHA_EXPIRATION, TimeUnit.MINUTES);
    log.info("验证码短信「{}」发送至手机「{}」  => {}", code, phone);
    // 验证码模板 ID 暂时可以写死
    String templateId = "";
    Map<String, String> map = new HashMap<>(1);
    map.put("code", code);
    SmsTemplate smsTemplate = SpringUtils.getBean(SmsTemplate.class);
    SmsResult result = smsTemplate.send(phone, templateId, map);
    if (!result.getIsSuccess()) {
      log.error("验证码短信发送异常 => {}", result);
      return R.fail(result.getMessage());
    }
    return R.ok();
}

发送测试

手机接收到短信即可！

小结

现在短信验证码已经可以推送至手机上了，接下来修改短信登录，通过手机号发送短信验证码，然后登录！