指南

render 函数 & jsx

基础

在绝大多数情况下，Vue 推荐你使用模板来组织构建 HTML。然而在一些场景下，你确实需要完整的 JavaScript 编程能力。作为模板的替代增强，你可以使用render 函数，它更接近编译器。

让我们深入一个例子，其中，使用 render 函数是比较推荐的方式。假设你要生成固定的标题：

<h1>
  <a name="hello-world" href="#hello-world">
    Hello world!
  </a>
</h1>

对于以上 HTML，你决定要使用如下组件接口：

<anchored-heading :level="1">Hello world!</anchored-heading>

当你开始创建一个只根据 level prop 生成标题的组件时，你会很快想到这样实现：

<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>
Vue.component('anchored-heading', {
  template: '#anchored-heading-template',
  props: {
    level: {
      type: Number,
      required: true
    }
  }
})

在这种场景中，并不适合使用模板。不仅会很繁琐，而且要在每个不同级的 h 标签中重复 <slot></slot>，并且在其中添加固定元素时也必须做同样的事。

虽然大多数组件中都非常适合使用模板，但是在这里明显是一种特殊场景。因此，让我们尝试使用 render 函数来重写上面的示例：

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。

nodes, trees 和 virtual DOM

在我们深入 render 函数之前，略微了解浏览器的工作原理是比较重要的事情。以如下 HTML 为例：

<div>
  <h1>My title</h1>
  Some text content
  <!-- TODO: Add tagline  -->
</div>

在浏览器读取这段代码时，会构建一个 “DOM 节点”树(tree of “DOM nodes”)，以帮助浏览器跟踪所有情况，就像通过创建一个家谱树，来跟踪一个大家族。

对于以上 HTML，其 DOM 节点树如下：

DOM Tree Visualization

每个元素都是一个节点。每一段文字都是一个节点。甚至注释也都是节点！节点只是页面的一部分。正如在一棵家谱树中一样，每个节点都可以有子节点（也就是说，每个节点都可以包含多个子节点）。

有效地更新所有这些节点可能是很困难的，但幸运的是，你无需手动执行。相反，只需在 Vue 模板中，在页面中添加你需要用到的 HTML：

<h1>{{ blogTitle }}</h1>

或者通过一个 render 函数：

render: function (createElement) {
  return createElement('h1', this.blogTitle)
}

在这两种场景中，Vue 会自动保持页面更新，更确切地说，在 blogTitle 修改时，也同样能够及时更新。

virtual DOM

Vue 通过实现一个 virtual DOM，来跟踪那些「真正需要对 DOM 所做的修改」。仔细看看这一行：

return createElement('h1', this.blogTitle)

createElement 实际返回的是什么呢？准确地说，返回的并非一个真正的 DOM 元素。可能更确切地说，应该将其命名为 createNodeDescription（译注：createNodeDescription，创建节点描述），包含「哪些节点应该由 Vue 渲染在页面上」的相关描述信息，也包括所有子节点的相关描述。我们将以上这个节点描述称为 “virtual node”（译注：virtual node，虚拟节点），通常缩写为 VNode。”virtual DOM” 就是由 Vue 组件树构建出来的，被称为整个 VNodes 树。

createElement 参数

接下来你必须熟悉的事情是，如何在 createElement 函数中使用模板功能。以下是 createElement 接受的参数：

// @returns {VNode}
createElement(
  // {String | Object | Function}
  // HTML 标签名称，或组件选项对象，
  // 或一个最终解析(resolve)为 HTML 标签名称或组件选项对象的异步函数。必选参数。
  'div',

  // {Object}
  // 一个数据对象，
  // 和模板中用到的属性相对应。可选参数。
  {
    // （详情请看下一节）
  },

  // {String | Array}
  // 子虚拟 DOM 节点(children VNode)组成，或使用 `createElement()` 生成，
  // 或使用字符串的“文本虚拟 DOM 节点(text VNode)”。可选参数。
  [
    'Some text comes first.',
    createElement('h1', 'A headline'),
    createElement(MyComponent, {
      props: {
        someProp: 'foobar'
      }
    })
  ]
)

深入了解数据对象(The Data Object In-Depth)

需要注意的一点：类似于 v-bind:class 和 v-bind:style 在模板中有着特殊的处理，下面这些字段(field)都处于 VNode 数据对象的顶层(top-level)。此对象还允许绑定普通的 HTML 属性和 DOM 属性，如 innerHTML（这将替换为 v-html 指令）：

