微信小程序登錄的前端設(shè)計(jì)與實(shí)現(xiàn)

歡迎來(lái)我的博客閱讀:「微信小程序登錄的前端設(shè)計(jì)與實(shí)現(xiàn)」

一. 前言

對(duì)于登錄/注冊(cè)的設(shè)計(jì)如此精雕細(xì)琢的目的,當(dāng)然是想讓這個(gè)作為應(yīng)用的基礎(chǔ)能力,有足夠的健壯性,避免出現(xiàn)全站性的阻塞。

同時(shí)要充分考慮如何解耦和封裝,在開(kāi)展新的小程序的時(shí)候,能更快的去復(fù)用能力,避免重復(fù)采坑。

登錄注冊(cè)這模塊,就像個(gè)冰山,我們以為它就是「輸入賬號(hào)密碼,就完成登錄了」,但實(shí)際下面還有各種需要考慮的問(wèn)題。

image

在此,跟在座的各位分享一下,最近做完一個(gè)小程序登錄/注冊(cè)模塊之后,沉淀下來(lái)的一些設(shè)計(jì)經(jīng)驗(yàn)和想法。

二. 業(yè)務(wù)場(chǎng)景

在用戶瀏覽小程序的過(guò)程中,由業(yè)務(wù)需要,往往需要獲取用戶的一些基本信息,常見(jiàn)的有:

  1. 微信昵稱
  2. 微信手機(jī)號(hào)

而不同的產(chǎn)品,對(duì)于用戶的信息要求不盡相同,也會(huì)有不一樣的授權(quán)流程。

第一種,常見(jiàn)于電商系統(tǒng)中,用戶購(gòu)買商品的時(shí)候,為了識(shí)別用戶多平臺(tái)的賬號(hào),往往用手機(jī)號(hào)去做一個(gè)聯(lián)系,這時(shí)候需要用戶去授權(quán)手機(jī)號(hào)。

授權(quán)手機(jī)號(hào)

第二種,為了讓用戶信息得到基本的初始化,往往需要更進(jìn)一步獲取用戶信息:如微信昵稱,unionId 等,就需要詢問(wèn)用戶授權(quán)。

授權(quán)用戶信息

第三種,囊括第一種,第二種。

完整授權(quán)流程

三. 概念

秉著沉淀一套通用的小程序登錄方案和服務(wù)為目標(biāo),我們?nèi)シ治鲆幌聵I(yè)務(wù),得出變量。

在做技術(shù)設(shè)計(jì)之前,講點(diǎn)必要的廢話,對(duì)一些概念進(jìn)行基本調(diào)頻。

2.1 關(guān)于「登錄」

登錄在英文中是 「login」,對(duì)應(yīng)的還有 「logout」。而登錄之前,你需要擁有一個(gè)賬號(hào),就要 「register」(or sign up)。

話說(shuō)一開(kāi)始的產(chǎn)品是沒(méi)有登錄/注冊(cè)功能的,用的人多了就慢慢有了。出于產(chǎn)品本身的需求,需要對(duì)「用戶」進(jìn)行身份識(shí)別。

在現(xiàn)實(shí)社會(huì)中,我們每個(gè)人都有一個(gè)身份ID:身份證。當(dāng)我到了16歲的時(shí)候,第一次去公安局領(lǐng)身份證的時(shí)候,就完成了一次「注冊(cè)」行為。然后我去網(wǎng)吧上網(wǎng),身份證刷一下,完成了一次「登錄」行為。

那么對(duì)于虛擬世界的互聯(lián)網(wǎng)來(lái)說(shuō),這個(gè)身份證明就是「賬號(hào)+密碼」。

常見(jiàn)的登錄/注冊(cè)方式有:

  1. 賬號(hào)密碼注冊(cè)

    在互聯(lián)網(wǎng)的早期,個(gè)人郵箱和手機(jī)覆蓋度小。所以,就需要用戶自己想一個(gè)賬號(hào)名,我們注冊(cè)個(gè)QQ號(hào),就是這種形式。

    from 汽車之家
  2. 郵箱地址注冊(cè)

    千禧年之后,PC互聯(lián)網(wǎng)時(shí)代快速普及,我們都創(chuàng)建了屬于自己的個(gè)人郵箱。加上QQ也自帶郵箱賬號(hào)。由于郵箱具有個(gè)人私密性,且能夠進(jìn)行信息的溝通,因此,大部分網(wǎng)站開(kāi)始采用郵箱賬號(hào)作為用戶名來(lái)進(jìn)行注冊(cè),并且會(huì)在注冊(cè)的過(guò)程中要求登錄到相應(yīng)郵箱內(nèi)查收激活郵件,驗(yàn)證我們對(duì)該注冊(cè)郵箱的所有權(quán)。

    from 支付寶
  3. 手機(jī)號(hào)碼注冊(cè)

    在互聯(lián)網(wǎng)普及之后,智能手機(jī)與移動(dòng)互聯(lián)網(wǎng)發(fā)展迅猛。手機(jī)也成為每個(gè)人必不可少的移動(dòng)設(shè)備,同時(shí)移動(dòng)互聯(lián)網(wǎng)也已經(jīng)深深融入每個(gè)人的現(xiàn)代生活當(dāng)中。所以,相較于郵箱,目前手機(jī)號(hào)碼與個(gè)人的聯(lián)系更加緊密,而且越來(lái)越多的移動(dòng)應(yīng)用出現(xiàn),采用手機(jī)號(hào)碼作為用戶名的注冊(cè)方式也得到了廣泛的使用。

    from 知乎

