微信登陸遵循協議Aouth2.0中的受權碼模式api
咱們來看一下Aouth2.0中的受權碼模式是怎麼定義的:服務器
受權碼模式(authorization code)是功能最完整、流程最嚴密的受權模式。它的特色就是經過客戶端的後臺服務器,與」服務提供商」的認證服務器進行互動。
它的步驟以下:微信
(A)用戶訪問客戶端,後者將前者導向認證服務器。app
(B)用戶選擇是否給予客戶端受權。ide
(C)假設用戶給予受權,認證服務器將用戶導向客戶端事先指定的」重定向URI」(redirection URI),同時附上一個受權碼。ui
(D)客戶端收到受權碼,附上早先的」重定向URI」,向認證服務器申請令牌。這一步是在客戶端的後臺的服務器上完成的,對用戶不可見。this
(E)認證服務器覈對了受權碼和重定向URI,確認無誤後,向客戶端發送訪問令牌(access token)和更新令牌(refresh token)url
1
2
3
4
5
6
7
|
{
// send oauth request
Final SendAuth.Req req =
new
SendAuth.Req();
req.scope =
"snsapi_userinfo"
;
req.state =
"wechat_sdk_demo_test"
;
api.sendReq(req);
}
|
用這段代碼向微信開放平臺請求受權碼code,可拉起微信並打開受權登陸頁(前提是你安裝了微信應用並已登陸,未登陸的會引導你先登陸),以下圖:spa
1.若是微信受權頁不顯示,請檢查你的APP簽名是否和你在騰訊開放平臺的APP簽名一致,不一致可修改騰訊開放平臺中的APP簽名,修改後重裝微信或清除微信數據後重試。3d
2.在你的包名相應目錄下新建一個wxapi目錄,並在該wxapi目錄下新增一個WXEntryActivity類,該類繼承自Activity(例如應用程序的包名爲net.sourceforge,則新的包名爲:net.sourceforge.wxapi),此處應注意包名不要弄錯,新增類的名字必須爲WXEntryActivity。
返回說明
用戶點擊受權後,微信客戶端會被拉起,跳轉至受權界面,用戶在該界面點擊容許或取消,SDK經過SendAuth的Resp返回數據給調用方。回調WXEntryActivity中的onResp(BaseResp resp)方法,以下:
1 @Override 2 public void onResp(BaseResp resp) { 3 int errorCode = resp.errCode; 4 switch (errorCode) { 5 case BaseResp.ErrCode.ERR_OK: 6 //用戶贊成 7 String code = ((SendAuth.Resp) resp).code; 8 break; 9 case BaseResp.ErrCode.ERR_AUTH_DENIED: 10 //用戶拒絕 11 break; 12 case BaseResp.ErrCode.ERR_USER_CANCEL: 13 //用戶取消 14 break; 15 default: 16 break; 17 } 18 ToastUtil.showMessageLong(this, resp.errStr); 19 }
客戶端收到受權碼後,向本身的服務器發起登陸請求,並附帶收到的受權碼。
服務端收到登陸請求,向微信開放平臺請求獲取access_token,微信開放平臺返回Json字符串:
獲取第一步的code後,請求如下連接獲取access_token:
1 private String getAccessToken(String code) { 2 String url = "https://api.weixin.qq.com/sns/oauth2/access_token?appid=APPID&secret=SECRET&code=CODE&grant_type=authorization_code"; 3 URI uri = URI.create(url); 4 HttpClient client = new DefaultHttpClient(); 5 HttpGet get = new HttpGet(uri); 6 7 HttpResponse response; 8 try { 9 response = client.execute(get); 10 if (response.getStatusLine().getStatusCode() == 200) { 11 HttpEntity entity = response.getEntity(); 12 13 BufferedReader reader = new BufferedReader(new InputStreamReader(entity.getContent(), "UTF-8")); 14 StringBuilder sb = new StringBuilder(); 15 16 for (String temp = reader.readLine(); temp != null; temp = reader.readLine()) { 17 sb.append(temp); 18 } 19 20 JSONObject object = new JSONObject(sb.toString().trim()); 21 accessToken = object.getString("access_token"); 22 openID = object.getString("openid"); 23 refreshToken = object.getString("refresh_token"); 24 expires_in = object.getLong("expires_in"); 25 return accessToken; 26 } 27 } catch (ClientProtocolException e) { 28 // TODO Auto-generated catch block 29 e.printStackTrace(); 30 } catch (IOException e) { 31 // TODO Auto-generated catch block 32 e.printStackTrace(); 33 } catch (IllegalStateException e) { 34 // TODO Auto-generated catch block 35 e.printStackTrace(); 36 } catch (JSONException e) { 37 // TODO Auto-generated catch block 38 e.printStackTrace(); 39 } 40 41 return null; 42 }
參數說明
參數 是否必須 說明 appid 是 應用惟一標識,在微信開放平臺提交應用審覈經過後得到 secret 是 應用密鑰AppSecret,在微信開放平臺提交應用審覈經過後得到 code 是 填寫第一步獲取的code參數 grant_type 是 填authorization_code回說明**
正確的返回:
1 { 2 "access_token":"ACCESS_TOKEN", 3 "expires_in":7200, 4 "refresh_token":"REFRESH_TOKEN", 5 "openid":"OPENID", 6 "scope":"SCOPE", 7 "unionid":"o6_bmasdasdsad6_2sgVt7hMZOPfL" 8 }
參數 說明 access_token 接口調用憑證 expires_in access_token 接口調用憑證超時時間,單位(秒) refresh_token 用戶刷新access_token openid 受權用戶惟一標識 scope 用戶受權的做用域,使用逗號(,)分隔 unionid 只有在用戶將公衆號綁定到微信開放平臺賬號後,纔會出現該字段。
服務端收到返回的access_token,將access_token,expires_in,access_token是否有效 等數據返回給客戶端,客戶端成功登陸
客戶端可利用已有的access_token獲取微信用戶信息
獲取access_token後,進行接口調用,有如下前提:
對於接口做用域(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,從而致使沒法獲取到須要用戶受權才容許得到的數據和基礎功能。
以獲取用戶信息爲例:
1 private void getUserInfo() { 2 if (isAccessTokenIsInvalid() && System.currentTimeMillis() < expires_in) { 3 String uri = "https://api.weixin.qq.com/sns/userinfo?access_token=" + accessToken + "&openid=" + openID; 4 HttpClient client = new DefaultHttpClient(); 5 HttpGet get = new HttpGet(URI.create(uri)); 6 try { 7 HttpResponse response = client.execute(get); 8 if (response.getStatusLine().getStatusCode() == 200) { 9 BufferedReader reader = new BufferedReader(new InputStreamReader(response.getEntity().getContent(), "UTF-8")); 10 StringBuilder builder = new StringBuilder(); 11 for (String temp = reader.readLine(); temp != null; temp = reader.readLine()) { 12 builder.append(temp); 13 } 14 JSONObject object = new JSONObject(builder.toString().trim()); 15 String nikeName = object.getString("nickname"); 16 } 17 } catch (ClientProtocolException e) { 18 // TODO Auto-generated catch block 19 e.printStackTrace(); 20 } catch (IOException e) { 21 // TODO Auto-generated catch block 22 e.printStackTrace(); 23 } catch (JSONException e) { 24 // TODO Auto-generated catch block 25 e.printStackTrace(); 26 } 27 } 28 }
假設用戶已經得到受權,則下次登陸時只須要驗證access_token是否有效,無效則從新獲取受權,有效則無需從新得到受權。
1.用戶向本身的服務器請求登陸,登陸方式爲微信登陸,附帶上次登陸返回的的access_token
2.服務器收到用戶的登陸請求,向微信開放平臺發送access_token是否有效的驗證請求以下:
1 private boolean isAccessTokenIsInvalid() { 2 String url = "https://api.weixin.qq.com/sns/auth?access_token=" + accessToken + "&openid=" + openID; 3 URI uri = URI.create(url); 4 HttpClient client = new DefaultHttpClient(); 5 HttpGet get = new HttpGet(uri); 6 HttpResponse response; 7 try { 8 response = client.execute(get); 9 if (response.getStatusLine().getStatusCode() == 200) { 10 HttpEntity entity = response.getEntity(); 11 12 BufferedReader reader = new BufferedReader(new InputStreamReader(entity.getContent(), "UTF-8")); 13 StringBuilder sb = new StringBuilder(); 14 15 for (String temp = reader.readLine(); temp != null; temp = reader.readLine()) { 16 sb.append(temp); 17 } 18 JSONObject object = new JSONObject(sb.toString().trim()); 19 int errorCode = object.getInt("errcode"); 20 if (errorCode == 0) { 21 return true; 22 } 23 } 24 } catch (ClientProtocolException e) { 25 // TODO Auto-generated catch block 26 e.printStackTrace(); 27 } catch (IOException e) { 28 // TODO Auto-generated catch block 29 e.printStackTrace(); 30 } catch (JSONException e) { 31 // TODO Auto-generated catch block 32 e.printStackTrace(); 33 } 34 return false; 35 }
返回說明
1 正確的Json返回結果: 2 { 3 "errcode":0,"errmsg":"ok" 4 } 5 錯誤的Json返回示例: 6 { 7 "errcode":40003,"errmsg":"invalid openid" 8 }
若是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失效的後,須要用戶從新受權。
1 private void refreshAccessToken() { 2 String uri = "https://api.weixin.qq.com/sns/oauth2/refresh_token?appid=" + ShareUtil.APP_ID + "&grant_type=refresh_token&refresh_token=" 3 + refreshToken; 4 HttpClient client = new DefaultHttpClient(); 5 HttpGet get = new HttpGet(URI.create(uri)); 6 try { 7 HttpResponse response = client.execute(get); 8 if (response.getStatusLine().getStatusCode() == 200) { 9 BufferedReader reader = new BufferedReader(new InputStreamReader(response.getEntity().getContent(), "UTF-8")); 10 StringBuilder builder = new StringBuilder(); 11 for (String temp = reader.readLine(); temp != null; temp = reader.readLine()) { 12 builder.append(temp); 13 } 14 JSONObject object = new JSONObject(builder.toString().trim()); 15 accessToken = object.getString("access_token"); 16 refreshToken = object.getString("refresh_token"); 17 openID = object.getString("openid"); 18 expires_in = object.getLong("expires_in"); 19 } 20 } catch (ClientProtocolException e) { 21 // TODO Auto-generated catch block 22 e.printStackTrace(); 23 } catch (IOException e) { 24 // TODO Auto-generated catch block 25 e.printStackTrace(); 26 } catch (JSONException e) { 27 // TODO Auto-generated catch block 28 e.printStackTrace(); 29 } 30 }
返回說明
1 正確的返回: 2 { 3 "access_token":"ACCESS_TOKEN", 4 "expires_in":7200, 5 "refresh_token":"REFRESH_TOKEN", 6 "openid":"OPENID", 7 "scope":"SCOPE" 8 } 9 參數 說明 10 access_token 接口調用憑證 11 expires_in access_token接口調用憑證超時時間,單位(秒) 12 refresh_token 用戶刷新access_token 13 openid 受權用戶惟一標識 14 scope 用戶受權的做用域,使用逗號(,)分隔 15 16 錯誤返回樣例: 17 { 18 "errcode":40030,"errmsg":"invalid refresh_token" 19 }
3.服務端獲取到新的access_token等信息,並返回給客戶端,客戶端成功登陸或者從新獲取受權。