你也許不知道的Vuejs - 單檔案元件

by yugasun from yugasun.com/post/you-ma… 本文可全文轉載，但需要保留原作者和出處。

為什麼需要單檔案元件

在之前的例項中，我們都是通過 Vue.component 或者 components 屬性的方式來定義元件，這種方式在很多中小規模的專案中還好，但在複雜的專案中，下面這些缺點就非常明顯了：

字串模板：缺乏高亮，書寫麻煩，特別是 HTML 多行的時候，雖然可以將模板寫在 html 檔案中，但是侵入性太強，不利於元件解耦分離。 不支援CSS：意味著當 HTML 和 JavaScript 元件化時，CSS明顯被遺漏了 沒有構建步驟：限制只能使用 HTML 和 ES5 JavaScript，而不能使用前處理器。

Vuejs 提供的副檔名為 .vue 的 單檔案元件 為以上所有問題提供瞭解決方案。

初識單檔案元件

還是利用 工欲善其事必先利其器 中的原始碼，在 src 目錄下建立 hello.vue 檔案，內容如下：

<template>
  <h2>{{ msg }}</h2>
</template>
<script>
export default {
  data () {
    return {
      msg: 'Hello Vue.js 單檔案元件~'
    }
  }
}
</script>
<style>
h2 {
  color: green;
}
</style>
複製程式碼

然後在 app.js 中引入使用：

// ES6 引入模組語法
import Vue from 'vue';
import hello from './hello.vue';

new Vue({
  el: "#app",
  template: '<hello/>',
  components: {
    hello
  }
});
複製程式碼

此時專案是沒法執行的，因為 .vue 檔案 webpack 是沒法是別的，它需要對應的 vue-loader 來處理才行，而且細心的朋友會發現 hello.vue 中用到了 ES6 語法，此時就需要用到相應的語法轉化 loader 將 ES6 轉化成主流瀏覽器相容的 ES5 語法，這裡就需要用到官方推薦的 babel 工具了。先安裝需要的 loader:

# hello.vue 檔案中使用了 css，所以需要 css-loader 來處理，vue-loader 會自動呼叫
npm install vue-loader css-loader babel-loader babel-core babel-preset-env --save-dev
複製程式碼

有的人疑惑只是使用 babel-loader 為什麼還需要安裝後面這麼多工具呢，這是因為很多工具都是獨立的，loader 只是為了配合 webpack 使用的橋樑，而這裡 babel-core 和 babel-preset-env 才是實現 ES6 到 ES5 的核心。

我們再修改 webpack.config.js 配置如下：

module.exports = {
  // ...
  module: {
    // 這裡用來配置處理不同字尾檔案所使用的loader
    rules: [
      {
        test: /.vue$/,
        loader: 'vue-loader'
      },
      {
        test: /.js$/,
        loader: 'babel-loader'
      }
    ]
  }
}
複製程式碼

對於 babel 的配置，我們還需在專案根目錄下剛建立 .babelrc 檔案來配置 Babel presets 和 其他相關外掛，內容如下：

{
  "presets": [ "env" ]
}
複製程式碼

但是雖然雖然都配置好了，專案還是還是會報錯，報如下錯誤：

ERROR in ./src/hello.vue
Module build failed: Error: Cannot find module 'vue-template-compiler'
複製程式碼

有人就不高興了，明明是按照官方提示安裝了依賴，並正確的進行配置，為什麼還是會報錯呢？遇到錯誤不要怕，先閱讀下錯誤是什麼，很容易發現，是因為 Cannot find module 'vue-template-compiler'，這是因為 vue-loader 在處理 .vue 檔案時，還需要依賴 vue-template-compiler 工具來處理。

剛開始我不知道官方為什麼沒有直接告訴使用者需要安裝這個依賴，通過閱讀 vue-loader 才明白其 package.json 檔案中是將 vue-template-compiler 和 css-loader 作為 peerDependencies，而 peerDependencies 在安裝的時候，並不會自動安裝（npm@3.0+），只會給出相關警告，所以這個需要我們手動安裝的，當然在 .vue 檔案中如果需要寫 CSS，也必須用到 css-loader，這個也是在 peerDependencies 中。相關討論：https://github.com/vuejs/vue-loader/issues/1158