到了 2020 年,微信用戶規(guī)模達(dá) 12 億。那么,微信賬號(hào),起碼在中國(guó),已成為新一代互聯(lián)網(wǎng)世界的「身份標(biāo)識(shí)」。

而對(duì)微信小程序而言,天然就能知道當(dāng)前用戶的微信賬號(hào)ID。微信允許小程序應(yīng)用,能在用戶無(wú)感知的情況下,悄無(wú)聲息的「登錄」到我們的小程序應(yīng)用中去,這個(gè)就是我們經(jīng)常稱之為的「靜默登錄」。

其實(shí)微信小程序的登錄,跟傳統(tǒng) Web 應(yīng)用的「單點(diǎn)登錄」本質(zhì)是一樣的概念。

  1. 單點(diǎn)登錄:在 A 站登錄了,C 站和 B 站能實(shí)現(xiàn)快速的「靜默登錄」。
  2. 微信小程序登錄:在微信中,登錄了微信賬號(hào),那么在整個(gè)小程序生態(tài)中,都可以實(shí)現(xiàn)「靜默登錄」。

由于 Http 本來(lái)是無(wú)狀態(tài)的,業(yè)界基本對(duì)于登錄態(tài)的一般做法:

  1. cookie-session:常用于瀏覽器應(yīng)用中
  2. access token:常用于移動(dòng)端等非瀏覽器應(yīng)用

在微信小程序來(lái)說(shuō),對(duì)于「JS邏輯層」并不是一個(gè)瀏覽器環(huán)境,自然沒(méi)有 Cookie,那么通常會(huì)使用 access token 的方式。

2.2 關(guān)于「授權(quán)」

對(duì)于需要更進(jìn)一步獲取用的用戶昵稱、用戶手機(jī)號(hào)等信息的產(chǎn)品來(lái)說(shuō)。微信出于用戶隱私的考慮,需要用戶主動(dòng)同意授權(quán)。小程序應(yīng)用才能獲取到這部分信息,這就有了目前流行的小程序「授權(quán)用戶信息」、「授權(quán)手機(jī)號(hào)」的交互了。

出于不同的用戶信息敏感度不同的考慮,微信小程序?qū)τ诓煌挠脩粜畔⑻峁甘跈?quán)」的方式不盡相同:

  1. 調(diào)用具體 API 方式,彈窗授權(quán)。
    1. 例如調(diào)用 wx.getLocation() 的時(shí)候,如果用戶未授權(quán),則會(huì)彈出地址授權(quán)界面。
    2. 如果拒絕了,就不會(huì)再次彈窗,wx.getLocation()直接返回失敗。
  2. <button open-type="xxx" /> 方式。
    1. 僅支持:用戶敏感信息,用戶手機(jī)號(hào),需要配合后端進(jìn)行對(duì)稱加解密,方能拿到數(shù)據(jù)。
    2. 用戶已拒絕,再次點(diǎn)擊按鈕,仍然會(huì)彈窗。
  3. 通過(guò) wx.authorize(),提前詢問(wèn)授權(quán),之后需要獲取相關(guān)信息的時(shí)候不用再次彈出授權(quán)。

四. 詳細(xì)設(shè)計(jì)

梳理清楚了概念之后,我們模塊的劃分上,可以拆分為兩大塊:

  1. 登錄:負(fù)責(zé)與服務(wù)端創(chuàng)建起一個(gè)會(huì)話,這個(gè)會(huì)話實(shí)現(xiàn)靜默登錄以及相關(guān)的容錯(cuò)處理等,模塊命名為:Session
  2. 授權(quán):負(fù)責(zé)與用戶交互,獲取與更新信息,以及權(quán)限的控制處理等,模塊命名為:Auth

3.1 登錄的實(shí)現(xiàn)

3.1.1 靜默登錄

微信登錄

微信官方提供的登錄方案,總結(jié)為三步:

  1. 前端通過(guò) wx.login() 獲取一次性加密憑證 code,交給后端。
  2. 后端把這個(gè) code 傳輸給微信服務(wù)器端,換取用戶唯一標(biāo)識(shí) openId 和授權(quán)憑證 session_key。(用于后續(xù)服務(wù)器端和微信服務(wù)器的特殊 API 調(diào)用,具體看:微信官方文檔-服務(wù)端獲取開(kāi)放數(shù)據(jù))。
  3. 后端把從微信服務(wù)器獲取到的用戶憑證與自行生成的登錄態(tài)憑證(token),傳輸給前端。前端保存起來(lái),下次請(qǐng)求的時(shí)候帶給后端,就能識(shí)別哪個(gè)用戶。

如果只是實(shí)現(xiàn)這個(gè)流程的話,挺簡(jiǎn)單的。

