vue-cli@3.0 使用及配置說明

前端小魚人發表於2019-05-07

使用vue-cli3已經有相當一段時間了,一直沒怎麼去注意其中的配置,所以趁著這段時間總結下應用過程中的一些經驗,本文是從安裝到開發使用的一個過程講解,也可以說是新手向的文章,文字有點多,請耐心觀看。

(一)安裝:

1、下載安裝node: 登陸node官網 並選擇自己合適的node版本進行安裝;

2、安裝vue-cli腳手架工具

npm install -g @vue/cli
# OR
# 推薦使用
npm install -g yarn # 如果已有安裝,此步驟不需要
yarn global add @vue/cli 
複製程式碼

(二)建立一個專案:

vue create my-project
# OR
vue ui
複製程式碼
  • 選擇合適的配置
# 版本資訊
Vue CLI v3.7.0 
? Please pick a preset:
# 基礎配置
  vue-cli3-demo (vue-router, vuex, sass, babel, typescript, unit-mocha)
  default (babel, eslint)
# 自定義配置,這裡我們選擇自定義選項,點選回車
> Manually select features
複製程式碼
  • 選擇需要的外掛及編譯工具
? Check the features needed for your project:
# 程式碼轉換,可以讓你更好的書寫前沿技術
 (*) Babel
# JavaScript 的一個超集,好東西用起來
 (*) TypeScript
# PWA支援,不要求使用可以不選
 ( ) Progressive Web App (PWA) Support
 (*) Router
 (*) Vuex
# css預編譯器
 (*) CSS Pre-processors
# 程式碼格式化
 (*) Linter / Formatter
# 書寫單元測試用的,不要求使用可以不選
>(*) Unit Testing
 ( ) E2E Testing
複製程式碼
  • 接下來的配置選項
# 是否使用class風格進行元件開發
? Use class-style component syntax? Yes
# 使用 babel 對 TypeScript 程式碼進行編譯轉換
? Use Babel alongside TypeScript for auto-detected polyfills? Yes

? Use history mode for router? (Requires proper server setup for index fallback in production) Yes
# 選擇css預編譯,這裡我們選擇Sass/SCSS
? Pick a CSS pre-processor (PostCSS, Autoprefixer and CSS Modules are supported by default): Sass/SCSS (with node-sass)
# 選擇程式碼格式化配置
? Pick a linter / formatter config: Standard
# 程式碼檢查方式
? Pick additional lint features: (Press <space> to select, <a> to toggle all, <i> to invert selection)Lint on save
# 選擇單元測試工具
? Pick a unit testing solution: Mocha
# 是否將配置放在單獨的檔案中
? Where do you prefer placing config for Babel, PostCSS, ESLint, etc.? In dedicated config files
# 是否將此次配置儲存
? Save this as a preset for future projects? No
複製程式碼
  • 最後
cd my-project
npm run install
npm run serve
# OR 推薦使用
yarn install
yarn serve
複製程式碼

(三)目錄結構

預覽圖

(四)環境變數配置

環境變數說明

.env                # 在所有的環境中被載入
.env.local          # 在所有的環境中被載入,但會被 git 忽略
.env.[mode]         # 只在指定的模式中被載入
.env.[mode].local   # 只在指定的模式中被載入,但會被 git 忽略
複製程式碼
  1. 新建環境變數 .env.development.test 用於測試環境 並新增如下程式碼
NODE_ENV='development'
VUE_APP_URL='你的測試環境域名'
複製程式碼

只有以 VUE_APP_ 開頭的變數會被 webpack.DefinePlugin 靜態嵌入到客戶端側的包中。你可以在應用的程式碼中這樣訪問它們:

console.log(process.env.VUE_APP_URL)
複製程式碼
  1. 修改 package.json,並在scripts裡面新增如下程式碼
"serve:test": "vue-cli-service serve --mode development.test",
複製程式碼
  1. 如果專案中有使用到公共環境變數,為了避免在每個.env檔案中配置,我們也可以在vue.config.js裡面進行配置

在設定之前我們先來看下2.0時代的環境變數配置,之前在 prod.env.js 中我們會如下配置:

'use strict'
module.exports = {
    NODE_ENV: '"production"'
}
複製程式碼

顯然這樣的配置我們目前不能修改,因為目前的配置檔案只有vue.config.js,所以我們新增如下程式碼,進行公共環境變數的設定。

// vue.config.js
module.exports = {
    chainWebpack: config => {
        // 新增環境變數 
        config.plugin("define")
            .tap(args => {
                args[0]["process.env"].VUE_APP_ENVBANE = JSON.stringify("環境變數值")
                return args;
            });
    },
}

