vue實踐01之vue-cli腳手架

nothing-everything發表於2018-04-03

VUE-CLI實踐

本文主要參考技術胖老師的視訊教程。

建立工程

使用語句vue init <template-name> <project-name>
其中<template-name>：表示模板名稱，vue-cli官方為我們提供了5種模板：

webpack-一個全面的webpack+vue-loader的模板，功能包括熱載入，linting,檢測和CSS擴充套件。
webpack-simple-一個簡單webpack+vue-loader的模板，不包含其他功能，讓你快速的搭建vue的開發環境。
browserify-一個全面的Browserify+vueify 的模板，功能包括熱載入，linting,單元檢測。
browserify-simple-一個簡單Browserify+vueify的模板，不包含其他功能，讓你快速的搭建vue的開發環境。
simple-一個最簡單的單頁應用模板。

vue init webpack demo01

? Project name vuedemo01
? Project description A Vue.js project
? Author jake1036 <jake1036@126.com>
? Vue build standalone
? Install vue-router? Yes
? Use ESLint to lint your code? Yes
? Pick an ESLint preset Standard
? Set up unit tests No
? Setup e2e tests with Nightwatch? No
? Should we run `npm install` for you after the project has been created? (reco
mmended) npm

   vue-cli · Generated "vuedemo01".
複製程式碼

VUE-CLI工程目錄結構

.
|-- build                            // 專案構建(webpack)相關程式碼
|   |-- build.js                     // 生產環境構建程式碼
|   |-- check-version.js             // 檢查node、npm等版本
|   |-- dev-client.js                // 熱過載相關
|   |-- dev-server.js                // 構建本地伺服器
|   |-- utils.js                     // 構建工具相關
|   |-- webpack.base.conf.js         // webpack基礎配置
|   |-- webpack.dev.conf.js          // webpack開發環境配置
|   |-- webpack.prod.conf.js         // webpack生產環境配置
|-- config                           // 專案開發環境配置
|   |-- dev.env.js                   // 開發環境變數
|   |-- index.js                     // 專案一些配置變數
|   |-- prod.env.js                  // 生產環境變數
|   |-- test.env.js                  // 測試環境變數
|-- src                              // 原始碼目錄
|   |-- components                     // vue公共元件
|   |-- store                          // vuex的狀態管理
|   |-- App.vue                        // 頁面入口檔案
|   |-- main.js                        // 程式入口檔案，載入各種公共元件
|-- static                           // 靜態檔案，比如一些圖片，json資料等
|   |-- data                           // 群聊分析得到的資料用於資料視覺化
|-- .babelrc                         // ES6語法編譯配置
|-- .editorconfig                    // 定義程式碼格式
|-- .gitignore                       // git上傳需要忽略的檔案格式
|-- README.md                        // 專案說明
|-- favicon.ico 
|-- index.html                       // 入口頁面
|-- package.json                     // 專案基本資訊
.
複製程式碼

重點檔案講解

package.json package.json檔案是專案根目錄下的一個檔案，定義該專案開發所需要的各種模組以及一些專案配置資訊（如專案名稱、版本、描述、作者等）。
package.json 裡的scripts欄位，這個欄位定義了你可以用npm執行的命令。在開發環境下，在命令列工具中執行npm run dev ，就相當於執行 node build/dev-server.js也就是開啟了一個node寫的開發伺服器。由此可以看出script欄位是用來指定npm相關命令的縮寫。

"scripts": {
    "dev": "node build/dev-server.js",
    "build": "node build/build.js"
  },
複製程式碼

dependencies欄位和devDependencies欄位

dependencies欄位指專案執行時所依賴的模組；
devDependencies欄位指定了專案開發時所依賴的模組
在命令列中執行npm install命令，會自動安裝dependencies和devDempendencies欄位中的模組。

webpack配置相關
我們在上面說了執行npm run dev 就相當於執行了node build/dev-server.js,說明這個檔案相當重要，先來熟悉一下它。我貼出程式碼並給出重要的解釋。

/ 檢查 Node 和 npm 版本
require('./check-versions')()
 
// 獲取 config/index.js 的預設配置
var config = require('../config')
 
// 如果 Node 的環境無法判斷當前是 dev / product 環境
// 使用 config.dev.env.NODE_ENV 作為當前的環境
 
if (!process.env.NODE_ENV) process.env.NODE_ENV = JSON.parse(config.dev.env.NODE_ENV)
 