但要實(shí)現(xiàn)一個(gè)健壯的登錄過(guò)程,還需要注意更多的邊界情況:

  1. 收攏 wx.login() 的調(diào)用

    由于 wx.login() 會(huì)產(chǎn)生不可預(yù)測(cè)的副作用,例如會(huì)可能導(dǎo)致session_key失效,從而導(dǎo)致后續(xù)的授權(quán)解密場(chǎng)景中的失敗。我們這里可以提供一個(gè)像 session.login() 的方法,掌握 wx.login() 控制權(quán),對(duì)其做一系列的封裝和容錯(cuò)處理。

  2. 調(diào)用的時(shí)機(jī)

    通常我們會(huì)在應(yīng)用啟動(dòng)的時(shí)候( app.onLaunch() ),去發(fā)起靜默登錄。但這里會(huì)由小程序生命周期設(shè)計(jì)問(wèn)題而導(dǎo)致的一個(gè)異步問(wèn)題:加載頁(yè)面的時(shí)候,去調(diào)用一個(gè)需要登錄態(tài)的后端 API 的時(shí)候,前面異步的靜態(tài)登錄過(guò)程有可能還沒(méi)有完成,從而導(dǎo)致請(qǐng)求失敗。

    當(dāng)然也可以在第一個(gè)需要登錄態(tài)的接口調(diào)用的時(shí)候以異步阻塞的方式發(fā)起登錄調(diào)用,這個(gè)需要結(jié)合良好設(shè)計(jì)的接口層。

    以上講到的兩種場(chǎng)景的詳細(xì)設(shè)計(jì)思路下文會(huì)講到。

  3. 并發(fā)調(diào)用的問(wèn)題

    在業(yè)務(wù)場(chǎng)景中,難免會(huì)出現(xiàn)多處代碼需要觸發(fā)登錄,如果遇到極端情況,這多處代碼同時(shí)間發(fā)起調(diào)用。那就會(huì)造成短時(shí)間多次發(fā)起登錄過(guò)程,盡管之前的請(qǐng)求還沒(méi)有完成。針對(duì)這種情況,我們可以以第一個(gè)調(diào)用為阻塞,后續(xù)調(diào)用等待結(jié)果,就像精子和卵子結(jié)合的過(guò)程。

  4. 未過(guò)期調(diào)用的問(wèn)題

    如果我們的登錄態(tài)未過(guò)期,完全可以正常使用的,默認(rèn)情況就不需再去發(fā)起登錄過(guò)程了。這時(shí)候我們可以默認(rèn)情況下先去檢查登錄態(tài)是否可用,不能用,我們?cè)侔l(fā)起請(qǐng)求。然后還可以提供一個(gè)類似 session.login({ force: true })的參數(shù)去強(qiáng)行發(fā)起登錄。

3.1.2 靜默登錄異步狀態(tài)的處理

1. 應(yīng)用啟動(dòng)的時(shí)候調(diào)用

因?yàn)榇蟛糠智闆r都需要依賴登錄態(tài),我們會(huì)很自然而然的想到把這個(gè)調(diào)用的時(shí)機(jī)放到應(yīng)用啟動(dòng)的時(shí)候( app.onLaunch() )來(lái)調(diào)用。

但是由于原生的小程序啟動(dòng)流程中, App,Page,Component 的生命周期鉤子函數(shù),都不支持異步阻塞。

那么我們很容易會(huì)遇到 app.onLaunch 發(fā)起的「登錄過(guò)程」在 page.onLoad 的時(shí)候還沒(méi)有完成,我們就無(wú)法正確去做一些依賴登錄態(tài)的操作。

針對(duì)這種情況,我們?cè)O(shè)計(jì)了一個(gè)狀態(tài)機(jī)的工具:status

狀態(tài)機(jī)

基于狀態(tài)機(jī),我們就可以編寫這樣的代碼:

import { Status } from '@beautywe/plugin-status';

// on app.js
App({
    status: {
       login: new Status('login');
    },

    onLaunch() {
        session
            // 發(fā)起靜默登錄調(diào)用
            .login()

            // 把狀態(tài)機(jī)設(shè)置為 success
            .then(() => this.status.login.success())
      
            // 把狀態(tài)機(jī)設(shè)置為 fail
            .catch(() => this.status.login.fail());
    },
});


// on page.js
Page({
    onLoad() {
      const loginStatus = getApp().status.login;
      
      // must 里面會(huì)進(jìn)行狀態(tài)的判斷,例如登錄中就等待,登錄成功就直接返回,登錄失敗拋出等。
      loginStatus().status.login.must(() => {
        // 進(jìn)行一些需要登錄態(tài)的操作...
      });
    },
});

2. 在「第一個(gè)需要登錄態(tài)接口」被調(diào)用的時(shí)候去發(fā)起登錄

更進(jìn)一步,我們會(huì)發(fā)現(xiàn),需要登錄態(tài)的更深層次的節(jié)點(diǎn)是在發(fā)起的「需要登錄態(tài)的后端 API 」的時(shí)候。

那么我們可以在調(diào)用「需要登錄態(tài)的后端 API」的時(shí)候再去發(fā)起「靜默登錄」,對(duì)于并發(fā)的場(chǎng)景,讓其他請(qǐng)求等待一下就好了。

fly.js 作為 wx.request() 封裝的「網(wǎng)絡(luò)請(qǐng)求層」,做一個(gè)簡(jiǎn)單的例子:

// 發(fā)起請(qǐng)求,并表明該請(qǐng)求是需要登錄態(tài)的
fly.post('https://...', params, { needLogin: true });

