徹底搞清楚vue3的defineExpose巨集函數是如何暴露方法給父組件使用

来源:https://www.cnblogs.com/heavenYJJ/p/18219427
-Advertisement-
Play Games

前言 眾所周知,當子組件使用setup後,父組件就不能像vue2那樣直接就可以訪問子組件內的屬性和方法。這個時候就需要在子組件內使用defineExpose巨集函數來指定想要暴露出去的屬性和方法。這篇文章來講講defineExpose巨集函數是如何暴露出去這些屬性和方法給父組件使用。註:本文中使用的vu ...


前言

眾所周知,當子組件使用setup後,父組件就不能像vue2那樣直接就可以訪問子組件內的屬性和方法。這個時候就需要在子組件內使用defineExpose巨集函數來指定想要暴露出去的屬性和方法。這篇文章來講講defineExpose巨集函數是如何暴露出去這些屬性和方法給父組件使用。註:本文中使用的vue版本為3.4.19

關註公眾號:【前端歐陽】,給自己一個進階vue的機會

加我微信heavenyjj0012回覆「666」,免費領取歐陽研究vue源碼過程中收集的源碼資料,歐陽寫文章有時也會參考這些資料。同時讓你的朋友圈多一位對vue有深入理解的人。

看個demo

父組件index.vue的代碼如下:

<template>
  <ChildDemo ref="child" />
  <button @click="handleClick">調用子組件的validate方法</button>
</template>

<script setup lang="ts">
import ChildDemo from "./child.vue";
import { ref } from "vue";

const child = ref();

function handleClick() {
  console.log(child.value.validate);
  child.value.validate?.();
}
</script>

上面的代碼很簡單,通過ref拿到子組件的實例賦值給child變數。然後在按鈕的click事件中列印出子組件的validate方法和執行validate方法。

再來看看子組件child.vue不使用defineExpose巨集的例子,代碼如下:

<template></template>

<script setup>
function validate() {
  console.log("執行子組件validate方法");
}
</script>

在瀏覽器中點擊父組件的button按鈕,可以看到控制臺中列印的是undefined,並且子組件內的validate方法也沒有執行。因為子組件使用了setup,預設是不會暴露setup中定義的屬性和方法。如下圖:
no-defineExpose

我們再來看看子組件child.vue使用defineExpose巨集的例子,代碼如下:

<template></template>

<script setup>
function validate() {
  console.log("執行子組件validate方法");
}

defineExpose({
  validate,
});
</script>

在瀏覽器中點擊父組件的button按鈕,可以看到控制臺中列印的不再是undefined,子組件內的validate方法也執行了。如下圖:
has-defineExpose

關註公眾號:【前端歐陽】,給自己一個進階vue的機會

加我微信heavenyjj0012回覆「666」,免費領取歐陽研究vue源碼過程中收集的源碼資料,歐陽寫文章有時也會參考這些資料。同時讓你的朋友圈多一位對vue有深入理解的人。

編譯後的代碼

首先需要在瀏覽器中找到編譯後的使用defineExpose巨集的child.vue文件,在network面板中找到child.vue,然後右鍵點擊Open in Sources panel就可以在source面板中找到編譯後的child.vue。如下圖:
network

為了要在瀏覽器中debug,我們還需要在設置中關閉瀏覽器的javascript source map,如下圖:
source-map

現在我們來看看編譯後的child.vue文件,代碼如下:

const _sfc_main = {
  __name: "child",
  setup(__props, { expose: __expose }) {
    function validate() {
      console.log("執行子組件validate方法");
    }
    __expose({
      validate,
    });
    const __returned__ = { validate };
    return __returned__;
  },
};

function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
  return null;
}
_sfc_main.render = _sfc_render;
export default _sfc_main;

從上面可以看到_sfc_main對象中的setup對應的就是我們源代碼<script setup>中的內容,並且defineExpose巨集函數也不在了,變成了一個__expose方法(defineExpose巨集函數如何編譯成__expose方法我們會在下一篇文章講)。如下圖:
convert

expose方法

__expose方法打個斷點,刷新頁面此時斷點停留在__expose方法上面。點擊step into進入到__expose方法內部,如下圖:
step-into

進入到__expose方法內部,我們發現__expose方法是在一個createSetupContext函數中定義的。在我們這個場景中createSetupContext函數簡化後的代碼如下:

function createSetupContext(instance) {
  const expose = (exposed) => {
    instance.exposed = exposed || {};
  };

  return Object.freeze({
    // ...省略
    expose,
  });
}

我們先來看看函數中的instance變數,我想你通過名字應該已經猜到了他就是當前vue實例對象。如下圖:
instance

在vue實例對象中有我們熟悉的data方法、directives和componens屬性等。

expose函數內部做的事情也很簡單,將子組件需要暴露的屬性或者方法組成的對象賦值給vue實例上的exposed屬性。

父組件訪問子組件的validate方法

