前言
平時部署前端專案流程是:先部署到測試環境ok後再發布到生產環境上,部署到測試環境用 xshell 連上伺服器,然後用 xftp 連線伺服器,然後本地 build 專案,接著把 build 好的檔案通過 xftp 上傳到伺服器上,整個流程感覺稍有繁瑣,重複。
本教程講解的是 Vue-CLI 3.x 腳手架搭建的vue專案, 利用scp2自動化部署到靜態檔案伺服器 Nginx
一 安裝scp2
scp2是一個基於ssh2增強實現,純粹使用JavaScript編寫。 而ssh2就是一個使用nodejs對於SSH2的模擬實現。scp,是secure copy的縮寫, scp是Linux系統下基於SSH登陸進行安全的遠端檔案拷貝命令。這裡我們就用這個功能,在Vue編譯構建成功之後,將專案推送至測試/生產環境,以方便測試,提高效率。 安裝scp2:
npm install scp2 --save-dev
複製程式碼
二、配置測試/生產環境 伺服器SSH遠端登陸賬號資訊
1. 在專案根目錄下, 建立 .env.dev 檔案 (測試環境變數)
VUE_APP_SERVER_ID變數表示 當前需部署的測試伺服器ID為0
// .env.dev檔案中
VUE_APP_SERVER_ID=0
複製程式碼
2. 在專案根目錄下, 建立 .env.prod 檔案 (生產環境變數)
VUE_APP_SERVER_ID變數表示 當前需部署的生產伺服器ID為1
// .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];
複製程式碼
三、使用scp2庫,建立自動化部署指令碼
在專案根目錄下, 建立 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' ? '生產' : '測試') + '伺服器...');
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'));
}
}
);
複製程式碼
四、新增 package.json 中的 scripts 命令, 自定義名稱為 "deploy",
釋出到測試環境命令為 npm run deploy:dev
,生產環境為 npm run deploy:prod
"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能跨平臺地設定及使用環境變數,這裡用來設定是生產環境還是測試環境。
圖解
結束語
歡迎指正,Vue學習群493671066 歡迎大家加入我的前端學習交流群一起學習進步。