// 在 fly 攔截器中處理邏輯
fly.interceptors.request.use(async (req)=>{

  // 在請(qǐng)求需要登錄態(tài)的時(shí)候
  if (req.needLogin !== false) {

    // ensureLogin 核心邏輯是:判斷是否已登錄,如否發(fā)起登錄調(diào)用,如果正在登錄,則進(jìn)入隊(duì)列等待回調(diào)。
    await session.ensureLogin();
    
    // 登錄成功后,獲取 token,通過(guò) headers 傳遞給后端。
    const token = await session.getToken();
    Object.assign(req.headers, { [AUTH_KEY_NAME]: token });
  }
  
  return req;
});

3.1.3 自定義登錄態(tài)過(guò)期的容錯(cuò)處理

當(dāng)自定義登錄態(tài)過(guò)期的時(shí)候,后端需要返回特定的狀態(tài)碼,例如:AUTH_EXPIREDAUTH_INVALID 等。

前端可以在「網(wǎng)絡(luò)請(qǐng)求層」去監(jiān)聽(tīng)所有請(qǐng)求的這個(gè)狀態(tài)碼,然后發(fā)起刷新登錄態(tài),再去重放失敗的請(qǐng)求:

// 添加響應(yīng)攔截器
fly.interceptors.response.use(
    (response) => {
      const code = res.data;
        
      // 登錄態(tài)過(guò)期或失效
      if ( ['AUTH_EXPIRED', 'AUTH_INVALID'].includes(code) ) {
      
        // 刷新登錄態(tài)
        await session.refreshLogin();
        
        // 然后重新發(fā)起請(qǐng)求
        return fly.request(request);
      }
    }
)

那么如果并發(fā)的發(fā)起多個(gè)請(qǐng)求,都返回了登錄態(tài)失效的狀態(tài)碼,上述代碼就會(huì)被執(zhí)行多次。

我們需要對(duì) session.refreshLogin() 做一些特殊的容錯(cuò)處理:

  1. 請(qǐng)求鎖:同一時(shí)間,只允許一個(gè)正在過(guò)程中的網(wǎng)絡(luò)請(qǐng)求。
  2. 等待隊(duì)列:請(qǐng)求被鎖定之后,調(diào)用該方法的所有調(diào)用,都推入一個(gè)隊(duì)列中,等待網(wǎng)絡(luò)請(qǐng)求完成之后共用返回結(jié)果。
  3. 熔斷機(jī)制:如果短時(shí)間內(nèi)多次調(diào)用,則停止響應(yīng)一段時(shí)間,類似于 TCP 慢啟動(dòng)。

示例代碼:

class Session {
  // ....
  
  // 刷新登錄保險(xiǎn)絲,最多重復(fù) 3 次,然后熔斷,5s 后恢復(fù)
  refreshLoginFuseLine = REFRESH_LOGIN_FUSELINE_DEFAULT;
  refreshLoginFuseLocked = false;
  refreshLoginFuseRestoreTime = 5000;

  // 熔斷控制
  refreshLoginFuse(): Promise<void> {
    if (this.refreshLoginFuseLocked) {
      return Promise.reject('刷新登錄-保險(xiǎn)絲已熔斷,請(qǐng)稍后');
    }
    if (this.refreshLoginFuseLine > 0) {
      this.refreshLoginFuseLine = this.refreshLoginFuseLine - 1;
      return Promise.resolve();
    } else {
      this.refreshLoginFuseLocked = true;
      setTimeout(() => {
        this.refreshLoginFuseLocked = false;
        this.refreshLoginFuseLine = REFRESH_LOGIN_FUSELINE_DEFAULT;
        logger.info('刷新登錄-保險(xiǎn)絲熔斷解除');
      }, this.refreshLoginFuseRestoreTime);
      return Promise.reject('刷新登錄-保險(xiǎn)絲熔斷!!');
    }
  }

  // 并發(fā)回調(diào)隊(duì)列
  refreshLoginQueueMaxLength = 100;
  refreshLoginQueue: any[] = [];
  refreshLoginLocked = false;