複製程式碼

(五)新增配置檔案 vue.config.js

vue.config.js 是一個可選的配置檔案,如果專案的 (和 package.json 同級的) 根目錄中存在這個檔案,那麼它會被 @vue/cli-service 自動載入。你也可以使用 package.json 中的 vue 欄位,但是注意這種寫法需要你嚴格遵照 JSON 的格式來寫。

// vue.config.js
module.exports = {
    // baseUrl從 Vue CLI 3.3 起已棄用,請使用publicPath。
    // baseUrl:'./', 
    // 配置sub-path後訪問路徑為https://xxx-path/sub-path/#/
    publicPath: process.env.NODE_ENV === 'production' ? '/sub-path/' : '/',
    // 輸出檔案路徑,預設為dist
    outputDir: 'dist',  
    // 放置生成的靜態資源 (js、css、img、fonts) 的 (相對於 outputDir 的) 目錄。
    assetsDir: '', 
    // 指定生成的 index.html 的輸出路徑 (相對於 outputDir)。也可以是一個絕對路徑
    indexPath: '',
    // 配置多頁應用
    pages: {
        index: {
            // page 的入口
            entry: 'src/index/main.js',
            // 模板來源
            template: 'public/index.html',
            // 在 dist/index.html 的輸出
            filename: 'index.html',
            // 當使用 title 選項時,
            // template 中的 title 標籤需要是 <title><%= htmlWebpackPlugin.options.title %></title>
            title: 'Index Page',
            // 在這個頁面中包含的塊,預設情況下會包含
            // 提取出來的通用 chunk 和 vendor chunk。
            chunks: ['chunk-vendors', 'chunk-common', 'index']
        },
        // 當使用只有入口的字串格式時,
        // 模板會被推導為 `public/subpage.html`
        // 並且如果找不到的話,就回退到 `public/index.html`。
        // 輸出檔名會被推導為 `subpage.html`。
        subpage: 'src/subpage/main.js',
    },
    lintOnSave: true,  // 儲存時 lint 程式碼
    // css相關配置
    css: {
        // 是否使用css分離外掛 ExtractTextPlugin
        extract: true,
        // 開啟 CSS source maps?
        sourceMap: false,
        // css預設器配置項
        loaderOptions: {
            // pass options to sass-loader
            sass: {
                // 自動注入全域性變數樣式
                data: `
                    @import "src/你的全域性scss檔案路徑";
                `
            }
        },
        // 啟用 CSS modules for all css / pre-processor files.
        modules: false,
    },
    // 生產環境是否生成 sourceMap 檔案
    productionSourceMap: false,
    //是否為 Babel 或 TypeScript 使用 thread-loader。該選項在系統的 CPU 有多於一個核心時自動啟用,僅作用於生產構建。
    parallel: require('os').cpus().length > 1,
    // 所有 webpack-dev-server 的選項都支援
    devServer: {
        port: 8080, // 配置埠
        open: true, // 自動開啟瀏覽器
        compress: true, // 開啟壓縮
        // 設定讓瀏覽器 overlay 同時顯示警告和錯誤
        overlay: {
            warnings: true,
            errors: true
        },
        // 設定請求代理
        proxy: {
            '/api': {
                target: '<url>',
                ws: true,
                changeOrigin: true
            },
            '/foo': {
                target: '<other_url>'
            }
        }
    },
}
複製程式碼

(六)修改webpack配置資訊

vue-cli3.0的版本已經將webpack的配置整合進vue.config.js裡面了

// 安裝 babel-polyfill
// npm install babel-polyfill 或者 yarn add babel-polyfill
// 安裝 uglifyjs-webpack-plugin
// npm install uglifyjs-webpack-plugin -D 或者 yarn add uglifyjs-webpack-plugin -D

// vue.config.js
const UglifyJsPlugin = require('uglifyjs-webpack-plugin');
const isProduction = process.env.NODE_ENV === 'production';

module.exports = {
    chainWebpack: config => {
        // 引入babel-polyfill
        config
            .entry('index')
            .add('babel-polyfill')
            .end();
        // 新增檔案路徑別名
        config.resolve.alias.set("@", resolve("src"));
        if (isProduction) {
            // 生產環境注入cdn
            config.plugin('html')
                .tap(args => {
                    args[0].cdn = cdn;
                    return args;
                });
        }
    },
    configureWebpack: config => {
        if (isProduction) {
            // 為生產環境修改配置...
            config.plugins.push(
                //新增程式碼壓縮工具,及設定生產環境自動刪除console
                new UglifyJsPlugin({
                    uglifyOptions: {
                        compress: {
                            warnings: false,
                            drop_debugger: true,
                            drop_console: true,
                        },
                    },
                    sourceMap: false,
                    parallel: true,
                })
            );
        } else {
            // 為開發環境修改配置...
        }
    },
}
複製程式碼
  1. 分離第三方外掛,引入cdn配置

