oauth2

package
v0.0.0-...-0447b3e Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 17, 2016 License: GPL-3.0, Apache-2.0 Imports: 9 Imported by: 0

README

网页授权获取用户基本信息

snsapi_base 版本，不需要用户确认授权
package main

import (
	"encoding/json"
	"fmt"
	"io"
	"log"
	"net/http"
	"net/url"

	"github.com/chanxuehong/session"
	"github.com/chanxuehong/util/random"
	"github.com/chanxuehong/wechat/mp/user/oauth2"
)

var (
	sessionStorage = session.New(20*60, 60*60)

	oauth2Config = oauth2.NewOAuth2Config(
		"appid",     // 填上自己的参数
		"appsecret", // 填上自己的参数
		"http://192.168.1.168/page2",
		"snsapi_base",
	)
)

func Page1Handler(w http.ResponseWriter, r *http.Request) {
	state := string(random.NewToken())

	sid := string(random.NewSessionId())
	if err := sessionStorage.Add(sid, state); err != nil {
		io.WriteString(w, err.Error())
		return
	}

	cookie := http.Cookie{
		Name:     "sid",
		Value:    sid,
		HttpOnly: true,
	}
	http.SetCookie(w, &cookie)

	http.Redirect(w, r, oauth2Config.AuthCodeURL(state), http.StatusFound)
}

func Page2Handler(w http.ResponseWriter, r *http.Request) {
	if r.URL == nil {
		io.WriteString(w, "r.URL == nil")
		return
	}
	urlValues, err := url.ParseQuery(r.URL.RawQuery)
	if err != nil {
		io.WriteString(w, err.Error())
		return
	}

	cookie, err := r.Cookie("sid")
	if err != nil {
		io.WriteString(w, err.Error())
		return
	}
	session, err := sessionStorage.Get(cookie.Value)
	if err != nil {
		io.WriteString(w, err.Error())
		return
	}

	savedState := session.(string)

	code := urlValues.Get("code")
	urlState := urlValues.Get("state")

	if savedState != urlState {
		io.WriteString(w, fmt.Sprintf("state 不匹配, session 中的为 %q, url 传递过来的是 %q", savedState, urlState))
		return
	}

	if code == "" {
		log.Println("客户禁止授权")
		return
	}

	oauth2Client := oauth2.Client{
		OAuth2Config: oauth2Config,
	}

	token, err := oauth2Client.Exchange(code)
	if err != nil {
		io.WriteString(w, err.Error())
		return
	}

	json.NewEncoder(w).Encode(token)
	return
}

func init() {
	http.HandleFunc("/page1", Page1Handler)
	http.HandleFunc("/page2", Page2Handler)
}

func main() {
	http.ListenAndServe(":80", nil)
}
snsapi_userinfo 版本，需要用户确认授权
package main

import (
	"encoding/json"
	"fmt"
	"io"
	"log"
	"net/http"
	"net/url"

	"github.com/chanxuehong/session"
	"github.com/chanxuehong/util/random"
	"github.com/chanxuehong/wechat/mp/user/oauth2"
)

var (
	sessionStorage = session.New(20*60, 60*60)

	oauth2Config = oauth2.NewOAuth2Config(
		"appid",     // 填上自己的参数
		"appsecret", // 填上自己的参数
		"http://192.168.1.168/page2",
		"snsapi_userinfo",
	)
)

func Page1Handler(w http.ResponseWriter, r *http.Request) {
	state := string(random.NewToken())

	sid := string(random.NewSessionId())
	if err := sessionStorage.Add(sid, state); err != nil {
		io.WriteString(w, err.Error())
		return
	}

	cookie := http.Cookie{
		Name:     "sid",
		Value:    sid,
		HttpOnly: true,
	}
	http.SetCookie(w, &cookie)

	http.Redirect(w, r, oauth2Config.AuthCodeURL(state), http.StatusFound)
}

func Page2Handler(w http.ResponseWriter, r *http.Request) {
	if r.URL == nil {
		io.WriteString(w, "r.URL == nil")
		return
	}
	urlValues, err := url.ParseQuery(r.URL.RawQuery)
	if err != nil {
		io.WriteString(w, err.Error())
		return
	}

	cookie, err := r.Cookie("sid")
	if err != nil {
		io.WriteString(w, err.Error())
		return
	}
	session, err := sessionStorage.Get(cookie.Value)
	if err != nil {
		io.WriteString(w, err.Error())
		return
	}

	savedState := session.(string)

	code := urlValues.Get("code")
	urlState := urlValues.Get("state")

	if savedState != urlState {
		io.WriteString(w, fmt.Sprintf("state 不匹配, session 中的为 %q, url 传递过来的是 %q", savedState, urlState))
		return
	}

	if code == "" {
		log.Println("客户禁止授权")
		return
	}

	oauth2Client := oauth2.Client{
		OAuth2Config: oauth2Config,
	}

	_, err = oauth2Client.Exchange(code)
	if err != nil {
		io.WriteString(w, err.Error())
		return
	}

	userinfo, err := oauth2Client.UserInfo(oauth2.Language_zh_CN)
	if err != nil {
		io.WriteString(w, err.Error())
		return
	}

	json.NewEncoder(w).Encode(userinfo)
	return
}