// 使用 NodeJS 自帶的檔案路徑工具
var path = require('path')
 
// 使用 express
var express = require('express')
 
// 使用 webpack
var webpack = require('webpack')
 
// 一個可以強制開啟瀏覽器並跳轉到指定 url 的外掛
var opn = require('opn')
 
// 使用 proxyTable
var proxyMiddleware = require('http-proxy-middleware')
 
// 使用 dev 環境的 webpack 配置
var webpackConfig = require('./webpack.dev.conf')
 
// default port where dev server listens for incoming traffic
 
// 如果沒有指定執行埠，使用 config.dev.port 作為執行埠
var port = process.env.PORT || config.dev.port
 
// Define HTTP proxies to your custom API backend
// https://github.com/chimurai/http-proxy-middleware
 
// 使用 config.dev.proxyTable 的配置作為 proxyTable 的代理配置
var proxyTable = config.dev.proxyTable
 
// 使用 express 啟動一個服務
var app = express()
 
// 啟動 webpack 進行編譯
var compiler = webpack(webpackConfig)
 
// 啟動 webpack-dev-middleware，將 編譯後的檔案暫存到記憶體中
var devMiddleware = require('webpack-dev-middleware')(compiler, {
  publicPath: webpackConfig.output.publicPath,
  stats: {
    colors: true,
    chunks: false
  }
})
 
// 啟動 webpack-hot-middleware，也就是我們常說的 Hot-reload
var hotMiddleware = require('webpack-hot-middleware')(compiler)
// force page reload when html-webpack-plugin template changes
compiler.plugin('compilation', function (compilation) {
  compilation.plugin('html-webpack-plugin-after-emit', function (data, cb) {
    hotMiddleware.publish({ action: 'reload' })
    cb()
  })
})
 
// proxy api requests
// 將 proxyTable 中的請求配置掛在到啟動的 express 服務上
Object.keys(proxyTable).forEach(function (context) {
  var options = proxyTable[context]
  if (typeof options === 'string') {
    options = { target: options }
  }
  app.use(proxyMiddleware(context, options))
})
 
// handle fallback for HTML5 history API
// 使用 connect-history-api-fallback 匹配資源，如果不匹配就可以重定向到指定地址
app.use(require('connect-history-api-fallback')())
 
// serve webpack bundle output
// 將暫存到記憶體中的 webpack 編譯後的檔案掛在到 express 服務上
app.use(devMiddleware)
 
// enable hot-reload and state-preserving
// compilation error display
// 將 Hot-reload 掛在到 express 服務上
app.use(hotMiddleware)
 
// serve pure static assets
// 拼接 static 資料夾的靜態資源路徑
var staticPath = path.posix.join(config.dev.assetsPublicPath, config.dev.assetsSubDirectory)
// 為靜態資源提供響應服務
app.use(staticPath, express.static('./static'))
 
// 讓我們這個 express 服務監聽 port 的請求，並且將此服務作為 dev-server.js 的介面暴露
module.exports = app.listen(port, function (err) {
  if (err) {
    console.log(err)
    return
  }
  var uri = 'http://localhost:' + port
  console.log('Listening at ' + uri + '\n')
 
  // when env is testing, don't need open it
  // 如果不是測試環境，自動開啟瀏覽器並跳到我們的開發地址
  if (process.env.NODE_ENV !== 'testing') {
    opn(uri)
  }
})
複製程式碼

babelrc
Babel直譯器的配置檔案，存放在根目錄下。Babel是一個轉碼器，專案裡需要用它將ES6程式碼轉為ES5程式碼。如果你想了解更多，可以檢視babel的知識。

{
  //設定轉碼規則
  "presets": [
    ["env", { "modules": false }],
    "stage-2"
  ],
  //轉碼用的外掛
  "plugins": ["transform-runtime"],
  "comments": false,
  //對BABEL_ENV或者NODE_ENV指定的不同的環境變數，進行不同的編譯操作
  "env": {
    "test": {
      "presets": ["env", "stage-2"],
      "plugins": [ "istanbul" ]
    }
  }
}
複製程式碼

editorconfig
該檔案定義專案的編碼規範，編譯器的行為會與.editorconfig檔案中定義的一致，並且其優先順序比編譯器自身的設定要高，這在多人合作開發專案時十分有用而且必要。

root = true
 
