notify

Documentation

Index

• type BasicNotificationMessage
• type Channel
• type GeneratedMessage
  • func (m *GeneratedMessage[T]) Message() (T, error)
• type Handler
• type Manager
  • func NewManager() *Manager
  • func (m *Manager) Broadcast(ctx context.Context, msg *Message) map[Channel]error
  • func (m *Manager) Get(ch Channel) (Handler, bool)
  • func (m *Manager) Register(ch Channel, h Handler)
  • func (m *Manager) Send(ctx context.Context, ch Channel, msg *Message) error
• type Message
• type MessageType
• type Notifier
• type NotifierWrap
  • func WrapNotifierDynamic[T any](notifier Notifier[T], messageGen func() (BasicNotificationMessage[T], error)) NotifierWrap
  • func WrapNotifierStatic[T any](notifier Notifier[T], message BasicNotificationMessage[T]) NotifierWrap
• type NotifierWrapper
  • func (w NotifierWrapper[T]) Send(ctx context.Context) (bool, error)
• type SystemNotify
  • func NewSystemNotify() *SystemNotify
  • func (n *SystemNotify) AddNotify(notifier NotifierWrap)

Types

type BasicNotificationMessage

type BasicNotificationMessage[T any] interface {
	Message() (T, error)
}

BasicNotificationMessage 是一个泛型接口，Message 可以返回不同类型

type Channel

type Channel string

Channel 定义渠道标识

const (
	ChannelFeishu Channel = "feishu"
	ChannelSms    Channel = "sms"
	ChannelEmail  Channel = "email"
	ChannelWechat Channel = "wechat"
)

type GeneratedMessage

type GeneratedMessage[T any] struct {
	Data T
}

GeneratedMessage 兼容动态数据

func (*GeneratedMessage[T]) Message

func (m *GeneratedMessage[T]) Message() (T, error)

type Handler

type Handler interface {
	Send(ctx context.Context, msg *Message) error
}

Handler 定义了统一的发送接口 业务层调用此接口，不关心底层的泛型实现

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

Manager 统一管理所有的通知 Handler

func NewManager

func NewManager() *Manager

func (*Manager) Broadcast

func (m *Manager) Broadcast(ctx context.Context, msg *Message) map[Channel]error

Broadcast 广播消息给所有已注册的渠道 (可选功能)

func (*Manager) Get

func (m *Manager) Get(ch Channel) (Handler, bool)

Get 获取指定渠道的 Handler

func (*Manager) Register

func (m *Manager) Register(ch Channel, h Handler)

Register 注册一个渠道的 Handler

func (*Manager) Send

func (m *Manager) Send(ctx context.Context, ch Channel, msg *Message) error

Send 通过指定渠道发送消息

type Message

type Message struct {
	// 基础字段
	To      []string    // 接收者列表 (UserID, Phone, Email 等，取决于 Channel)
	Subject string      // 标题 (邮件、飞书富文本等使用)
	Content string      // 内容 (文本内容)
	Type    MessageType // 消息类型

	// 扩展字段
	TemplateID   string         // 模版 ID (如短信、飞书模板消息)
	TemplateVars map[string]any // 模版变量
	Files        []string       // 附件链接
	Extra        map[string]any // 渠道特定的额外参数 (如飞书的 card_id, 交互配置等)
}

Message 是业务层使用的统一消息模型 它屏蔽了底层渠道的差异，提供了最常用的字段

type MessageType

type MessageType string

MessageType 定义消息类型

const (
	MsgTypeText     MessageType = "text"
	MsgTypeMarkdown MessageType = "markdown" // 部分渠道支持，不支持的可能降级为 Text
	MsgTypeCard     MessageType = "card"     // 复杂卡片，通常需要 channel 特定的 Extra 数据
)

type Notifier

type Notifier[T any] interface {
	Send(ctx context.Context, message BasicNotificationMessage[T]) (bool, error)
}

Notifier 是一个发送通知的接口，T 是 BasicNotificationMessage 的返回类型

type NotifierWrap

type NotifierWrap interface {
	Send(ctx context.Context) (bool, error)
}

func WrapNotifierDynamic

func WrapNotifierDynamic[T any](notifier Notifier[T], messageGen func() (
	BasicNotificationMessage[T], error)) NotifierWrap

func WrapNotifierStatic

func WrapNotifierStatic[T any](notifier Notifier[T], message BasicNotificationMessage[T]) NotifierWrap

WrapNotifierStatic 方法，支持静态和动态消息生成

type NotifierWrapper

type NotifierWrapper[T any] struct {
	Notifier   Notifier[T]
	Message    BasicNotificationMessage[T]
	MessageGen func() (BasicNotificationMessage[T], error)
}

func (NotifierWrapper[T]) Send

func (w NotifierWrapper[T]) Send(ctx context.Context) (bool, error)

type SystemNotify

type SystemNotify struct {
	Notify []NotifierWrap
}

func NewSystemNotify

func NewSystemNotify() *SystemNotify

func (*SystemNotify) AddNotify

func (n *SystemNotify) AddNotify(notifier NotifierWrap)