func init() {
	http.HandleFunc("/page1", Page1Handler)
	http.HandleFunc("/page2", Page2Handler)
}

func main() {
	http.ListenAndServe(":80", nil)
}

Documentation

Overview

网页授权获取用户基本信息.

Index

Constants

View Source 
const (
	Language_zh_CN = "zh_CN" // 简体中文
	Language_zh_TW = "zh_TW" // 繁体中文
	Language_en    = "en"    // 英文
)
View Source 
const (
	SexUnknown = 0 // 未知
	SexMale    = 1 // 男性
	SexFemale  = 2 // 女性
)

Variables

View Source 
var ErrNoHeadImage = errors.New("没有头像")

Functions

func AuthCodeURL 

func AuthCodeURL(appId, redirectURL, scope, state string) string

构造请求用户授权获取code的地址. 

appId:       公众号的唯一标识
redirectURL: 授权后重定向的回调链接地址
             如果用户同意授权，页面将跳转至 redirect_uri/?code=CODE&state=STATE。
             若用户禁止授权，则重定向后不会带上code参数，仅会带上state参数redirect_uri?state=STATE
scope:       应用授权作用域，
             snsapi_base （不弹出授权页面，直接跳转，只能获取用户openid），
             snsapi_userinfo （弹出授权页面，可通过openid拿到昵称、性别、所在地。
             并且，即使在未关注的情况下，只要用户授权，也能获取其信息）
state:       重定向后会带上state参数，开发者可以填写a-zA-Z0-9的参数值，最多128字节

Types

type Client 

type Client struct {
	*OAuth2Config
	*OAuth2Token // 程序会自动更新最新的 OAuth2Token 到这个字段, 如有必要该字段可以保存起来

	HttpClient *http.Client // 如果 httpClient == nil 则默认用 http.DefaultClient
}

func (*Client) CheckAccessTokenValid 

func (clt *Client) CheckAccessTokenValid() (valid bool, err error)

检验授权凭证（access_token）是否有效. 

NOTE:
1. Client 需要指定 OAuth2Token
2. 先判断 err 然后再判断 valid

func (*Client) Exchange 

func (clt *Client) Exchange(code string) (token *OAuth2Token, err error)

通过code换取网页授权access_token. 

NOTE:
1. Client 需要指定 OAuth2Config
2. 如果指定了 OAuth2Token, 则会更新这个 OAuth2Token, 同时返回的也是指定的 OAuth2Token;
   否则会重新分配一个 OAuth2Token.

func (*Client) TokenRefresh 

func (clt *Client) TokenRefresh() (token *OAuth2Token, err error)

刷新access_token（如果需要）. 

NOTE: Client 需要指定 OAuth2Config, OAuth2Token

func (*Client) UserInfo 

func (clt *Client) UserInfo(lang string) (info *UserInfo, err error)

获取用户信息(需scope为 snsapi_userinfo). 

NOTE:
1. Client 需要指定 OAuth2Config, OAuth2Token
2. lang 可能的取值是 zh_CN, zh_TW, en, 如果留空 "" 则默认为 zh_CN.

type OAuth2Config 

type OAuth2Config struct {
	AppId, AppSecret string

	// 应用授权作用域，多个作用域用逗号（,）分隔;
	// 目前有 snsapi_base, snsapi_userinfo.
	Scope string

	// 用户授权后跳转的目的地址
	// 用户授权后跳转到 RedirectURL?code=CODE&state=STATE
	// 用户禁止授权跳转到 RedirectURL?state=STATE
	RedirectURL string
}

func NewOAuth2Config 

func NewOAuth2Config(AppId, AppSecret, RedirectURL string, Scope ...string) *OAuth2Config

func (*OAuth2Config) AuthCodeURL 

func (cfg *OAuth2Config) AuthCodeURL(state string) string

请求用户授权获取code的地址.

type OAuth2Token 

type OAuth2Token struct {
	AccessToken  string
	RefreshToken string
	ExpiresAt    int64 // 过期时间, unixtime, 分布式系统要求时间同步, 建议使用 NTP

	OpenId string
	Scopes []string // 用户授权的作用域
}

用户相关的 oauth2 token 信息

type UserInfo 

type UserInfo struct {
	OpenId   string `json:"openid"`   // 用户的唯一标识
	Nickname string `json:"nickname"` // 用户昵称
	Sex      int    `json:"sex"`      // 用户的性别，值为1时是男性，值为2时是女性，值为0时是未知
	City     string `json:"city"`     // 普通用户个人资料填写的城市
	Province string `json:"province"` // 用户个人资料填写的省份
	Country  string `json:"country"`  // 国家，如中国为CN

	// 用户头像，最后一个数值代表正方形头像大小（有0、46、64、96、132数值可选，0代表640*640正方形头像），
	// 用户没有头像时该项为空
	HeadImageURL string `json:"headimgurl,omitempty"`

	// 用户特权信息，json 数组，如微信沃卡用户为（chinaunicom）
	Privilege []string `json:"privilege"`

	// 用户统一标识。针对一个微信开放平台帐号下的应用，同一用户的unionid是唯一的。
	UnionId string `json:"unionid"`
}

func (*UserInfo) HeadImageSize 

func (info *UserInfo) HeadImageSize() (size int, err error)

获取用户图像的大小, 如果用户没有图像则返回 ErrNoHeadImage 错误.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.