一. 思路
- 先执行 npm run build 打包项目
- 用scp工具讲本地打包文件传输至远端服务器
二. 安装依赖
npm 执行:
npm i shelljs scp2 ora --save-dev
shelljs: 在node环境中直接执行命令行(shell)操作
scp2: nodejs文件传输工具
ora: 加载提示工具
三. 编写程序
在项目根目录中新建 deploy 文件夹, 新建 config.js 基础配置文件
再新建 index.js 文件, 写入
const shell = require('shelljs');
const scpClient = require('scp2');
const ora = require('ora');
const fs = require('fs');
const config = require('./config.js');
// 打包 npm run build
const compileDist = async () => {
if (shell.exec(`npm run build`).code === 0) {
console.log('打包成功')
}
}
// 连接远端服务器
async function connectSSh() {
const server = {
host:config.ip,//服务器IP
port:config.port,//服务器端口
username:config.username,//服务器ssh登录用户名
password:config.password,//服务器ssh登录密码
path:config.path//服务器web目录
}
const loading = ora('正在部署至 ' + config.ip);
loading.start();
// 开始部署至远端服务器
scpClient.scp(config.localPath, server, (err)=>{
loading.stop()
if(err) {
console.log('部署失败')
console.error(err);
throw err
}else {
console.log('部署成功')
}
})
}
function checkExistBuild() {
return new Promise((resolve, reject) => {
fs.stat(config.localPath, function(err, stats) {
// 先判断文件(夹)是否存在
if (!stats) {
resolve(false);
} else if (stats.isDirectory()) {
resolve(true);
} else {
resolve(false);
}
})
})
}
function deleteFolder(path) {
let files = [];
if( fs.existsSync(path) ) {
files = fs.readdirSync(path);
files.forEach(function(file,index){
let curPath = path + "/" + file;
if(fs.statSync(curPath).isDirectory()) {
deleteFolder(curPath);
} else {
fs.unlinkSync(curPath);
}
});
fs.rmdirSync(path);
}
}
// 定义主任务
async function runTask () {
// 需要重新打包, 如果已经存在包则先删除 -- 此处可省略
let bool = await checkExistBuild();
if (bool) {
const loading = ora('正在删除文件夹: ' + config.localPath);
loading.start();
deleteFolder(config.localPath);
loading.stop();
}
await compileDist() // 打包完成
await connectSSh() // 提交上传
}
// 开始执行
runTask()
四. 执行程序
4.1 第一种方式
可以在项目根目录中直接执行
node deploy/index.js
4.2 第二种方式
在根目录 package.json 文件中增加执行脚本
{
// ...other things
"scripts": {
// ...other things
"deploy": "node deploy/index.js",
"D": " node deploy/index.js"
},
"dependencies": {
// ...other things
}
}
然后执行 npm run deploy / npm run D 即可
--扩展
其他更简单的方法是正常打包完成之后, 直接在控制台执行scp命令进行部署即可
scp -r ./dist/ root@xxx.xx.xxx.xxx:/xxxxxxx/xxxxxxx/xxx/dist/
脚本解释:
- scp: 本地传输远程文件命令
- -r: 可选参数, 指循环遍历本地夹下的所有文件并传输至远端
- ./dist/: 本地打包生成的文件夹路径
- root@xxx.xx.xxx.xxx: 远程服务器连接配置
- /xxxxxxx/xxxxxxx/xxx/dist/: 远程服务器部署位置
如果出现传输失败,一般是本地与服务器之间的ssh免密登录没有配置好
可执行ssh-copy-id本地密钥部署至服务器
ssh-copy-id -i ~/.ssh/id_rsa.pub root@xxx.xx.xxx.xxx