  // 刷新登錄態(tài)
  refreshLogin(): Promise<void> {
    return Promise.resolve()
    
      // 回調(diào)隊(duì)列 + 熔斷 控制
      .then(() => this.refreshLoginFuse())
      .then(() => {
        if (this.refreshLoginLocked) {
          const maxLength = this.refreshLoginQueueMaxLength;
          if (this.refreshLoginQueue.length >= maxLength) {
            return Promise.reject(`refreshLoginQueue 超出容量:${maxLength}`);
          }
          return new Promise((resolve, reject) => {
            this.refreshLoginQueue.push([resolve, reject]);
          });
        }
        this.refreshLoginLocked = true;
      })

      // 通過(guò)前置控制之后,發(fā)起登錄過(guò)程
      .then(() => {
        this.clearSession();
        wx.showLoading({ title: '刷新登錄態(tài)中', mask: true });
        return this.login()
          .then(() => {
            wx.hideLoading();
            wx.showToast({ icon: 'none', title: '登錄成功' });
            this.refreshLoginQueue.forEach(([resolve]) => resolve());
            this.refreshLoginLocked = false;
          })
          .catch(err => {
            wx.hideLoading();
            wx.showToast({ icon: 'none', title: '登錄失敗' });
            this.refreshLoginQueue.forEach(([, reject]) => reject());
            this.refreshLoginLocked = false;
            throw err;
          });
      });

  // ...
}

3.1.4 微信 session_key 過(guò)期的容錯(cuò)處理

我們從上面的「靜默登錄」之后,微信服務(wù)器端會(huì)下發(fā)一個(gè) session_key 給后端,而這個(gè)會(huì)在需要獲取微信開(kāi)放數(shù)據(jù)的時(shí)候會(huì)用到。

微信開(kāi)放數(shù)據(jù)

session_key 是有時(shí)效性的,以下摘自微信官方描述:

會(huì)話密鑰 session_key 有效性

開(kāi)發(fā)者如果遇到因?yàn)?session_key 不正確而校驗(yàn)簽名失敗或解密失敗,請(qǐng)關(guān)注下面幾個(gè)與 session_key 有關(guān)的注意事項(xiàng)。

  1. wx.login 調(diào)用時(shí),用戶的 session_key 可能會(huì)被更新而致使舊 session_key 失效(刷新機(jī)制存在最短周期,如果同一個(gè)用戶短時(shí)間內(nèi)多次調(diào)用 wx.login,并非每次調(diào)用都導(dǎo)致 session_key 刷新)。開(kāi)發(fā)者應(yīng)該在明確需要重新登錄時(shí)才調(diào)用 wx.login,及時(shí)通過(guò) auth.code2Session 接口更新服務(wù)器存儲(chǔ)的 session_key。
  2. 微信不會(huì)把 session_key 的有效期告知開(kāi)發(fā)者。我們會(huì)根據(jù)用戶使用小程序的行為對(duì) session_key 進(jìn)行續(xù)期。用戶越頻繁使用小程序,session_key 有效期越長(zhǎng)。
  3. 開(kāi)發(fā)者在 session_key 失效時(shí),可以通過(guò)重新執(zhí)行登錄流程獲取有效的 session_key。使用接口 wx.checkSession可以校驗(yàn) session_key 是否有效,從而避免小程序反復(fù)執(zhí)行登錄流程。
  4. 當(dāng)開(kāi)發(fā)者在實(shí)現(xiàn)自定義登錄態(tài)時(shí),可以考慮以 session_key 有效期作為自身登錄態(tài)有效期,也可以實(shí)現(xiàn)自定義的時(shí)效性策略。

翻譯成簡(jiǎn)單的兩句話:

  1. session_key 時(shí)效性由微信控制,開(kāi)發(fā)者不可預(yù)測(cè)。
  2. wx.login 可能會(huì)導(dǎo)致 session_key 過(guò)期,可以在使用接口之前用wx.checkSession 檢查一下。

而對(duì)于第二點(diǎn),我們通過(guò)實(shí)驗(yàn)發(fā)現(xiàn),偶發(fā)性的在 session_key 已過(guò)期的情況下,wx.checkSession 會(huì)概率性返回 true

社區(qū)也有相關(guān)的反饋未得到解決:

所以結(jié)論是:wx.checkSession可靠性是不達(dá) 100% 的。

基于以上,我們需要對(duì) session_key 的過(guò)期做一些容錯(cuò)處理:

  1. 發(fā)起需要使用 session_key 的請(qǐng)求前,做一次 wx.checkSession 操作,如果失敗了刷新登錄態(tài)。
  2. 后端使用 session_key 解密開(kāi)放數(shù)據(jù)失敗之后,返回特定錯(cuò)誤碼(如:DECRYPT_WX_OPEN_DATA_FAIL),前端刷新登錄態(tài)。

示例代碼:

// 定義檢查 session_key 有效性的操作
const ensureSessionKey = async () => {
  const hasSession = await new Promise(resolve => {
    wx.checkSession({
      success: () => resolve(true),
      fail: () => resolve(false),
    });
  });
  
  if (!hasSession) {
    logger.info('sessionKey 已過(guò)期,刷新登錄態(tài)');

    // 接上面提到的刷新登錄邏輯
    return session.refreshLogin();
  }

  return Promise.resolve();
}

// 在發(fā)起請(qǐng)求的時(shí)候,先做一次確保 session_key 最新的操作(以 fly.js 作為網(wǎng)絡(luò)請(qǐng)求層為例)
const updatePhone = async (params) => {
  await ensureSessionKey();
  const res = await fly.post('https://xxx', params);
}

// 添加響應(yīng)攔截器, 監(jiān)聽(tīng)網(wǎng)絡(luò)請(qǐng)求返回
fly.interceptors.response.use(
    (response) => {
      const code = res.data;
        
      // 登錄態(tài)過(guò)期或失效
      if ( ['DECRYPT_WX_OPEN_DATA_FAIL'].includes(code)) {

        // 刷新登錄態(tài)
        await session.refreshLogin();
        
        // 由于加密場(chǎng)景的加密數(shù)據(jù)由用戶點(diǎn)擊產(chǎn)生,session_key 可能已經(jīng)更改,需要用戶重新點(diǎn)擊一遍。
        wx.showToast({ title: '網(wǎng)絡(luò)出小差了,請(qǐng)稍后重試', icon: 'none' });
      }
    }
)

3.2 授權(quán)的實(shí)現(xiàn)

3.2.1 組件拆分與設(shè)計(jì)

