【Node.js】 ファイルをArrayBuffer経由で読み込み・保存する

元々Node.jsには固有のモジュールとしてBufferオブジェクトが存在していて、ファイルから読み込んだデータはBufferオブジェクトに格納されるように設計されています。

しかしECMAScriptの2015年版で、バッファーとして動作可能なArrayBufferオブジェクトがJavaScritとして標準搭載されました。

そのためブラウザ等でJavaScriptコードを作成してきた人は、BufferよりもArrayBufferの方が使いやすいです。

そこで今回は、Node.jsでファイルの入出力する際にArrayBufferを経由する方法をお伝えします。

ArrayBufferは任意のバイト数のメモリ（バッファー）を確保しが、確保したメモリに直接アクセスすることができません。

アクセスするには、DataViewまたはTypedArrayというオブジェクトをインターフェースとして使用します。

そのためこの記事では、DataViewやTypedArrayを用いた操作についてお伝えしています。

ファイルからデータを読み込み、ArrayBufferとして受け取るには、次のようにします。

const fs = require("fs");

fs.readFile("./binary.dat", (err, result) => {
    if (err) throw err;

    const u8 = new Uint8Array( result.buffer );
    
        // 同じバッファーを参照しているかの確認
    console.log( u8.buffer === result.buffer );  // true
});

コールバック関数の第二引数は、Node.js固有のBufferオブジェクトです。
BufferオブジェクトとArrayBufferオブジェクトは、仕様が異なるオブジェクトです。
そのためDataViewまたはTypedArrayに、バッファーとして渡すことができませんでした。

しかしNode.js v8からBufferオブジェクトに追加されたbufferプロパティは、ArrayBufferオブジェクトを返します。
そのため、このプロパティを使用して、DataViewまたはTypedArrayオブジェクトを作成することができます。

ネットで検索すると、次のようなコードを紹介している記事がありますが、古い記事が現在も上位表示されているようです。

const u8 = new Unit8Array( result.length );
for (let i = 0; i < result.length; i++ ) {
        u8[i] = result[i];
}

現在はbufferプロパティを使用できるので、ループで一つずつ代入する必要はありません。

ArrayBufferデータをファイルに書き込む場合、基本的にはDataViewまたはTypedArrayオブジェクトをfs.writeFileに渡すだけです。

const fs = require("fs");

const arr = Uint8Array.of(100,200,300,400);
fs.writeFile("./binary.dat", arr, err => {
    if (err) throw err;
    console.log("出力しました");
});

TypedArrayオブジェクトの種類に係らず、バッファーの内容がそのまま出力されます。

2バイト以上のTypedArrayオブジェクトを使用する場合は注意が必要です。

TypedArrayへのアクセスは、現在の環境のエンディアンが考慮されます。
そのためエンディアンが異なるシステム間でデータのやり取りがあると、上手く受け渡せない可能性があります。

詳しくは次のページを読んでみてください。
■【JavaScript】 2バイト以上のTypedArrayバイナリ保存はエンディアンに注意