Node.js API詳細解のzlibモジュールの使い方分析

本論文の実例はNode.js APIの詳細な解のzlibモジュールの使い方を述べている。皆さんに参考にしてあげます。具体的には以下の通りです。
Node.js API詳細解のzlib
zlibモジュールはGzipとDeflate/Inflateによる圧縮機能を提供しています。

const zlib = require('zlib');

圧縮または伸張データストリーム（例えばファイル）は、zlibストリームを介してソースデータストリームをターゲットストリームに転送することによって達成される。

const gzip = zlib.createGzip();
const fs = require('fs');
const inp = fs.createReadStream('input.txt');
const out = fs.createWriteStream('input.txt.gz');
inp.pipe(gzip).pipe(out);

zlibは、HTTPで定義されたgzipおよびdeflateコンテンツ符号化機構をサポートするために使用されてもよい。
HTTPのAcceept Ecodingヘッダフィールドは、クライアントによって受信された圧縮符号化をマークするために使用される。
なお、以下に示す例は大幅に簡略化され、基本的な概念を示している。zlibコードを使うとコストが高くなります。結果はキャッシュされます。

//        
const zlib = require('zlib');
const http = require('http');
const fs = require('fs');
const request = http.get({ host: 'example.com',
              path: '/',
              port: 80,
              headers: { 'Accept-Encoding': 'gzip,deflate' } });
request.on('response', (response) => {
 const output = fs.createWriteStream('example.com_index.html');
 switch (response.headers['content-encoding']) {
  //   ,      zlib.createUnzip()           
  case 'gzip':
   response.pipe(zlib.createGunzip()).pipe(output);
   break;
  case 'deflate':
   response.pipe(zlib.createInflate()).pipe(output);
   break;
  default:
   response.pipe(output);
   break;
 }
});

//      
//          gzip            .
//                .
const zlib = require('zlib');
const http = require('http');
const fs = require('fs');
http.createServer((request, response) => {
 const raw = fs.createReadStream('index.html');
 let acceptEncoding = request.headers['accept-encoding'];
 if (!acceptEncoding) {
  acceptEncoding = '';
 }
 //   ：         accept-encoding    .
 //    http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3
 if (/\bdeflate\b/.test(acceptEncoding)) {
  response.writeHead(200, { 'Content-Encoding': 'deflate' });
  raw.pipe(zlib.createDeflate()).pipe(response);
 } else if (/\bgzip\b/.test(acceptEncoding)) {
  response.writeHead(200, { 'Content-Encoding': 'gzip' });
  raw.pipe(zlib.createGzip()).pipe(response);
 } else {
  response.writeHead(200, {});
  raw.pipe(response);
 }
}).listen(1337);

Contstants（定数）
説明:
これらはzlib.hの全部の定数で定義されていますが、同時にrequire('zlib').constants定数にも定義されています。
注意：以前は、リキッド（'zlib'）からこれらの定数を直接取得することができました。例えば、zlib.Z_NOの_FLUSH.
現在もモジュールから直接これらの定数にアクセスできますが、推奨されていません。
デモ:

const zlib = require('zlib');
//      flush  .
zlib.constants.Z_NO_FLUSH
zlib.constants.Z_PARTIAL_FLUSH
zlib.constants.Z_SYNC_FLUSH
zlib.constants.Z_FULL_FLUSH
zlib.constants.Z_FINISH
zlib.constants.Z_BLOCK
zlib.constants.Z_TREES
//     /        .         ,             .
zlib.constants.Z_OK
zlib.constants.Z_STREAM_END
zlib.constants.Z_NEED_DICT
zlib.constants.Z_ERRNO
zlib.constants.Z_STREAM_ERROR
zlib.constants.Z_DATA_ERROR
zlib.constants.Z_MEM_ERROR
zlib.constants.Z_BUF_ERROR
zlib.constants.Z_VERSION_ERROR
//     .
zlib.constants.Z_NO_COMPRESSION
zlib.constants.Z_BEST_SPEED
zlib.constants.Z_BEST_COMPRESSION
zlib.constants.Z_DEFAULT_COMPRESSION
//     
zlib.constants.Z_FILTERED
zlib.constants.Z_HUFFMAN_ONLY
zlib.constants.Z_RLE
zlib.constants.Z_FIXED
zlib.constants.Z_DEFAULT_STRATEGY

