corporation

Documentation

Overview

企业微信开发 SDK

See: https://work.weixin.qq.com/api/doc

Index

• Variables
• func GetAccessToken(app *App) (accessToken string, err error)
• func NoticeAccessTokenExpire(app *App) (err error)
• type AccessToken
• type App
  • func (app *App) SetAccessTokenCacheDriver(driver cachego.Cache)
  • func (app *App) SetGetAccessTokenHandler(f GetAccessTokenFunc)
  • func (app *App) SetNoticeAccessTokenExpireHandler(f NoticeAccessTokenExpireFunc)
• type AppConfig
• type Client
  • func (client *Client) HTTPGet(uri string) (resp []byte, err error)
  • func (client *Client) HTTPPost(uri string, payload io.Reader, contentType string) (resp []byte, err error)
• type Config
• type Corporation
  • func New(config Config) (corporation *Corporation)
  • func (corporation *Corporation) NewApp(config AppConfig) (app *App)
  • func (corporation *Corporation) SetLogger(logger *log.Logger)
• type GetAccessTokenFunc
• type NoticeAccessTokenExpireFunc
• type Server
  • func (s *Server) EchoStr(writer http.ResponseWriter, request *http.Request)
  • func (s *Server) ParseXML(request *http.Request) (m interface{}, err error)
  • func (s *Server) Response(writer http.ResponseWriter, request *http.Request, reply interface{}) (err error)

Examples

• Corporation.SetLogger

Variables

var (
	WXServerUrl      = "https://qyapi.weixin.qq.com" // 微信 api 服务器地址
	UserAgent        = "cvblood/qywxapi"
	ErrorAccessToken = errors.New("access token error")
	ErrorSystemBusy  = errors.New("system busy")
)

Functions

func GetAccessToken

func GetAccessToken(app *App) (accessToken string, err error)

从 公众号实例 的 AccessToken 管理器 获取 access_token

如果没有 access_token 或者 已过期，那么刷新

func NoticeAccessTokenExpire

func NoticeAccessTokenExpire(app *App) (err error)

NoticeAccessTokenExpire 只需将本地存储的 access_token 删除，即完成了 access_token 已过期的 主动通知

retry 请求的时候，会发现本地没有 access_token ，从而触发refresh

Types

type AccessToken

type AccessToken struct {
	Cache                          cachego.Cache
	GetAccessTokenHandler          GetAccessTokenFunc
	NoticeAccessTokenExpireHandler NoticeAccessTokenExpireFunc
}

AccessToken 管理器 处理缓存 和 刷新 逻辑

type App

type App struct {
	Config      AppConfig
	AccessToken AccessToken
	Client      Client
	Server      Server
	Corporation *Corporation
}

应用

func (*App) SetAccessTokenCacheDriver

func (app *App) SetAccessTokenCacheDriver(driver cachego.Cache)

SetAccessTokenCacheDriver 设置 AccessToken 缓存器 默认为文件缓存：目录 os.TempDir()

驱动接口类型 为 cachego.Cache

func (*App) SetGetAccessTokenHandler

func (app *App) SetGetAccessTokenHandler(f GetAccessTokenFunc)

SetGetAccessTokenHandler 设置 AccessToken 获取方法。默认 从本地缓存获取（过期从微信接口刷新）

如果有多实例服务，可以设置为 Redis 或 RPC 等中控服务器 获取 就可以避免 AccessToken 刷新冲突

func (*App) SetNoticeAccessTokenExpireHandler

func (app *App) SetNoticeAccessTokenExpireHandler(f NoticeAccessTokenExpireFunc)

SetNoticeAccessTokenExpireHandler 设置 AccessToken 过期 通知

框架提供的默认机制是 删除本地缓存的 access_token，那么 retry 的时候 会触发 刷新

如果有多实例服务，可以设置为 通知 中控服务器 去刷新

type AppConfig

type AppConfig struct {
	AgentId        string
	Secret         string
	Token          string
	EncodingAESKey string
}

应用配置

type Client

type Client struct {
	Ctx *App
}

HttpClient 用于向微信接口发送请求

func (*Client) HTTPGet

func (client *Client) HTTPGet(uri string) (resp []byte, err error)

HTTPGet GET 请求

func (*Client) HTTPPost

func (client *Client) HTTPPost(uri string, payload io.Reader, contentType string) (resp []byte, err error)

HTTPPost POST 请求

type Config

type Config struct {
	Corpid string
}

配置

type Corporation

type Corporation struct {
	Config Config
	Logger *log.Logger
}

Corporation 企业实例

func New

func New(config Config) (corporation *Corporation)

创建企业实例

func (*Corporation) NewApp

func (corporation *Corporation) NewApp(config AppConfig) (app *App)

创建应用实例

func (*Corporation) SetLogger

func (corporation *Corporation) SetLogger(logger *log.Logger)

SetLogger 日志记录 默认输出到 os.Stdout

可以新建 logger 输出到指定文件

如果不想开启日志，可以 SetLogger(nil)

Example

package main

import (
	"log"
	"os"

	"github.com/cvblood/qywxapi/corporation"
)

func main() {

	var Ctx *corporation.Corporation

	// 输出日志到控制台
	Ctx.SetLogger(log.New(os.Stdout, "[corporation ]", log.LstdFlags))

	// 记录日志到指定文件
	logFile, _ := os.OpenFile("/path/to/file", os.O_WRONLY, 0644)
	Ctx.SetLogger(log.New(logFile, "[corporation ]", log.LstdFlags))

	// 关闭日志
	Ctx.SetLogger(nil)
}

type GetAccessTokenFunc

type GetAccessTokenFunc func(ctx *App) (accessToken string, err error)

GetAccessTokenFunc 获取 access_token 方法接口

type NoticeAccessTokenExpireFunc

type NoticeAccessTokenExpireFunc func(ctx *App) (err error)

NoticeAccessTokenExpireFunc 通知中控 刷新 access_token

type Server

type Server struct {
	Ctx *App
}

响应微信请求 或 推送消息/事件 的服务器

func (*Server) EchoStr

func (s *Server) EchoStr(writer http.ResponseWriter, request *http.Request)

EchoStr 服务器接口校验

msg_signature=ASDFQWEXZCVAQFASDFASDFSS &timestamp=13500001234 &nonce=123412323 &echostr=ENCRYPT_STR

func (*Server) ParseXML

func (s *Server) ParseXML(request *http.Request) (m interface{}, err error)

ParseXML 解析微信推送过来的消息/事件

POST /api/callback?msg_signature=ASDFQWEXZCVAQFASDFASDFSS &timestamp=13500001234 &nonce=123412323

<xml>

<ToUserName><![CDATA[toUser]]></ToUserName>
<AgentID><![CDATA[toAgentID]]></AgentID>
<Encrypt><![CDATA[msg_encrypt]]></Encrypt>

</xml>

func (*Server) Response

func (s *Server) Response(writer http.ResponseWriter, request *http.Request, reply interface{}) (err error)

Response 响应微信消息