知道問題了，直接安裝下就可以了：

npm install vue-template-compiler css-loader --save-dev
複製程式碼

再次執行專案，頁面中出現了我們的內容，並沒報錯，ok，大功告成~

使用前處理器

我們已經學會在 .vue 中寫 css 了，那麼如果使用 sass 前處理器呢？首先安裝上篇文章中提到的模組：

npm install sass-loader node-sass --save-dev
複製程式碼

配置只需兩步：

1. 修改 webpack.config.js 中 vue-loader 配置

  module.exports = {
    // ...
    module: {
      // 這裡用來配置處理不同字尾檔案所使用的loader
      rules: [
        {
          test: /.vue$/,
          loader: 'vue-loader',
          options: {
            loaders: {
              // 這裡也可以使用連寫方式，但是不利於自定義話引數配置
              // scss: 'vue-style-loader!css-loader!sass-loader'
              scss: [
                {
                  loader: 'vue-style-loader'
                },
                {
                  loader: 'css-loader'
                },
                {
                  loader: 'sass-loader'
                }
              ]
            }
          }
        },
        // ...
      ]
    }
  }

複製程式碼

2. 給 .vue 檔案中的 style 標籤，新增 lang="scss" 屬性。

配置完後，就可以再 .vue 檔案中，愉快地編寫 sass 語法了。

載入全域性設定檔案

實際開發中，我們在編寫 sass 檔案時，經常會將全域性的 scss 變數提取出來，放到一個單獨的檔案中，但是這樣就有個問題，每個需要用到的元件，都需要手動 @import './styles/_var.scss' 進來，非常不友好。外掛 sass-resources-loader 就很好地幫我們解決這個問題，先安裝一下：

npm install sass-resources-loader --save-dev
複製程式碼

然後修改 webpack.config.js 檔案中 vue-loader 相關配置：

  // ...
  {
    test: /.vue$/,
    loader: 'vue-loader',
    options: {
      loaders: {
        scss: [
          {
            loader: 'vue-style-loader'
          },
          {
            loader: 'css-loader'
          },
          {
            loader: 'sass-loader'
          },
          // 看這裡，看這裡，看這裡
          {
            loader: 'sass-resources-loader',
            options: {
              // 這裡的resources 屬性是個陣列，可以放多個想全域性引用的檔案
              resources: [resolve('./src/styles/_var.scss')]
            }
          }
        ]
      }
    }
  }
  // ...
複製程式碼

配置就完成了，我們再來測試下。

在 src 目錄下分別建立 hello1.vue 和 hello2.vue 檔案：

<!-- hello1.vue -->
<template>
  <h1>{{ msg }}</h1>
</template>
<script>
export default {
  name: 'hello1',
  data () {
    return {
      msg: 'Hello Vue.js 單檔案元件~'
    }
  }
}
</script>
<style lang="scss">
h1 {
  color: $green;
}
</style>

<!-- hello2.vue -->
<template>
  <h1>{{ msg }}</h1>
</template>
<script>
export default {
  name: 'hello2',
  data () {
    return {
      msg: 'Hello Vue.js 單檔案元件~'
    }
  }
}
</script>
<style lang="scss">
h1 {
  color: $red;
}
</style>
複製程式碼

然後建立一個 styles 目錄，並在其中新建存放全域性變數的檔案 _var.scss:

$green: rgb(41, 209, 41);
$red: rgb(177, 28, 28);
複製程式碼

接下來，在 app.js 中引用兩個元件：

import Vue from 'vue';
import hello1 from './hello1.vue';
import hello2 from './hello2.vue';

new Vue({
  el: "#app",
  template: '<div><hello1/><hello2/></div>',
  components: {
    hello1,
    hello2
  }
});
複製程式碼