Options
説明:
各クラスにはoptionsオブジェクトがあります。すべてのオプションはオプションです。
注意：いくつかのオプションは圧縮だけに関連しています。
デモ:

const zlib = require('zlib');
const Options = {
 flush: zlib.constants.Z_NO_FLUSH,
 finishFlush: zlib.constants.Z_FINISH,
 chunkSize: 16*1024,
 windowBits 2, //  8..15    ，        ，       ，      。    deflateInit，     15
 level: 6,  //(    ，  0-9  ，1    ，9     ，      6    。     )
 memLevel: 8,  // (                  ，1            。9     ，    。    8。     )
 strategy: 7, // (        ,     )
 dictionary: ' | | ',  // (     ，       )
 info: true  //(  true,    buffer   engine)
}

zlib.com nstants
説明:
Zlib相関定数を列挙したオブジェクトを提供します。
デモ:

const zlib = require('zlib');
console.log(zlib.constants);
// { Z_NO_FLUSH: 0,
//  Z_PARTIAL_FLUSH: 1,
//  Z_SYNC_FLUSH: 2,
//  Z_FULL_FLUSH: 3,
//  Z_FINISH: 4,
//  Z_BLOCK: 5,
//  Z_OK: 0,
//  Z_STREAM_END: 1,
//  Z_NEED_DICT: 2,
//  Z_ERRNO: -1,
//  Z_STREAM_ERROR: -2,
//  Z_DATA_ERROR: -3,
//  Z_MEM_ERROR: -4,
//  Z_BUF_ERROR: -5,
//  Z_VERSION_ERROR: -6,
//  Z_NO_COMPRESSION: 0,
//  Z_BEST_SPEED: 1,
//  Z_BEST_COMPRESSION: 9,
//  Z_DEFAULT_COMPRESSION: -1,
//  Z_FILTERED: 1,
//  Z_HUFFMAN_ONLY: 2,
//  Z_RLE: 3,
//  Z_FIXED: 4,
//  Z_DEFAULT_STRATEGY: 0,
//  ZLIB_VERNUM: 4784,
//  DEFLATE: 1,
//  INFLATE: 2,
//  GZIP: 3,
//  GUNZIP: 4,
//  DEFLATERAW: 5,
//  INFLATERAW: 6,
//  UNZIP: 7,
//  Z_MIN_WINDOWBITS: 8,
//  Z_MAX_WINDOWBITS: 15,
//  Z_DEFAULT_WINDOWBITS: 15,
//  Z_MIN_CHUNK: 64,
//  Z_MAX_CHUNK: Infinity,
//  Z_DEFAULT_CHUNK: 16384,
//  Z_MIN_MEMLEVEL: 1,
//  Z_MAX_MEMLEVEL: 9,
//  Z_DEFAULT_MEMLEVEL: 8,
//  Z_MIN_LEVEL: -1,
//  Z_MAX_LEVEL: 9,
//  Z_DEFAULT_LEVEL: -1 }

zlib.creat Deflate(options)
説明:
与えられたoptionsを持つ新しいDeflateオブジェクトを作成して返します。
deflateを使ってデータを圧縮することができます。
デモ:

const zlib = require('zlib');
const deflate = zlib.createDeflate();
const fs = require('fs');
const inp = fs.createReadStream('a.js');
console.log( inp.pipe(deflate) );
// Deflate {
//  _readableState:
//  ReadableState { ... },
//  bytesRead: 0,
//  _handle: Zlib { jsref: [Circular], onerror: [Function: zlibOnError] },
//  _hadError: false,
//  _writeState: Uint32Array [ 0, 0 ],
//  _outBuffer: ,
//  _outOffset: 0,
//  _level: -1,
//  _strategy: 0,
//  _chunkSize: 16384,
//  _flushFlag: 0,
//  _scheduledFlushFlag: 0,
//  _origFlushFlag: 0,
//  _finishFlushFlag: 4,
//  _info: undefined }

zlib.creat Inflate(options)
説明:
与えられたoptionsを持つ新しいInflateオブジェクトを作成して返します。
Inflateはdeflateフローを解凍するために使用されます。
デモ:

