基于Node.js實現(xiàn)壓縮和解壓縮的方法

更新時間：2018年02月13日 10:30:26 作者：蘇千

本篇文章主要介紹了基于Node.js實現(xiàn)壓縮和解壓縮的方法，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧

壓縮格式

zip 和 gzip 是兩種我們最常見到的壓縮格式，當(dāng)然，gzip 在 Windows 下很少有人接觸。

tar 是一種歸檔格式，它默認(rèn)不會壓縮，需要結(jié)合 gzip 來將最終的 tar 文件以 gzip 格式壓縮成為一個 tar.gz 文件，通常我們會縮寫為 tgz。

為什么沒有提到 rar？因為它是專利保護的算法，你可以免費獲得解壓工具，而壓縮工具是需要付費的。所以我們一般應(yīng)用場景下，很少會提供 rar 壓縮文件。

本文將分別介紹 gzip，tar，tgz 和 zip 的壓縮和解壓縮在 Node.js 下如何實現(xiàn)。

未壓縮文件庫

本文所使用的未壓縮文件庫來自于 urllib ，需要先 clone 它下來到指定目錄。

復(fù)制代碼代碼如下:

git clone https://github.com/node-modules/urllib.git nodejs-compressing-demo

gzip

在 Linux 的世界，每個工具的職責(zé)會很純粹，非常單一，如 gzip，它只會對文件進行壓縮，至于文件夾如何打包壓縮，跟它沒關(guān)系，那是 tar 要去負責(zé)的事情。

gzip 命令行壓縮一個文件

例如我們要將 nodejs-compressing-demo/lib/urllib.js 文件進行 gzip 壓縮，會得到一個 urllib.js.gz 文件，源文件會被刪除。

$ ls -l nodejs-compressing-demo/lib/urllib.js
-rw-r--r-- 1 a a 31318 Feb 12 11:27 nodejs-compressing-demo/lib/urllib.js

$ gzip nodejs-compressing-demo/lib/urllib.js

$ ls -l nodejs-compressing-demo/lib/urllib.js.gz
-rw-r--r-- 1 a a 8909 Feb 12 11:27 nodejs-compressing-demo/lib/urllib.js.gz

# 還原壓縮文件
$ gunzip nodejs-compressing-demo/lib/urllib.js.gz

文件大小從 31318 字節(jié)減少到 8909 字節(jié)，超過 3.5 倍的壓縮效果。

還可以通過 pipe 方式，結(jié)合 cat 命令，將文件壓縮并保存為任意文件：

$ ls -l nodejs-compressing-demo/README.md
-rw-r--r-- 1 a a 13747 Feb 12 11:27 nodejs-compressing-demo/README.md

$ cat nodejs-compressing-demo/README.md | gzip > README.md.gz

$ ls -l README.md.gz
-rw-r--r-- 1 a a 4903 Feb 12 11:50 README.md.gz

Node.js 實現(xiàn) gzip

當(dāng)然，我們不會真的從零開始實現(xiàn)一個 gzip 算法和工具，在 Node.js 的世界，早已有人為你準(zhǔn)備好這些基礎(chǔ)庫，我們只需要開箱即用。

本文將會使用 compressing 模塊，實現(xiàn)所有壓縮和解壓縮代碼。

為什么會選擇 compressing？因為它有足夠充分的代碼質(zhì)量和單元測試保證，處于活躍的維護狀態(tài)，API 非常友好，而且還支持流式接口。

Promise 接口

const compressing = require('compressing');

// 選擇 gzip 格式，然后調(diào)用 compressFile 方法
compressing.gzip.compressFile('nodejs-compressing-demo/lib/urllib.js', 'nodejs-compressing-demo/lib/urllib.js.gz')
 .then(() => {
  console.log('success');
 })
 .catch(err => {
  console.error(err);
 });

// 解壓縮是反響過程，接口都統(tǒng)一為 uncompress
compressing.gzip.uncompress('nodejs-compressing-demo/lib/urllib.js.gz', 'nodejs-compressing-demo/lib/urllib.js2')
 .then(() => {
  console.log('success');
 })
 .catch(err => {
  console.error(err);
 });

結(jié)合 async/await 的編程模型，代碼寫起來就是一個普通的異步 io 操作。

const compressing = require('compressing');

