什么是单文件组件?

简言之,单文件组件就是一个文件扩展名为.vuesingle-file-components(SFC)。是Vue.js自定义的一种文件格式,一个.vue文件,就是一个单独的组件,在文件内封装了组件的相关代码:HTMLCSSJS

浏览器本身并不支持.vue文件,所以必须对.vue文件进行加载解析,此时需要vue-loader,类似的loader还有许多,如:html-loader、css-loader、style-loader、babel-loader等。
所以我们开发项目时,通常需要依赖webpack,vite等构建工具;

 

为什么要用单文件组件?

在最早的Vue项目中,我们使用Vue.componnet来直接定义全局组件,使用new Vue(el: '#container')在每个页面内指定一个容器元素,因为后缀为.js,可以直接被浏览器支持;

这种方式通常运作在很多小规模的项目中,只用来加持特定的视图(把Vue当成插件来使用);

Vue.component("counter",{    //1.组件名为"conter"; 2.data 写函数; 3.template 写组件的内容(元素和触发的事件)
   el:"#container",
data:function(){
return {count:0}
},
//template 是模板的意思,在 html 里面是一个可以同时控制多个子元素的父元素。在这里定义了组件的内容
template:'<button v-on:click="count++">点击计算点击次数:{{count}}次</button>'
})

如上所示,这种写法在稍大型的项目中,这种方式的弊端也很明显:

  • 全局定义(Global definitions)强制要求每个component中的命名不能重复;

  • 字符串模板(String templates)缺乏语法高亮,在HTML中有多行的时候,需要用到丑陋的\;

  • 不支持CSS(No CSS Suport)CSS明显被遗漏;

  • 没有构建步骤(No build step)限制只能使用HTML和ES5 Javascript,而不能使用预处理器,如 Pug (formerly Jade) 和 Babel (with ES2015 modules),和 Stylus。;

     

单文件组件(SFC)长啥样?

<template>
 <div class="example">{{ msg }}</div>
</template>
<script>
export default {
 data() {
   return {
     msg: 'Hello world!'
  }
}
}
</script>
<style>
.example {
 color: red;
}
</style>
<custom1>
这里可以是,例如:组件的文档
</custom1>

 

语言块
  • <template>

    • 每个.vue文件最多可同时包含一个顶层<template>块。

    • 其中的内容会被提取出来并传递给@vue/compiler-com,预编译为Javascript的渲染函数,并附属到导出的组件上作为其render选项;

  • <script>

    • 每个vue文件最多可同时包含一个script块(不包括<script setup>);

    • 该脚本将作为ES Module 来执行;

    • 其默认导出的内容应该是Vue组件选项对象,它要么是一个普通的对象,要么是defineComponent的返回值;

  • <script setup>

    • 每个vue文件最多可同时包含一个<script setup>块(不包括<script>);

    • 该脚本会被预处理并作为组件的setup()函数使用,也就是说它会在每个组件实例中执行。

    • <script setup>的顶层绑定会自动暴露给模板。

  • <style>

    • 每个.vue文件最多可同时包含一个<style>块。

    • <style>标签可以通过scopedmodule attribute(更多详情请查看 SFC 样式特性)将样式封装在当前组件内,多个不同封装模式的<style>标签可以在同一个组件张混用;

     

自定义块

为了满足任何项目特定的需求,.vue文件中还可以包含额外的自定义块,例如<docs>块。自定义块的一些真实场景的案例包括:

  • Gridsome:<page-query>

  • vite-plugin-vue-gql:<gql>

  • vue-i18n:<i18n>

对 Custom Block 的处理依赖于工具——如果你想要构建自己的自定义块集成,更多详情请查看 SFC 工具

 

自动的name推断

SFC 在下列情况会依据它的文件名来自动推断组件名称:

  • 开发环境警告格式化

  • DevTools 检查

  • 递归的自引用。例如:名为FooBar的文件可以在模板中用<FooBar/>引用它自己。这种方式比明确注册或引入的组件的优先级要低

 

预处理

块可以使用lang attribute 声明预处理语言。最常见的场景就是在<script>块中使用 TypeScript:

<script lang="ts">
// 使用 TypeScript
</script>

lang 可以用于任何块——例如可以在<script>中使用 Sass 以及在<template>中使用 Pug:

<template lang="pug">
p {{ msg }}
</template>

<style lang="scss">
$primary-color: #333;
 body {
   color: $primary-color;
}
</style>

注意,基于不同的工具链,预处理器的集成方式有所不同。查看相关文档以获取示例:

  • Vite

  • Vue CLI

  • webpack + vue-loader

 

文件分离——src引入

如果你倾向于将*.vue组件拆分为多个文件,可以使用src attribute 来引入外部的文件作为语言块:

<template src="./template.html"></template>
<style src="./style.css"></style>
<script src="./script.js"></script>

注意src引入所需遵循的路径解析规则与webpack模块请求一致,即:

  • 相对路径需要以./开头。

  • 你可以从npm依赖中引入资源:

<!-- 从已安装的 "todomvc-app-css" npm 包中引入文件 -->
<style src="todomvc-app-css/index.css">

src 引入也能用于自定义块,例如:

<unit-test src="./unit-test.js"></unit-test>

 

注释

在每个块中,注释应该使用相应语言(HTML, CSS, JavaScript, Pug,等等)的语法。对于顶层的注释而言,使用 HTML 注释语法:<!--这里是注释内容-->