Vue-CLI 3.x 自動部署項目至服務器

時間 2019-12-12

原文原文鏈接

前言

平時部署前端項目流程是：先部署到測試環境ok後再發布到生產環境上，部署到測試環境用 xshell 連上服務器，而後用 xftp 鏈接服務器，而後本地 build 項目，接着把 build 好的文件經過 xftp 上傳到服務器上，整個流程感受稍有繁瑣，重複。javascript

本教程講解的是 Vue-CLI 3.x 腳手架搭建的vue項目, 利用scp2自動化部署到靜態文件服務器 Nginxhtml

一安裝scp2

scp2是一個基於ssh2加強實現，純粹使用JavaScript編寫。
而ssh2就是一個使用nodejs對於SSH2的模擬實現。scp，是secure copy的縮寫, scp是Linux系統下基於SSH登錄進行安全的遠程文件拷貝命令。這裏咱們就用這個功能，在Vue編譯構建成功以後，將項目推送至測試/生產環境，以方便測試，提升效率。
安裝scp2：前端

npm install scp2 --save-dev

2、配置測試/生產環境服務器SSH遠程登錄帳號信息

1. 在項目根目錄下, 建立 .env.dev 文件 (測試環境變量)

VUE_APP_SERVER_ID變量表示當前需部署的測試服務器ID爲0vue

// .env.dev文件中
VUE_APP_SERVER_ID=0

2. 在項目根目錄下, 建立 .env.prod 文件 (生產環境變量)

VUE_APP_SERVER_ID變量表示當前需部署的生產服務器ID爲1java

// .env.prod文件中
VUE_APP_SERVER_ID=1

3. 在項目根目錄下, 建立 deploy/products.js 文件

/*
 *讀取env環境變量
 */
const fs = require('fs');
const path = require('path');
// env 文件 判斷打包環境指定對應的服務器id
const envfile = process.env.NODE_ENV === 'prod' ? '../.env.prod' : '../.env.dev';
// env環境變量的路徑
const envPath = path.resolve(__dirname, envfile);
// env對象
const envObj = parse(fs.readFileSync(envPath, 'utf8'));
const SERVER_ID = parseInt(envObj['VUE_APP_SERVER_ID']);

function parse(src) {
  // 解析KEY=VAL的文件
  const res = {};
  src.split('\n').forEach(line => {
    // matching "KEY' and 'VAL' in 'KEY=VAL'
    // eslint-disable-next-line no-useless-escape
    const keyValueArr = line.match(/^\s*([\w\.\-]+)\s*=\s*(.*)?\s*$/);
    // matched?
    if (keyValueArr != null) {
      const key = keyValueArr[1];
      let value = keyValueArr[2] || '';

      // expand newlines in quoted values
      const len = value ? value.length : 0;
      if (len > 0 && value.charAt(0) === '"' && value.charAt(len - 1) === '"') {
        value = value.replace(/\\n/gm, '\n');
      }

      // remove any surrounding quotes and extra spaces
      value = value.replace(/(^['"]|['"]$)/g, '').trim();

      res[key] = value;
    }
  });
  return res;
}

/*
 *定義多個服務器帳號 及 根據 SERVER_ID 導出當前環境服務器帳號
 */
const SERVER_LIST = [
  {
    id: 0,
    name: 'A-生產環境',
    domain: 'www.prod.com',// 域名
    host: '46.106.38.24',// ip
    port: 22,// 端口
    username: 'root', // 登陸服務器的帳號
    password: 'root',// 登陸服務器的帳號
    path: '/mdm/nginx/dist'// 發佈至靜態服務器的項目路徑
  },
  {
    id: 1,
    name: 'B-測試環境',
    domain: 'test.xxx.com',
    host: 'XX.XX.XX.XX',
    port: 22,
    username: 'root',
    password: 'xxxxxxx',
    path: '/usr/local/www/xxx_program_test/'
  }
];

module.exports = SERVER_LIST[SERVER_ID];

3、使用scp2庫,建立自動化部署腳本

在項目根目錄下, 建立 deploy/index.js 文件node

const scpClient = require('scp2');
const ora = require('ora');
const chalk = require('chalk');
const server = require('./products');
const spinner = ora('正在發佈到' + (process.env.NODE_ENV === 'prod' ? '生產' : '測試') + '服務器...');
spinner.start();
scpClient.scp(
  'dist/',
  {
    host: server.host,
    port: server.port,
    username: server.username,
    password: server.password,
    path: server.path
  },
  function (err) {
    spinner.stop();
    if (err) {
      console.log(chalk.red('發佈失敗.\n'));
      throw err;
    } else {
      console.log(chalk.green('Success! 成功發佈到' + (process.env.NODE_ENV === 'prod' ? '生產' : '測試') + '服務器! \n'));
    }
  }
);

4、添加 package.json 中的 scripts 命令, 自定義名稱爲 "deploy",

發佈到測試環境命令爲 npm run deploy:dev,生產環境爲 npm run deploy:prodnginx

"scripts": {
    "serve": "vue-cli-service serve --mode dev",
    "build": "vue-cli-service build --mode prod",
    "deploy:dev": "npm run build && cross-env NODE_ENV=dev node ./deploy",
    "deploy:prod": "npm run build && cross-env NODE_ENV=prod node ./deploy",
  },

ps 這裏用到了cross_env 得安裝 npm i --save-dev cross-env cross-env能跨平臺地設置及使用環境變量，這裏用來設置是生產環境仍是測試環境。git

圖解

結束語

歡迎指正，Vue學習羣493671066 歡迎你們加入個人前端學習交流羣一塊兒學習進步。github

補充

有熱心的小夥伴說，打包每次hash值不一樣，dist裏面文件豈不是愈來愈多，能夠用 ssh2 先把dist文件刪除，刪除後重啓nginx再上傳至服務器。vue-cli

//  deploy/index.js裏面
const scpClient = require('scp2');
const ora = require('ora');
const chalk = require('chalk');
const server = require('./products');
const spinner = ora(
  '正在發佈到' +
    (process.env.NODE_ENV === 'prod' ? '生產' : '測試') +
    '服務器...'
);

var Client = require('ssh2').Client;

var conn = new Client();
conn
  .on('ready', function() {
    // rm 刪除dist文件，\n 是換行 換行執行 重啓nginx命令 我這裏是用docker重啓nginx
    conn.exec('rm -rf /mdm/nginx/dist\ndocker restart nginx', function(
      err,
      stream
    ) {
      if (err) throw err;
      stream
        .on('close', function(code, signal) {
          // 在執行shell命令後，把開始上傳部署項目代碼放到這裏面
          spinner.start();
          scpClient.scp(
            './dist',
            {
              host: server.host,
              port: server.port,
              username: server.username,
              password: server.password,
              path: server.path
            },
            function(err) {
              spinner.stop();
              if (err) {
                console.log(chalk.red('發佈失敗.\n'));
                throw err;
              } else {
                console.log(
                  chalk.green(
                    'Success! 成功發佈到' +
                      (process.env.NODE_ENV === 'prod'
                        ? '生產'
                        : '測試') +
                      '服務器! \n'
                  )
                );
              }
            }
          );

          conn.end();
        })
        .on('data', function(data) {
          console.log('STDOUT: ' + data);
        })
        .stderr.on('data', function(data) {
          console.log('STDERR: ' + data);
        });
    });
  })
  .connect({
    host: server.host,
    port: server.port,
    username: server.username,
    password: server.password
    //privateKey: require('fs').readFileSync('/home/admin/.ssh/id_dsa')
  });