如何利用node提升工作效率

這篇文章主要為大家展示了“如何利用node提升工作效率”，內容簡而易懂，條理清晰，希望能夠幫助大家解決疑惑，下面讓小編帶領大家一起研究并學習一下“如何利用node提升工作效率”這篇文章吧。

在工作項目中需要依賴外部文件，此文件由其他團隊維護，使用 jenkins 構建，構建產物推送至 [Amazon S3](aws.amazon.com/pm/serv-s3/…)，我們需要從 S3 手動下載文件然后復制到工程中，整個過程可以考慮自動化完成。

另外還遇到了一個嚴重的問題：我們需要的構建產物在 S3 中的路徑類似 'a/b//c/'，多余的一個 / 實際上是一個名為 '/' 的文件夾，此文件夾使用 windows 的 S3 Browser 可以正常識別，在 mac 下大概是因為 '/' 被看作文件分隔符，因此嘗試幾個 GUI 工具均無法正常識別目錄，因此 mac 開發者還需要在虛擬機中使用 windows 下載產物，這個過程是極其浪費且無意義的。

由于 Amazon 提供了 API 訪問的方式，因此想到可以實現腳本來完成下載更新的工作。

流程梳理

未使用腳本：

使用腳本：

jenkins → 產物名 → 執行腳本

這樣直接就可以完成了，可以省去手動流程，還不會出現 '/' 的 bug 問題。

開發

連接 AWS

這里使用 Amazon 提供的 aws-sdk，使用 S3 client，傳入 accessKeyId 和 secretAccessKey 就可以連接了：

import S3 from "aws-sdk/clients/s3";
const s3 = new S3({ credentials: { accessKeyId, secretAccessKey } });

下載文件

aws-sdk 中提供了 bucket 和文件的增刪改查接口，這里我們可以提前拿到 jenkins 構建出的產物文件名，這里需要根據文件名和位置下載文件：

const rs = s3
  .getObject({ Bucket: "your bucket name", Key: "file dir + path" })
  .createReadStream();

Bucket 即存儲文件的 Bucket 位置，Key 是文件在 S3 中的路徑信息，整個路徑相當于是目錄名 + 文件名。

這里我們可以獲取到一個 ReadStream，之后使用 node.js 可直接寫入本地：

const ws = fs.createWriteStream(path.join(__dirname, outputfilename));
rs.pipe(ws);

解壓

解壓使用 node-tar 工具，直接安裝即可：

npm install tar

extract 別名為 x，這里直接使用 tar.x 方法，此方法可以直接處理 ReadStream，將原始數據解壓后寫入文件中，因此我們這里直接把 ReadStream 傳入 tar.x 即可，不需要保存原始的 .tar 文件：

- const ws = fs.createWriteStream(path.join(__dirname, outputfilename));
- rs.pipe(ws);
+ rs.pipe(tar.x({ C: path.join(__dirname, outputfilename) }));

這里的 pipe 操作會返回 stream 對象，我們可以監聽 finish 方法來處理后續流程：

const s = rs.pipe(tar.x({ C: path.join(__dirname, outputfilename) }));
s.on('finish', () => {
	// do something ...
})

Flatten 目錄

原始文件有子文件夾，我們需要都移到最外層，因此需要做一個平鋪文件夾的操作。

這里使用 fs 相關 API 進行讀取，fs API 分為同步和異步兩種，同步 API 函數名以 Sync 結尾，異步函數默認為 callback error first 風格，在 fs/promises 下提供了對應的 promise 風格異步 API，這里根據需要使用即可。

由于我們的目錄只有一層，因此只做一層 flatten，如果有多層可以使用遞歸來實現：

async function flatten(dir) {
  const fileAndDirs = await fsp.readdir(dir);
  const dirs = fileAndDirs.filter((i) =>
    fs.lstatSync(path.join(dir, i)).isDirectory()
  );
  for (const innerDir of dirs) {
    const innerFile = await fsp.readdir(path.join(dir, innerDir));
    await Promise.all([
      innerFile
        .filter((item) => fs.lstatSync(path.join(dir, innerDir, item)).isFile())
        .map((item) =>
          fsp.rename(path.join(dir, innerDir, item), path.join(dir, item))
        ),
    ]);
    remove(path.join(dir, innerDir));
  }
}

復制到目標位置

之后復制到我們的工程目錄即可，復制只需要調用 copyFile API，對于不需要的文件這里使用正則表達式配置 exclude 黑名單：

async function copy(from, to) {
  const files = await fsp.readdir(from);
  await Promise.all(
    files
      .filter((item) => !exclude.test(item))
      .map((item) => fsp.copyFile(path.join(from, item), path.join(to, item)))
  );
}

配置文件

在實際使用時，配置文件要和代碼分離，這里的 accessKeyId 和 secretAccessKey 應該由每個使用者自己配置，因此放在單獨的配置文件中，此文件由用戶本地創建，在主程序中讀取相關配置內容：

// config.js
module.exports = {
  s3: {
    accessKeyId: 'accessKeyId',
    secretAccessKey: 'secretAccessKey',
  }
};
// main.js
if (!fs.existsSync('config.js')) {
  console.error('please create a config file');
  return;
}
const config = require(path.resolve(__dirname, 'config.js'));

傳遞參數

每次下載的文件名需要在調用時傳入，寫在文件中會頻繁修改，這里直接作為參數傳遞。

node.js 中可以通過 process.argv 來讀取，argv 是一個數組，這個數組第一個元素是 node 所在的安裝路徑，第二個元素是當前執行的腳本所在路徑，從第三個元素開始是自定義參數，因此需要從 process.argv[2] 開始。如果有復雜的命令行參數需求可以使用命令行參數解析庫如 commander，由于本例只需要一個參數，這里直接讀即可：

const filename = process.argv[2];
if (!filename) {
	console.error('please run script with params');
	return;
}

至此，一個可用的命令行工具就完成了。

以上是“如何利用node提升工作效率”這篇文章的所有內容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內容對大家有所幫助，如果還想學習更多知識，歡迎關注億速云行業資訊頻道！