前言
常规的部署项目，一般分为两种方式:
第一种：直接上传。部署项目需要经过本地build，压缩文件，将压缩包上传至服务器并解压文件等步骤，过程较为繁琐。
第二种：利用git服务器。ssh进入web服务器 ---> 执行git clone或git pull将项目克隆至服务器 ---> 执行npm install ---> 执行npm run build。缺点：1、服务器需要预安装node + npm；2、服务器上多了不需要的Vue项目源码。
无论以上哪种方法，过程都相对繁琐并存在明显都缺点。
下面我们将讲解如何使用Vue-CLI 3.x 脚手架搭建的vue项目, 利用scp2自动化部署到静态文件服务器 Nginx，让前端自动化部署快速且优雅。
一、Nginx服务器文件的配置
server {
listen 80;
server_name www.xxxxxx.com;#生产环境
location / {
root /usr/local/www/xxx_program/;
index index.html;
try_files $uri $uri/ /index.html;
}
}
server {
listen 80;
server_name test.xxxxxx.com; #测试环境
location / {
root /usr/local/www/xxx_program/;
index index.html;
try_files $uri $uri/ /index.html;
}
}
二、安装spc2
scp2是一个基于ssh2增强实现，纯粹使用JavaScript编写。
而ssh2就是一个使用nodejs对于SSH2的模拟实现。scp，是secure copy的缩写, scp是Linux系统下基于SSH登陆进行安全的远程文件拷贝命令。这里我们就用这个功能，在Vue编译构建成功之后，将项目推送至测试/生产环境，以方便测试，提高效率。
npm install scp2 --save-dev
三、配置测试/生产环境及服务器SSH远程登录账号信息
1. 在项目根目录下, 创建 .env.development文件 (测试环境变量)
VUE_APP_SERVER_ID变量表示 当前需部署的测试服务器ID为0
// .env.development 文件中
VUE_APP_SERVER_ID=0
2. 在项目根目录下, 创建 .env.production 文件 (生产环境变量)
VUE_APP_SERVER_ID变量表示 当前需部署的生产服务器ID为1
// .env.production文件中
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 === 'production' ? '../.env.production' : '../.env.development';
// 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.ycmc.com',// 域名
host: '112.11.11.0',// ip
port: 22,// 端口
username: 'root', // 登录服务器的账号
password: 'password',// 登录服务器的账号
path: '/www/wwwroot/test_admin'// 发布至静态服务器的项目路径
},
{
id: 1,
name: 'B-生产环境',
domain: 'test.xxx.com',
host: 'XX.XX.XX.XX',
port: 22,
username: 'root',
password: 'xxxxxxx',
path: '/www/wwwroot/test_admin'
}
];
module.exports = SERVER_LIST[SERVER_ID];
ps:scp2使用STPF连接，这里填写的是服务器账号密码，并非FTP账号。
四、使用scp2创建自动化脚本部署
在项目根目录下, 创建 deploy/index.js 文件
// deploy/index.js里面
const scpClient = require('scp2');
const ora = require('ora');
const chalk = require('chalk');
const server = require('./products');
const spinner = ora(
`正在发布到${server.name},请稍后....../n
地址:${server.domain}
`
);
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! 成功发布'));
}
}
);
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
});
五、添加自定义scripts命令
在package.json中添加运行命令
"scripts": {
"serve": "vue-cli-service serve --mode dev",
"build": "vue-cli-service build --mode prod",
"deploy:dev": "npm run build && cross-env NODE_ENV=development node ./deploy",
"deploy:prod": "npm run build && cross-env NODE_ENV=production node ./deploy",
}
ps 这里用到了cross_env 得安装 npm i --save-dev cross-env cross-env能跨平台地设置及使用环境变量，这里用来设置是生产环境还是测试环境。
至此自动化部署配置完成。
最后
此方案可能不是最优雅的解决方式，但是也算完整地搞了一套部署流程，并解决了传统两种方式的缺点，更多更好的自动化部署方案靠大家自己摸索了。