async function main() {
 try {
  await compressing.gzip.compressFile('nodejs-compressing-demo/lib/urllib.js',
   'nodejs-compressing-demo/lib/urllib.js.gz');
  console.log('success');
 } catch (err) {
  console.error(err);
 }

 // 解壓縮
 try {
  await compressing.gzip.uncompress('nodejs-compressing-demo/lib/urllib.js.gz',
   'nodejs-compressing-demo/lib/urllib.js2');
  console.log('success');
 } catch (err) {
  console.error(err);
 }
}

main();

Stream 接口

需要特別注意的是，使用 Stream 模式編程，需要處理每個 stream 的 error 事件，并且要手動銷毀所有 stream 。

fs.createReadStream('nodejs-compressing-demo/lib/urllib.js')
 .on('error', handleError)
 .pipe(new compressing.gzip.FileStream()) // It's a transform stream
 .on('error', handleError)
 .pipe(fs.createWriteStream('nodejs-compressing-demo/lib/urllib.js.gz2'))
 .on('error', handleError);

// 解壓縮，就是 pipe 的方向倒轉(zhuǎn)過來
fs.createReadStream('nodejs-compressing-demo/lib/urllib.js.gz2')
 .on('error', handleError)
 .pipe(new compressing.gzip.UncompressStream()) // It's a transform stream
 .on('error', handleError)
 .pipe(fs.createWriteStream('nodejs-compressing-demo/lib/urllib.js3'))
 .on('error', handleError);

根據(jù)官方的Backpressuring in Streams 推薦，我們應(yīng)該使用 pump 模塊來配合 Stream 模式編程，由 pump 來完成這些 Stream 的清理工作。

const pump = require('pump');

const source = fs.createReadStream('nodejs-compressing-demo/lib/urllib.js');
const target = fs.createWriteStream('nodejs-compressing-demo/lib/urllib.js.gz2');

pump(source, new compressing.gzip.FileStream(), target, err => {
 if (err) {
  console.error(err);
 } else {
  console.log('success');
 }
});

// 解壓縮
pump(fs.createReadStream('nodejs-compressing-demo/lib/urllib.js.gz2'),
  new compressing.gzip.FileStream(),
  fs.createWriteStream('nodejs-compressing-demo/lib/urllib.js3'),
  err => {
 if (err) {
  console.error(err);
 } else {
  console.log('success');
 }
});

Stream 接口的優(yōu)勢

Stream 接口看起來比 Promise 接口復(fù)雜多了，為何還會有這種應(yīng)用場景呢？

其實在 HTTP 服務(wù)領(lǐng)域，Stream 模型會有更大的優(yōu)勢，因為 HTTP 請求本身就是一個 Request Stream，如要將一個上傳文件以 gzip 壓縮返回，使用 Stream 接口不需要將上傳文件保存到本地磁盤，而是直接消費這個文件流。

使用 egg 文件上傳的示例代碼，我們稍微改造一下，就能實現(xiàn) gzip 壓縮然后返回。

const pump = require('pump');

class UploadFormController extends Controller {
 // ... other codes

 async upload() {
  const stream = await this.ctx.getFileStream();
  // 直接將壓縮流賦值給 ctx.body，實現(xiàn)邊壓縮邊返回的流式響應(yīng)
  this.ctx.body = pump(stream, new compressing.gzip.FileStream());
 }
}

tar | gzip > tgz

gzip 章節(jié)可以提前知道，tar 是負責(zé)對文件夾進行打包:package:的。

例如要對 nodejs-compressing-dem o 整個文件夾打包成一個文件發(fā)送給別人，可以通過 tar 命令完成。

$ tar -c -f nodejs-compressing-demo.tar nodejs-compressing-demo/

$ ls -l nodejs-compressing-demo.tar
-rw-r--r-- 1 a a 206336 Feb 12 14:01 nodejs-compressing-demo.tar

如大家所見，tar 打包出來的文件一般都比較大，因為它是未壓縮的，大小跟實際文件夾總大小接近。所以我們都會在打包同時進行壓縮。

$ tar -c -z -f nodejs-compressing-demo.tgz nodejs-compressing-demo/

$ ls -l nodejs-compressing-demo.tgz
-rw-r--r-- 1 a a 39808 Feb 12 14:07 nodejs-compressing-demo.tgz

tar 和 tgz 超過 5 倍大小的差異，可以大大減少網(wǎng)絡(luò)傳輸帶寬。

Node.js 實現(xiàn) tgz

Promise 接口

先使用 compressing.tar.compressDir(sourceDir, targetFile) 將一個文件夾打包到一個 tar 文件，然后使用上文的 gzip 壓縮方式，將 tar 文件壓縮為 tgz 文件。

