Vue 组件注册实例详解

本文实例讲述了vue 组件注册。分享给大家供大家参考，具体如下：

1 组件名

在注册一个组件的时候，我们始终需要给它一个名字。比如在全局注册的时候我们已经看到了：

vue.component('my-component-name', { /* ... */ })

该组件名就是 vue.component 的第一个参数。

你给予组件的名字可能依赖于你打算拿它来做什么。当直接在 dom 中使用一个组件 (而不是在字符串模板或单文件组件) 的时候，我们强烈推荐遵循 w3c 规范 中的自定义组件名 (字母全小写且必须包含一个连字符)。这会帮助你避免和当前以及未来的 html 元素相冲突。

你可以在风格指南 中查阅到关于组件名的其它建议。

2 组件名大小写

定义组件名的方式有两种：

使用 kebab-case

vue.component('my-component-name', { /* ... */ })

当使用 kebab-case (短横线分隔命名) 定义一个组件时，你也必须在引用这个自定义元素时使用 kebab-case，例如 <my-component-name>。

使用 pascalcase

vue.component('mycomponentname', { /* ... */ })

当使用 pascalcase (驼峰式命名) 定义一个组件时，你在引用这个自定义元素时两种命名法都可以使用。也就是说 <my-component-name> 和 <mycomponentname> 都是可接受的。注意，尽管如此，直接在 dom (即非字符串的模板) 中使用时只有 kebab-case 是有效的。

3 全局注册

到目前为止，我们只用过 vue.component 来创建组件：

vue.component('my-component-name', {
 // ... 选项 ...
})

这些组件是全局注册的。也就是说它们在注册之后可以用在任何新创建的 vue 根实例 (new vue) 的模板中。比如：

html：

<div id="app">
 <component-a></component-a>
 <component-b></component-b>
 <component-c></component-c>
</div>

js：

vue.component('component-a', { /* ... */ })
vue.component('component-b', { /* ... */ })
vue.component('component-c', { /* ... */ })
new vue({ el: '#app' })

在所有子组件中也是如此，也就是说这三个组件在各自内部也都可以相互使用。

4 局部注册

全局注册往往是不够理想的。比如，如果你使用一个像 webpack 这样的构建系统，全局注册所有的组件意味着即便你已经不再使用一个组件了，它仍然会被包含在你最终的构建结果中。这造成了用户下载的 javascript 的无谓的增加。

在这些情况下，你可以通过一个普通的 javascript 对象来定义组件：

var componenta = { /* ... */ }
var componentb = { /* ... */ }
var componentc = { /* ... */ }

然后在 components 选项中定义你想要使用的组件：

new vue({
 el: '#app'
 components: {
  'component-a': componenta,
  'component-b': componentb
 }
})

对于 components 对象中的每个属性来说，其属性名就是自定义元素的名字，其属性值就是这个组件的选项对象。

注意局部注册的组件在其子组件中不可用。例如，如果你希望 componenta 在 componentb 中可用，则你需要这样写：

var componenta = { /* ... */ }
var componentb = {
 components: {
  'component-a': componenta
 },
 // ...
}

或者如果你通过 babel 和 webpack 使用 es2015 模块，那么代码看起来更像：

import componenta from './componenta.vue'
export default {
 components: {
  componenta
 },
 // ...
}

注意在 es2015+ 中，在对象中放一个类似 componenta 的变量名其实是 componenta: componenta 的缩写，即这个变量名同时是：

• 用在模板中的自定义元素的名称。
• 包含了这个组件选项的变量名。

5 模块系统

如果你没有通过 import/require 使用一个模块系统，也许可以暂且跳过。如果你使用了，那么我们会为你提供一些特殊的使用说明和注意事项。

5.1 在模块系统中局部注册

如果你还在阅读，说明你使用了诸如 babel 和 webpack 的模块系统。在这些情况下，我们推荐创建一个 components 目录，并将每个组件放置在其各自的文件中。

然后你需要在局部注册之前导入每个你想使用的组件。例如，在一个假设的 componentb.js 或 componentb.vue 文件中：

import componenta from './componenta'
import componentc from './componentc'
export default {
 components: {
  componenta,
  componentc
 },
 // ...
}

现在 componenta 和 componentc 都可以在 componentb的模板中使用了。

5.2 基础组件的自动化全局注册

可能你的许多组件只是包裹了一个输入框或按钮之类的元素，是相对通用的。我们有时候会把它们称为基础组件，它们会在各个组件中被频繁的用到。

所以会导致很多组件里都会有一个包含基础组件的长列表：

import basebutton from './basebutton.vue'
import baseicon from './baseicon.vue'
import baseinput from './baseinput.vue'
export default {
 components: {
  basebutton,
  baseicon,
  baseinput
 }
}

而只是用于模板中的一小部分：

<baseinput
 v-model="searchtext"
 @keydown.enter="search"
/>
<basebutton @click="search">
 <baseicon name="search"/>
</basebutton>

幸好如果你使用了 webpack (或在内部使用了 webpack 的 vue cli 3+ )，那么就可以使用 require.context 只全局注册这些非常通用的基础组件。这里有一份可以让你在应用入口文件 (比如 src/main.js) 中全局导入基础组件的示例代码：

import vue from 'vue'
import upperfirst from 'lodash/upperfirst'
import camelcase from 'lodash/camelcase'
const requirecomponent = require.context(
 // 其组件目录的相对路径
 './components',
 // 是否查询其子目录
 false,
 // 匹配基础组件文件名的正则表达式
 /base[a-z]\w+\.(vue|js)$/
)
requirecomponent.keys().foreach(filename => {
 // 获取组件配置
 const componentconfig = requirecomponent(filename)
 // 获取组件的 pascalcase 命名
 const componentname = upperfirst(
  camelcase(
   // 剥去文件名开头的 `'./` 和结尾的扩展名
   filename.replace(/^\.\/(.*)\.\w+$/, '$1')
  )
 )
 // 全局注册组件
 vue.component(
  componentname,
  // 如果这个组件选项是通过 `export default` 导出的，
  // 那么就会优先使用 `.default`，
  // 否则回退到使用模块的根。
  componentconfig.default || componentconfig
 )
})

记住全局注册的行为必须在根 vue 实例 (通过 new vue) 创建之前发生。有一个真实项目情景下的示例。

希望本文所述对大家vue.js程序设计有所帮助。