重新執行專案就可以了。

有作用域的 style

單檔案元件中為我們提供了一個非常便利的功能，就是當 style 標籤新增 scoped 屬性時，標籤內的樣式將只作用於當前元件中的元素。

接著上面的例子，執行後會發現 hello1.vue 中的 h1 顏色並不是想要的 $green 色，而是被 hello2.vue 中的樣式覆蓋了。於是分別在 hello1.vue 和 hello2.vue 的 style 標籤上新增 scoped 屬性，如下：

<!-- hello1.vue -->
<style lang="scss" scoped>
h1 {
  color: $green;
}
</style>

<!-- hello2.vue -->
<style lang="scss" scoped>
h1 {
  color: $red;
}
</style>
複製程式碼

這樣一來我們的兩個 h1 標籤顏色都顯示正常了。

自定義塊

在編寫某些開源元件時，有時候我們需要同時維護多個元件和元件說明，但是每次修改就要同時修改 .vue 和 .md 檔案，相當麻煩。.vue 檔案的 自定義語言塊 功能，就允許我們將 markdown 說明同時寫進 .vue 檔案中，然後通過外掛將其說明部分單獨提取到相應的 .md 檔案中，這樣就可以同時維護說明文件和元件功能了。

比如我們將 hello1.vue 檔案修改如下：

<docs>
  # 標題
    這是標題內容，[倉庫地址](https://github.com/yugasun/You-May-Not-Know-Vuejs)
  ## 子標題
    這是子標題內容
</docs>
<template>
  <h1>{{ msg }}</h1>
</template>
<script>
export default {
  name: 'hello1',
  data () {
    return {
      msg: 'Hello Vue.js 單檔案元件~'
    }
  }
}
</script>
<style lang="scss" scoped>
h1 {
  color: $green;
}
</style>
複製程式碼

然後修改 webpack.config.js 配置：

const path = require('path');
// 引入相關外掛
const ExtractTextPlugin = require('extract-text-webpack-plugin');

function resolve(dir) {
  return path.resolve(__dirname, dir);
}

module.exports = {
  // 入口檔案
  entry: './src/app.js',
  // 編譯輸出檔案
  output: {
    path: resolve('./'),
    filename: 'build.js'
  },
  resolve: {
    alias: {
      // 因為我們這裡用的是 require 引入方式，所以應該使用vue.common.js/vue.js/vue.min.js
      'vue$': 'vue/dist/vue.common.js'
    }
  },
  devServer: {
    // 這裡定義 webpack-dev-server 開啟的web服務的根目錄
    contentBase: resolve('./')
  },
  module: {
    // 這裡用來配置處理不同字尾檔案所使用的loader
    rules: [
      {
        test: /.vue$/,
        loader: 'vue-loader',
        options: {
          loaders: {
            scss: [
              {
                loader: 'vue-style-loader'
              },
              {
                loader: 'css-loader'
              },
              {
                loader: 'sass-loader'
              },
              {
                loader: 'sass-resources-loader',
                options: {
                  resources: [resolve('./src/styles/_var.scss')]
                }
              }
            ],
            docs: ExtractTextPlugin.extract('raw-loader')
          }
        }
      },
      {
        test: /.js$/,
        loader: 'babel-loader'
      }
    ]
  },
  plugins: [
    new ExtractTextPlugin('docs.md')
  ]
}
複製程式碼

這裡用到了 extract-text-webpack-plugin 匯出 text 外掛，和 raw-loader，分別都安裝下就行。

然後執行構建命令 npm run build，等執行結束，根目錄下會同時生成一個 docs.md 檔案，這就是我們想編寫的說明文件。

總結

關於 單檔案元件 就到這裡，實際上 vue-loader 在處理 .vue 檔案時，還有很多強大的功能，我們這裡只是帶著大家感受一般專案中如何使用，同時解釋了下相關使用原理說明，更多的功能，建議閱讀 vue-loader官方文件 。

原始碼在此

專題目錄

You-May-Not-Know-Vuejs