多应用+插件架构,代码干净,二开方便,首家独创一键云编译技术,文档视频完善,免费商用码云13.8K 广告
## 基础 Vue 推荐在绝大多数情况下使用 template 来创建你的 HTML。然而在一些场景中,你真的需要 JavaScript 的完全编程的能力,这时你可以用 **render 函数**,它比 template 更接近编译器。 让我们深入一个简单的例子,这个例子里 `render` 函数很实用。假设我们要生成锚点标题 (anchored headings): ``` html <h1> <a name="hello-world" href="#hello-world"> Hello world! </a> </h1> ``` 对于上面的 HTML,我们决定这样定义组件接口: ``` html <anchored-heading :level="1">Hello world!</anchored-heading> ``` 当我们开始写一个只能通过 `level` prop 动态生成 heading 标签的组件时,你可能很快想到这样实现: ``` html <script type="text/x-template" id="anchored-heading-template"> <h1 v-if="level === 1"> <slot></slot> </h1> <h2 v-else-if="level === 2"> <slot></slot> </h2> <h3 v-else-if="level === 3"> <slot></slot> </h3> <h4 v-else-if="level === 4"> <slot></slot> </h4> <h5 v-else-if="level === 5"> <slot></slot> </h5> <h6 v-else-if="level === 6"> <slot></slot> </h6> </script> ``` ``` js Vue.component('anchored-heading', { template: '#anchored-heading-template', props: { level: { type: Number, required: true } } }) ``` 在这种场景中使用 template 并不是最好的选择:首先代码冗长,为了在不同级别的标题中插入锚点元素,我们需要重复地使用 `<slot></slot>`。 虽然模板在大多数组件中都非常好用,但是在这里它就不是很简洁的了。那么,我们来尝试使用 `render` 函数重写上面的例子: ``` js Vue.component('anchored-heading', { render: function (createElement) { return createElement( 'h' + this.level, // 标签名称 this.$slots.default // 子元素数组 ) }, props: { level: { type: Number, required: true } } }) ``` 简单清晰很多!简单来说,这样代码精简很多,但是需要非常熟悉 Vue 的实例属性。在这个例子中,你需要知道,向组件中传递不带 `slot` 特性的子元素时,比如 `anchored-heading` 中的 `Hello world!`,这些子元素被存储在组件实例中的 `$slots.default` 中。如果你还不了解,**在深入 render 函数之前推荐阅读[实例属性 API](../api/#实例属性)。** ## 节点、树以及虚拟 DOM 在深入渲染函数之前,了解一些浏览器的工作原理是很重要的。以下面这段 HTML 为例: ```html <div> <h1>My title</h1> Some text content <!-- TODO: 添加标签行 --> </div> ``` 当浏览器读到这些代码时,它会建立一个[“DOM 节点”树](https://javascript.info/dom-nodes)来保持追踪,如同你会画一张家谱树来追踪家庭成员的发展一样。 HTML 的 DOM 节点树如下图所示: ![DOM Tree Visualization](https://box.kancloud.cn/f70b86bfbbfe1962dc5d6125105f1122_1352x860.png) 每个元素都是一个节点。每片文字也是一个节点。甚至注释也都是节点。一个节点就是页面的一个部分。就像家谱树一样,每个节点都可以有孩子节点 (也就是说每个部分可以包含其它的一些部分)。 高效的更新所有这些节点会是比较困难的,不过所幸你不必再手动完成这个工作了。你只需要告诉 Vue 你希望页面上的 HTML 是什么,这可以是在一个模板里: ```html <h1>{{ blogTitle }}</h1> ``` 或者一个渲染函数里: ``` js render: function (createElement) { return createElement('h1', this.blogTitle) } ``` 在这两种情况下,Vue 都会自动保持页面的更新,即便 `blogTitle` 发生了改变。 ### 虚拟 DOM Vue 通过建立一个**虚拟 DOM** 对真实 DOM 发生的变化保持追踪。请仔细看这行代码: ``` js return createElement('h1', this.blogTitle) ``` `createElement` 到底会返回什么呢?其实不是一个*实际的* DOM 元素。它更准确的名字可能是 `createNodeDescription`,因为它所包含的信息会告诉 Vue 页面上需要渲染什么样的节点,及其子节点。我们把这样的节点描述为“虚拟节点 (Virtual Node)”,也常简写它为“VNode”。“虚拟 DOM”是我们对由 Vue 组件树建立起来的整个 VNode 树的称呼。 ## `createElement` 参数 接下来你需要熟悉的是如何在 `createElement` 函数中生成模板。这里是 `createElement` 接受的参数: ``` js // @returns {VNode} createElement( // {String | Object | Function}  // 一个 HTML 标签字符串,组件选项对象,或者 // 解析上述任何一种的一个 async 异步函数。必需参数。  'div', // {Object}  // 一个包含模板相关属性的数据对象 // 你可以在 template 中使用这些特性。可选参数。 {    // (详情见下一节) }, // {String | Array}  // 子虚拟节点 (VNodes),由 `createElement()` 构建而成, // 也可以使用字符串来生成“文本虚拟节点”。可选参数。 [ '先写一些文字', createElement('h1', '一则头条'), createElement(MyComponent, { props: { someProp: 'foobar' } }) ] ) ``` ### 深入 data 对象 有一点要注意:正如在模板语法中,`v-bind:class` 和 `v-bind:style`,会被特别对待一样,在 VNode 数据对象中,下列属性名是级别最高的字段。该对象也允许你绑定普通的 HTML 特性,就像 DOM 属性一样,比如 `innerHTML` (这会取代 `v-html` 指令)。 ``` js { // 和`v-bind:class`一样的 API // 接收一个字符串、对象或字符串和对象组成的数组 'class': { foo: true, bar: false }, // 和`v-bind:style`一样的 API // 接收一个字符串、对象或对象组成的数组 style: { color: 'red', fontSize: '14px' }, // 普通的 HTML 特性 attrs: { id: 'foo' }, // 组件 props props: { myProp: 'bar' }, // DOM 属性 domProps: { innerHTML: 'baz' }, // 事件监听器基于 `on` // 所以不再支持如 `v-on:keyup.enter` 修饰器 // 需要手动匹配 keyCode。 on: { click: this.clickHandler },  // 仅用于组件,用于监听原生事件,而不是组件内部使用 // `vm.$emit` 触发的事件。 nativeOn: { click: this.nativeClickHandler },  // 自定义指令。注意,你无法对 `binding` 中的 `oldValue` // 赋值,因为 Vue 已经自动为你进行了同步。  directives: [ { name: 'my-custom-directive', value: '2', expression: '1 + 1', arg: 'foo', modifiers: { bar: true } } ],  // 作用域插槽格式 // { name: props => VNode | Array<VNode> } scopedSlots: { default: props => createElement('span', props.text) },  // 如果组件是其他组件的子组件,需为插槽指定名称  slot: 'name-of-slot', // 其他特殊顶层属性 key: 'myKey', ref: 'myRef', // 如果你在渲染函数中向多个元素都应用了相同的 ref 名, // 那么 `$refs.myRef` 会变成一个数组。 refInFor: true } ``` ### 完整示例 有了这些知识,我们现在可以完成我们最开始想实现的组件: ``` js var getChildrenTextContent = function (children) { return children.map(function (node) { return node.children ? getChildrenTextContent(node.children) : node.text }).join('') } Vue.component('anchored-heading', { render: function (createElement) {    // 创建 kebab-case 风格的ID   var headingId = getChildrenTextContent(this.$slots.default) .toLowerCase() .replace(/\W+/g, '-') .replace(/(^\-|\-$)/g, '') return createElement( 'h' + this.level, [ createElement('a', { attrs: { name: headingId, href: '#' + headingId } }, this.$slots.default) ] ) }, props: { level: { type: Number, required: true } } }) ``` ### 约束 #### VNodes 必须唯一 组件树中的所有 VNodes 必须是唯一的。这意味着,下面的 render function 是无效的: ``` js render: function (createElement) { var myParagraphVNode = createElement('p', 'hi') return createElement('div', [    // 错误-重复的 VNodes    myParagraphVNode, myParagraphVNode ]) } ``` 如果你真的需要重复很多次的元素/组件,你可以使用工厂函数来实现。例如,下面这个例子 render 函数完美有效地渲染了 20 个相同的段落: ``` js render: function (createElement) { return createElement('div', Array.apply(null, { length: 20 }).map(function () { return createElement('p', 'hi') }) ) } ``` ## 使用 JavaScript 代替模板功能 ### `v-if` 和 `v-for` 只要在原生的 JavaScript 中可以轻松完成的操作,Vue 的 render 函数就不会提供专有的替代方法。比如,在 template 中使用的 `v-if` 和 `v-for`: ``` html <ul v-if="items.length"> <li v-for="item in items">{{ item.name }}</li> </ul> <p v-else>No items found.</p> ``` 这些都会在 render 函数中被 JavaScript 的 `if`/`else` 和 `map` 重写: ``` js props: ['items'], render: function (createElement) { if (this.items.length) { return createElement('ul', this.items.map(function (item) { return createElement('li', item.name) })) } else { return createElement('p', 'No items found.') } } ``` ### `v-model` render 函数中没有与 `v-model` 的直接对应 - 你必须自己实现相应的逻辑: ``` js props: ['value'], render: function (createElement) { var self = this return createElement('input', { domProps: { value: self.value }, on: { input: function (event) { self.$emit('input', event.target.value) } } }) } ``` 这就是深入底层的代价,但与 `v-model` 相比,这可以让你更好地控制交互细节。 ### 事件 & 按键修饰符 对于 `.passive`、`.capture` 和 `.once`事件修饰符, Vue 提供了相应的前缀可以用于 `on`: | Modifier(s) | Prefix | | ------ | ------ | | `.passive` | `&` | | `.capture` | `!` | | `.once` | `~` | | `.capture.once` or<br>`.once.capture` | `~!` | 例如: ```javascript on: { '!click': this.doThisInCapturingMode, '~keyup': this.doThisOnce, '~!mouseover': this.doThisOnceInCapturingMode } ``` 对于其他的修饰符,前缀不是很重要,因为你可以在事件处理函数中使用事件方法: | Modifier(s) | Equivalent in Handler | | ------ | ------ | | `.stop` | `event.stopPropagation()` | | `.prevent` | `event.preventDefault()` | | `.self` | `if (event.target !== event.currentTarget) return` | | Keys:<br>`.enter`, `.13` | `if (event.keyCode !== 13) return` (change `13` to [another key code](http://keycode.info/) for other key modifiers) | | Modifiers Keys:<br>`.ctrl`, `.alt`, `.shift`, `.meta` | `if (!event.ctrlKey) return` (change `ctrlKey` to `altKey`, `shiftKey`, or `metaKey`, respectively) | 这里是一个使用所有修饰符的例子: ```javascript on: { keyup: function (event) {    // 如果触发事件的元素不是事件绑定的元素    // 则返回    if (event.target !== event.currentTarget) return    // 如果按下去的不是 enter 键或者    // 没有同时按下 shift 键    // 则返回    if (!event.shiftKey || event.keyCode !== 13) return    // 阻止 事件冒泡   event.stopPropagation()    // 阻止该元素默认的 keyup 事件    event.preventDefault() // ... } } ``` ### 插槽 你可以通过 [`this.$slots`](../api/#vm-slots) 访问静态插槽的内容,得到的是一个 VNodes 数组: ``` js render: function (createElement) { // `<div><slot></slot></div>` return createElement('div', this.$slots.default) } ``` 也可以通过 [`this.$scopedSlots`](../api/#vm-scopedSlots) 访问作用域插槽,得到的是一个返回 VNodes 的函数: ``` js props: ['message'], render: function (createElement) { // `<div><slot :text="message"></slot></div>` return createElement('div', [ this.$scopedSlots.default({ text: this.message }) ]) } ``` 如果要用渲染函数向子组件中传递作用域插槽,可以利用 VNode 数据对象中的 `scopedSlots` 域: ``` js render: function (createElement) { return createElement('div', [ createElement('child', { // 在数据对象中传递 `scopedSlots` // 格式:{ name: props => VNode | Array<VNode> } scopedSlots: { default: function (props) { return createElement('span', props.text) } } }) ]) } ``` ## JSX 如果你写了很多 `render` 函数,可能会觉得下面这样的代码写起来很痛苦: ``` js createElement( 'anchored-heading', { props: { level: 1 } }, [ createElement('span', 'Hello'), ' world!' ] ) ``` 特别是模板如此简单的情况下: ``` html <anchored-heading :level="1"> <span>Hello</span> world! </anchored-heading> ``` 这就是为什么会有一个 [Babel 插件](https://github.com/vuejs/babel-plugin-transform-vue-jsx),用于在 Vue 中使用 JSX 语法,它可以让我们回到更接近于模板的语法上。 ``` js import AnchoredHeading from './AnchoredHeading.vue' new Vue({ el: '#demo', render: function (h) { return ( <AnchoredHeading level={1}> <span>Hello</span> world! </AnchoredHeading> ) } }) ``` <p class="tip">将 `h` 作为 `createElement` 的别名是 Vue 生态系统中的一个通用惯例,实际上也是 JSX 所要求的,如果在作用域中 `h` 失去作用,在应用中会触发报错。</p> 更多关于 JSX 映射到 JavaScript,阅读 [使用文档](https://github.com/vuejs/babel-plugin-transform-vue-jsx#usage)。 ## 函数式组件 之前创建的锚点标题组件是比较简单,没有管理或者监听任何传递给他的状态,也没有生命周期方法。它只是一个接收参数的函数。 在这个例子中,我们标记组件为 `functional`,这意味它是无状态 (没有[响应式数据](../api/#选项-数据)),无实例 (没有 `this` 上下文)。 一个**函数式组件**就像这样: ``` js Vue.component('my-component', { functional: true, // Props 可选 props: { // ... }, // 为了弥补缺少的实例 // 提供第二个参数作为上下文 render: function (createElement, context) { // ... } }) ``` > 注意:在 2.3.0 之前的版本中,如果一个函数式组件想要接受 props,则 `props` 选项是必须的。在 2.3.0 或以上的版本中,你可以省略 `props` 选项,所有组件上的特性都会被自动解析为 props。 在 2.5.0 及以上版本中,如果你使用了[单文件组件](single-file-components.html),那么基于模板的函数式组件可以这样声明: ``` html <template functional> </template> ``` 组件需要的一切都是通过上下文传递,包括: - `props`:提供所有 prop 的对象 - `children`: VNode 子节点的数组 - `slots`: 返回所有插槽的对象的函数 - `data`:传递给组件的[数据对象](#深入-data-对象),作为 `createElement` 的第二个参数传入组件 - `parent`:对父组件的引用 - `listeners`: (2.3.0+) 一个包含了所有在父组件上注册的事件侦听器的对象。这只是一个指向 `data.on` 的别名。 - `injections`: (2.3.0+) 如果使用了 [`inject`](../api/#provide-inject) 选项,则该对象包含了应当被注入的属性。 在添加 `functional: true` 之后,锚点标题组件的 render 函数之间简单更新增加 `context` 参数,`this.$slots.default` 更新为 `context.children`,之后`this.level` 更新为 `context.props.level`。 因为函数式组件只是一个函数,所以渲染开销也低很多。然而,对持久化实例的缺乏也意味着函数式组件不会出现在 [Vue devtools](https://github.com/vuejs/vue-devtools) 的组件树里。 在作为包装组件时它们也同样非常有用,比如,当你需要做这些时: - 程序化地在多个组件中选择一个 - 在将 children, props, data 传递给子组件之前操作它们。 下面是一个依赖传入 props 的值的 `smart-list` 组件例子,它能代表更多具体的组件: ``` js var EmptyList = { /* ... */ } var TableList = { /* ... */ } var OrderedList = { /* ... */ } var UnorderedList = { /* ... */ } Vue.component('smart-list', { functional: true, props: { items: { type: Array, required: true }, isOrdered: Boolean }, render: function (createElement, context) { function appropriateListComponent () { var items = context.props.items if (items.length === 0) return EmptyList if (typeof items[0] === 'object') return TableList if (context.props.isOrdered) return OrderedList return UnorderedList } return createElement( appropriateListComponent(), context.data, context.children ) } }) ``` ### 向子元素或子组件传递特性和事件 在普通组件中,没有被定义为 prop 的特性会自动添加到组件的根元素上,将现有的同名特性替换或与其[智能合并](class-and-style.html)。 然而函数式组件要求你显式定义该行为: ```js Vue.component('my-functional-button', { functional: true, render: function (createElement, context) { // 完全透明的传入任何特性、事件监听器、子结点等。 return createElement('button', context.data, context.children) } }) ``` 向 `createElement` 通过传入 `context.data` 作为第二个参数,我们就把 `my-functional-button` 上面所有的特性和事件监听器都传递下去了。事实上这是非常透明的,那些事件甚至并不要求 `.native` 修饰符。 如果你使用基于模板的函数式组件,那么你还需要手动添加特性和监听器。因为我们可以访问到其独立的上下文内容,所以我们可以使用 `data.attrs` 传递任何 HTML 特性,也可以使用 `listeners` *(即 `data.on` 的别名)* 传递任何事件监听器。 ```html <template functional> <button class="btn btn-primary" v-bind="data.attrs" v-on="listeners" > <slot/> </button> </template> ``` ### `slots()` 和 `children` 对比 你可能想知道为什么同时需要 `slots()` 和 `children`。`slots().default` 不是和 `children` 类似的吗?在一些场景中,是这样,但是如果是函数式组件和下面这样的 children 呢? ``` html <my-functional-component> <p slot="foo"> first </p> <p>second</p> </my-functional-component> ``` 对于这个组件,`children` 会给你两个段落标签,而 `slots().default` 只会传递第二个匿名段落标签,`slots().foo` 会传递第一个具名段落标签。同时拥有 `children` 和 `slots()` ,因此你可以选择让组件通过 `slot()` 系统分发或者简单的通过 `children` 接收,让其他组件去处理。 ## 模板编译 你可能有兴趣知道,Vue 的模板实际是编译成了 render 函数。这是一个实现细节,通常不需要关心,但如果你想看看模板的功能是怎样被编译的,你会发现会非常有趣。下面是一个使用 `Vue.compile` 来实时编译模板字符串的简单 demo: