lzh-1.8-sms-spring-boot-starter

简介

lzh-1.8-sms-spring-boot-starter 是一个基于 Spring Boot 的 Starter，用于集成阿里云短信服务（Aliyun SMS）到你的项目中，方便快速发送短信。该项目利用了阿里云提供的 SDK，并封装了常见的短信发送功能。

功能特性

• 支持通过配置启用或禁用阿里云短信服务。
• 支持自定义短信签名、模板代码和接收手机号。
• 提供简洁的 API 接口用于发送短信。
• 使用 Gson 处理 JSON 数据，方便数据转换。

主要组件

• AliyunSMSComponentConfig: Spring Boot 自动配置类，用于创建 SmsComponent Bean。
• AliYunSMSProperty: 用于加载配置文件中与阿里云短信服务相关的属性。
• SmsComponent: 核心短信发送组件，封装了发送短信的具体实现。

配置说明

在使用此 Starter 前，需在 Spring Boot 的配置文件（application.yml 或 application.properties）中添加以下配置：

aliyun:
  sms:
    enabled: true # 启用短信服务
    regionId: your-region-id
    accessKeyId: your-access-key-id
    secret: your-secret
    endPoint: your-endpoint
    product: your-product
    domainUrl: your-domain-url
    connectionTimeout: 5000
    readTimeout: 5000

使用示例

通过注入 SmsComponent 实例，可直接使用其方法发送短信：

@Autowired
private SmsComponent smsComponent;

public void sendSMS(String phone, String smsSignature, String templateCode, Map<String, String> params) {
    smsComponent.doSendSms(phone, smsSignature, templateCode, params);
}

异常处理

• VinusException: 自定义运行时异常，用于处理短信发送过程中的错误。

枚举类

• AliyunSmsApiErrorCode: 定义阿里云短信服务 API 的错误码。

贡献指南

欢迎为本项目贡献代码或提出建议，只需 Fork 本项目，修改后提交 Pull Request 即可。

开源协议

本项目遵循 MIT 协议，更多详情请查看项目中的 LICENSE 文件。