cn.zkdcloud.core

类 Oauth2AuthorizeComponent

java.lang.Object

cn.zkdcloud.core.Oauth2AuthorizeComponent

所有已实现的接口:

Component

public class Oauth2AuthorizeComponent
extends Object
implements Component

网页授权管理

版本:

2017/8/31

作者:

zk

字段概要

字段

限定符和类型	字段和说明
static Oauth2AuthorizeComponent	authorizeComponent 授权实例
static String	GET_USER_ACCESS_TOKEN 获取用户access token url
static String	GET_USER_INFO 获取用户信息(GET)
static String	REFRESH_ACCESS_TOKEN 刷新yoghurt access token url
static String	SNSAPI_BASE_URL scope为snsapi_base 授权
static String	SNSAPI_USERINFO_URL scope为snsapi_userinfo 授权

方法概要

限定符和类型	方法和说明
static Oauth2AuthorizeComponent	getInstance() 获取授权组件实例
String	getUserAccessToken(String code) 根据code获取用户授权的access_token
String	getUserInfo(String code) 根据code 获取用户信息
String	getUserInfo(String access_token, String openid) 拉取用户信息(需scope为 snsapi_userinfo)
String	getUserInfo(String access_token, String openid, String lang) 拉取用户信息(需scope为 snsapi_userinfo)
void	init() 可以初始化snsapiUrl
boolean	isEffective(String access_token, String openid) 检查该access是否有效
String	refreshUserAccessToken(String refresh_token) 刷新拉取用户access token(GET/POST)
void	setSnsapiUrl(String redirect_uri, String state) 设置scope为snsapi_base 和 snsapi_userinfo 授权

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

authorizeComponent

public static Oauth2AuthorizeComponent authorizeComponent

授权实例

SNSAPI_BASE_URL

public static String SNSAPI_BASE_URL

scope为snsapi_base 授权

SNSAPI_USERINFO_URL

public static String SNSAPI_USERINFO_URL

scope为snsapi_userinfo 授权

GET_USER_ACCESS_TOKEN

public static String GET_USER_ACCESS_TOKEN

获取用户access token url

REFRESH_ACCESS_TOKEN

public static String REFRESH_ACCESS_TOKEN

刷新yoghurt access token url

GET_USER_INFO

public static String GET_USER_INFO

获取用户信息(GET)

方法详细资料

init

public void init()

可以初始化snsapiUrl

指定者:

init 在接口中 Component

setSnsapiUrl

public void setSnsapiUrl(String redirect_uri,
                         String state)

设置scope为snsapi_base 和 snsapi_userinfo 授权

参数:

redirect_uri - 重定向url,应当使用https链接来确保授权code的安全性。

state - 重定向后会带上state参数，开发者可以填写a-zA-Z0-9的参数值，最多128字节

getUserInfo

public String getUserInfo(String code)

根据code 获取用户信息

参数:

code - code 5分钟未被使用自动过期

返回:

userInfo

getUserAccessToken

public String getUserAccessToken(String code)

根据code获取用户授权的access_token

参数:

code - code作为换取access_token的票据，每次用户授权带上的code将不一样，code只能使用一次，5分钟未被使用自动过期

返回:

jsonStr { "access_token":"ACCESS_TOKEN", "expires_in":7200, "refresh_token":"REFRESH_TOKEN", "openid":"OPENID", "scope":"SCOPE" }

refreshUserAccessToken

public String refreshUserAccessToken(String refresh_token)

刷新拉取用户access token(GET/POST)

参数:

refresh_token - refresh token

返回:

jsonStr { "access_token":"ACCESS_TOKEN", "expires_in":7200, "refresh_token":"REFRESH_TOKEN", "openid":"OPENID", "scope":"SCOPE" }

getUserInfo

public String getUserInfo(String access_token,
                          String openid)

拉取用户信息(需scope为 snsapi_userinfo)

参数:

access_token - 网页授权接口调用凭证

openid - 用户的唯一标识

返回:

用户信息jsonStr { "openid":" OPENID", " nickname": NICKNAME, "sex":"1", "province":"PROVINCE" "city":"CITY", "country":"COUNTRY", "headimgurl": "http://wx.qlogo.cn/Q1dZuTOgvLLrhJbERQQ, "privilege":[ "PRIVILEGE1" "PRIVILEGE2" ], "unionid": "o6_bmasdasdsad6_2sgVt7hMZOPfL" }

getUserInfo

public String getUserInfo(String access_token,
                          String openid,
                          String lang)

拉取用户信息(需scope为 snsapi_userinfo)

参数:

access_token - 网页授权接口调用凭证

openid - 用户的唯一标识

返回:

用户信息jsonStr { "openid":" OPENID", " nickname": NICKNAME, "sex":"1", "province":"PROVINCE" "city":"CITY", "country":"COUNTRY", "headimgurl": "http://wx.qlogo.cn/Q1dZuTOgvLLrhJbERQQ, "privilege":[ "PRIVILEGE1" "PRIVILEGE2" ], "unionid": "o6_bmasdasdsad6_2sgVt7hMZOPfL" }

isEffective

public boolean isEffective(String access_token,
                           String openid)

检查该access是否有效

参数:

access_token - access_token

openid - openid

返回:

is or not effective

getInstance

public static Oauth2AuthorizeComponent getInstance()

获取授权组件实例

返回:

authorizeComponent