微信小程式中怎麼自訂元件？以下這篇文章為大家介紹一下微信小程式中自訂元件的方法，希望對大家有幫助！

在微信小程式開發(fā)過程中，對於一些可能在多個頁面都使用的頁面模組，可以把它封裝成一個元件，以提高開發(fā)效率。雖然說我們可以引入整個元件庫例如 weui、vant 等，但有時候考慮微信小程式的套件體積限制問題，通常封裝為自訂的元件更為可控。

並且對於某些業(yè)務(wù)模組，我們就可以封裝為元件重複使用。本文主要講述以下兩個面向：

• 元件的宣告與使用
• 元件通訊

元件的宣告與使用

微信小程式的元件系統(tǒng)底層是透過Exparser 元件框架來實現(xiàn)，它內(nèi)建在小程式的基礎(chǔ)庫中，小程式內(nèi)的所有元件，包括內(nèi)建元件和自訂元件都由Exparser 組織管理。

自訂元件和寫入頁面一樣包含以下幾個檔案：

• index.json
• index.wxml
• index.wxss
• index.js
• index.wxs

以寫一個tab 元件為例： 編寫自訂元件時需要在json 檔案中講component 欄位設(shè)為true：

{
    "component": true
}

在js#文件中，基礎(chǔ)庫提供有Page 和Component 兩個建構(gòu)器，Page 對應(yīng)的頁面為頁面根元件，Component 則對應(yīng)：

Component({
    options: { // 組件配置
        addGlobalClass: true,
        // 指定所有 _ 開頭的數(shù)據(jù)字段為純數(shù)據(jù)字段
        // 純數(shù)據(jù)字段是一些不用于界面渲染的 data 字段，可以用于提升頁面更新性能
        pureDataPattern: /^_/, 
        multipleSlots: true // 在組件定義時的選項中啟用多slot支持
    },
    properties: {
        vtabs: {type: Array, value: []},
    },
    data: {
        currentView: 0,
    },
    observers: { // 監(jiān)測
        activeTab: function(activeTab) {
            this.scrollTabBar(activeTab);
        }
    }, 
    relations: {  // 關(guān)聯(lián)的子/父組件
        '../vtabs-content/index': {
            type: 'child', // 關(guān)聯(lián)的目標(biāo)節(jié)點應(yīng)為子節(jié)點
            linked: function(target) {
                this.calcVtabsCotentHeight(target);
            },
            unlinked: function(target) {
                delete this.data._contentHeight[target.data.tabIndex];
            }
        }
    },
    lifetimes: { // 組件聲明周期
        created: function() {
            // 組件實例剛剛被創(chuàng)建好時
        },
        attached: function() {
            // 在組件實例進(jìn)入頁面節(jié)點樹時執(zhí)行
        },
        detached: function() {
            // 在組件實例被從頁面節(jié)點樹移除時執(zhí)行
        },
    },
    methods: { // 組件方法
        calcVtabsCotentHeight(target) {}
    } 
});

如果有了解Vue2 的小夥伴，會發(fā)現(xiàn)這個聲明很熟悉。

在小程式啟動時，建構(gòu)器會將開發(fā)者設(shè)定的properties、data、methods等定義段，

寫入Exparser的元件註冊表中。這個組件在被其它組件引用時，就可以根據(jù)這些註冊資訊來建立自訂組件的實例。

模版檔案wxml：

<view class=&#39;vtabs&#39;>
    <slot />
</view>

樣式檔案：

.vtabs {}

外部頁面元件使用，只需要在頁面的json 檔案中引入

{
  "navigationBarTitleText": "商品分類",
  "usingComponents": {
    "vtabs": "../../../components/vtabs",
  }
}

在初始化頁面時，Exparser 會建立出頁面根元件的一個實例，用到的其他元件也會回應(yīng)建立元件實例（這是一個遞迴的過程）：

元件所建立的過程大致上有以下幾個要點：

• 根據(jù)元件註冊訊息，從元件原型上建立出元件節(jié)點的JS 對象，即元件的this;

• 將元件註冊資訊中的data 複製一份，作為元件數(shù)據(jù)，即this.data;

• 將這份資料結(jié)合元件WXML，據(jù)此建立出Shadow Tree（元件的節(jié)點樹），由於Shadow Tree 中可能引用有其他元件，因而這會遞歸觸發(fā)其他元件建立過程；

