聊聊前端开发中Vue.js组件间的循环引用方法。
组件是可以在它们自己的模板中调用自身的。不过它们只能通过 name
选项来做这件事:
什么是组件:
众所周知组件是Vue.js最强大的功能之一。组件可以扩展HTML元素,封装可重用的代码。在较高层面上,组件是自定义的元素,Vue.js的编译器为它添加特殊功能。在有些情况下,组件也可以是原生HTML元素的形式,以is特性扩展。下面话不多说了,来一起看看本文的正文内容。
引言
写了大大小小不少基于vue的项目,但是基本没用到过组件循环引用的知识。
为了查缺补漏,照着官方文档撸一个DEMO:https://cn.vuejs.org/v2/guide/components-edge-cases.html
本人的运行版本为 vue-cli@2.8.1,启用项目后,将以下 js 文件和 vue 文件放置在相应的目录中运行。
main.js
import Vue from 'vue'
import App from './App'
new Vue({
el: '#app',
template: '<App/>',
components: { App }
})
main.js 导入 App 组件,并在 components 中注册 App 组件。
App.vue
<template>
<div id="app">
<li v-for="folder in folders">
<tree-folder v-bind:folder="folder"></tree-folder>
</li>
</div>
</template>
<script>
import TreeFolder from './components/tree-folder'
export default {
data: function () {
return {
folders: [
{
name: 'folder1',
children: [{
name: 'folder1 - folder1',
children: [{
name: 'folder1 - folder1 - folder1'
}]
}, {
name: 'folder1 - folder2',
children: [{
name: 'folder1 - folder2 - folder1'
}, {
name: 'folder1 - folder2 - folder2'
}]
}]
},
{
name: 'folder 2',
children: [{
name: 'folder2 - folder1',
children: [{
name: 'folder2 - folder1 - folder1'
}]
}, {
name: 'folder2 - folder2',
children: [{
name: 'folder2-content1'
}]
}]
},
{
name: 'folder 3',
children: [{
name: 'folder3 - folder1',
children: [{
name: 'folder3 - folder1 - folder1'
}]
}, {
name: 'folder3 - folder2',
children: [{
name: 'folder3-content1'
}]
}]
}
]
}
},
components: {
TreeFolder
}
}
</script>
App 组件导入 TreeFolder 组件,并在 components 中注册 TreeFolder 组件。
components/tree-folder.vue
<template>
<p>
<span>{{ folder.name }}</span>
<tree-folder-contents :children="folder.children"></tree-folder-contents>
</p>
</template>
<script>
// 官方文档:「在我们的例子中,将 tree-folder 组件做为切入起点。我们知道制造矛盾的是 tree-folder-contents 子组件,所以我们在 tree-folder 组件的生命周期钩子函数 beforeCreate 中去注册 tree-folder-contents 组件」
export default {
props: ['folder'],
data: function () {
return {}
},
beforeCreate: function () {
// 官方文档给出的是require
// this.$options.components.TreeFolderContents = require('./tree-folder-contents.vue')
// 在基于vue-cli@2.8.1按照上面的写法还是会报错
// Failed to mount component: template or render function not defined.
// 所以我们应该改为基于es6的写法异步加载一个组件如下
this.$options.components.TreeFolderContents = () => import('./tree-folder-contents.vue')
}
}
</script>
TreeFolder 组件导入 TreeFolderContents 组件,并在 components 中注册 TreeFolderContents 组件。
components/tree-folder-contents.vue
<template>
<ul>
<li v-for="child in children">
<tree-folder v-if="child.children" :folder="child"></tree-folder>
<span v-else>{{ child.name }}</span>
</li>
</ul>
</template>
<script>
import TreeFolder from './tree-folder'
export default {
props: ['children'],
components: {
TreeFolder
}
}
</script>
TreeFolderContents 组件又导入 TreeFolder 组件,并在 components 中注册 TreeFolder 组件,产生了循环引用。
组件之间的循环引用 {#组件之间的循环引用}
假设你需要构建一个文件目录树,像访达或资源管理器那样的。你可能有一个 <tree-folder>
组件,模板是这样的:
<p>
<span>{{ folder.name }}</span>
<tree-folder-contents :children="folder.children"/>
</p>
还有一个 <tree-folder-contents>
组件,模板是这样的:
<ul>
<li v-for="child in children">
<tree-folder v-if="child.children" :folder="child"/>
<span v-else>{{ child.name }}</span>
</li>
</ul>
当你仔细观察的时候,你会发现这些组件在渲染树中互为对方的后代和 祖先------一个悖论!当通过 Vue.component
全局注册组件的时候,这个悖论会被自动解开。如果你是这样做的,那么你可以跳过这里。
然而,如果你使用一个模块系统依赖/导入组件,例如通过 webpack 或 Browserify,你会遇到一个错误:
Failed to mount component: template or render function not defined.
为了解释这里发生了什么,我们先把两个组件称为 A 和 B。模块系统发现它需要 A,但是首先 A 依赖 B,但是 B 又依赖 A,但是 A 又依赖 B,如此往复。这变成了一个循环,不知道如何不经过其中一个组件而完全解析出另一个组件。为了解决这个问题,我们需要给模块系统一个点,在那里"A 反正是需要 B 的,但是我们不需要先解析 B。"
在我们的例子中,把 <tree-folder>
组件设为了那个点。我们知道那个产生悖论的子组件是 <tree-folder-contents>
组件,所以我们会等到生命周期钩子 beforeCreate
时去注册它:
beforeCreate: function () {
this.$options.components.TreeFolderContents = require('./tree-folder-contents.vue').default
}
或者,在本地注册组件的时候,你可以使用 webpack 的异步 import
:
components: {
TreeFolderContents: () => import('./tree-folder-contents.vue')
}
这样问题就解决了!