第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的配置文件，固然还有不少文件，咱们会在之后的文章中讲