在用戶信息和手機(jī)號(hào)獲取的方式上,微信是以 <button open-type='xxx' /> 的方式,讓用戶主動(dòng)點(diǎn)擊授權(quán)的。

那么為了讓代碼更解耦,我們?cè)O(shè)計(jì)這樣三個(gè)組件:

  1. <user-contaienr getUserInfo="onUserInfoAuth">: 包裝點(diǎn)擊交互,通過(guò) <slot> 支持點(diǎn)擊區(qū)域的自定義UI。
  2. <phone-container getPhonenNmber="onPhoneAuth"> : 與 <user-container> 同理。
  3. <auth-flow>: 根據(jù)業(yè)務(wù)需要,組合 <user-container>、<phone-container> 組合來(lái)定義不同的授權(quán)流程。

以開(kāi)頭的業(yè)務(wù)場(chǎng)景的流程為例,它有這樣的要求:

  1. 有多個(gè)步驟。
  2. 如果中途斷掉了,可以從中間接上。
  3. 有些場(chǎng)景中,只要求達(dá)到「用戶信息授權(quán)」,而不需要完成「用戶手機(jī)號(hào)」。
完整授權(quán)流程

那么授權(quán)的階段可以分三層:

// 用戶登錄的階段
export enum AuthStep {
  // 階段一:只有登錄態(tài),沒(méi)有用戶信息,沒(méi)有手機(jī)號(hào)
  ONE = 1,

  // 階段二:有用戶信息,沒(méi)有手機(jī)號(hào)
  TWO = 2,

  // 階段三:有用戶信息,有手機(jī)號(hào)
  THREE = 3,
}

AuthStep 的推進(jìn)過(guò)程是不可逆的,我們可以定義一個(gè) nextStep 函數(shù)來(lái)封裝 AuthStep 更新的邏輯。外部使用的話,只要無(wú)腦調(diào)用 nextStep 方法,等待回調(diào)結(jié)果就行。

示例偽代碼:

// auth-flow component

Component({
  // ...
  
  data: {
    // 默認(rèn)情況下,只需要到達(dá)階段二。
    mustAuthStep: AuthStep.TWO
  },
  
  // 允許臨時(shí)更改組件的需要達(dá)到的階段。
  setMustAuthStep(mustAuthStep: AuthStep) {
    this.setData({ mustAuthStep });
  },
  
  // 根據(jù)用戶當(dāng)前的信息,計(jì)算用戶處在授權(quán)的階段
  getAuthStep() {
    let currAuthStep;
    
    // 沒(méi)有用戶信息,尚在第一步
    if (!session.hasUser() || !session.hasUnionId()) {
      currAuthStep = AuthStepType.ONE;
    }

    // 沒(méi)有手機(jī)號(hào),尚在第二步
    if (!session.hasPhone()) {
      currAuthStep = AuthStepType.TWO;
    }

    // 都有,尚在第三步
    currAuthStep = AuthStepType.THREE;
    return currAuthStep;
  }
  
  // 發(fā)起下一步授權(quán),如果都已經(jīng)完成,就直接返回成功。
  nextStep(e) {
    const { mustAuthStep } = this.data;
    const currAuthStep = this.updateAuthStep();
  
    // 已完成授權(quán)
    if (currAuthStep >= mustAuthStep || currAuthStep === AuthStepType.THREE) {
      // 更新全局的授權(quán)狀態(tài)機(jī),廣播消息給訂閱者。
      return getApp().status.auth.success();
    }

    // 第一步:更新用戶信息
    if (currAuthStep === AuthStepType.ONE) {
      // 已有密文信息,更新用戶信息
      if (e) session.updateUser(e);

      // 更新到視圖層,展示對(duì)應(yīng)UI,等待獲取用戶信息
      else this.setData({ currAuthStep });
      return;
    }

    // 第二步:更新手機(jī)信息
    if (currAuthStep === AuthStepType.TWO) {
      // 已有密文信息,更新手機(jī)號(hào)
      if (e) this.bindPhone(e);

      // 未有密文信息,彈出獲取窗口
      else this.setData({ currAuthStep });
      return;
    }

    console.warn('auth.nextStep 錯(cuò)誤', { currAuthStep, mustAuthStep });
  },
  
  // ...
});

那么我們的 <auth-flow> 中就可以根據(jù) currAuthStepmustAuthStep 來(lái)去做不同的 UI 展示。需要注意的是使用 <user-container><phone-container> 的時(shí)候連接上 nextStep(e) 函數(shù)。

示例偽代碼:

<view class="auth-flow">

  <!-- 已完成授權(quán) -->
  <block wx:if="{{currAuthStep === mustAuthStep || currAuthStep === AuthStep.THREE}}">
    <view>已完成授權(quán)</view>
  </block>

  <!-- 未完成授權(quán),第一步:授權(quán)用戶信息 -->
  <block wx:elif="{{currAuthStep === AuthStep.ONE}}">
    <user-container bind:getuserinfo="nextStep">
      <view>授權(quán)用戶信息</view>
    </user-container>
  </block>

  <!-- 未完成授權(quán),第二步:授權(quán)手機(jī)號(hào) -->
  <block wx:elif="{{currAuthStep === AuthStep.TWO}}">
    <phone-container bind:getphonenumber="nextStep">
      <view>授權(quán)手機(jī)號(hào)</view>
    </phone-container>
  </block>
  
