Documentation
¶
Overview ¶
Package notify 提供统一通知中心:多渠道(短信/邮件/站内信等)发送抽象。 业务只依赖统一入口,渠道通过 Register 插拔;与 framework/sms、framework/mail 组合使用。
Index ¶
- func RegisterTemplate(name, content string)
- func Render(content string, params map[string]interface{}) (string, error)
- func RenderTemplate(name string, params map[string]interface{}) (string, error)
- func Template(name string) (string, bool)
- type Content
- type MailAdapter
- type Manager
- func (m *Manager) Channels() []string
- func (m *Manager) Register(sender Sender) error
- func (m *Manager) Send(ctx context.Context, channel, target string, content Content) error
- func (m *Manager) SendAll(ctx context.Context, target string, content Content, channels ...string) error
- func (m *Manager) Sender(channel string) (Sender, bool)
- type RateLimiter
- type SMSAdapter
- type Sender
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterTemplate ¶ added in v1.77.0
func RegisterTemplate(name, content string)
RegisterTemplate 注册通知模板(同名覆盖)。 占位符语法:{{key}};渲染时从 params 取值,支持 map 嵌套键如 {{user.name}}。
func RenderTemplate ¶ added in v1.77.0
RenderTemplate 按模板名渲染:占位符从 params 取值。 模板未注册、参数缺失时返回错误(缺失参数会在错误中列出,便于排查)。 嵌套键 {{user.name}} 从 map[string]interface{} 逐层取值。
Types ¶
type Content ¶
type Content struct {
Title string // 标题(邮件/站内信)
Body string // 正文内容
Template string // 渠道模板 ID
Params map[string]string // 模板参数
}
Content 是通知内容。 Template 为渠道模板 ID(如短信签名模板、邮件模板),Body 为直接内容。 两者至少提供一个;实现按渠道能力选择模板渲染或直发。
type MailAdapter ¶ added in v1.69.0
type MailAdapter struct {
// contains filtered or unexported fields
}
MailAdapter 把 framework/mail 客户端包装为 notify.Sender(渠道 "email")。 content.Title 为邮件主题,content.Body 为 HTML 正文。
func NewMailAdapter ¶ added in v1.69.0
func NewMailAdapter(client *mail.Client) *MailAdapter
NewMailAdapter 创建邮件适配器。
func (*MailAdapter) Channel ¶ added in v1.69.0
func (a *MailAdapter) Channel() string
Channel 返回渠道标识。
type Manager ¶
type Manager struct {
// contains filtered or unexported fields
}
Manager 是多渠道通知管理器。
type RateLimiter ¶ added in v1.87.0
type RateLimiter struct {
// contains filtered or unexported fields
}
RateLimiter 通知频控器:按 key(如 channel:target)限制发送频率, 用于防短信轰炸、验证码刷接口等场景。基于进程内滑动窗口; 多实例部署如需全局频控,建议在 Sender 内接入 Redis 计数(可扩展)。
func NewRateLimiter ¶ added in v1.87.0
func NewRateLimiter(window time.Duration, max int) *RateLimiter
NewRateLimiter 创建频控器:window 窗口内同一 key 最多 max 次。 window<=0 或 max<=0 时频控关闭(Allow 恒 true)。
func (*RateLimiter) Allow ¶ added in v1.87.0
func (r *RateLimiter) Allow(key string) bool
Allow 判断 key 是否允许发送(滑动窗口内未超限)。 key 建议格式 "channel:target"(如 "sms:13800138000"),由调用方拼接。
func (*RateLimiter) Clean ¶ added in v1.87.0
func (r *RateLimiter) Clean()
Clean 清理全部 key 的过期记录(窗口滑动后自动失效;可周期性调用)。
type SMSAdapter ¶ added in v1.69.0
type SMSAdapter struct {
// contains filtered or unexported fields
}
SMSAdapter 把 framework/sms 客户端包装为 notify.Sender(渠道 "sms")。 content.Template 覆盖默认模板 Code;content.Params 作为模板变量。
func NewSMSAdapter ¶ added in v1.69.0
func NewSMSAdapter(client *sms.Client, signName, templateCode string) *SMSAdapter
NewSMSAdapter 创建短信适配器。 signName/templateCode 为默认值,单次发送可通过 content.Template 覆盖模板。