• #將ShadowTree 拼接到Composed Tree（最終在拼接成的頁面節(jié)點樹）上，並產(chǎn)生一些快取資料用於優(yōu)化元件更新效能；

• #觸發(fā)元件的created 生命週期函數(shù)；

• 如果不是頁面根元件，需要根據(jù)元件節(jié)點上的屬性定義，來設(shè)定元件的屬性值；

• 當(dāng)元件實例展示在頁面上時，觸發(fā)組件的attached 生命週期函數(shù)，如果Shadow Tree 中有其他元件，也逐一觸發(fā)它們的生命週期函數(shù)。

元件通訊

由於業(yè)務(wù)的負(fù)責(zé)度，我們常常需要把一個大型頁面拆分為多個元件，多個元件之間需要進(jìn)行數(shù)據(jù)通訊。

對於跨代元件通訊可以考慮全域狀態(tài)管理，這裡只討論常見的父子元件通訊：

方法一WXML 資料綁定

用於父元件向子元件的指定屬性設(shè)定資料。

子宣告properties 屬性

Component({
    properties: {
        vtabs: {type: Array, value: []}, // 數(shù)據(jù)項格式為 `{title}`
    }
})

父元件呼叫：

    <vtabs vtabs="{{ vtabs }}"</vtabs>

方法二事件

用於子元件向父元件傳遞數(shù)據(jù)，可以傳遞任意資料。

子元件派發(fā)事件，先在 wxml 結(jié)構(gòu)綁定子元件的點擊事件：

   <view bindtap="handleTabClick">

再在 js 檔案中進(jìn)行派發(fā)事件，事件名稱可以自訂填寫， 第二個參數(shù)可以傳遞資料對象，第三個參數(shù)為事件選項。

 handleClick(e) {
     this.triggerEvent(
         'tabclick', 
         { index }, 
         { 
             bubbles: false,  // 事件是否冒泡
             // 事件是否可以穿越組件邊界，為 false 時，事件只在引用組件的節(jié)點樹上觸發(fā)，
             // 不進(jìn)入其他任何組件的內(nèi)部
             composed: false,  
             capturePhase: false // 事件是否擁有捕獲階段 
         }
     );
 },
 handleChange(e) {
     this.triggerEvent('tabchange', { index });
 },

最後，在父元件中監(jiān)聽使用：

<vtabs 
    vtabs="{{ vtabs }}"
    bindtabclick="handleTabClick" 
    bindtabchange="handleTabChange" 
>

#方法三selectComponent 取得元件實例物件

selectComponent 方法可以取得子元件的實例，從而呼叫子元件的方法。

父元件的 wxml

<view>
    <vtabs-content="goods-content{{ index }}"></vtabs-content>
</view>

父元件的 js

Page({
    reCalcContentHeight(index) {
        const goodsContent = this.selectComponent(`#goods-content${index}`);
    },
})

selector類似於 CSS 的選擇器，但僅支援下列語法。

• ID選擇器：#the-id（筆者只測試了這個，其他讀者可自行測試）
• class選擇器（可以連續(xù)指定多個）：.a-class.another-class
• 子元素選擇器：.the-parent > .the-child
• 后代選擇器：.the-ancestor .the-descendant
• 跨自定義組件的后代選擇器：.the-ancestor >>> .the-descendant
• 多選擇器的并集：#a-node, .some-other-nodes

方法四 url 參數(shù)通信

在電商/物流等微信小程序中，會存在這樣的用戶故事，有一個「下單頁面A」和「貨物信息頁面B」

• 在「下單頁面 A」填寫基本信息，需要下鉆到「詳細(xì)頁面B」填寫詳細(xì)信息的情況。比如一個寄快遞下單頁面，需要下鉆到貨物信息頁面填寫更詳細(xì)的信息，然后返回上一個頁面。
• 在「下單頁面 A」下鉆到「貨物頁面B」，需要回顯「貨物頁面B」的數(shù)據(jù)。

微信小程序由一個 App() 實例和多個 Page() 組成。小程序框架以棧的方式維護(hù)頁面（最多10個） 提供了以下 API 進(jìn)行頁面跳轉(zhuǎn)，頁面路由如下

• wx.navigateTo（只能跳轉(zhuǎn)位于棧內(nèi)的頁面）