</view>

3.2.2 權(quán)限攔截的處理

到這里,我們制作好了用來(lái)承載授權(quán)流程的組件 <auth-flow> ,那么接下來(lái)就是決定要使用它的時(shí)機(jī)了。

我們梳理需要授權(quán)的場(chǎng)景:

  1. 點(diǎn)擊某個(gè)按鈕,例如:購(gòu)買某個(gè)商品。

    對(duì)于這種場(chǎng)景,常見(jiàn)的是通過(guò)彈窗完成授權(quán),用戶可以選擇關(guān)閉。

授權(quán)模型-彈窗
  1. 瀏覽某個(gè)頁(yè)面,例如:訪問(wèn)個(gè)人中心。

    對(duì)于這種場(chǎng)景,我們可以在點(diǎn)擊跳轉(zhuǎn)某個(gè)頁(yè)面的時(shí)候,進(jìn)行攔截,彈窗處理。但這樣的缺點(diǎn)是,跳轉(zhuǎn)到目標(biāo)頁(yè)面的地方可能會(huì)很多,每個(gè)都攔截,難免會(huì)錯(cuò)漏。而且當(dāng)目標(biāo)頁(yè)面作為「小程序落地頁(yè)面」的時(shí)候,就避免不了。

    這時(shí)候,我們可以通過(guò)重定向到授權(quán)頁(yè)面來(lái)完成授權(quán)流程,完成之后,再回來(lái)。

授權(quán)模型-頁(yè)面

那么我們定義一個(gè)枚舉變量:

// 授權(quán)的展示形式
export enum AuthDisplayMode {
  // 以彈窗形式
  POPUP = 'button',

  // 以頁(yè)面形式
  PAGE = 'page',
}

我們可以設(shè)計(jì)一個(gè) mustAuth 方法,在點(diǎn)擊某個(gè)按鈕,或者頁(yè)面加載的時(shí)候,進(jìn)行授權(quán)控制。

偽代碼示例:

class Session {
  // ...
  
  mustAuth({
    mustAuthStep = AuthStepType.TWO, // 需要授權(quán)的LEVEL,默認(rèn)需要獲取用戶資料
    popupCompName = 'auth-popup',   // 授權(quán)彈窗組件的 id
    mode = AuthDisplayMode.POPUP, // 默認(rèn)以彈窗模式
  } = {}): Promise<void> {
    
    // 如果當(dāng)前的授權(quán)步驟已經(jīng)達(dá)標(biāo),則返回成功
    if (this.currentAuthStep() >= mustAuthStep) return Promise.resolve();

    // 嘗試獲取當(dāng)前頁(yè)面的 <auth-popup id="auth-popup" /> 組件實(shí)例
    const pages = getCurrentPages();
    const curPage = pages[pages.length - 1];
    const popupComp = curPage.selectComponent(`#${popupCompName}`);

    // 組件不存在或者顯示指定頁(yè)面,跳轉(zhuǎn)到授權(quán)頁(yè)面
    if (!popupComp || mode === AuthDisplayMode.PAGE) {
      const curRoute = curPage.route;

      // 跳轉(zhuǎn)到授權(quán)頁(yè)面,帶上當(dāng)前頁(yè)面路由,授權(quán)完成之后,回到當(dāng)前頁(yè)面。
      wx.redirectTo({ url: `authPage?backTo=${encodeURIComponent(curRoute)}` });
      return Promise.resolve();
    }
    
    // 設(shè)置授權(quán) LEVEL,然后調(diào)用 <auth-popup> 的 nextStep 方法,進(jìn)行進(jìn)一步的授權(quán)。
    popupComp.setMustAuthStep(mustAuthStep);
    popupComp.nextStep();

    // 等待成功回調(diào)或者失敗回調(diào)
    return new Promise((resolve, reject) => {
      const authStatus = getApp().status.auth;
      authStatus.onceSuccess(resolve);
      authStatus.onceFail(reject);
    });
  }
  
  // ...
}

那么我們就能在按鈕點(diǎn)擊,或者頁(yè)面加載的時(shí)候進(jìn)行授權(quán)攔截:

Page({
  onLoad() {
    session.mustAuth().then(() => {
      // 開(kāi)始初始化頁(yè)面...
    });
  }
  
  onClick(e) {
    session.mustAuth().then(() => {
      // 開(kāi)始處理回調(diào)邏輯...
    });
  }
})

當(dāng)然,如果項(xiàng)目使用了 TS 的話,或者支持 ES7 Decorator 特性的話,我們可以為 mustAuth 提供一個(gè)裝飾器版本:

export function mustAuth(option = {}) {
  return function(
    _target,
    _propertyName,
    descriptor,
  ) {
    // 劫持目標(biāo)方法
    const method = descriptor.value;
    
    // 重寫目標(biāo)方法
    descriptor.value = function(...args: any[]) {
      return session.mustAuth(option).then(() => {
        // 登錄完成之后,重放原來(lái)方法
        if (method) return method.apply(this, args);
      });
    };
  };
}

那么使用方式就簡(jiǎn)單一些了:

Page({
  @mustAuth();
  onLoad() {
    // 開(kāi)始初始化頁(yè)面...
  }
  
  @mustAuth();
  onClick(e) {
    // 開(kāi)始處理回調(diào)邏輯...
  }
});