[*]    // 對所有檔案應用下面的規則
charset = utf-8                    // 編碼規則用utf-8
indent_style = space               // 縮排用空格
indent_size = 2                    // 縮排數量為2個空格
end_of_line = lf                   // 換行符格式
insert_final_newline = true        // 是否在檔案的最後插入一個空行
trim_trailing_whitespace = true    // 是否刪除行尾的空格
複製程式碼

main.js檔案解讀

main.js是整個專案的入口檔案,在src資料夾下：

import Vue from 'vue'      
import App from './App'
import router from './router'
 
Vue.config.productionTip = false   //生產環境提示，這裡設定成了false
 
/* eslint-disable no-new */
new Vue({
  el: '#app',
  router,
  template: '<App/>',
  components: { App }
})
複製程式碼

通過程式碼可以看出這裡引進了App的元件和的模板，它是通過 import App from './App'這句程式碼引入的。我們找到App.vue檔案，開啟檢視。

App.vue檔案

<template>
  <div id="app">
    <img src="./assets/logo.png">
    <router-view></router-view>
  </div>
</template>
 
<script>
export default {
  name: 'app'
}
</script>
 
<style>
#app {
  font-family: 'Avenir', Helvetica, Arial, sans-serif;
  -webkit-font-smoothing: antialiased;
  -moz-osx-font-smoothing: grayscale;
  text-align: center;
  color: #2c3e50;
  margin-top: 60px;
}
</style>
複製程式碼

app.vue檔案我們可以分成三部分解讀，

標籤包裹的內容：這是模板的HTMLDom結構，裡邊引入了一張圖片和標籤，標籤說明使用了路由機制。我們會在以後專門拿出一篇文章講Vue-router。
標籤包括的js內容：你可以在這裡些一些頁面的動態效果和Vue的邏輯程式碼。
標籤包裹的css內容：這裡就是你平時寫的CSS樣式，對頁面樣子進行裝飾用的，需要特別說明的是你可以用來宣告這些css樣式只在本模板中起作用。

router/index.js 路由檔案

引文在app.vue中我們看到了路由檔案，雖然router的內容比較多，但是我們先簡單的看一下。下篇文章我們就開始講Vue-router。

import Vue from 'vue'
import Router from 'vue-router'
import Hello from '@/components/Hello'
 
Vue.use(Router)
 
export default new Router({
  routes: [
    {
      path: '/',
      name: 'Hello',
      component: Hello
    }
  ]
})
複製程式碼

我們可以看到 import Hello from '@/components/Hello'這句話，檔案引入了/components/Hello.vue檔案。這個檔案裡就配置了一個路由，就是當我們訪問網站時給我們顯示Hello.vue的內容。

Hello.vue檔案解讀

這個檔案就是我們在第一節課看到的頁面檔案了。也是分為<template><script><style>三個部分，以後我們大部分的工作都是寫這些.vue結尾的檔案。現在我們可以試著改一些內容，然後預覽一下。

<template>
  <div class="hello">
    <h1>{{ msg }}</h1>
    <h2>Essential Links</h2>
    <ul>
      <li><a href="https://vuejs.org" target="_blank">Core Docs</a></li>
      <li><a href="https://forum.vuejs.org" target="_blank">Forum</a></li>
      <li><a href="https://gitter.im/vuejs/vue" target="_blank">Gitter Chat</a></li>
      <li><a href="https://twitter.com/vuejs" target="_blank">Twitter</a></li>
      <br>
      <li><a href="http://vuejs-templates.github.io/webpack/" target="_blank">Docs for This Template</a></li>
    </ul>
    <h2>Ecosystem</h2>
    <ul>
      <li><a href="http://router.vuejs.org/" target="_blank">vue-router</a></li>
      <li><a href="http://vuex.vuejs.org/" target="_blank">vuex</a></li>
      <li><a href="http://vue-loader.vuejs.org/" target="_blank">vue-loader</a></li>
      <li><a href="https://github.com/vuejs/awesome-vue" target="_blank">awesome-vue</a></li>
    </ul>
  </div>
</template>
 
<script>
export default {
  name: 'hello',
  data () {
    return {
      msg: 'Welcome to Your Vue.js App'
    }
  }
}
</script>
 
<!-- Add "scoped" attribute to limit CSS to this component only -->
<style scoped>
h1, h2 {
  font-weight: normal;
}
 
ul {
  list-style-type: none;
  padding: 0;
}
 
