me.chanjar.weixin.common.service

接口 WxOAuth2Service

所有已知实现类:

WxOAuth2ServiceDecorator

public interface WxOAuth2Service

oauth2 相关接口.

作者:

Binary Wang created on 2020-08-08

方法概要

限定符和类型	方法和说明
String	buildAuthorizationUrl(String redirectUri, String scope, String state) 构造oauth2授权的url连接.
WxOAuth2AccessToken	getAccessToken(String code) 用code换取oauth2的access token.
WxOAuth2AccessToken	getAccessToken(String appId, String appSecret, String code) 用code换取oauth2的access token.
WxOAuth2UserInfo	getUserInfo(WxOAuth2AccessToken oAuth2AccessToken, String lang) 用oauth2获取用户信息, 当前面引导授权时的scope是snsapi_userinfo的时候才可以.
WxOAuth2AccessToken	refreshAccessToken(String refreshToken) 刷新oauth2的access token.
boolean	validateAccessToken(WxOAuth2AccessToken oAuth2AccessToken) 验证oauth2的access token是否有效.

方法详细资料

buildAuthorizationUrl

String buildAuthorizationUrl(String redirectUri,
                             String scope,
                             String state)

 构造oauth2授权的url连接.
 详情请见: 网页授权
 

参数:

redirectUri - 用户授权完成后的重定向链接，无需urlencode, 方法内会进行encode

scope - scope,静默:snsapi_base, 带信息授权:snsapi_userinfo

state - state

返回:

url

getAccessToken

WxOAuth2AccessToken getAccessToken(String code)
                            throws WxErrorException

 用code换取oauth2的access token.
 详情请见: 网页授权获取用户基本信息
 

参数:

code - code

返回:

token对象

抛出:

WxErrorException - .

getAccessToken

WxOAuth2AccessToken getAccessToken(String appId,
                                   String appSecret,
                                   String code)
                            throws WxErrorException

用code换取oauth2的access token.

参数:

appId - the appid

appSecret - the secret

code - code

返回:

token对象

抛出:

WxErrorException - .

refreshAccessToken

WxOAuth2AccessToken refreshAccessToken(String refreshToken)
                                throws WxErrorException

 刷新oauth2的access token.
 

参数:

refreshToken - 刷新token

返回:

新的token对象

抛出:

WxErrorException - .

getUserInfo

WxOAuth2UserInfo getUserInfo(WxOAuth2AccessToken oAuth2AccessToken,
                             String lang)
                      throws WxErrorException

 用oauth2获取用户信息, 当前面引导授权时的scope是snsapi_userinfo的时候才可以.
 

参数:

oAuth2AccessToken - token对象

lang - zh_CN, zh_TW, en

返回:

用户对象

抛出:

WxErrorException - .

validateAccessToken

boolean validateAccessToken(WxOAuth2AccessToken oAuth2AccessToken)

 验证oauth2的access token是否有效.
 

参数:

oAuth2AccessToken - token对象

返回:

是否有效