{
  // 和 `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 值是否为 enter 键值。
  on: {
    click: this.clickHandler
  },
  // 仅对于组件，
  // 用于监听原生事件，而不是组件内部
  // 使用 `vm.$emit` 触发的事件。
  nativeOn: {
    click: this.nativeClickHandler
  },
  // 自定义指令。
  // 注意，由于 Vue 会追踪旧值，
  // 所以不能对`绑定`的`旧值`设值
  directives: [
    {
      name: 'my-custom-directive',
      value: '2',
      expression: '1 + 1',
      arg: 'foo',
      modifiers: {
        bar: true
      }
    }
  ],
  // 作用域插槽(scoped slot)的格式如下
  // { name: props => VNode | Array<VNode> }
  scopedSlots: {
    default: props => createElement('span', props.text)
  },
  // 如果此组件是另一个组件的子组件，
  // 需要为插槽(slot)指定名称
  slot: 'name-of-slot',
  // 其他特殊顶层(top-level)属性
  key: 'myKey',
  ref: 'myRef'
}

完整示例

有了这些知识，我们现在就可以完成开始想实现的组件：

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) {
    // create kebabCase 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
    }
  }
})

限制(Constraints)

VNodes 必须唯一

组件树中的所有 VNode 必须是唯一的。也就是说，以下 render 函数无效：

render: function (createElement) {
  var myParagraphVNode = createElement('p', 'hi')
  return createElement('div', [
    // 哟 - VNode 重复！
    myParagraphVNode, myParagraphVNode
  ])
}

如果你真的需要多次重复相同的元素/组件，你可以使用工厂函数来实现。例如，下面的 render 函数，完美有效地渲染了 20 个相同的段落。

render: function (createElement) {
  return createElement('div',
    Array.apply(null, { length: 20 }).map(function () {
      return createElement('p', 'hi')
    })
  )
}

使用原生 JavaScript 的替换模板功能(Replacing Template Features with Plain JavaScript)

v-if and v-for

无论什么功能，都可以在原生 JavaScript 中轻松实现，所以 Vue 的 render 函数无需提供专用的替代方案。例如，在模板中使用 v-if 和 v-for：

<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 来实现：

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 对标的功能 - 你必须自己实现逻辑：

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 相比较，这也可以更好地控制交互细节。

事件 & 按键修饰符(Event & Key Modifiers)

对于 .passive, .capture 和 .once 这样的事件修饰符, Vue 提供了用于 on 的前缀:

修饰符 前缀
.passive &
.capture !
.once ~
.capture.once 或
.once.capture		 ~!

示例:

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:
.enter, .13		 if (event.keyCode !== 13) return (change 13 to another key code for other key modifiers)
Modifiers Keys:
.ctrl, .alt, .shift, .meta		 if (!event.ctrlKey) return (change ctrlKey to altKey, shiftKey, or metaKey, respectively)

这里是所有修饰符一起使用的例子:

on: {
  keyup: function (event) {
    // 如果触发事件的元素不是事件绑定的元素
    // 则返回
    if (event.target !== event.currentTarget) return
    // 如果按下去的不是 enter 键或者
    // 没有同时按下 shift 键
    // 则返回
    if (!event.shiftKey || event.keyCode !== 13) return
    // 阻止事件冒泡
    event.stopPropagation()
    // 阻止该元素默认的 keyup 事件
    event.preventDefault()
    // ...
  }
}

slots

使用this.$slots访问静态插槽内容作为 VNode 数组：

render: function (createElement) {
  // <div><slot></slot></div>
  return createElement('div', this.$slots.default)
}

使用 this.$scopedSlots 访问作用域插槽作为返回 VNodes 的函数:

props: ['message'],
render: function (createElement) {
  // `<div><slot :text="message"></slot></div>`
  return createElement('div', [
    this.$scopedSlots.default({
      text: this.message
    })
  ])
}

使用 render 函数传递作用域插槽到子组件，使用 VNode 数据中的 scopedSlots 关键字：

render: function (createElement) {
  return createElement('div', [
    createElement('child', {
      // pass scopedSlots in the data object
      // in the form of { name: props => VNode | Array<VNode> }
      scopedSlots: {
        default: function (props) {
          return createElement('span', props.text)
        }
      }
    })
  ])
}

JSX

如果你写了很多 render 函数，可能会觉得痛苦：

createElement(
  'anchored-heading', {
    props: {
      level: 1
    }
  }, [
    createElement('span', 'Hello'),
    ' world!'
  ]
)

特别是模板如此简单的情况下：

<anchored-heading :level="1">
  <span>Hello</span> world!
</anchored-heading>

这就是会有一个 Babel plugin 插件，用于在 Vue 中使用 JSX 语法的原因，它可以让我们回到于更接近模板的语法上。