這裡介紹一個開源的cdn庫 www.bootcdn.cn/

// vue.config.js
const isProduction = process.env.NODE_ENV === 'production';
const cdn = {
    css: [],
    js: [
        'https://xxx-cdn-path/vue.runtime.min.js',
        'https://xxx-cdn-path/vue-router.min.js',
        'https://xxx-cdn-path/vuex.min.js',
        'https://xxx-cdn-path/axios.min.js',
    ]
}

module.exports = {
    configureWebpack: config => {
        if (isProduction) {
            // 用cdn方式引入,分離第三方外掛
            config.externals = {
                'vue': 'Vue',
                'vuex': 'Vuex',
                'vue-router': 'VueRouter',
                'axios': 'axios'
            }
        } else {
            // 為開發環境修改配置...
        }
    },
}
複製程式碼

修改html檔案

<!DOCTYPE html>
<html lang="zh">

<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width,initial-scale=1.0">
  <link rel="icon" href="<%= BASE_URL %>static/favicon.ico" type="image/x-icon" />
  <link rel="shortcut icon" href="<%= BASE_URL %>static/favicon.ico" type="image/x-icon" />
  <title>my-project</title>
  <!-- 使用CDN的CSS檔案 -->
  <% for (var i in htmlWebpackPlugin.options.cdn && htmlWebpackPlugin.options.cdn.css) { %>
    <link href="<%= htmlWebpackPlugin.options.cdn.css[i] %>" rel="preload" as="style">
    <link href="<%= htmlWebpackPlugin.options.cdn.css[i] %>" rel="stylesheet">
  <% } %>
  <!-- 使用CDN的JS檔案 -->
  <% for (var i in htmlWebpackPlugin.options.cdn && htmlWebpackPlugin.options.cdn.js) { %>
    <link href="<%= htmlWebpackPlugin.options.cdn.js[i] %>" rel="preload" as="script">
  <% } %>
</head>

<body>
  <noscript>
    <strong>We're sorry but eye-admin doesn't work properly without JavaScript enabled. Please enable it to continue.</strong>
  </noscript>
  <div id="app"></div>
  <!-- built files will be auto injected -->
  <% for (var i in htmlWebpackPlugin.options.cdn && htmlWebpackPlugin.options.cdn.js) { %>
    <script src="<%= htmlWebpackPlugin.options.cdn.js[i] %>"></script>
  <% } %>
</body>

</html>
複製程式碼

(七)關於打包後請求數的優化點Preload and Prefetch

首先我們看一張圖

預覽圖

從圖中我們可以看出首次載入的資源非常多,有217個請求,為什麼會這樣呢?

檢視官方文件,可以得知:

<link rel="preload"> 是一種 resource hint,用來指定頁面載入後很快會被用到的資源,所以在頁面載入的過程中,我們希望在瀏覽器開始主體渲染之前儘早 preload。

預設情況下,一個 Vue CLI 應用會為所有初始化渲染需要的檔案自動生成 preload 提示。

這些提示會被 @vue/preload-webpack-plugin 注入,並且可以通過 chainWebpack 的 config.plugin('preload') 進行修改和刪除。
複製程式碼
<link rel="prefetch"> 是一種 resource hint,用來告訴瀏覽器在頁面載入完成後,利用空閒時間提前獲取使用者未來可能會訪問的內容。

預設情況下,一個 Vue CLI 應用會為所有作為 async chunk 生成的 JavaScript 檔案 (通過動態 import() 按需 code splitting 的產物) 自動生成 prefetch 提示。

這些提示會被 @vue/preload-webpack-plugin 注入,並且可以通過 chainWebpack 的 config.plugin('prefetch') 進行修改和刪除。
複製程式碼

所以修改vue.config.js檔案

// vue.config.js
module.exports = {
  chainWebpack: config => {
    // 移除 prefetch 外掛
    config.plugins.delete('preload');
    config.plugins.delete('prefetch');
  }
}
複製程式碼

(八)總結

vue-cli3在專案配置上精簡了很多,而且它也提供了很多配置選項,滿足定製化需要。各種配置也特別貼心,可以按照自己專案的需要進行自定義修改,大大減少了提升了開發的工作效率。

以上就是本文的全部內容,我們已經將vue-cli3.0從安裝到修改配置的過程講解結束了,希望對大家的學習有所幫助

相關文章