const compressing = require('compressing');

compressing.tar.compressDir('nodejs-compressing-demo', 'nodejs-compressing-demo.tar')
 .then(() => {
  return compressing.gzip.compressFile('nodejs-compressing-demo.tar',
   'nodejs-compressing-demo.tgz');
 });
 .then(() => {
  console.log('success');
 })
 .catch(err => {
  console.error(err);
 });

// 解壓縮
compressing.gzip.uncompress('nodejs-compressing-demo.tgz', 'nodejs-compressing-demo.tar')
 .then(() => {
  return compressing.tar.uncompress('nodejs-compressing-demo.tar',
   'nodejs-compressing-demo2');
 });
 .then(() => {
  console.log('success');
 })
 .catch(err => {
  console.error(err);
 });

結(jié)合 async/await 的編程模型，代碼寫起來會更加容易閱讀：

const compressing = require('compressing');

async function main() {
 try {
  await compressing.tar.compressDir('nodejs-compressing-demo',
   'nodejs-compressing-demo.tar');
  await compressing.gzip.compressFile('nodejs-compressing-demo.tar',
   'nodejs-compressing-demo.tgz');
  console.log('success');
 } catch (err) {
  console.error(err);
 }
 
 // 解壓縮
 try {
  await compressing.gzip.uncompress('nodejs-compressing-demo.tgz',
   'nodejs-compressing-demo.tar');
  await compressing.tar.uncompress('nodejs-compressing-demo.tar',
   'nodejs-compressing-demo2');
  console.log('success');
 } catch (err) {
  console.error(err);
 }
}

main();

Stream 接口

通過 compressing.tar.Stream 類，可以動態(tài)添加任意文件、文件夾到一個 tar stream 對象中，非常靈活。

const tarStream = new compressing.tar.Stream();
// dir
tarStream.addEntry('dir/path/to/compress');
// file
tarStream.addEntry('file/path/to/compress');
// buffer
tarStream.addEntry(buffer);
// stream
tarStream.addEntry(stream);

const destStream = fs.createWriteStream('path/to/destination.tgz');
pump(tarStream, new compressing.gzip.FileStream(), destStream, err => {
 if (err) {
  console.error(err);
 } else {
  console.log('success');
 }
});

zip

zip 其實可以看作是 tar + gzip 的「商業(yè)化」結(jié)合，它讓使用者不需要區(qū)分是壓縮文件還是壓縮文件夾，反正用我 zip 就對了。

使用 zip 命令行工具壓縮一個文件夾的例子：

$ zip -r nodejs-compressing-demo.zip nodejs-compressing-demo/
 adding: nodejs-compressing-demo/ (stored 0%)
 adding: nodejs-compressing-demo/test/ (stored 0%)
 ...
 adding: nodejs-compressing-demo/.travis.yml (deflated 36%)

$ ls -l nodejs-compressing-demo.*
-rw-r--r-- 1 a a 206336 Feb 12 14:06 nodejs-compressing-demo.tar
-rw-r--r-- 1 a a  39808 Feb 12 14:07 nodejs-compressing-demo.tgz
-rw-r--r-- 1 a a  55484 Feb 12 14:34 nodejs-compressing-demo.zip

通過 tgz 和 zip 文件大小對比，可以看出默認(rèn)的壓縮參數(shù)下，gzip 的效果會比 zip 好。

Node.js 實現(xiàn) zip

實現(xiàn)代碼跟 tar 類似，只不過默認(rèn)是壓縮的，不需要再添加 gzip 的過程。

const compressing = require('compressing');

compressing.zip.compressDir('nodejs-compressing-demo', 'nodejs-compressing-demo.zip')
 .then(() => {
  console.log('success');
 })
 .catch(err => {
  console.error(err);
 });

// 解壓縮
compressing.zip.uncompress('nodejs-compressing-demo.zip', 'nodejs-compressing-demo3')
 .then(() => {
  console.log('success');
 })
 .catch(err => {
  console.error(err);
 });

總結(jié)

基于 Node.js 實現(xiàn)的壓縮和解壓縮是否比想象中簡單？感謝 npm 這個巨人，讓我們編程也能擁有命令行工具那樣簡單的體驗。

無論是 Promise 接口，還是 Stream 接口，都有它最合適的場景，你會選擇了嗎？

到此，你擁有的壓縮和解壓縮能力，你能夠做什么樣的服務(wù)和功能呢？

以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: