vue-cli 專案結構

王志強發表於2019-02-16
Vue

Vue-cli 專案結構

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檔案是專案根目錄下的一個檔案，定義該專案開發所需要的各種模組以及一些專案配置資訊.在專案根目錄下執行npm i可以安裝所需依賴包.
裡面的scripts欄位，定義了可以快速使用npm命令代替繁瑣的命令執行檔案,其中npm run dev相當於執行 node build/dev-server.js 也就是開啟了一個node寫的開發行建議伺服器，是相關命令的縮寫.

"scripts": {
    "dev": "node build/dev-server.js",
    "build": "node build/build.js"
}

dependencies欄位：專案執行所依賴的模組；
devDependencies欄位: 指定專案開發所依賴的模組;

二、webpack

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 + `
`)

  // when env is testing, don`t need open it
  // 如果不是測試環境，自動開啟瀏覽器並跳到我們的開發地址
  if (process.env.NODE_ENV !== `testing`) {
    opn(uri)
  }
})

webpack.base.config.js : webpack的基礎配置檔案

.babelrc : Babel直譯器的配置檔案，存放在根目錄下、Babel是一個轉碼器，專案裡需要用它將ES6程式碼轉為ES5程式碼.
具體程式碼詳解請翻到頁面底部的引用地址…

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

npm run build 命令
將寫好的網頁放到伺服器上，執行該命令後，vue-cli會自動將專案打包，生成dist資料夾，這個資料夾就是我們要傳到伺服器上的檔案.

main.js檔案

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

Vue.config.productionTip = false   //生產環境提示，這裡設定成了false

這裡面最陌生的檔案就是這句話，其他都是vue.js和ES6的寫法,不多說.

還有就是通過 import App from `./App` 引入了App元件.

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>

<template></template>標籤裡面是html結構,<router-view></router-view>是一個出口.
<script></script>標籤為js內容
<style></style>為css內容，其中scoped宣告樣式只在模板中起作用.

相關文章