li {
  display: inline-block;
  margin: 0 10px;
}
 
a {
  color: #42b983;
}
</style>
複製程式碼

npm run dev

開發模式下執行我們的程式。給我們自動構建了開發用的伺服器環境和在瀏覽器中開啟，並實時監視我們的程式碼更改，即時呈現給我們。

npm run build命令

有小夥伴問我，如何把寫好的Vue網頁放到伺服器上，那我就在這裡講解一下，主要的命令就是要用到npm run build 命令。我們在命令列中輸入npm run build命令後，vue-cli會自動進行專案釋出打包。你在package.json檔案的scripts欄位中可以看出，你執行的npm run build命令就相對執行的 node build/build.js 。
package.json的scripts 欄位：

 "scripts": {
    "dev": "node build/dev-server.js",
    "build": "node build/build.js"
  },
複製程式碼

在執行完npm run build命令後，在你的專案根目錄生成了dist資料夾，這個資料夾裡邊就是我們要傳到伺服器上的檔案。 dist資料夾下目錄包括：

index.html 主頁檔案:因為我們開發的是單頁web應用，所以說一般只有一個html檔案。
static 靜態資原始檔夾：裡邊js、CSS和一些圖片。

參考文章

技術胖

VUE學習之腳手架（vue-cli）
2019-01-21
Vue
Vue-cli 腳手架搭建
2018-01-26
Vue
vue-cli 腳手架詳解
2019-03-04
Vue
搭建Vue2.0腳手架（vue-cli）
2018-05-21
Vue
兩步建立vue-cli腳手架
2019-08-21
Vue
vue-cli多頁面腳手架
2018-04-25
Vue
vue-cli腳手架專案構成
2018-02-05
Vue
仿 vue-cli 搭建屬於自己的腳手架
2019-03-27
Vue
vue-cli 3.0腳手架與vux的配合使用
2018-11-01
VueUX
vue-cli腳手架原理以及製作方式（一）
2018-05-26
Vue
腳手架vue-cli系列二：vue-cli的工程模板與構建工具
2018-09-27
Vue
vue - Vue腳手架
2022-05-05
Vue
vue腳手架多頁自動化生成實踐
2023-02-28
Vue
基於vue-cli重構多頁面腳手架
2018-01-23
Vue
vue腳手架
2018-09-28
Vue
node環境搭建和vue-cli腳手架使用詳解
2018-06-01
Vue
基於vue-cli的多頁面應用腳手架
2018-03-06
Vue
不會手寫vue-cli腳手架，leader竟要辭退我！
2021-09-09
Vue
走進Vue-cli原始碼，自己動手搭建前端腳手架工具
2018-04-02
Vue原始碼前端
Vue.js(一) 基於vue-cli腳手架工具構建Vue專案
2017-05-19
Vue.js
(精華)2020年7月12日 vue 手搭腳手架vue-cli
2020-07-12
Vue
vue腳手架工具
2018-07-20
Vue
vue-cli腳手架打包的靜態資源請求出錯
2019-06-05
Vue
vue-cli腳手架新版和舊版的安裝與使用
2020-11-05
Vue
vue-cli腳手架中webpack配置基礎檔案詳解
2018-05-10
VueWeb
vue - Vue腳手架/TodoList案例
2022-05-06
Vue
vue腳手架基礎
2020-11-21
Vue
Vue學習之vue-cli腳手架下載安裝及配置【轉存】
2020-09-29
Vue
在 vue-cli 腳手架中引用 jQuery、bootstrap 以及使用 sass、less 編寫 css [vue-cli配置入門]
2017-08-10
VuejQuerybootCSS
[今日白學]npm、Vue-CLi 3.x腳手架的安裝教程
2019-03-25
NPMVue
如何用vue搭建腳手架
2020-12-08
Vue
手摸手教你使用vue-cli腳手架-詳細步驟圖文解析[vue入門]
2017-08-05
Vue
vue - Vue腳手架（終結篇）/ vue動畫
2022-05-08
Vue動畫
【 Vue 】 Vue 使用腳手架建立專案
2020-11-28
Vue
前端部署腳手架專網專案實踐
2022-01-17
前端
使用vue-cli腳手架工具建立一個簡單的單頁應用
2021-09-09
Vue
Vue多頁應用腳手架
2019-03-03
Vue
webpack4配置vue腳手架
2019-04-14
WebVue