1. 程式人生 > >一個 JS 庫就能解決小程式跨頁傳遞事件訊息和資料

一個 JS 庫就能解決小程式跨頁傳遞事件訊息和資料

由於微信小程式 wx.navigateBack 方法並不支援返回傳值,導致頁面在返回後,不能方便地即時更新資料。

一.需求分析
此類需求大概意思是:A 頁面進入 B 頁面,B 頁面返回並傳值給 A或在B頁面觸發事件時,A頁面也有事件觸發改變。

業務分析

普遍方法為:
第一種:利用微信的 wx.setStorage,將資料快取在小程式例項內。從 B 頁面返回 A 頁面時,B 頁面先將資料快取;然後在 A 頁面的 onshow 方法裡,呼叫 wx.getStorage 讀取快取來實現。但為日後維護帶來大量隱患。(用全域性變數方法類似)

第二種:獲取前一個 page 例項的方法,也可以實現此功能。部分程式碼如下:

var pages = getCurrentPages();
var currPage = pages[pages.length - 1];   //當前頁面
var prevPage = pages[pages.length - 2];  //上一個頁面

//直接呼叫上一個頁面的 setData() 方法,把資料存到上一個頁面中去
prevPage.setData({
  mdata:1 
})

這種方法的弊端:因為進入 B 頁面的入口可能是很多個。這樣做,可能會導致獲取到的頁面例項不正確。

二.方法介紹(onfire.js的下載地址https://github.com/hustcc/onfire.js


下面進入正題介紹onfire.js()
onfire.js 是一個很簡單的事件分發 JavaScript 庫(僅僅 0.9kb),簡潔實用。它可以應用於:
1.簡單的事件分發。
2.在 React、Vue.js、Angular 中用於跨元件的輕量級實現。
3.事件訂閱和釋出。

使用思路:(做過移動端開發的都知道,類似於iOS的通知和安卓的廣播)
a.A 頁面先訂閱一個事件,並定義處理方法;
b.從 B 頁面返回時,傳送訊息;
c.A 頁面解除安裝時,解除訂閱。

我的使用方法為:
A 頁面程式碼:

var onfire = require("../utils/onfire.js");
var that;
var eventObj = onfire.on('key', function () {
    // 當訊息被傳遞時,做具體的事
});

Page({
  data: {
  },
  onLoad: function(options) {
    // Do some initialize when page load.
  },
  onReady: function() {
    // Do something when page ready.
  },
  onUnload: function (e) {
    onfire.un('key');
    onfire.un(eventObj);//移除
  }
})

我們可以在 A 頁面直接呼叫 onfire.on 方法,訂閱一個名字為 key 的訊息。在上面的程式碼中,訊息附帶的引數無傳參。
如果需要傳參的話,直接在 function 裡增加引數即可,例如:

var eventObj = onfire.on('key', function (data){
  // 執行操作
})

需要注意的是,一定要在 onUnload 裡(在頁面被關閉時)取消訂閱訊息,並取消繫結 eventObj。

B 頁面裡程式碼在回撥的地方加入以下程式碼:

onfire.fire('key');//key 為上文中訂閱的訊息
   // 有引數時
   onfire.fire('key','test');

三.分析庫程式碼

function _bind(eventName, callback, is_one, context) {
    if (typeof eventName !== string_str || typeof callback !== function_str) {
      throw new Error('args: '+string_str+', '+function_str+'');
    }
    if (! hasOwnKey(__onfireEvents, eventName)) {
      __onfireEvents[eventName] = {};
    }
    __onfireEvents[eventName][++__cnt] = [callback, is_one, context];

    return [eventName, __cnt];
  }

從程式碼中可以看出訂閱 on 方法的時候,實際呼叫 _bind 方法。該方法利用一個二維陣列,來儲存訂閱的物件。

 function _fire_func(eventName, args) {
    if (hasOwnKey(__onfireEvents, eventName)) {
      _each(__onfireEvents[eventName], function(key, item) {
        item[0].apply(item[2], args); //執行訂閱時的方法
        if (item[1]) delete __onfireEvents[eventName][key]; // 當型別為只訂閱一次時,通知後即移除自己。
      });
    }
  }

而 fire 傳送訊息方法的實質,是呼叫 _fire_func 方法,通過名字(key)來遍歷訂閱者,然後通知訂閱者。

function un(event) {
    var eventName, key, r = false, type = typeof event;
    if (type === string_str) {
      // 如果存在key值,則移除陣列
      if (hasOwnKey(__onfireEvents, event)) {
        delete __onfireEvents[event];
        return true;
      }
      return false;
    }
    else if (type === 'object') {
      eventName = event[0];
      key = event[1];
      //如果找到這個物件則解除安裝
      if (hasOwnKey(__onfireEvents, eventName) && hasOwnKey(__onfireEvents[eventName], key)) {
        delete __onfireEvents[eventName][key];
        return true;
      }
      //否則返回false
      return false;
    }
    else if (type === function_str) {
        //兩層迴圈來判斷方法名
      _each(__onfireEvents, function(key_1, item_1) {
        _each(item_1, function(key_2, item_2) {
          if (item_2[0] === event) {
            delete __onfireEvents[key_1][key_2];
            r = true;
          }
        });
      });
      return r;
    }
    return true;
  }

呼叫un方法,通過名字(key)來遍歷訂閱者,找到後移除。

注:因為解除安裝支援按 key、物件、方法解除安裝,所以需要先判斷型別,然後按各自規則去解除繫結。