import AnchoredHeading from './AnchoredHeading.vue'

new Vue({
  el: '#demo',
  render: function (h) {
    return (
      <AnchoredHeading level={1}>
        <span>Hello</span> world!
      </AnchoredHeading>
    )
  }
})

将 h 作为 createElement 的别名是 Vue 生态系统中的一个通用惯例，实际上也是 JSX 所要求的，如果在作用域中 h 失去作用， 在应用中会触发报错。

更多关于 JSX 映射到 JavaScript，阅读 使用文档。

函数式组件

前面我们创建的锚点标题组件比较简单，没有管理维护状态，或者 watch 任何传递给它的状态，也没有生命周期方法。它只是一个接收 props 的函数。

在这个例子中，我们将组件记为 functional，这意味它无状态（没有 响应式 data)），无实例（没有 this 上下文）。一个函数式组件就像这样：

Vue.component('my-component', {
  functional: true,
  // 为了弥补缺少的实例
  // 我们提供了第二个参数 context 作为上下文
  render: function (createElement, context) {
    // ...
  },
  // props 是可选项
  props: {
    // ...
  }
})

注意：在 2.3.0 之前的版本中，如果一个函数式组件想要接收 props，则 props 选项是必选项。而在 2.3.0+ 版本中，你可以省略 props 选项，所有组件节点上的发现的属性，都会被隐式地提取为 props。

在 2.5.0+ 版本，如果你使用的是单文件组件，则可以通过如下方式，声明基于模板的函数式组件：

<template functional>
</template>

组件需要的一切都是通过 context 传递，包括：

在添加 functional: true 之后，修改下锚点标题组件的 render 函数，需要添加 context 参数，将 this.$slots.default 修改为 context.children，然后将 this.level 修改为 context.props.level。

由于函数式组件只是函数，因此渲染性能开销也低很多。然而，由于缺少持久性实例，意味着它们不会出现在 Vue devtools 的组件树中。

在作为容器组件(wrapper component)时它们也同样非常有用。例如，当你需要实现如下需求：

以下是一个 smart-list 组件示例，我们能将它的行为委派给更加具体的组件中，这取决于向其传入的 prop：

var EmptyList = { /* ... */ }
var TableList = { /* ... */ }
var OrderedList = { /* ... */ }
var UnorderedList = { /* ... */ }

Vue.component('smart-list', {
  functional: true,
  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
    )
  },
  props: {
    items: {
      type: Array,
      required: true
    },
    isOrdered: Boolean
  }
})

向子元素或子组件传递属性和事件

在普通组件中，非 Prop 属性将自动添加到组件的根元素中，并会替换或智能合并具有相同名称的所有已有属性。

然而，在函数式组件中，则要求你显式定义该行为：

Vue.component('my-functional-button', {
  functional: true,
  render: function (createElement, context) {
    // 清晰明确地传入所有属性(attribute)、事件监听器(event listener) 和 children。
    return createElement('button', context.data, context.children)
  }
})

向 createElement 传递 context.data 作为第二个参数，我们就把 my-functional-button 组件上所有的属性和事件监听器都向下进行传递。这是非常明确的行为，事实上，这些事件甚至不需要添加 .native 修饰符。

如果你在使用基于模板的函数式组件，那么你还必须手动添加属性和监听器。由于我们可以访问到其独立的上下文内容，所以我们可以使用 data.attrs 来延续传递所有 HTML 属性，以及使用 listeners（也就是 data.on 的别名）来延续传递所有事件监听器。

<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 的函数式组件呢？

<my-functional-component>
  <p slot="foo">
    first
  </p>
  <p>second</p>
</my-functional-component>

对于这个组件，children 会给你两个 p 标签，而 slots().default 只会传递第二个匿名 p 标签，slots().foo 会传递第一个具名 p 标签。同时具有 children 和 slots()，可以帮助你进行明确选择，使组件确定是通过一个 slot 系统处理，还是直接延续传递 children，委派给其他组件去负责处理。

模板编译

你或许很有兴趣了解 Vue 模板实际编译为 render 函数的过程。这是一个实现细节，通常不需要关心，但如果你想看看特定模板的功能是怎样被编译的，你会发现会非常有趣。下面是一个使用 Vue.compile 实时编译模板字符串的简单示例：

{{ result.render }}
_m({{ index }}): {{ fn }}
{{ result.staticRenderFns }}
{{ result }}

原文：https://vuejs.org/v2/guide/render-function.html

← 自定义指令 插件 →
发现错误？想参与编辑？ 在 GitHub 上编辑此页！