https://github.com/johnmai-dev/gsms
📲 一款满足你的多种发送需求的短信发送组件，参考overtrue/easy-sms实现的 Go 版本
https://github.com/johnmai-dev/gsms
aliyun-sms easy-sms go go-sms golang golang-sms sms sms-client sms-gateway yunpian-sms
Last synced: 3 months ago
JSON representation
📲 一款满足你的多种发送需求的短信发送组件，参考overtrue/easy-sms实现的 Go 版本
- Host: GitHub
- URL: https://github.com/johnmai-dev/gsms
- Owner: johnmai-dev
- License: mit
- Created: 2023-02-25T06:24:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-20T06:02:51.000Z (almost 2 years ago)
- Last Synced: 2025-06-09T07:18:18.632Z (about 1 year ago)
- Topics: aliyun-sms, easy-sms, go, go-sms, golang, golang-sms, sms, sms-client, sms-gateway, yunpian-sms
- Language: Go
- Homepage: https://github.com/maiqingqiang/Gsms
- Size: 63.5 KB
- Stars: 19
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![go report card][go-report-card]][go-report-card-url]
[![Go.Dev reference][go.dev-reference]][go.dev-reference-url]
[![Go package][go-pacakge]][go-pacakge-url]
[![MIT License][license-shield]][license-url]
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
Gsms :calling:
:calling: 一款满足你的多种发送需求的短信发送组件，此项目参考 easy-sms 实现的 Go 版本
## 特点
1. 支持目前市面多家服务商
2. 一套写法兼容所有平台
3. 简单配置即可灵活增减服务商
4. 内置多种服务商轮询策略、支持自定义轮询策略
5. 统一的返回值格式，便于日志与监控
6. 自动轮询选择可用的服务商
7. 更多等你去发现与改进...
## 平台支持
- [云片](https://www.yunpian.com)
- [阿里云](https://www.aliyun.com/)
- [腾讯云 SMS](https://cloud.tencent.com/product/sms)
- 欢迎PR，或者你提供帮助我来开发~
## 安装
```shell
go get -u github.com/maiqingqiang/gsms
```
## 使用
```go
package main
import (
"github.com/maiqingqiang/gsms"
"github.com/maiqingqiang/gsms/gateways/aliyun"
"github.com/maiqingqiang/gsms/gateways/yunpian"
"github.com/maiqingqiang/gsms/message"
"log"
)
func main() {
client := gsms.New(
[]gsms.Gateway{
&yunpian.Gateway{
ApiKey: "ApiKey",
Signature: "Signature",
},
&aliyun.Gateway{
AccessKeyId: "AccessKeyId",
AccessKeySecret: "AccessKeySecret",
SignName: "SignName",
},
},
gsms.WithGateways([]string{
yunpian.NAME, aliyun.NAME,
}),
)
results, err := client.Send(18888888888, &message.Message{
Template: "5532044",
Data: map[string]string{
"code": "521410",
},
})
if err != nil {
log.Fatalf("发送失败 %+v", err)
}
log.Printf("发送成功 %+v", results)
}
```
## 短信内容
由于使用多网关发送，所以一条短信要支持多平台发送，每家的发送方式不一样，但是我们抽象定义了以下公用属性：
- `Content` 文字内容，使用在像云片类似的以文字内容发送的平台
- `Template` 模板 ID，使用在以模板ID来发送短信的平台
- `Data` 模板变量，使用在以模板ID来发送短信的平台
所以，在使用过程中你可以根据所要使用的平台定义发送的内容。
```go
client.Send(18888888888, &core.Message{
Template: "SMS_00000001",
Data: map[string]string{
"code": "521410",
},
})
client.Send(18888888888, &core.Message{
Content: "您的验证码为: 6379",
})
```
### 闭包方式
```go
client.Send(18888888888, &core.Message{
Template: func(gateway core.GatewayInterface) string {
if gateway.Name() == aliyun.NAME {
return "SMS_271385117"
}
return "5532044"
},
Data: func(gateway core.GatewayInterface) map[string]string {
if gateway.Name() == aliyun.NAME {
return map[string]string{
"code": "1111",
}
}
return map[string]string{
"code": "6379",
}
},
})
```
## 发送网关
```go
client.Send(18888888888, &core.Message{
Template: "5532044",
Data: map[string]string{
"code": "6379",
},
}, yunpian.NAME, aliyun.NAME)
```
## 自定义网关
只需要实现 `gsms.Gateway` 接口即可，例如：
## 场景发送
```go
var _ gsms.Message = (*OrderPaidMessage)(nil)
type OrderPaidMessage struct {
OrderNo string
}
func (o *OrderPaidMessage) Gateways() ([]string, error) {
return []string{yunpian.NAME}, nil
}
func (o *OrderPaidMessage) Strategy() (gsms.Strategy, error) {
return nil, nil
}
func (o *OrderPaidMessage) GetContent(gateway gsms.Gateway) (string, error) {
return fmt.Sprintf("您的订单:%s, 已经完成付款", o.OrderNo), nil
}
func (o *OrderPaidMessage) GetTemplate(gateway gsms.Gateway) (string, error) {
return "5532044", nil
}
func (o *OrderPaidMessage) GetData(gateway gsms.Gateway) (map[string]string, error) {
return map[string]string{
"code": "6379",
}, nil
}
func (o *OrderPaidMessage) GetType(gateway gsms.Gateway) (string, error) {
return message.TextMessage, nil
}
client.Send(18888888888, &OrderPaidMessage{OrderNo: "1234"})
```
## 各平台配置说明
### [阿里云](https://www.aliyun.com/)
短信内容使用 `Template` + `Data`
```go
&aliyun.Gateway{
AccessKeyId: "AccessKeyId",
AccessKeySecret: "AccessKeySecret",
SignName: "【默认签名】",
}
```
### [云片](https://www.yunpian.com)
短信内容使用 `Content`
```go
&yunpian.Gateway{
ApiKey: "ApiKey",
Signature: "【默认签名】", // 内容中无签名时使用
}
```
### [腾讯云 SMS](https://cloud.tencent.com/product/sms)
短信内容使用 `Template` + `Data`
```go
&qcloud.Gateway{
SdkAppId: "",
SecretId: "",
SecretKey: "",
SignName: "",
}
```
## 版权说明
该项目签署了 MIT 授权许可，详情请参阅 [LICENSE](LICENSE)
## 鸣谢
- [安正超](https://github.com/overtrue)
- [easy-sms](https://github.com/overtrue/easy-sms)
[contributors-shield]: https://img.shields.io/github/contributors/maiqingqiang/Gsms.svg
[contributors-url]: https://github.com/maiqingqiang/Gsms/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/maiqingqiang/Gsms.svg
[forks-url]: https://github.com/maiqingqiang/Gsms/network/members
[stars-shield]: https://img.shields.io/github/stars/maiqingqiang/Gsms.svg
[stars-url]: https://github.com/maiqingqiang/Gsms/stargazers
[issues-shield]: https://img.shields.io/github/issues/maiqingqiang/Gsms.svg
[issues-url]: https://github.com/maiqingqiang/Gsms/issues
[license-shield]: https://img.shields.io/github/license/maiqingqiang/Gsms.svg
[license-url]: https://github.com/maiqingqiang/Gsms/blob/main/LICENSE
[go-report-card]: https://goreportcard.com/badge/github.com/maiqingqiang/Gsms
[go-report-card-url]: https://goreportcard.com/report/github.com/maiqingqiang/Gsms
[go.dev-reference]: https://img.shields.io/badge/go.dev-reference-blue?logo=go&logoColor=white
[go.dev-reference-url]: https://pkg.go.dev/github.com/maiqingqiang/gsms?tab=doc
[go-pacakge]: https://github.com/maiqingqiang/Gsms/actions/workflows/test.yml/badge.svg?branch=main
[go-pacakge-url]: https://github.com/maiqingqiang/Gsms/actions/workflows/test.yml