SpringBoot项目实现短信发送接口开发的实践

下面是关于“SpringBoot项目实现短信发送接口开发的实践”的攻略：

1. 场景与背景

在很多应用场景下，我们需要向用户发送短信信息，比如验证码、通知等。本攻略将介绍如何使用 SpringBoot 来快速实现短信发送接口的开发。

2. 技术选型

SpringBoot
阿里云SMS服务

3. 实践步骤

3.1. 创建SpringBoot项目

首先，我们需要创建一个新的SpringBoot项目。可以使用Spring Initializr来创建，或者使用你喜欢的方式。

3.2. 导入依赖

在pom.xml中添加以下依赖：

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

3.3. 配置AccessKey

在application.yml中添加以下配置：

aliyun:
  access-key-id: your_access_key_id
  access-key-secret: your_access_key_secret

3.4. 编写短信发送代码

@Service
public class SmsServiceImpl implements SmsService {

    @Autowired
    private SmsProperties smsProperties;

    private static final Logger LOGGER = LoggerFactory.getLogger(SmsServiceImpl.class);

    @Override
    public boolean sendSms(String phoneNumber, String templateCode, Map<String, Object> params) {
        DefaultProfile profile = DefaultProfile.getProfile(
                smsProperties.getRegionId(),
                smsProperties.getAccessKeyId(),
                smsProperties.getAccessKeySecret()
        );
        IAcsClient acsClient = new DefaultAcsClient(profile);
        SendSmsRequest request = new SendSmsRequest();
        request.setPhoneNumbers(phoneNumber);
        request.setSignName(smsProperties.getSignName());
        request.setTemplateCode(templateCode);
        request.setTemplateParam(JSONObject.toJSONString(params));
        try {
            SendSmsResponse response = acsClient.getAcsResponse(request);
            LOGGER.info("Send sms response: {}", response);
            if (StringUtils.equals(response.getCode(), "OK")) {
                return true;
            }
        } catch (ClientException e) {
            LOGGER.error("Send sms error", e);
        }
        return false;
    }
}

3.5. 配置短信参数

在application.yml中添加以下配置：

sms:
  sign-name: your_sign_name
  region-id: cn-hangzhou
  template-code:
    code1: your_template_code1
    code2: your_template_code2

3.6. 调用短信发送接口

@RestController
public class SmsController {

    @Autowired
    private SmsService smsService;

    @PostMapping("/sendSms")
    public ResponseEntity<ClientResponse<String>> sendSms(@RequestBody SmsRequest smsRequest) {
        Map<String, Object> params = new HashMap<>();
        params.put("code", smsRequest.getCode());
        params.put("expire", smsRequest.getExpire());
        boolean result = smsService.sendSms(smsRequest.getPhoneNumber(), "code1", params);
        if (result) {
            return ResponseEntity.ok().body(ClientResponse.success("Send sms success"));
        }
        return ResponseEntity.badRequest().body(ClientResponse.error("Send sms error"));
    }
}

其中，SmsRequest为短信请求的DTO类。

4. 示例说明

4.1. 示例1：发送验证码

例如，我们需要对手机号为13912345678的用户发送验证码123456，过期时间为5分钟。可以通过调用以下接口：

POST /sendSms
RequestBody:
{
    "phoneNumber": "13912345678",
    "code": "123456",
    "expire": 5
}

接口返回结果：

{
    "code": 0,
    "msg": "Send sms success",
    "data": null
}

4.2. 示例2：发送通知短信

例如，我们需要向所有用户发送一条关于系统维护的通知短信。可以通过调用以下接口：

POST /sendSms
RequestBody:
{
    "phoneNumber": "all",
    "code": "system_maintenance",
    "expire": 0
}

其中，phoneNumber参数设置为all，表示对所有用户发送短信，expire参数设置为0，表示不需要过期时间。