{ "componentChunkName": "component---src-templates-blog-post-jsx", "path": "/post/nodejs-is-now-supported-brotli-compression/", "result": {"data":{"site":{"siteMetadata":{"title":"WEB EGG","author":"Leko - CTO at Yuimedi"}},"markdownRemark":{"id":"64e5d54e-ef93-50be-a1b3-31dced3d6ac2","excerpt":"以下の PR により、Node.js に Brotli 圧縮がサポートされました。 — zlib: add Brotli support by addaleax · Pull Request #24938 · nodejs/node まだ master に入ったばかり（2019/01/06 マージ）なので 201…","html":"

以下の PR により、Node.js に Brotli 圧縮がサポートされました。

\n
\n

— zlib: add Brotli support by addaleax · Pull Request #24938 · nodejs/node

\n
\n

まだ master に入ったばかり（2019/01/06 マージ）なので 2019/01/08 現在リリースはされていませんが、手元でビルドすれば試せるようになります。
\n2019/01/20: 11.7.0 でリリースされました。リリースノート

\n

Brotli とは

\n

Brotli とは、Google が作成した新しいデータ圧縮/解凍アルゴリズムの一種です。
\ngzip(Zopfli)と比較して高い圧縮率と圧縮/解凍のパフォーマンスが特徴です。HTML や JavaScript などと相性の良い辞書が用いられており、web 関連のリソースにおいてより高い圧縮率を発揮します。圧縮・解凍のパフォーマンスもよく、gzip に変わる新しい圧縮形式として注目されています。\nIE を除くメジャーなブラウザですでにサポートされており、現時点で Brotli でコンテンツを配信している web サービス、web サイトも多いことでしょう。

\n

Brotli 自体については以下の記事がとても参考になりました。

\n
\n

— WEB スピード向上・転送量削減する Brotli 圧縮と CDN の連携 | REDBOX Labo
\n— Brotli を用いた静的コンテンツ配信最適化と Accept-Encoding: br について | blog.jxck.io

\n
\n

なお当ブログでも.br（Brotli の拡張子）と.gz の静的ファイルを配布しています。

\n

背景

\n

Brotli に関しての議論は以下の Issue から確認できます。

\n
\n

— Feature Idea: Brotli support in core · Issue #18964 · nodejs/node

\n
\n

TLDR;
\nIE 以外のほぼすべてのモダンブラウザが Brotli 形式のリクエストをサポートしたので、コアに入れようという話です。

\n

これまでの Brotli の利用方法

\n

これまでは Brotli 圧縮を利用するために、主に２つの npm パッケージがよく使われていました。
\ngoogle/brotliにて提供されている C++のコードを gyp でビルドするiltorbと、Emscripten でラップしたbrotliの２つです。
\nDL 数の変遷はこちら。

\n
\n

\n \n \n \n \n \n \n
\nhttps://npmcharts.com/compare/iltorb,brotli

\n
\n

Google 公式の C++をそのまま Node.js で動くよう port にした iltorb が流行ったあとに、gyp 不要でお手軽な brotli が徐々に人気を獲得していったように見えます。DL 数が乱高下しているところはなにがあったんでしょう。。。

\n

なお当ブログは Brotli 圧縮のためにgatsby-plugin-brotliを利用しています。このプラグインは内部で brotli の方を利用していました。

\n

これからの Brotli の利用方法

\n

Brotli サポートがリリースされれば、npm パッケージには不要になり、Node.js のzlibモジュールから Brotli が利用できるようになります。
\n使い方はPR 内のドキュメントの差分を見るのがわかりやすいです。HTTP サーバでどのように Brotli のリクエストを扱えばいいかのデモコードなどがあります。

\n

例えば文字列を Brotli で圧縮して解凍するプログラムは次ようになります。
\nなお、この記事を作成した時点ではまだリリースされてないので、試すには master ブランチでビルドした最新版の Node.js が必要になります。

\n
const {\n  brotliCompress,\n  brotliCompressSync,\n  brotliDecompress,\n  brotliDecompressSync,\n} = require('zlib')\nconst { promisify } = require('util')\n\nconst text = 'Hello world'\n\n// Promise\n;(async () => {\n  const brotliCompressAsync = promisify(brotliCompress)\n  const brotliDecompressAsync = promisify(brotliDecompress)\n\n  const compressed = await brotliCompressAsync(text)\n  const decodedBuffer = await brotliDecompressAsync(compressed)\n  const decodedText = decodedBuffer.toString()\n  console.log(decodedText) // => Hello world\n  console.log(decodedText === text) // => true\n})()\n\n// Sync\nconst compressed = brotliCompressSync(text)\nconst decodedBuffer = brotliDecompressSync(compressed)\nconst decodedText = decodedBuffer.toString()\nconsole.log(decodedText) // => Hello world\nconsole.log(decodedText === text) // => true
\n

brotliCompress, brotliCompressSyncが圧縮、brotliDecompress, brotliDecompressSyncが解凍用の関数です。
\n圧縮および解凍には、String, Buffer, ArrayBufferなどを渡せます。

\n

圧縮率などのオプションを変更するには zlib.constants の中にある定数たちを使います。詳しくはドキュメントを参照してください。
\n圧縮率はBROTLI_MIN_QUALITYからBROTLI_MAX_QUALITYの間の整数値が指定できます。

\n
const { constants, brotliCompressSync } = require('zlib')\nconst { BROTLI_PARAM_QUALITY, BROTLI_MAX_QUALITY } = constants\n\nconst text = 'Hello world'\nconst maxCompressed = brotliCompressSync(text, {\n  params: {\n    [BROTLI_PARAM_QUALITY]: BROTLI_MAX_QUALITY,\n  },\n})
\n

stream を利用したサンプルはこんな感じです。

\n
const fs = require('fs')\nconst { createBrotliCompress } = require('zlib')\n\nfs.createReadStream('./test.txt')\n  .pipe(createBrotliCompress())\n  .pipe(fs.createWriteStream('./test.txt.br'))
\n
const fs = require('fs')\nconst { createBrotliDecompress } = require('zlib')\n\nconst pipeline = fs\n  .createReadStream('./test.txt.br')\n  .pipe(createBrotliDecompress())\n\n;(async () => {\n  let text = ''\n  for await (let chunk of pipeline) {\n    text += chunk\n  }\n\n  console.log(text)\n})()
\n

さいごに

\n

web とのシナジーが高い Brotli ですが、実際のところ.br ファイルを配信するには Apache や nginx・h2o などのレイヤで処理させたり CDN 側に移譲したりすることが多いと思います。仮に実装するとしても express のミドルウェア（や何かしらの npm パッケージ）を使うことがほとんどで、zlib を用いて自前で Node.js レイヤで圧縮プログラムを書く機会はそう多くないと思います。そういったサービスやライブラリの中身が npm モジュールではなく zlib モジュールにおきかわるだけで、実質的な恩恵/影響を受けることは少ないかもしれません。

\n

ちなみに私は CLI ツールや書き捨ての変換スクリプトを書くときに.gz を読み書きするために結構使ってます。これからは gzip じゃなくても問題ない場合は積極的に Brotli を使っていこうと思います。

\n

多くのユースケースにおいて直接的な恩恵は少ないかもしれませんが、Brotli とは何か、素の Node.js だけで Brotli 圧縮/解凍できるようになったことを頭の片隅に入れておき、使いどころが来たらここぞとばかりに使うといいかなと思います。

","timeToRead":6,"frontmatter":{"title":"Node.jsの11.7.0からzlibモジュールでBrotli圧縮が使えるようになりました","tags":["Node.js"],"date":"January 08, 2019","featuredImage":null}}},"pageContext":{"slug":"/nodejs-is-now-supported-brotli-compression/","previous":{"fields":{"slug":"/impression-comparison-of-middleman-and-gatsby/"},"frontmatter":{"title":"ブログをMiddlemanからGatsbyに乗り換えた雑感","tags":["JavaScript","Gatsby","Middleman"]}},"next":{"fields":{"slug":"/gatsby-remark-discoverable-oembed/"},"frontmatter":{"title":"Gatsbyの記事にoEmbed準拠のコンテンツを埋め込めるようにした","tags":["JavaScript","Gatsby","oEmbed","AST","remark"]}}}}, "staticQueryHashes": ["2585454260","2954598359"]}