本文引用了3位做者「精品惟居」、「 Yangfan2016」、「 MrYun」的部分文章內容,一併感謝。html
掃碼登陸這個功能,最先應該是微信的PC端開始搞,雖然有點反人類的功能(不掃碼也沒別的方式登陸),但不得不說仍是很酷的。前端
下面這張圖,不論是IM開發者仍是普通用戶,應該很熟悉:程序員
因而,搞IM產品的老闆和產品經理們,今後又多了一個要拋給程序員們的需求——「爲何微信有掃一掃登陸,而咱們的沒有?」。web
好吧,每次只要是微信有的功能,IM程序員們想甩鍋,難度就有點大了,必竟老闆們都都會想固然認爲,微信有的「我」的IM產品裏也得有。ajax
既然沒法迴避,那就只能老老實實搞懂技術原理,而後自已使勁擼吧。redis
本文將簡要的介紹掃碼登陸功能的技術實現邏輯,並實際結合淘寶、微信的掃碼登陸功能,學習和研究大廠主流應用的技術實現思路。json
首先介紹下什麼是掃碼登陸。如今大部分同窗手機上都裝有微信、qq和淘寶這一類的軟件。而這些app都有他們相對應的網頁端。爲了讓用戶在使用他們的網頁時登陸更加方便和安全,使用手機掃一掃就能夠登陸的服務,就顯的天然而然了。跨域
幾個主流大廠應用掃碼登陸時的界面效果以下:promise
有不少小夥伴可能會感到很神奇,網頁上只是顯示了個二維碼,它怎麼就知道是哪一個手機掃到了二維碼,而且進行登陸的呢?並且,登陸完成之後,還能直接把用戶信息顯示給用戶,真的是很神奇啊。瀏覽器
接下來就是對於這個服務的詳細實現。
首先用戶打開網站的登陸頁面的時候,向瀏覽器的服務器發送獲取登陸二維碼的請求。服務器收到請求後,隨機生成一個uuid,將這個id做爲key值存入redis服務器,同時設置一個過時時間,再過時後,用戶登陸二維碼須要進行刷新從新獲取。
同時,將這個key值和本公司的驗證字符串合在一塊兒,經過二維碼生成接口,生成一個二維碼的圖片(二維碼生成,網上有不少現成的接口和源碼,這裏再也不介紹)。而後,將二維碼圖片和uuid一塊兒返回給用戶瀏覽器。
瀏覽器拿到二維碼和uuid後,會每隔一秒向瀏覽器發送一次,登陸是否成功的請求。請求中攜帶有uuid做爲當前頁面的標識符。這裏有的同窗就會奇怪了,服務器只存了個uuid在redis中做爲key值,怎麼會有用戶的id信息呢?
這裏確實會有用戶的id信息,這個id信息是由手機服務器存入redis中的。具體請繼續閱讀「手機端與服務器的配合邏輯」。
話說,瀏覽器拿到二維碼後,將二維碼展現到網頁上,並給用戶一個提示:請掏出您的手機,打開掃一掃進行登陸。
用戶拿出手機掃描二維碼,就能夠獲得一個驗證信息和一個uuid(掃描二維碼獲取字符串的功能在網上一樣有不少demo,這裏就不詳細介紹了)。
因爲手機端已經進行過了登陸,在訪問手機端的服務器的時候,參數中都回攜帶一個用戶的token,手機端服務器能夠從中解析到用戶的userId(這裏從token中取值而不是手機端直接傳userid是爲了安全,直接傳userid可能會被截獲和修改,token是加密的,被修改的風險會小不少)。手機端將解析到的數據和用戶token一塊兒做爲參數,向服務器發送驗證登陸請求(這裏的服務器是手機服務器,手機端的服務器跟網頁端服務器不是同一臺服務器)。
服務器收到請求後,首先對比參數中的驗證信息,肯定是否爲用戶登陸請求接口。若是是,返回一個確認信息給手機端。
手機端收到返回後,將登陸確認框顯示給用戶(防止用戶誤操做,同時使登陸更加人性化)。用戶確認是進行的登陸操做後,手機再次發送請求。服務器拿到uuId和userId後,將用戶的userid做爲value值存入redis中以uuid做爲key的鍵值對中。
而後,瀏覽器再次發送請求的時候,瀏覽器端的服務器就能夠獲得一個用戶Id,並調用登陸的方法,聲成一個瀏覽器端的token,再瀏覽器再次發送請求的時候,將用戶信息返回給瀏覽器,登陸成功。這裏存儲用戶id而不是直接存儲用戶信息是由於,手機端的用戶信息,不必定是和瀏覽器端的用戶信息徹底一致。
本節咱們以淘寶的掃碼登陸爲例,來實際研究分析一下淘寶的掃碼登陸實現邏輯。
登陸界面 https://login.taobao.com/member/login.jhtml 傳回來的參數爲:
而後請求(GET)報文是這樣的:
https://qrlogin.taobao.com/qrcodelogin/qrcodeLoginCheck.do?lgToken=2c3b4d53ef0513787bf4ce711ea5ba53&defaulturl=&_ksTS=1540106757739_2804&callback=jsonp2805
關鍵的就是lgToken,是網頁的惟一ID,當打開了二維碼登陸的時候,網頁在輪詢(應該是長輪詢long polling)調用接口去請求服務器。
若是沒有掃碼,返回的爲:
若是掃了的話則會返回:
{
"code": "10001",
"message": "mobile scan QRCode success",
"success": true
}
長時間沒有掃碼的話,網頁端會中止輪詢,二維碼失效!
當手機端確認登陸後,接口返回的是:
{ "code": "10006", "success": true, "url": "https://login.taobao.com/member/loginByIm.do?uid=cntaobaoxxx&token=ff82fc0d1d395a33d3b38ec5a4981336&time=1530179143250&asker=qrcodelogin&ask_version=1.0.0&defaulturl=https://www.taobao.com&webpas=0b7aed2d43f01825183e4a49c6cae47d1479929926"}
表示登陸成功,固然手機端與服務端在點擊"確認登陸"之間的交互可能就是這樣:網頁端生成的lgToken去請求服務端,服務端記住了這個lgToken並認爲登陸了,當網頁端再次輪詢請求接口時,就返回真正的登陸態Token,網頁端此時就能夠憑着這個Token來登陸了。
詳細的技術邏輯以下圖所示:
微信的網頁版訪問地址是:https://wx.qq.com/,有興趣也能夠自行深刻研究。
// 獲取uuid
getUUID: function() {
vare = t.defer();
returnwindow.QRLogin = {},
$.ajax({
url: i.API_jsLogin,
dataType: "script"
}).done(function() {
200 == window.QRLogin.code ? e.resolve(window.QRLogin.uuid) : e.reject(window.QRLogin.code)
}).fail(function() {
e.reject()
}),
e.promise
}
// 查看掃碼狀態
checkLogin: function(e, a) {
varn = t.defer()
, a = a || 0;
returnwindow.code = 0,
window.checkLoginPromise = $.ajax({
url: i.API_login + "?loginicon=true&uuid="+ e + "&tip="+ a + "&r="+ ~newDate,
dataType: "script",
timeout: 35e3
}).done(function() {
newRegExp("/"+ location.host + "/");
if(window.redirect_uri && window.redirect_uri.indexOf("/"+ location.host + "/") < 0)
returnvoid (location.href = window.redirect_uri);
vare = {
code: window.code,
redirect_uri: window.redirect_uri,
userAvatar: window.userAvatar
};
n.resolve(e)
}).fail(function() {
n.reject()
}),
n.promise
}
* 408 掃碼超時:若是手機沒有掃碼或沒有受權登陸,服務器會阻塞約25s,而後返回狀態碼 408 -> 前端繼續輪詢
* 400 二維碼失效:大約5分鐘的時間內不掃碼,二維碼失效
* 201 已掃碼:若是手機已經掃碼,服務器當即返回狀態碼和用戶的基本信息 (window.code=201,window.code.userAvator="..."),-> 前端繼續輪詢
* 200 已受權:若是手機點擊了確認登陸,服務器返回200及token -> 前端中止輪詢, 獲取到token,重定向到目標頁
具體的代碼示例以下:
// 根據服務器返回的掃碼狀態,進行相應的操做
functiono(c) {
switch(c.code) {
case200:
t.newLoginPage(c.redirect_uri).then(function(t) {
varo = t.match(/<ret>(.*)<\/ret>/)
, r = t.match(/<script>(.*)<\/script>/)
, c = t.match(/<skey>(.*)<\/skey>/)
, s = t.match(/<wxsid>(.*)<\/wxsid>/)
, l = t.match(/<wxuin>(.*)<\/wxuin>/)
, d = t.match(/<pass_ticket>(.*)<\/pass_ticket>/)
, f = t.match(/<message>(.*)<\/message>/)
, u = t.match(/<redirecturl>(.*)<\/redirecturl>/);
returnu ? void (window.location.href = u[1]) : o && "0"!= o[1] ? (alert(f && f[1] || "登陸失敗"),
i.report(i.AUTH_FAIL_COUNT, 1),
void location.reload()) : (e.$emit("newLoginPage", {
Ret: o && o[1],
SKey: c && c[1],
Sid: s && s[1],
Uin: l && l[1],
Passticket: d && d[1],
Code: r
}),
void (a.getCookie("webwx_data_ticket") || n.report(n.ReportType.cookieError, {
text: "webwx_data_ticket 票據丟失",
cookie: document.cookie
})))
});
break;
case201:
e.isScan = !0,
n.report(n.ReportType.timing, {
timing: {
scan: Date.now()
}
}),
t.checkLogin(e.uuid).then(o, function(t) {
!t && window.checkLoginPromise && (e.isBrokenNetwork = !0)
});
break;
case408:
t.checkLogin(e.uuid).then(o, function(t) {
!t && window.checkLoginPromise && (e.isBrokenNetwork = !0)
});
break;
case400:
case500:
case0:
vars = a.getCookie("refreshTimes") || 0;
s < 5 ? (s++,
a.setCookie("refreshTimes", s, .5),
document.location.reload()) : e.isNeedRefresh = !0;
break;
case202:
e.isScan = !1,
e.isAssociationLogin = !1,
a.setCookie("login_frequency", 0, 2),
window.checkLoginPromise && (window.checkLoginPromise.abort(),
window.checkLoginPromise = null),
r()
}
e.code = c.code,
e.userAvatar = c.userAvatar,
a.log("get code", c.code)
}
微信網頁端掃碼登陸時,輪詢的數據返回採用的是JSONP的形式,這是爲了解決跨域問題。如對JSONP不瞭解的,能夠閱讀《詳解Web端通訊方式的演進:從Ajax、JSONP 到 SSE、Websocket》一文的「3、JSONP」這一節。
微信網頁端掃碼登陸時,輪詢採用了後臺根據掃碼狀況阻塞前臺請求,優化輪詢及減小前端的無效輪詢。這種技術,請詳見《新手入門貼:史上最全Web端即時通信技術原理詳解》一文中的「解決方案3.2:長輪詢(long-polling)」這一節,
掃碼登陸這個功能,如今已經不僅出現有IM應用裏,各類帶有移動端的線上網站也都有了這個功能,因此本文中介紹的技術原理並不侷限於只用於實現IM應用中的掃碼登陸。
另外,爲了方便抓取真實的數據進行分析研究,本文中的PC端案例分析是針對的是網頁端,但實際上若是你的PC端是富客戶端(也就是.exe、.dmg這樣的安裝版),原理也是同樣的,並且還不須要考慮瀏覽器裏的跨域問題等。
閱讀本文時,可能涉及到傳統的Web端即時通信技術(爲了掃碼登陸的實時性),好比長輪詢等,若是您對這些技術還不太瞭解的話,能夠系統學習一下即時通信網整理的有關Web端即時通信方面的資料。好比從這兩篇文章開始:《新手入門貼:詳解Web端即時通信技術的原理》、《Web端即時通信技術盤點:短輪詢、Comet、Websocket、SSE》。(本文同步發佈於:http://www.52im.net/thread-2892-1-1.html)