vue-cli 項目結構

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                     // 項目基本信息

重要文件解釋:

1、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字段: 指定項目開發所依賴的模塊;

2、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 + '\n')

  // 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聲明樣式只在模板中起做用.