博客 / 詳情

返回

使用Node.js、pm2和ssh2模塊實現一個簡單的Node.js項目部署腳本

本文將介紹如何使用Node.js和ssh2模塊實現一個簡單的部署腳本，將本地的項目文件上傳到遠程服務器上。我們將使用dotenv模塊來管理環境變量，以及child_process模塊來執行命令行操作。

首先，我們需要安裝ssh2和dotenv模塊：

npm install ssh2 dotenv --save

然後，我們需要在項目根目錄下創建一個.env文件，用來存放一些敏感的配置信息，例如服務器的IP地址、端口號、用户名、私鑰等。這樣，我們就可以避免將這些信息暴露在代碼中，也方便我們根據不同的環境進行切換。.env文件的內容如下：

HOST=192.168.1.100
SSHPORT=22
USER=root
KEYFILE=~/.ssh/id_rsa
SSHKEY="
-----BEGIN OPENSSH PRIVATE KEY-----
...
-----END OPENSSH PRIVATE KEY-----
"
const fs = require('fs');
const Client = require('ssh2').Client;
require('dotenv').config();

其中，fs模塊是Node.js內置的文件系統模塊，用來讀寫文件；Client是ssh2模塊提供的一個類，用來創建SSH連接；dotenv模塊是用來加載.env文件中的配置信息到process.env對象中。

然後，我們需要定義一些常量，用來存放SSH連接配置和本地目錄路徑和遠程目錄路徑：

// SSH連接配置
const sshConfig = {
    host: process.env.HOST || '127.0.0.1',
    port: process.env.SSHPORT || 22,
    username: process.env.USER || 'root',
    privateKey: process.env.SSHKEY || fs.readFileSync(process.env.KEYFILE || '/.ssh/id_rsa').toString(),
    // 這裏使用的是通過密鑰登入，使用密碼登入也是可以的，兩種配置項可以並存，其中一個失敗了ssh2會則嘗試另一個方法
};

// 本地目錄路徑和遠程目錄路徑
const localDir = __dirname;
const remoteDir = '/www/wwwroot/img-service';

其中，我們使用了process.env對象中的屬性來獲取環境變量的值，如果沒有定義，則使用默認值。注意，私鑰需要轉換為字符串格式。

接着，我們需要創建一個Client實例，並調用connect方法來建立SSH連接：

// 創建SSH連接
const conn = new Client();
conn.on('ready', () => {
    console.log('SSH連接成功');
    // ...
}).connect(sshConfig);

// 監聽error事件  
conn.on('error', (err) => {  
    console.error('SSH連接失敗', err);  
});  
  
// 結束SSH連接  
conn.on('end', () => {  
    console.log('SSH連接已斷開');  
});

在ready事件的回調函數中，我們需要進行部署操作。具體來説，我們需要做兩件事：一是執行npm run build命令來構建項目；二是將構建後的文件上傳到遠程服務器上。(當然，構建指令也可以在連接之前進行)

// 項目構建
const { execSync } = require('child_process');
execSync('npm run build', { stdio: 'inherit' })

execSync 是 Node.js 的一個內置模塊，它可以同步地執行一個子進程，並返回子進程的輸出。這樣可以避免異步的回調地獄，也可以保證構建的順序和正確性。stdio 參數是用來控制子進程的輸入輸出的，它可以是一個數組或一個字符串。如果是一個數組，那麼它表示子進程的標準輸入、標準輸出和標準錯誤的流。如果是一個字符串，那麼它表示子進程的所有流的模式。inherit 表示子進程的流和父進程的流相同，也就是説，子進程的輸出會顯示在父進程的控制枱中。