• wx.redirectTo（可跳轉(zhuǎn)位于棧外的新頁面，并替代當(dāng)前頁面）

• wx.navigateBack（返回上一層頁面，不能攜帶參數(shù)）

• wx.switchTab（切換 Tab 頁面，不支持 url 參數(shù)）

• wx.reLaunch（小程序重啟）

可以簡單封裝一個 jumpTo 跳轉(zhuǎn)函數(shù)，并傳遞參數(shù)：

export function jumpTo(url, options) {
    const baseUrl = url.split('?')[0];
    // 如果 url 帶了參數(shù)，需要把參數(shù)也掛載到 options 上
    if (url.indexof('?') !== -1) {
        const { queries } = resolveUrl(url);
        Object.assign(options, queries, options); // options 的優(yōu)先級最高
    } 
    cosnt queryString = objectEntries(options)
        .filter(item => item[1] || item[0] === 0) // 除了數(shù)字 0 外，其他非值都過濾
        .map(
            ([key, value]) => {
                if (typeof value === 'object') {
                    // 對象轉(zhuǎn)字符串
                    value = JSON.stringify(value);
                }
                if (typeof value === 'string') {
                    // 字符串 encode
                    value = encodeURIComponent(value);
                }
                return `${key}=${value}`;
            }
        ).join('&');
    if (queryString) { // 需要組裝參數(shù)
        url = `${baseUrl}?${queryString}`;
    }
    
    const pageCount = wx.getCurrentPages().length;
    if (jumpType === &#39;navigateTo&#39; && pageCount < 5) {
        wx.navigateTo({ 
            url,
            fail: () => { 
                wx.switch({ url: baseUrl });
            }
        });
    } else {
        wx.navigateTo({ 
            url,
            fail: () => { 
                wx.switch({ url: baseUrl });
            }
        });
    } 
}

jumpTo 輔助函數(shù)：

export const resolveSearch = search => {
    const queries = {};
    cosnt paramList = search.split('&');
    paramList.forEach(param => {
        const [key, value = ''] = param.split('=');
        queries[key] = value;
    });
    return queries;
};

export const resolveUrl = (url) => {
    if (url.indexOf('?') === -1) {
        // 不帶參數(shù)的 url
        return {
            queries: {},
            page: url
        }
    }
    const [page, search] = url.split('?');
    const queries = resolveSearch(search);
    return {
        page,
        queries
    };
};

在「下單頁面A」傳遞數(shù)據(jù)：

jumpTo({ 
    url: 'pages/consignment/index', 
    { 
        sender: { name: 'naluduo233' }
    }
});

在「貨物信息頁面B」獲得 URL 參數(shù)：

const sender = JSON.parse(getParam('sender') || '{}');

url 參數(shù)獲取輔助函數(shù)

// 返回當(dāng)前頁面
export function getCurrentPage() {
    const pageStack = wx.getCurrentPages();
    const lastIndex = pageStack.length - 1;
    const currentPage = pageStack[lastIndex];
    return currentPage;
}

// 獲取頁面 url 參數(shù)
export function getParams() {
    const currentPage = getCurrentPage() || {};
    const allParams = {};
    const { route, options } = currentPage;
    if (options) {
        const entries = objectEntries(options);
        entries.forEach(
            ([key, value]) => {
                allParams[key] = decodeURIComponent(value);
            }
        );
    }
    return allParams;
}

// 按字段返回值
export function getParam(name) {
    const params = getParams() || {};
    return params[name];
}

參數(shù)過長怎么辦？路由 api 不支持?jǐn)y帶參數(shù)呢？

雖然微信小程序官方文檔沒有說明可以頁面攜帶的參數(shù)有多長，但還是可能會有參數(shù)過長被截斷的風(fēng)險。

我們可以使用全局?jǐn)?shù)據(jù)記錄參數(shù)值，同時解決 url 參數(shù)過長和路由 api 不支持?jǐn)y帶參數(shù)的問題。

// global-data.js
// 由于 switchTab 不支持?jǐn)y帶參數(shù)，所以需要考慮使用全局?jǐn)?shù)據(jù)存儲
// 這里不管是不是 switchTab，先把數(shù)據(jù)掛載上去
const queryMap = {
    page: '',
    queries: {}
};

更新跳轉(zhuǎn)函數(shù)