3.3. 前后端交互協(xié)議整理

作為一套可復(fù)用的小程序登錄方案,當(dāng)然需要去定義好前后端的交互協(xié)議。

那么整套登錄流程下來(lái),需要的接口有這么幾個(gè):

登錄注冊(cè)前后端接口協(xié)議
  1. 靜默登錄 silentLogin

    1. 入?yún)ⅲ?
      1. code: 產(chǎn)自 wx.login()
    2. 出參:
      1. token: 自定義登錄態(tài)憑證
      2. userInfo: 用戶信息
    3. 說(shuō)明:
      1. 后端利用 code 跟微信客戶端換取用戶標(biāo)識(shí),然后注冊(cè)并登錄用戶,返回自定義登錄態(tài) token 給前端
      2. token 前端會(huì)存起來(lái),每個(gè)請(qǐng)求都會(huì)帶上
      3. userInfo 需要包含nicknamephone字段,前端用于計(jì)算當(dāng)前用戶的授權(quán)階段。當(dāng)然這個(gè)狀態(tài)的記錄可以放在后端,但是我們認(rèn)為放在前端,會(huì)更加靈活。
  2. 更新用戶信息 updateUser

    1. 入?yún)ⅲ?
      1. nickname: 用戶昵稱
      2. encrypt: 微信開(kāi)放數(shù)據(jù)相關(guān)的 iv, encryptedData
      3. 以及其他如性別地址等非必要字段
    2. 出參:
      1. userInfo:更新后的最新用戶信息
    3. 說(shuō)明:
      1. 后端解密微信開(kāi)放數(shù)據(jù),獲取隱蔽數(shù)據(jù),如:unionId
      2. 后端支持更新包括 nickname等用戶基本信息。
      3. 前端會(huì)把 userInfo 信息更新到 session 中,用于計(jì)算授權(quán)階段。
  3. 更新用戶手機(jī)號(hào) updatePhone

    1. 入?yún)ⅲ?
      1. encrypt:微信開(kāi)放數(shù)據(jù)相關(guān)的 iv, encryptedData
    2. 出參:
      1. userInfo:更新后的最新用戶信息
    3. 說(shuō)明:
      1. 后端解密開(kāi)放式局,獲取手機(jī)號(hào),并更新到用戶信息中。
      2. 前端會(huì)把 userInfo 信息更新到 session 中,用于計(jì)算授權(quán)階段。
  4. 解綁手機(jī)號(hào) unbindPhone

    1. 入?yún)ⅲ?
    2. 出參:-
    3. 說(shuō)明:后端解綁用戶手機(jī)號(hào),成功與否,走業(yè)務(wù)定義的前后端協(xié)議。
  5. 登錄 logout

    1. 入?yún)ⅲ?
    2. 出參:-
    3. 說(shuō)明:后端主動(dòng)過(guò)期登錄態(tài),成功與否,走業(yè)務(wù)定義的前后端協(xié)議。

五. 架構(gòu)圖

最后我們來(lái)梳理一下整體的「登錄服務(wù)」的架構(gòu)圖:

微信小程序登錄服務(wù)架構(gòu)圖

由「登錄服務(wù)」和「底層建設(shè)」組合提供的通用服務(wù),業(yè)務(wù)層只需要去根據(jù)產(chǎn)品需求,定制授權(quán)的流程 <auth-flow> ,就能滿足大部分場(chǎng)景了。

六. 總結(jié)

本篇文章通過(guò)一些常見(jiàn)的登錄授權(quán)場(chǎng)景來(lái)展開(kāi)來(lái)描述細(xì)節(jié)點(diǎn)。

整理了「登錄」、「授權(quán)」的概念。

然后分別針對(duì)「登錄」介紹了一些關(guān)鍵的技術(shù)實(shí)現(xiàn):

  1. 靜默登錄
  2. 靜默登錄異步狀態(tài)的處理
  3. 自定義登錄態(tài)過(guò)期的容錯(cuò)處理
  4. 微信 session_key 過(guò)期的容錯(cuò)處理

而對(duì)于「授權(quán)」,會(huì)有設(shè)計(jì)UI部分的邏輯,還需要涉及到組件的拆分:

  1. 組件拆分與設(shè)計(jì)
  2. 權(quán)限攔截的處理

然后,梳理了這套登錄授權(quán)方案所依賴的后端接口,和給出最簡(jiǎn)單的參考協(xié)議。

最后,站在「秉著沉淀一套通用的小程序登錄方案和服務(wù)為目標(biāo)」的角度,梳理了一下架構(gòu)層面上的分層。

  1. 業(yè)務(wù)定制層
  2. 登錄服務(wù)層
  3. 底層建設(shè)

七. 參考

  1. fly.js 官網(wǎng)
  2. 微信官方文檔-授權(quán)
  3. 微信官方文檔-服務(wù)端獲取開(kāi)放數(shù)據(jù)
  4. 微信官方社區(qū)
    1. 小程序解密手機(jī)號(hào),隔一小段時(shí)間后,checksession:ok,但是解密失敗
    2. wx.checkSession有效,但是解密數(shù)據(jù)失敗
    3. checkSession判斷session_key未失效,但是解密手機(jī)號(hào)失敗
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容