第2節：Vue-cli項目結構講解

vue-cli腳手架工具就是爲咱們搭建了開發所須要的環境，爲咱們省去了不少精力。有必要對這個環境進行熟悉，咱們就從項目的結構講起。

Ps：因爲版本實時更新和你選擇安裝的不一樣（這裏列出的是模板爲webpack的目錄結構），因此你看到的有可能和下邊的有所差異。

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30

. |-- 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相關命令的縮寫。

 

1 2 3 4

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

dependencies字段和devDependencies字段

• dependencies字段指項目運行時所依賴的模塊；
• devDependencies字段指定了項目開發時所依賴的模塊；

在命令行中運行npm install命令，會自動安裝dependencies和devDempendencies字段中的模塊。package.json還有不少相關配置，若是你想全面瞭解，能夠專門去百度學習一下。

webpack配置相關

咱們在上面說了運行npm run dev 就至關於執行了node build/dev-server.js,說明這個文件至關重要，先來熟悉一下它。 我貼出代碼並給出重要的解釋。

dev-server.js

 

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109

// 檢查 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)   } })

 

webpack.base.confg.js   webpack的基礎配置文件

 

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30

... ... module.export = {     // 編譯入口文件     entry: {},     // 編譯輸出路徑     output: {},     // 一些解決方案配置     resolve: {},     resolveLoader: {},     module: {         // 各類不一樣類型文件加載器配置         loaders: {         ...         ...         // js文件用babel轉碼         {             test: /\.js$/,             loader: 'babel',             include: projectRoot,             // 哪些文件不須要轉碼             exclude: /node_modules/         },         ...         ...         }     },     // vue文件一些相關配置     vue: {} }

這裏有不少webpack的知識，我也有一個專門講webpack的視頻教程，你能夠去看一看《跟技術胖學webpack視頻教程》。

.babelrc

Babel解釋器的配置文件，存放在根目錄下。Babel是一個轉碼器，項目裏須要用它將ES6代碼轉爲ES5代碼。若是你想了解更多，能夠查看babel的知識。

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

{   //設定轉碼規則   "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文件中定義的一致，而且其優先級比編譯器自身的設置要高，這在多人合做開發項目時十分有用並且必要。

 

1 2 3 4 5 6 7 8 9

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    // 是否刪除行尾的空格

這是比較重要的關於vue-cli的配置文件，固然還有不少文件，咱們會在之後的文章中講