前言
平時部署前端項目流程是：先部署到測試環境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 歡迎大家加入我的前端學習交流群一起學習進步。
補充
有熱心的小伙伴說，打包每次hash值不同，dist里面文件豈不是越來越多，可以用 ssh2 先把dist文件刪除，刪除后重啟nginx再上傳至服務器。
// 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')
});