准備工作
在微信開放平台 https://open.weixin.qq.com/ 注冊成為開發者,具體步驟略
微信登錄接入
微信登錄遵循協議Aouth2.0中的授權碼模式
我們來看一下Aouth2.0中的授權碼模式是怎么定義的:
授權碼模式(authorization code)是功能最完整、流程最嚴密的授權模式。它的特點就是通過客戶端的后台服務器,與”服務提供商”的認證服務器進行互動。
它的步驟如下:
(A)用戶訪問客戶端,后者將前者導向認證服務器。
(B)用戶選擇是否給予客戶端授權。
(C)假設用戶給予授權,認證服務器將用戶導向客戶端事先指定的”重定向URI”(redirection URI),同時附上一個授權碼。
(D)客戶端收到授權碼,附上早先的”重定向URI”,向認證服務器申請令牌。這一步是在客戶端的后台的服務器上完成的,對用戶不可見。
(E)認證服務器核對了授權碼和重定向URI,確認無誤后,向客戶端發送訪問令牌(access token)和更新令牌(refresh token)
微信登錄的官方文檔將微信登錄分為3個步驟:
第一步.請求code
{
// send oauth request Final SendAuth.Req req = new SendAuth.Req(); req.scope = "snsapi_userinfo"; req.state = "wechat_sdk_demo_test"; api.sendReq(req); }
用這段代碼向微信開放平台請求授權碼code,可拉起微信並打開授權登錄頁(前提是你安裝了微信應用並已登錄,未登錄的會引導你先登錄),如下圖:
1.如果微信授權頁不顯示,請檢查你的APP簽名是否和你在騰訊開放平台的APP簽名一致,不一致可修改騰訊開放平台中的APP簽名,修改后重裝微信或清除微信數據后重試。
2.在你的包名相應目錄下新建一個wxapi目錄,並在該wxapi目錄下新增一個WXEntryActivity類,該類繼承自Activity(例如應用程序的包名為net.sourceforge,則新的包名為:net.sourceforge.wxapi),此處應注意包名不要弄錯,新增類的名字必須為WXEntryActivity。
返回說明
用戶點擊授權后,微信客戶端會被拉起,跳轉至授權界面,用戶在該界面點擊允許或取消,SDK通過SendAuth的Resp返回數據給調用方。回調WXEntryActivity中的onResp(BaseResp resp)方法,如下:
@Override public void onResp(BaseResp resp) { int errorCode = resp.errCode; switch (errorCode) { case BaseResp.ErrCode.ERR_OK: //用戶同意 String code = ((SendAuth.Resp) resp).code; break; case BaseResp.ErrCode.ERR_AUTH_DENIED: //用戶拒絕 break; case BaseResp.ErrCode.ERR_USER_CANCEL: //用戶取消 break; default: break; } ToastUtil.showMessageLong(this, resp.errStr); }
客戶端收到授權碼后,向自己的服務器發起登錄請求,並附帶收到的授權碼。
服務端收到登錄請求,向微信開放平台請求獲取access_token,微信開放平台返回Json字符串:
第二步:通過code獲取access_token(在自己服務器端做)
獲取第一步的code后,請求以下鏈接獲取access_token:
private String getAccessToken(String code) { String url = "https://api.weixin.qq.com/sns/oauth2/access_token?appid=APPID&secret=SECRET&code=CODE&grant_type=authorization_code"; URI uri = URI.create(url); HttpClient client = new DefaultHttpClient(); HttpGet get = new HttpGet(uri); HttpResponse response; try { response = client.execute(get); if (response.getStatusLine().getStatusCode() == 200) { HttpEntity entity = response.getEntity(); BufferedReader reader = new BufferedReader(new InputStreamReader(entity.getContent(), "UTF-8")); StringBuilder sb = new StringBuilder(); for (String temp = reader.readLine(); temp != null; temp = reader.readLine()) { sb.append(temp); } JSONObject object = new JSONObject(sb.toString().trim()); accessToken = object.getString("access_token"); openID = object.getString("openid"); refreshToken = object.getString("refresh_token"); expires_in = object.getLong("expires_in"); return accessToken; } } catch (ClientProtocolException e) { // TODO Auto-generated catch block e.printStackTrace(); } catch (IOException e) { // TODO Auto-generated catch block e.printStackTrace(); } catch (IllegalStateException e) { // TODO Auto-generated catch block e.printStackTrace(); } catch (JSONException e) { // TODO Auto-generated catch block e.printStackTrace(); } return null; }
參數說明
參數 是否必須 說明 appid 是 應用唯一標識,在微信開放平台提交應用審核通過后獲得 secret 是 應用密鑰AppSecret,在微信開放平台提交應用審核通過后獲得 code 是 填寫第一步獲取的code參數 grant_type 是 填authorization_code回說明**
正確的返回:
{
"access_token":"ACCESS_TOKEN",
"expires_in":7200,
"refresh_token":"REFRESH_TOKEN",
"openid":"OPENID",
"scope":"SCOPE",
"unionid":"o6_bmasdasdsad6_2sgVt7hMZOPfL"
}
參數 說明 access_token 接口調用憑證 expires_in access_token 接口調用憑證超時時間,單位(秒) refresh_token 用戶刷新access_token openid 授權用戶唯一標識 scope 用戶授權的作用域,使用逗號(,)分隔 unionid 只有在用戶將公眾號綁定到微信開放平台帳號后,才會出現該字段。
錯誤返回樣例: {"errcode":40029,"errmsg":"invalid code"}
服務端收到返回的access_token,將access_token,expires_in,access_token是否有效 等數據返回給客戶端,客戶端成功登錄
客戶端可利用已有的access_token獲取微信用戶信息
第三步:通過access_token調用接口
獲取access_token后,進行接口調用,有以下前提:
- access_token有效且未超時;
- 微信用戶已授權給第三方應用帳號相應接口作用域(scope)。
對於接口作用域(scope),能調用的接口有以下:
授權作用域(scope) 接口 接口說明 snsapi_base /sns/oauth2/access_token 通過code換取 access_token、refresh_token和已授權scope /sns/oauth2/refresh_token 刷新或續期access_token使用 /sns/auth 檢查access_token有效性 snsapi_userinfo /sns/userinfo 獲取用戶個人信息
其中snsapi_base屬於基礎接口,若應用已擁有其它scope權限,則默認擁有snsapi_base的權限。使用snsapi_base可以讓移動端網頁授權繞過跳轉授權登錄頁請求用戶授權的動作,直接跳轉第三方網頁帶上授權臨時票據(code),但會使得用戶已授權作用域(scope)僅為snsapi_base,從而導致無法獲取到需要用戶授權才允許獲得的數據和基礎功能。
以獲取用戶信息為例:
private void getUserInfo() { if (isAccessTokenIsInvalid() && System.currentTimeMillis() < expires_in) { String uri = "https://api.weixin.qq.com/sns/userinfo?access_token=" + accessToken + "&openid=" + openID; HttpClient client = new DefaultHttpClient(); HttpGet get = new HttpGet(URI.create(uri)); try { HttpResponse response = client.execute(get); if (response.getStatusLine().getStatusCode() == 200) { BufferedReader reader = new BufferedReader(new InputStreamReader(response.getEntity().getContent(), "UTF-8")); StringBuilder builder = new StringBuilder(); for (String temp = reader.readLine(); temp != null; temp = reader.readLine()) { builder.append(temp); } JSONObject object = new JSONObject(builder.toString().trim()); String nikeName = object.getString("nickname"); } } catch (ClientProtocolException e) { // TODO Auto-generated catch block e.printStackTrace(); } catch (IOException e) { // TODO Auto-generated catch block e.printStackTrace(); } catch (JSONException e) { // TODO Auto-generated catch block e.printStackTrace(); } } }
微信重復登錄
假設用戶已經獲得授權,則下次登錄時只需要驗證access_token是否有效,無效則重新獲取授權,有效則無需重新獲得授權。
1.用戶向自己的服務器請求登錄,登錄方式為微信登錄,附帶上次登錄返回的的access_token
2.服務器收到用戶的登錄請求,向微信開放平台發送access_token是否有效的驗證請求如下:
private boolean isAccessTokenIsInvalid() { String url = "https://api.weixin.qq.com/sns/auth?access_token=" + accessToken + "&openid=" + openID; URI uri = URI.create(url); HttpClient client = new DefaultHttpClient(); HttpGet get = new HttpGet(uri); HttpResponse response; try { response = client.execute(get); if (response.getStatusLine().getStatusCode() == 200) { HttpEntity entity = response.getEntity(); BufferedReader reader = new BufferedReader(new InputStreamReader(entity.getContent(), "UTF-8")); StringBuilder sb = new StringBuilder(); for (String temp = reader.readLine(); temp != null; temp = reader.readLine()) { sb.append(temp); } JSONObject object = new JSONObject(sb.toString().trim()); int errorCode = object.getInt("errcode"); if (errorCode == 0) { return true; } } } catch (ClientProtocolException e) { // TODO Auto-generated catch block
e.printStackTrace(); } catch (IOException e) { // TODO Auto-generated catch block
e.printStackTrace(); } catch (JSONException e) { // TODO Auto-generated catch block
e.printStackTrace(); } return false; }
返回說明
正確的Json返回結果:
{
"errcode":0,"errmsg":"ok" } 錯誤的Json返回示例: { "errcode":40003,"errmsg":"invalid openid" }
如果access_token有效,服務端將信息返回給客戶端,客戶端成功登錄。
如果access_token無效,服務端向微信開放平台發送刷新access_token的請求如下:
access_token是調用授權關系接口的調用憑證,由於access_token有效期(目前為2個小時)較短,當access_token超時后,可以使用refresh_token進行刷新,access_token刷新結果有兩種:
1.若access_token已超時,那么進行refresh_token會獲取一個新的access_token,新的超時時間;
2.若access_token未超時,那么進行refresh_token不會改變access_token,但超時時間會刷新,相當於續期access_token。
refresh_token擁有較長的有效期(30天),當refresh_token失效的后,需要用戶重新授權。
private void refreshAccessToken() { String uri = "https://api.weixin.qq.com/sns/oauth2/refresh_token?appid=" + APP_ID + "&grant_type=refresh_token&refresh_token=" + refreshToken; HttpClient client = new DefaultHttpClient(); HttpGet get = new HttpGet(URI.create(uri)); try { HttpResponse response = client.execute(get); if (response.getStatusLine().getStatusCode() == 200) { BufferedReader reader = new BufferedReader(new InputStreamReader(response.getEntity().getContent(), "UTF-8")); StringBuilder builder = new StringBuilder(); for (String temp = reader.readLine(); temp != null; temp = reader.readLine()) { builder.append(temp); } JSONObject object = new JSONObject(builder.toString().trim()); accessToken = object.getString("access_token"); refreshToken = object.getString("refresh_token"); openID = object.getString("openid"); expires_in = object.getLong("expires_in"); } } catch (ClientProtocolException e) { // TODO Auto-generated catch block e.printStackTrace(); } catch (IOException e) { // TODO Auto-generated catch block e.printStackTrace(); } catch (JSONException e) { // TODO Auto-generated catch block e.printStackTrace(); } }
返回說明
正確的返回:
{
"access_token":"ACCESS_TOKEN",
"expires_in":7200,
"refresh_token":"REFRESH_TOKEN",
"openid":"OPENID",
"scope":"SCOPE"
}
參數 說明 access_token 接口調用憑證 expires_in access_token接口調用憑證超時時間,單位(秒) refresh_token 用戶刷新access_token openid 授權用戶唯一標識 scope 用戶授權的作用域,使用逗號(,)分隔 錯誤返回樣例: { "errcode":40030,"errmsg":"invalid refresh_token" }
3.服務端獲取到新的access_token等信息,並返回給客戶端,客戶端成功登錄或者重新獲取授權。