vue-cli+webpack構建vue項目

在這裏插入圖片描述

vue-cli+webpack構建vue項目

第一步:安裝環境

  • 安裝vue-cli的前提是你已經安裝了npm,安裝npm你可以直接下載node的安裝包進行安裝。你可以在命令行工具裏輸入npm -v 檢測你是否安裝了npm和版本情況。出現版本號說明你已經安裝了npm和node,我這裏的npm版本爲3.10.10。如果該命令不可以使用,需要安裝node軟件包,根據你的系統版本選擇下載安裝就可以了。
  • npm沒有問題,接下來我們可以用npm 命令安裝vue-cli了,在命令行輸入下面的命令
    • npm install vue-cli -g
      
    • -g :代表全局安裝。如果你安裝時報錯,一般是網絡問題,你可以嘗試用cnpm來進行安裝。安裝完成後,可以用vue
    • -V來進行查看 vue-cli的版本號。注意這裏的V是大寫的.
  • 如果vue -V的命令管用了,說明已經順利的把vue-cli安裝到我們的計算機裏了。

第二步.初始化項目

  • 我們用vue init命令來初始化項目,具體看一下這條命令的使用方法。

  • vue init <template-name> <project-name>
    
    • init:表示我要用vue-cli來初始化項目
    • :表示模板名稱,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-一個最簡單的單頁應用模板。
    • :標識項目名稱,這個你可以根據自己的項目來起名字。
    • 在實際開發中,一般我們都會使用webpack這個模板,那我們這裏也安裝這個模板,在命令行輸入以下命令:
    • vue init webpack vueclitest
      
      • 輸入命令後,會詢問我們幾個簡單的選項,我們根據自己的需要進行填寫就可以了。
      • Project name :項目名稱 ,如果不需要更改直接回車就可以了。注意:這裏不能使用大寫,所以我把名稱改成了vueclitest
      • Project description:項目描述,默認爲A Vue.js project,直接回車,不用編寫。
      • Author:作者,如果你有配置git的作者,他會讀取。
      • Install vue-router? 是否安裝vue的路由插件,我們這裏需要安裝,所以選擇Y
      • Use ESLint to lint your code? 是否用ESLint來限制你的代碼錯誤和風格。我們這裏不需要輸入n,如果你是大型團隊開發,最好是進行配置。
      • setup unit tests with Karma + Mocha? 是否需要安裝單元測試工具Karma+Mocha,我們這裏不需要,所以輸入n。
      • Setup e2e tests with Nightwatch?是否安裝e2e來進行用戶行爲模擬測試,我們這裏不需要,所以輸入n。
      • # Installing project dependencies ...
        # ========================
        
        npm WARN deprecated [email protected]: Deprecated. Please use https://github.com/webpack-contrib/mini-css-extract-plugin
        npm WARN deprecated [email protected]: Browserslist 2 could fail on reading Browserslist >3.0 config used in other tools.
        npm WARN deprecated [email protected]: Switch to the `bfj` package for fixes and new features!
        npm WARN deprecated [email protected]: core-js@<3 is no longer maintained and not recommended for usage due to the number of issues. Please, upgrade your dependencies to the actual version of core-js@3.
        npm WARN deprecated [email protected]: Browserslist 2 could fail on reading Browserslist >3.0 config used in other tools.
        npm WARN deprecated [email protected]: use String.prototype.padStart()
        
        > [email protected] postinstall F:\htmldaima\integrated_project\vueclitest\node_modules\core-js
        > node -e "try{require('./postinstall')}catch(e){}"
        
        Thank you for using core-js ( https://github.com/zloirock/core-js ) for polyfilling JavaScript standard library!
        
        The project needs your help! Please consider supporting of core-js on Open Collective or Patreon:
        > https://opencollective.com/core-js
        > https://www.patreon.com/zloirock
        
        Also, the author of core-js ( https://github.com/zloirock ) is looking for a good job -)
        
        
        > [email protected] postinstall F:\htmldaima\integrated_project\vueclitest\node_modules\ejs
        > node ./postinstall.js
        
        Thank you for installing EJS: built with the Jake JavaScript build tool (https://jakejs.com/)
        
        
        > [email protected] postinstall F:\htmldaima\integrated_project\vueclitest\node_modules\webpack\node_modules\uglifyjs-webpack-plugin
        > node lib/post_install.js
        
        npm notice created a lockfile as package-lock.json. You should commit this file.
        npm WARN [email protected] requires a peer of ajv@^6.9.1 but none is installed. You must install peer dependencies yourself.
        npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules\fsevents):
        npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"win32","arch":"x64"})
        
        added 1562 packages from 786 contributors and audited 31314 packages in 113.248s
        found 82 vulnerabilities (68 low, 9 moderate, 5 high)
          run `npm audit fix` to fix them, or `npm audit` for details
        
        # Project initialization finished!
        # ========================
        
        To get started:
        
          cd vueclitest
          npm run dev
        
        Documentation can be found at https://vuejs-templates.github.io/webpack
        
  • 命令行出現上面的文字,說明我們已經初始化好了第一步。命令行提示我們現在可以作的三件事情。

  • cd vuecliTest 進入我們的vue項目目錄。

  • npm install 安裝我們的項目依賴包,也就是安裝package.json裏的包,如果你網速不好,你也可以使用cnpm來安裝。

  • npm run dev 開發模式下運行我們的程序。給我們自動構建了開發用的服務器環境和在瀏覽器中打開,並實時監視我們的代碼更改,即時呈現給我們。

  • 出現這個頁面,說明我們的初始化已經成功,現在可以快樂的玩耍了。

在這裏插入圖片描述

vue-cli項目結構詳解

由於版本實時更新和你選擇安裝的不同(這裏列出的是模板爲webpack的目錄結構),所以你看到的有可能和下邊的有所差別。

.
|-- 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": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
          "start": "npm run dev",
          "unit": "jest --config test/unit/jest.conf.js --coverage",
          "test": "npm run unit",
          "build": "node build/build.js"
        }
      
  • dependencies字段和devDependencies字段
    • dependencies字段指項目運行時所依賴的模塊;
    • devDependencies字段指定了項目開發時所依賴的模塊;
  • webpack配置相關
  • 運行npm run dev 就相當於執行了node build/dev-server.js,說明這個文件相當重要,先來熟悉一下它。 我貼出代碼並給出重要的解釋。
    • 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.confg.js webpack的基礎配置文件
      • module.export = {
            // 編譯入口文件
            entry: {},
            // 編譯輸出路徑
            output: {},
            // 一些解決方案配置
            resolve: {},
            resolveLoader: {},
            module: {
                // 各種不同類型文件加載器配置
                loaders: {
                ...
                ...
                // js文件用babel轉碼
                {
                    test: /\.js$/,
                    loader: 'babel',
                    include: projectRoot,
                    // 哪些文件不需要轉碼
                    exclude: /node_modules/
                },
                ...
                ...
                }
            },
            // vue文件一些相關配置
            vue: {}
        }
        
    • .babelrc
      • Babel解釋器的配置文件,存放在根目錄下。Babel是一個轉碼器,項目裏需要用它將ES6代碼轉爲ES5代碼
      • {
          //設定轉碼規則
          "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    // 是否刪除行尾的空格
        
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章