export function jumpTo(url, options) {
    // ...
    Object.assign(queryMap, {
        page: baseUrl,
        queries: options
    });
    // ...
    if (jumpType === 'switchTab') {
        wx.switchTab({ url: baseUrl });
    } else if (jumpType === &#39;navigateTo&#39; && pageCount < 5) {
        wx.navigateTo({ 
            url,
            fail: () => { 
                wx.switch({ url: baseUrl });
            }
        });
    } else {
        wx.navigateTo({ 
            url,
            fail: () => { 
                wx.switch({ url: baseUrl });
            }
        });
    }
}

url 參數(shù)獲取輔助函數(shù)

// 獲取頁面 url 參數(shù)
export function getParams() {
    const currentPage = getCurrentPage() || {};
    const allParams = {};
    const { route, options } = currentPage;
    if (options) {
        const entries = objectEntries(options);
        entries.forEach(
            ([key, value]) => {
                allParams[key] = decodeURIComponent(value);
            }
        );
+        if (isTabBar(route)) {
+           // 是 tab-bar 頁面，使用掛載到全局的參數(shù)
+           const { page, queries } = queryMap; 
+           if (page === `${route}`) {
+               Object.assign(allParams, queries);
+           }
+        }
    }
    return allParams;
}

輔助函數(shù)

// 判斷當(dāng)前路徑是否是 tabBar
const { tabBar} = appConfig;
export isTabBar = (route) => tabBar.list.some(({ pagePath })) => pagePath === route);

按照這樣的邏輯的話，是不是都不用區(qū)分是否是 isTabBar 頁面了，全部頁面都從 queryMap 中獲??？這個問題目前后續(xù)探究再下結(jié)論，因為我目前還沒試過從頁面實例的 options 中拿到的值是缺少的。所以可以先保留讀取 getCurrentPages 的值。

方法五 EventChannel 事件派發(fā)通信

前面我談到從「當(dāng)前頁面A」傳遞數(shù)據(jù)到被打開的「頁面B」可以通過 url 參數(shù)。那么想獲取被打開頁面?zhèn)魉偷疆?dāng)前頁面的數(shù)據(jù)要如何做呢？是否也可以通過 url 參數(shù)呢？

答案是可以的，前提是不需要保存「頁面A」的狀態(tài)。如果要保留「頁面 A」的狀態(tài)，就需要使用 navigateBack 返回上一頁，而這個 api 是不支持?jǐn)y帶 url 參數(shù)的。

這樣時候可以使用 頁面間事件通信通道 EventChannel。

pageA 頁面

// 
wx.navigateTo({
    url: 'pageB?id=1',
    events: {
        // 為指定事件添加一個監(jiān)聽器，獲取被打開頁面?zhèn)魉偷疆?dāng)前頁面的數(shù)據(jù)
        acceptDataFromOpenedPage: function(data) {
          console.log(data) 
        },
    },
    success: function(res) {
        // 通過eventChannel向被打開頁面?zhèn)魉蛿?shù)據(jù)
        res.eventChannel.emit('acceptDataFromOpenerPage', { data: 'test' })
    }
});

pageB 頁面

Page({
    onLoad: function(option){
        const eventChannel = this.getOpenerEventChannel()
        eventChannel.emit('acceptDataFromOpenedPage', {data: 'test'});
   
        // 監(jiān)聽acceptDataFromOpenerPage事件，獲取上一頁面通過eventChannel傳送到當(dāng)前頁面的數(shù)據(jù)
        eventChannel.on('acceptDataFromOpenerPage', function(data) {
          console.log(data)
        })
      }
})

會出現(xiàn)數(shù)據(jù)無法監(jiān)聽的情況嗎？

小程序的棧不超過 10 層，如果當(dāng)前「頁面A」不是第 10 層，那么可以使用 navigateTo 跳轉(zhuǎn)保留當(dāng)前頁面，跳轉(zhuǎn)到「頁面B」，這個時候「頁面B」填寫完畢后傳遞數(shù)據(jù)給「頁面A」時，「頁面A」是可以監(jiān)聽到數(shù)據(jù)的。

如果當(dāng)前「頁面A」已經(jīng)是第10個頁面，只能使用 redirectTo 跳轉(zhuǎn)「PageB」頁面。結(jié)果是當(dāng)前「頁面A」出棧，新「頁面B」入棧。這個時候?qū)ⅰ疙撁鍮」傳遞數(shù)據(jù)給「頁面A」，調(diào)用 navigateBack 是無法回到目標(biāo)「頁面A」的，因此數(shù)據(jù)是無法正常被監(jiān)聽到。

