Vue3 setup新增name的方法步驟

2022-12-01 14:02:34

Vue3中name有什麼用呢？

1.在遞迴元件的時候需要定義name

2.配合keep-alive include exclude 可以快取元件

3.在Vue有報錯或者偵錯的時候可以看到元件的name

Vue3 定義 name

1.自動生成

<script setup> 只要在script開啟setup語法糖模式單檔案元件會自動根據檔名生成對應的 name 選項例如 Tree.vue 那他的name 就是 Tree 自動生成，這樣做有一個弊端如果想修改name需要修改元件名稱如果有地方import 該元件需要一併修改。

2.在開啟一個script用來定義name

優點這種方式可以隨意定義name 弊端一個單檔案元件出現兩個script 會讓人感到疑惑。

<template>
<div></div>
</template>

<script lang="ts" setup>
import {ref,reactive } from 'vue'
</script>

<script lang='ts'>
 export default {
    name:"XXX"
 }
</script>

<style lang="less" scoped>

</style>

3.使用第三方外掛 unplugin-vue-define-options

安裝方法 npm i unplugin-vue-define-options -D

vite 使用

// vite.config.ts
import DefineOptions from 'unplugin-vue-define-options/vite'
import Vue from '@vitejs/plugin-vue'

export default defineConfig({
  plugins: [Vue(), DefineOptions()],
})

設定tsconfig.json

// tsconfig.json
{
  "compilerOptions": {
    // ...
    "types": ["unplugin-vue-define-options/macros-global" /* ... */]
  }
}

使用方法通過編譯宏 defineOptions 新增name 和 inheritAttrs

<script setup lang="ts">
defineOptions({
  name: 'Foo',
  inheritAttrs: false,
})
</script>

4.個人想法我想著直接在script 定義name 不好嗎？

<template>
<div></div>
</template>

<script name="xiaoman" lang="ts" setup>
import {ref,reactive } from 'vue'
</script>


<style lang="less" scoped>

</style>

這件事情在Vue社群也是進行了激烈的討論，而尤大也是做出了回覆

大致意思就是：尤大覺得這個構思很好，但是有一些擔憂，在我們使用元件的時候需要定義name 和 inheritAttrs 情況非常罕見，大部分元件庫的開發人員可能經常會使用這兩個東西，但對於90%的應用程式元件來說，這確實是一組不同的權衡，並且處理props將會變得很麻煩，再加上實現的複雜性，不確定做這件事是否值得。

不過已經有一個外掛實現該功能 unplugin-vue-setup-extend-plus

我們來複刻一個簡易版其原理還是加一個script 只不過開發人員看不到了這個script

Vue3 setup 支援 name 外掛實現思路借鑑上面外掛

import type { Plugin } from 'vite'
//@vue/compiler-sfc 這個外掛是處理我們單檔案元件的程式碼解析
import { compileScript, parse } from '@vue/compiler-sfc'

export default function setupName(): Plugin {
    return {

        name: 'vite:plugin:vue:name',
        //一個 Vite 外掛可以額外指定一個 `enforce` 屬性
        //（類似於 webpack 載入器）來調整它的應用順序。`enforce` 的值可以是`pre` 或 `post`
        //載入順序為
          //Alias
          //帶有 `enforce: 'pre'` 的使用者外掛
          //Vite 核心外掛
          //沒有 enforce 值的使用者外掛
          //Vite 構建用的外掛
          //帶有 `enforce: 'post'` 的使用者外掛
         //Vite 後置構建外掛（最小化，manifest，報告）
        enforce: "pre",
        //transform code引數就是我們寫的程式碼比如vue程式碼  id就是路徑例如/src/xx/xx.vue
        transform(code, id) {
            //只處理vue結尾的檔案
            if (/.vue$/.test(id)) {
                let { descriptor } = parse(code)
                //通過compileScript 處理script 返回result
                  //attrs: { name: 'xm', lang: 'ts', setup: true },
                  //lang: 'ts',
                  //setup: true,
                const result = compileScript(descriptor, { id })
                //attrs 此時就是一個物件
                const name = result.attrs.name 
                const lang = result.attrs.lang
                const inheritAttrs = result.attrs.inheritAttrs
                //寫入script
                const template = `
                <script ${lang ? `lang=${lang}` :  ''}>
                 export default {
                    ${name ? `name:"${name}",`  : ''}
                    ${inheritAttrs ? `inheritAttrs: ${inheritAttrs !== 'false'},` : ''}
                 }
                </script>
                `;
                //最後拼接上這段程式碼 也就是我們加的script這一段 返回code
                code += template;
               // console.log(code)
            }

            return code
        }
    }
}

然後在vite config ts 引入我們寫好的外掛

Tree.vue 子元件

<template>
    <div v-for="item in data">
        {{ item.name }}
        <xm v-if="item?.children?.length" :data='item?.children'></xm>
    </div>
</template>

<script name='xm' lang="ts" setup>
import { ref, reactive } from 'vue'
defineProps<{
    data: any[]
}>()
</script>

App.vue 父元件

<template>
    <TreeVue :data="data"></TreeVue>
</template>

<script lang="ts" setup>
import TreeVue from './components/Tree.vue';
const data = [
    {
        name: "1",
        children: [
            {
                name: "1-1",
                children: [
                    {
                        name: "1-1-1"
                    }
                ]
            }
        ]
    }
]
</script>

元件成功遞迴出來