Documentation
¶
Index ¶
- type AuthorizeEventHandler
- type AuthorizedEvent
- type CDATA
- type ComponentVerifyTicketEvent
- type ComponentVerifyTicketHandler
- type CryptoConfigProvider
- type CryptoConfigProviderFunc
- type EventHandler
- type EventMessage
- type ImageMessage
- type LinkMessage
- type LocationMessage
- type Message
- type MessageClient
- type MessageHandler
- type MessageProcessor
- func (p *MessageProcessor) ProcessMessage(xmlData []byte) (interface{}, error)
- func (p *MessageProcessor) RegisterAuthorizeEventHandler(handler AuthorizeEventHandler)
- func (p *MessageProcessor) RegisterComponentVerifyTicketHandler(handler ComponentVerifyTicketHandler)
- func (p *MessageProcessor) RegisterEventHandler(eventType string, handler EventHandler)
- func (p *MessageProcessor) RegisterMessageHandler(msgType string, handler MessageHandler)
- type SecureMessageProcessor
- func (p *SecureMessageProcessor) ClearCryptoCache(authorizerAppID string)
- func (p *SecureMessageProcessor) EncryptReply(authorizerAppID string, reply interface{}, timestamp string, nonce string) (string, error)
- func (p *SecureMessageProcessor) ProcessMessage(xmlData []byte) (interface{}, error)
- func (p *SecureMessageProcessor) ProcessSecureMessage(authorizerAppID string, msgSignature string, timestamp string, nonce string, ...) (interface{}, error)
- func (p *SecureMessageProcessor) RegisterAuthorizeEventHandler(handler AuthorizeEventHandler)
- func (p *SecureMessageProcessor) RegisterComponentVerifyTicketHandler(handler ComponentVerifyTicketHandler)
- func (p *SecureMessageProcessor) RegisterEventHandler(eventType string, handler EventHandler)
- func (p *SecureMessageProcessor) RegisterMessageHandler(msgType string, handler MessageHandler)
- func (p *SecureMessageProcessor) VerifyURL(authorizerAppID string, msgSignature string, timestamp string, nonce string, ...) (string, error)
- type SecureOption
- type TextMessage
- type UnauthorizedEvent
- type UpdateAuthorizedEvent
- type VideoMessage
- type VoiceMessage
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthorizeEventHandler ¶
type AuthorizeEventHandler interface {
HandleAuthorizeEvent(event interface{}) error
}
AuthorizeEventHandler 第三方平台授权事件处理器接口
type AuthorizedEvent ¶
type AuthorizedEvent struct {
EventMessage
AuthorizerAppID string `xml:"AuthorizerAppid"`
AuthorizationCode string `xml:"AuthorizationCode"`
AuthorizationCodeExpiredTime int64 `xml:"AuthorizationCodeExpiredTime"`
PreAuthCode string `xml:"PreAuthCode"`
}
AuthorizedEvent 授权成功事件
type ComponentVerifyTicketEvent ¶
type ComponentVerifyTicketEvent struct {
EventMessage
ComponentVerifyTicket string `xml:"ComponentVerifyTicket"`
}
ComponentVerifyTicketEvent 验证票据事件
type ComponentVerifyTicketHandler ¶
type ComponentVerifyTicketHandler interface {
HandleComponentVerifyTicket(event *ComponentVerifyTicketEvent) error
}
ComponentVerifyTicketHandler 第三方平台component_verify_ticket事件处理器接口
type CryptoConfigProvider ¶ added in v0.1.2
type CryptoConfigProvider interface {
// GetCryptoConfig 返回指定授权方的消息校验Token与消息加解密EncodingAESKey
GetCryptoConfig(authorizerAppID string) (token, encodingAESKey string, err error)
}
CryptoConfigProvider 授权方消息加解密配置提供者
第三方平台场景下,每个授权方都有独立的「消息校验Token」与「消息加解密EncodingAESKey」, 需要在授权流程中持久化(授权事件回调里可拿到),SDK 不假设存储方式,由宿主注入。
type CryptoConfigProviderFunc ¶ added in v0.1.2
CryptoConfigProviderFunc 函数式形式的 CryptoConfigProvider,便于快速注入
func (CryptoConfigProviderFunc) GetCryptoConfig ¶ added in v0.1.2
func (f CryptoConfigProviderFunc) GetCryptoConfig(authorizerAppID string) (string, string, error)
GetCryptoConfig 实现 CryptoConfigProvider
type EventHandler ¶
type EventHandler interface {
HandleEvent(event *EventMessage) (interface{}, error)
}
EventHandler 事件处理器接口
type EventMessage ¶
EventMessage 事件消息
type ImageMessage ¶
type ImageMessage struct {
Message
PicURL string `xml:"PicUrl"`
MediaID string `xml:"MediaId"`
MsgID int64 `xml:"MsgId,omitempty"`
}
ImageMessage 图片消息
type LinkMessage ¶
type LinkMessage struct {
Message
Title string `xml:"Title"`
Description string `xml:"Description"`
URL string `xml:"Url"`
MsgID int64 `xml:"MsgId,omitempty"`
}
LinkMessage 链接消息
type LocationMessage ¶
type LocationMessage struct {
Message
LocationX float64 `xml:"Location_X"`
LocationY float64 `xml:"Location_Y"`
Scale int `xml:"Scale"`
Label string `xml:"Label"`
MsgID int64 `xml:"MsgId,omitempty"`
}
LocationMessage 位置消息
type Message ¶
type Message struct {
XMLName xml.Name `xml:"xml"`
ToUserName string `xml:"ToUserName"`
FromUserName string `xml:"FromUserName"`
CreateTime int64 `xml:"CreateTime"`
MsgType string `xml:"MsgType"`
}
Message 基础消息结构
type MessageClient ¶
type MessageClient struct {
Client *openplatform.Client
}
MessageClient 消息客户端
func NewMessageClient ¶
func NewMessageClient(client *openplatform.Client) *MessageClient
NewMessageClient 创建新的消息客户端
type MessageHandler ¶
MessageHandler 消息处理器接口
type MessageProcessor ¶
type MessageProcessor struct {
// contains filtered or unexported fields
}
MessageProcessor 消息处理器
func (*MessageProcessor) ProcessMessage ¶
func (p *MessageProcessor) ProcessMessage(xmlData []byte) (interface{}, error)
ProcessMessage 处理消息
func (*MessageProcessor) RegisterAuthorizeEventHandler ¶
func (p *MessageProcessor) RegisterAuthorizeEventHandler(handler AuthorizeEventHandler)
RegisterAuthorizeEventHandler 注册授权事件处理器
func (*MessageProcessor) RegisterComponentVerifyTicketHandler ¶
func (p *MessageProcessor) RegisterComponentVerifyTicketHandler(handler ComponentVerifyTicketHandler)
RegisterComponentVerifyTicketHandler 注册component_verify_ticket事件处理器
func (*MessageProcessor) RegisterEventHandler ¶
func (p *MessageProcessor) RegisterEventHandler(eventType string, handler EventHandler)
RegisterEventHandler 注册事件处理器
func (*MessageProcessor) RegisterMessageHandler ¶
func (p *MessageProcessor) RegisterMessageHandler(msgType string, handler MessageHandler)
RegisterMessageHandler 注册消息处理器
type SecureMessageProcessor ¶
type SecureMessageProcessor struct {
// contains filtered or unexported fields
}
SecureMessageProcessor 安全消息处理器(支持加解密)
func NewSecureMessageProcessor ¶
func NewSecureMessageProcessor(opts ...SecureOption) *SecureMessageProcessor
NewSecureMessageProcessor 创建安全消息处理器
func (*SecureMessageProcessor) ClearCryptoCache ¶ added in v0.1.2
func (p *SecureMessageProcessor) ClearCryptoCache(authorizerAppID string)
ClearCryptoCache 清空加解密实例缓存 授权方重新授权、Token/EncodingAESKey 变更时需要调用,否则会继续使用旧配置
func (*SecureMessageProcessor) EncryptReply ¶
func (p *SecureMessageProcessor) EncryptReply( authorizerAppID string, reply interface{}, timestamp string, nonce string, ) (string, error)
EncryptReply 加密回复消息
func (*SecureMessageProcessor) ProcessMessage ¶
func (p *SecureMessageProcessor) ProcessMessage(xmlData []byte) (interface{}, error)
ProcessMessage 处理明文消息
func (*SecureMessageProcessor) ProcessSecureMessage ¶
func (p *SecureMessageProcessor) ProcessSecureMessage( authorizerAppID string, msgSignature string, timestamp string, nonce string, encryptedMsg string, ) (interface{}, error)
ProcessSecureMessage 处理安全消息(包含加解密,符合微信官方规范)
func (*SecureMessageProcessor) RegisterAuthorizeEventHandler ¶
func (p *SecureMessageProcessor) RegisterAuthorizeEventHandler(handler AuthorizeEventHandler)
RegisterAuthorizeEventHandler 注册授权事件处理器
func (*SecureMessageProcessor) RegisterComponentVerifyTicketHandler ¶
func (p *SecureMessageProcessor) RegisterComponentVerifyTicketHandler(handler ComponentVerifyTicketHandler)
RegisterComponentVerifyTicketHandler 注册component_verify_ticket事件处理器
func (*SecureMessageProcessor) RegisterEventHandler ¶
func (p *SecureMessageProcessor) RegisterEventHandler(eventType string, handler EventHandler)
RegisterEventHandler 注册事件处理器
func (*SecureMessageProcessor) RegisterMessageHandler ¶
func (p *SecureMessageProcessor) RegisterMessageHandler(msgType string, handler MessageHandler)
RegisterMessageHandler 注册消息处理器
type SecureOption ¶ added in v0.1.2
type SecureOption func(*SecureMessageProcessor)
SecureOption 安全消息处理器的可选配置
func WithCryptoConfigProvider ¶ added in v0.1.2
func WithCryptoConfigProvider(provider CryptoConfigProvider) SecureOption
WithCryptoConfigProvider 注入授权方加解密配置提供者(第三方平台多授权方场景必填)
func WithDefaultCryptoConfig ¶ added in v0.1.2
func WithDefaultCryptoConfig(token, encodingAESKey string) SecureOption
WithDefaultCryptoConfig 设置默认的消息校验Token与EncodingAESKey 适用于只有一个授权方、或自建公众号/小程序直接使用官方配置的场景
func WithTokenStorage ¶ added in v0.2.0
func WithTokenStorage(s storage.TokenStorage) SecureOption
WithTokenStorage 注入令牌存储(可选)
注入后加解密实例会从存储加载密钥轮换过渡期的上一次 EncodingAESKey(PrevKey); 未注入时 PrevKey 恒为空,轮换过渡期用旧密钥加密的消息将无法解密。
type TextMessage ¶
type TextMessage struct {
Message
Content string `xml:"Content"`
MsgID int64 `xml:"MsgId,omitempty"`
}
TextMessage 文本消息
type UpdateAuthorizedEvent ¶
type UpdateAuthorizedEvent struct {
EventMessage
AuthorizerAppID string `xml:"AuthorizerAppid"`
AuthorizationCode string `xml:"AuthorizationCode"`
AuthorizationCodeExpiredTime int64 `xml:"AuthorizationCodeExpiredTime"`
PreAuthCode string `xml:"PreAuthCode"`
}
UpdateAuthorizedEvent 授权更新事件