歐克，現在我們寫一下將本地目錄下的所有文件上傳至服務器上指定目錄的代碼，使用sftp進行文件上傳：

    // 將本地目錄下的所有文件上傳至服務器上指定目錄
    const uploadPromise = [];
    conn.sftp((err, sftp) => {
        if (err) throw err;
        // 待上傳文件or目錄
        const files = ['dist', 'package.json', '.env'];

        const uploadFile = (file) => {
            return new Promise((resolve, reject) => {
                try {
                    const localFilePath = localDir + '/' + file;
                    const remoteFilePath = remoteDir + '/' + file;
                    const readStream = fs.createReadStream(localFilePath);
                    const writeStream = sftp.createWriteStream(remoteFilePath);
                    writeStream.on('close', () => {
                        console.log(`文件 ${file} 上傳成功`);
                        resolve();
                    });
                    writeStream.on('error', (err) => {
                        console.log(`文件 ${file} 上傳失敗：${err}`);
                        reject(err);
                    });
                    readStream.pipe(writeStream);
                } catch (error) {
                    reject(error);
                }
            });
        }

同時我們需要有人解析文件目錄，並執行我們的上傳指令：

        const uploadDir = (files) => {
            files.forEach((file) => {
                // 檢查是否存在文件
                const isExist = fs.existsSync(file);
                const stat = fs.lstatSync(file);
                if (!isExist) {
                    console.log(`文件 ${file} 不存在`);
                }else if (stat.isDirectory(file)){
                    const dirFiles = fs.readdirSync(file);
                    uploadDir(dirFiles.map((dirFile) => file + '/' + dirFile));
                }else if (stat.isFile(file)){
                    uploadPromise.push(uploadFile(file));
                }
            });
        }
        uploadDir(files);

最後，還記得我們收集的Promise數組嗎？直接用Promise.all幫我們處理等待全部文件上傳後的回調：

        Promise.all(uploadPromise).then(() => {
            console.log('所有文件上傳成功');
            // 執行SSH命令
            conn.shell((err, stream) => {
                if (err) throw err;
                stream.on('close', () => {
                    console.log('遠程命令執行完畢');
                    conn.end();
                }).on('data', (data) => {
                    console.log('遠程命令輸出：\n' + data);
                }).stderr.on('data', (data) => {
                    console.log('遠程命令錯誤：\n' + data);
                });
                stream.end('ls -l /www/wwwroot/img-service\npm2 restart img-service\nexit\n');
            });
        }).catch((err) => {
            console.log('上傳失敗：' + err);
        });

歐克，最後附上完整代碼

const fs = require('fs');
const Client = require('ssh2').Client;
require('dotenv').config();

// 項目構建
const { execSync } = require('child_process');
execSync('npm run build', { stdio: 'inherit' })

// SSH連接配置
const sshConfig = {
    host: process.env.HOST || '127.0.0.1',
    port: process.env.SSHPORT || 22,
    username: process.env.USER || 'root',
    privateKey: process.env.SSHKEY || fs.readFileSync(process.env.KEYFILE || '/.ssh/id_rsa').toString(),
};

// 本地目錄路徑和遠程目錄路徑
const localDir = __dirname;
const remoteDir = '/www/wwwroot/img-service';


// 創建SSH連接
const conn = new Client();
// 監聽ready事件
conn.on('ready', () => {
    console.log('SSH連接成功');

    // 將本地目錄下的所有文件上傳至服務器上指定目錄
    const uploadPromise = [];
    conn.sftp((err, sftp) => {
        if (err) throw err;
        const files = ['dist', 'package.json', '.env'];

        const uploadFile = (file) => {
            return new Promise((resolve, reject) => {
                try {
                    const localFilePath = localDir + '/' + file;
                    const remoteFilePath = remoteDir + '/' + file;
                    const readStream = fs.createReadStream(localFilePath);
                    const writeStream = sftp.createWriteStream(remoteFilePath);
                    writeStream.on('close', () => {
                        console.log(`文件 ${file} 上傳成功`);
                        resolve();
                    });
                    writeStream.on('error', (err) => {
                        console.log(`文件 ${file} 上傳失敗：${err}`);
                        reject(err);
                    });
                    readStream.pipe(writeStream);
                } catch (error) {
                    reject(error);
                }
            });
        }

        const uploadDir = (files) => {
            files.forEach((file) => {
                // 檢查是否存在文件
                const isExist = fs.existsSync(file);
                const stat = fs.lstatSync(file);
                if (!isExist) {
                    console.log(`文件 ${file} 不存在`);
                }else if (stat.isDirectory(file)){
                    const dirFiles = fs.readdirSync(file);
                    uploadDir(dirFiles.map((dirFile) => file + '/' + dirFile));
                }else if (stat.isFile(file)){
                    uploadPromise.push(uploadFile(file));
                }
            });
        }
        uploadDir(files);

        Promise.all(uploadPromise).then(() => {
            console.log('所有文件上傳成功');
            // 執行SSH命令
            conn.shell((err, stream) => {
                if (err) throw err;
                stream.on('close', () => {
                    console.log('遠程命令執行完畢');
                    conn.end();
                }).on('data', (data) => {
                    console.log('遠程命令輸出：\n' + data);
                }).stderr.on('data', (data) => {
                    console.log('遠程命令錯誤：\n' + data);
                });
                stream.end('ls -l /www/wwwroot/img-service\npm2 restart img-service\nexit\n');
            });
        }).catch((err) => {
            console.log('上傳失敗：' + err);
        });
    });
}).connect(sshConfig);

// 監聽error事件
conn.on('error', (err) => {
    console.error('SSH連接失敗', err);
});

// 結束SSH連接
conn.on('end', () => {
    console.log('SSH連接已斷開');
});
node.js , pm2 , ssh2 , 前端
user avatar ivyzhang 頭像 suporka 頭像 heptagon 頭像 tempest_619c7f9d4e321 頭像 amsterdam_5caf807441f49 頭像 wuyuedexingkong 頭像 user_p5fejtxs 頭像 geoffzhu 頭像 yzsunlei 頭像 carloslab 頭像 643104191 頭像 anetin 頭像
32 位用戶收藏了這個故事！

發佈 評論

Some HTML is okay.