# aliyun-sms-spring-boot-starter

**Repository Path**: super9du/aliyun-sms-spring-boot-starter

## Basic Information

- **Project Name**: aliyun-sms-spring-boot-starter
- **Description**: 阿里云短信服务 spring-boot-starter
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://super9du.github.io/linux-primer/
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2022-08-21
- **Last Updated**: 2023-08-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Java, SpringBoot, starter, Aliyun, sms

## README

# aliyun-sms-spring-boot-starter

阿里云短信服务 spring-boot-starter。

```
        JDK 版本: 11
Spring Boot 版本: 2.7.2
```

用法
---

1. 配置（`application.properties`）
    ```properties
    aliyun.sms.accessKeyId=accessKeyId                  # 访问key(必)
    aliyun.sms.accessKeySecret=accessKeySecret          # 访问密钥(必)
    aliyun.sms.signature=signature                      # 短信签名(必)
    aliyun.sms.templates.templateCode1=templateCode1    # 短信模板编号和对应的短信模板变量(至少要配置一个键值对)
    aliyun.sms.templates.templateCode2=templateCode2
    ```

2. 代码使用
   ```java
   import com.aliyun.dysmsapi20170525.Client;
   import com.aliyun.dysmsapi20170525.models.SendSmsResponse;
   import super9du.sia.aliyun.sms.AliyunSmsTemplate;
   
   class Demo {
       /**
        * 获取阿里云 sms 原生的客户端对象
        */
       @Inject
       Client client;
   
       @Inject
       AliyunSmsTemplate template;
   
       void test() throws Exception {
           // 如果只配置了一个「短信模板编号」，那么可以直接使用 sendAuthCode 发送验证码
           SendSmsResponse resp1 = template.sendAuthCode("13245678901");
   
           // 使用阿里云原生的客户端能力
           client.sendSms(template.createSendSmsRequest("短信模板编号", "13245678901", "{\"code\":\"1234\"}"));
           // client.xxx()
       }
   }
   ```