const zlib = require('zlib');
const deflate = zlib.createDeflate();
const inflate = zlib.createInflate();
const fs = require('fs');
const inp = fs.createReadStream('a.js');
console.log( inp.pipe(deflate).pipe(inflate) );

zlib.creat Deflate Raw(options)
説明:
与えられたオプティクスを持つ新しいDeflateオブジェクトを作成して返します。
deflateを使ってデータを圧縮し、zlibヘッダを付加しません。
デモ:

const zlib = require('zlib');
const deflateRaw = zlib.createDeflateRaw();
const fs = require('fs');
const inp = fs.createReadStream('a.js');
console.log( inp.pipe(deflateRaw) );

zlib.creat Inflate Raw(options)
説明:
与えられたoptionsを持つ新しいInflateオブジェクトを作成して返します。
Inflate Rawはラウdeflateストリームを解凍するために使用されます。
デモ:

const zlib = require('zlib');
const deflateRaw = zlib.createDeflateRaw();
const inflateRaw = zlib.createInflateRaw();
const fs = require('fs');
const inp = fs.createReadStream('a.js');
console.log( inp.pipe(deflateRaw).pipe(inflateRaw) );

zlib.creat Gzip(options)
説明:
与えられたoptionsを持つ新しいGunzipオブジェクトを作成して返します。
gzipを使ってデータを圧縮します。
デモ:

const zlib = require('zlib');
const gzip = zlib.createGzip();
const fs = require('fs');
const inp = fs.createReadStream('a.js');
console.log( inp.pipe(gzip) );

zlib.creat Ginzip(options)
説明:
与えられたoptionsを持つ新しいGunzipオブジェクトを作成して返します。
Ginzipを使ってgzipストリームを展開します。
デモ:

const zlib = require('zlib');
const gzip = zlib.createGzip();
const gunzip = zlib.createGunzip();
const fs = require('fs');
const inp = fs.createReadStream('a.js');
console.log( inp.pipe(gzip).pipe(gunzip) );

zlib.creat Unizip(options)
説明:
与えられたoptionsを持つ新しいUnzipオブジェクトを作成して返します。
Unzipオブジェクトは、自動検出ヘッド情報によりGzipまたはDeflate圧縮されたストリームを伸張する。
デモ:

const zlib = require('zlib');
const gzip = zlib.createGzip();
const unzip = zlib.createUnzip();
const fs = require('fs');
const inp = fs.createReadStream('a.js');
console.log( inp.pipe(gzip).pipe(unzip) );

Conveience Methods（簡便な使い方）
説明:
以上、各圧縮類の使用を紹介しました。いくつかの対応の簡便な使い方を紹介します。
これらの方法はすべてBuffer，TypeAray，DataView，または文字列を最初のパラメータとして使用します。
一つのコールバック関数はオプションの第二のパラメータとしてzlibクラスに提供され、コールバックで呼び出されます。
各方法に対応するものは同じパラメータを受け入れるものがありますが、コールバックのバージョンはありません。
zlib.deflate(buffer[，options]，calback)
zlib.deflate Sync(buffer[，options])
zlib.inflate(buffer[，options]，calback)
zlib.inflate Sync(buffer[，options])
zlib.deflate Raw(buffer[，options]，calback)
zlib.deflate RawSync(buffer[，options])
zlib.inflate Raw(buffer[，options]，calback)
zlib.inflate RawSync(buffer[，options])
zlib.gzip(buffer[，options]，calback)
zlib.gzipSync(ブザー[，options])
zlib.gunzip(ブザー[，options]，calback)
zlib.gunzipSync(buffer[，options])
zlib.unzip(buffer[，options]，calback)
zlib.unzipSync(buffer[，options])
使用方法は以下の通りです。
デモ:

const input = '.................................';
zlib.deflate(input, (err, buffer) => {
 if (!err) {
  console.log(buffer.toString('base64'));
 } else {
  //     
 }
});
const buffer = Buffer.from('eJzT0yMAAGTvBe8=', 'base64');
zlib.unzip(buffer, (err, buffer) => {
 if (!err) {
  console.log(buffer.toString());
 } else {
  //     
 }
});

ここで述べたように皆さんのnode.jsプログラムの設計に役に立ちます。