在vue3中想要訪問子組件需要使用特殊的 ref attribute,在我們這個例子中就是使用<ChildDemo ref="child" />。這樣使用後就可以使用child變數訪問子組件,其實在這裡child變數的值就是一個名為getExposeProxy函數的返回值(後面的文章中會去詳細講解ref attribute是如何訪問子組件)。

getExposeProxy函數的代碼如下:

function getExposeProxy(instance) {
  if (instance.exposed) {
    return (
      instance.exposeProxy ||
      (instance.exposeProxy = new Proxy(proxyRefs(markRaw(instance.exposed)), {
        get(target, key) {
          if (key in target) {
            return target[key];
          } else if (key in publicPropertiesMap) {
            return publicPropertiesMap[key](instance);
          }
        },
        has(target, key) {
          // ...省略
        },
      }))
    );
  }
}

前面我們講過了defineExpose巨集函數中定義了想要暴露出來的屬性和方法,經過編譯後defineExpose巨集函數變成了__expose方法。執行__expose方法後會將子組件想要暴露的屬性或者方法組成的對象賦值給vue實例上的exposed屬性,也就是instance.exposed

在上面的getExposeProxy函數中就是返回了instance.exposedProxy對象,當我們使用child.value.validate訪問子組件的validate方法,其實就是訪問的是instance.exposed對象中的validate方法,而instance.exposed中的validate方法就是defineExpose巨集函數暴露的validate方法。如下圖:
full-progress

總結

父組件想要訪問子組件暴露的validate方法主要分為下麵四步:

  • 子組件使用defineExpose巨集函數聲明想要暴露validate方法。

  • defineExpose巨集函數經過編譯後變成__expose方法。

  • 執行__expose方法將子組件需要暴露的屬性或者方法組成的對象賦值給子組件vue實例上的exposed屬性,也就是instance.exposed

  • 父組件使用ref訪問子組件的validate方法,也就是訪問child.value.validate。其實訪問的就是上一步的instance.exposed.validate方法,最終訪問的就是defineExpose巨集函數中暴露的validate方法。

關註公眾號:【前端歐陽】,給自己一個進階vue的機會

加我微信heavenyjj0012回覆「666」,免費領取歐陽研究vue源碼過程中收集的源碼資料,歐陽寫文章有時也會參考這些資料。同時讓你的朋友圈多一位對vue有深入理解的人。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 前言 前端函數和應用側函數相互調用是指前端頁面中的JavaScript函數和應用程式側的函數之間進行相互調用。 在前端開發中,常常會使用JavaScript函數來處理用戶的交互事件和操作。這些函數可以在前端頁面中定義,例如通過事件監聽器或者按鈕點擊事件來觸發函數的執行。這些前端函數可以使用DOM ...
  • 前言 Web是一種基於互聯網的技術和資源的網路服務系統。它是指由許多互連的電腦組成的全球性電腦網路,使用戶能夠通過瀏覽器訪問和互動式使用各種信息和資源,如網頁、文檔、圖片、視頻、音頻等。通過Web,用戶可以瀏覽網頁、發送電子郵件、參與線上社交網路、進行線上購物等各種活動。Web的核心技術包括 ...
  • 在 recyclerview 中,想要無論滑動到哪,每次按遙控器落焦,需要落焦在左側第一個 item 上面,如果不能觸屏還好,觸屏會導致焦點丟失 根據系統的反饋,如果你滑動了列表,剛好列表的 item 卡在一半的位置,此時系統的落焦規則,不一定會到第一個 之前試過一個效果一般的方案,就是通過 fin ...
  • 在上一篇電腦啟動過程文章中介紹了電腦啟動的基本流程,本篇文章主要介紹Linux內核Kernel的啟動過程。 一、內核啟動的基本流程 sequenceDiagram participant Bootloader participant Kernel participant InitProcess ...
  • title: Vue3使用Composition API實現響應式 date: 2024/5/29 下午8:10:24 updated: 2024/5/29 下午8:10:24 categories: 前端開發 tags: Vue3 Composition Refs Reactive Watch L ...
  • 一、 是什麼 Node作為一門服務端語言,性能方面尤為重要,其衡量指標一般有如下: CPU 記憶體 I/O 網路 CPU 主要分成了兩部分: CPU負載:在某個時間段內,占用以及等待CPU的進程總數 CPU使用率:CPU時間占用狀況,等於 1 - 空閑CPU時間(idle time) / CPU總時間 ...
  • 1️⃣ 原因 由於是一個比較老的項目,所以在做功能時,用到了老項目的一個控制項,這一個控制項是以前封裝好的,依賴的是jquery-1.6.min.js。但是在做下拉框多選功能時,在網上找了一個下拉框多選的框架,但是這個框架依賴是jquery.js(3.7.1),所以才出現了這個問題。 簡單來說就是新老控 ...
  • 1、是什麼 pointer-events 直譯為指針事件,該屬性指定在什麼情況下某個DOM可以成為滑鼠事件的 target。 簡而言之,就是允許/禁止DOM的滑鼠事件(click事件、hover事件、mouse事件等滑鼠事件) 2、具體屬性分析 用法分析:pointer-events: auto | ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...