Node.js で DeprecationWarning: Buffer() is deprecated と出た？原因と解決策

2024-04-11

Node.js と npm における Buffer() の非推奨化について

Node.js v17.0.0 以降、Buffer() コンストラクタはセキュリティと使いやすさの問題により非推奨になりました。スクリプトを別のサーバーに移行すると、DeprecationWarning が発生する可能性があります。

原因

Buffer() は、バイナリデータのバッファを作成するために使用されます。しかし、いくつかの問題があります。

セキュリティ: バッファオーバーフロー攻撃に対して脆弱です。
使いにくさ: バッファの管理が複雑で、メモリリークが発生しやすいです。

解決策

Buffer() の代わりに、以下のいずれかの方法を使用することを推奨します。

Buffer.alloc() : 指定されたサイズで新しいバッファを作成します。

例

// 非推奨
const buffer = new Buffer(10);

// 推奨
const buffer = Buffer.alloc(10);

// または
const buffer = Buffer.from([1, 2, 3]);

影響を受けるコード

Buffer() を直接使用しているコードはすべて影響を受けます。また、Buffer を使用しているライブラリを使用しているコードも影響を受ける可能性があります。

移行手順

使用しているコードで Buffer() を使用している箇所をすべて特定します。
各箇所で Buffer.alloc()、Buffer.allocUnsafe()、または Buffer.from() のいずれかに置き換えます。
コードをテストして、問題がないことを確認します。

補足

この問題は Node.js v17.0.0 で導入されましたが、将来的に Node.js の将来のバージョンで Buffer() は削除される予定です。
問題を解決するために、コードをできるだけ早く移行することを推奨します。

例 1: Buffer.alloc() を使用して新しいバッファを作成する

// 非推奨
const buffer1 = new Buffer(10);

// 推奨
const buffer2 = Buffer.alloc(10);

// 両方のバッファは同じ内容になります
console.log(buffer1.toString()); // ""
console.log(buffer2.toString()); // ""

// 非推奨
const buffer1 = new Buffer(10);

// 推奨
const buffer2 = Buffer.allocUnsafe(10);

// バッファの内容は初期化されません
console.log(buffer1.toString()); // ""
console.log(buffer2.toString()); // "�" (ランダムな文字列)

const data = [1, 2, 3];

// 非推奨
const buffer1 = new Buffer(data);

// 推奨
const buffer2 = Buffer.from(data);

// 両方のバッファは同じ内容になります
console.log(buffer1.toString()); // "1,2,3"
console.log(buffer2.toString()); // "1,2,3"

ファイルの内容を読み込んでバッファを作成する:

const fs = require('fs');

const buffer = Buffer.from(fs.readFileSync('file.txt'));

文字列からバッファを作成する:

const buffer = Buffer.from('Hello, world!');

バッファを文字列に変換する:

const buffer = Buffer.from('Hello, world!');

const string = buffer.toString();

console.log(string); // "Hello, world!"

Buffer() の代替方法

Typed Arrays は、バイナリデータを表すための JavaScript の標準的な方法です。Buffer よりも効率的で安全です。

// Uint8Array を使用して新しいバッファを作成する
const buffer = new Uint8Array(10);

// バッファに値を設定する
buffer[0] = 1;
buffer[1] = 2;

// バッファの内容を出力する
console.log(buffer); // Uint8Array(10) [1, 2, 0, 0, 0, 0, 0, 0, 0, 0]

ArrayBuffer は、バイナリデータの生のバッファを表します。Typed Arrays は ArrayBuffer を基に構築されています。

// ArrayBuffer を使用して新しいバッファを作成する
const buffer = new ArrayBuffer(10);

// バッファに値を設定する
const uint8Array = new Uint8Array(buffer);
uint8Array[0] = 1;
uint8Array[1] = 2;

// バッファの内容を出力する
console.log(buffer); // ArrayBuffer(10)

DataView は、ArrayBuffer のデータを異なる形式で読み書きするためのインターフェースを提供します。

// DataView を使用して新しいバッファを作成する
const buffer = new ArrayBuffer(10);
const dataView = new DataView(buffer);

// バッファに値を設定する
dataView.setInt8(0, 1);
dataView.setInt8(1, 2);

// バッファの内容を出力する
console.log(dataView); // DataView { byteOffset: 0, byteLength: 10 }

第三者ライブラリ

buffer や arraybuffer などのライブラリは、Buffer の代替として使用できます。

// buffer ライブラリを使用する
const buffer = require('buffer');

const buffer = buffer.alloc(10);

// バッファに値を設定する
buffer[0] = 1;
buffer[1] = 2;

// バッファの内容を出力する
console.log(buffer); // <Buffer 01 02 00 00 00 00 00 00 00 00>