不過我分析做過的小程序中，棧中很少有10層的情況，5 層的也很少。因為調(diào)用 wx.navigateBack 、wx.redirectTo 會關(guān)閉當(dāng)前頁面，調(diào)用 wx.switchTab 會關(guān)閉其他所有非 tabBar 頁面。

所以很少會出現(xiàn)這樣無法回到上一頁面以監(jiān)聽到數(shù)據(jù)的情況，如果真出現(xiàn)這種情況，首先要考慮的不是數(shù)據(jù)的監(jiān)聽問題了，而是要保證如何能夠返回上一頁面。

比如在「PageA」頁面中先調(diào)用 getCurrentPages 獲取頁面的數(shù)量，再把其他的頁面刪除，之后在跳轉(zhuǎn)「PageB」頁面，這樣就避免「PageA」調(diào)用 wx.redirectTo導(dǎo)致關(guān)閉「PageA」。但是官方是不推薦開發(fā)者手動更改頁面棧的，需要慎重。

如果有讀者遇到這種情況，并知道如何解決這種的話，麻煩告知下，感謝。

使用自定義的事件中心 EventBus

除了使用官方提供的 EventChannel 外，我們也可以自定義一個全局的 EventBus 事件中心。 因為這樣更加靈活，不需要在調(diào)用 wx.navigateTo 等APi里傳入?yún)?shù)，多平臺的遷移性更強。

export default class EventBus {
 private defineEvent = {};
 // 注冊事件
 public register(event: string, cb): void { 
  if(!this.defineEvent[event]) {
   (this.defineEvent[event] = [cb]); 
  }
  else {
   this.defineEvent[event].push(cb); 
  } 
 }
 // 派遣事件
 public dispatch(event: string, arg?: any): void {
  if(this.defineEvent[event]) {{
            for(let i=0, len = this.defineEvent[event].length; i<len; ++i) { 
                this.defineEvent[event][i] && this.defineEvent[event][i](arg); 
            }
        }}
 }
 // on 監(jiān)聽
 public on(event: string, cb): void {
  return this.register(event, cb); 
 }
 // off 方法
    public off(event: string, cb?): void {
        if(this.defineEvent[event]) {
            if(typeof(cb) == "undefined") { 
                delete this.defineEvent[event]; // 表示全部刪除 
            } else {
                // 遍歷查找 
                for(let i=0, len=this.defineEvent[event].length; i<len; ++i) { 
                    if(cb == this.defineEvent[event][i]) {
                        this.defineEvent[event][i] = null; // 標(biāo)記為空 - 防止dispath 長度變化 
                        // 延時刪除對應(yīng)事件
                        setTimeout(() => this.defineEvent[event].splice(i, 1), 0); 
                        break; 
                    }
                }
            }
        } 
    }

    // once 方法，監(jiān)聽一次
    public once(event: string, cb): void { 
        let onceCb = arg => {
         cb && cb(arg); 
         this.off(event, onceCb); 
        }
        this.register(event, onceCb); 
    }
    // 清空所有事件
    public clean(): void {
        this.defineEvent = {}; 
    }
}

export connst eventBus = new EventBus();

在 PageA 頁面監(jiān)聽：

eventBus.on('update', (data) => console.log(data));

在 PageB 頁面派發(fā)

eventBus.dispatch('someEvent', { name: 'naluduo233'});

小結(jié)

本文主要討論了微信小程序如何自定義組件，涉及兩個方面：

• 組件的聲明與使用
• 組件的通信

如果你使用的是 taro 的話，直接按照 react 的語法自定義組件就好。而其中的組件通信的話，因為 taro 最終也是會編譯為微信小程序，所以 url 和 eventbus 的頁面組件通信方式是適用的。后續(xù)會分析 vant-ui weapp 的一些組件源碼，看看有贊是如何實踐的。

感謝閱讀，如有錯誤的地方請指出

【相關(guān)學(xué)習(xí)推薦：小程序開發(fā)教程】

以上是淺析微信小程式中自訂元件的方法的詳細(xì)內(nèi)容。更多資訊請關(guān)注PHP中文網(wǎng)其他相關(guān)文章！