Node.js querystring モジュール

Node.js 組み込みモジュール


querystring は Node.js に組み込まれたコアモジュールで、URLクエリ文字列(query string)の解析とフォーマットに特化しています。クエリ文字列はURL内の疑問符(?)の後の部分で、通常はキーと値のペアで構成されます。例:?name=John&age=30。

このモジュールは、フロントエンドとバックエンド間のデータ転送やAPI開発などのシーンで非常に実用的で、開発者がURLパラメータを簡単に処理するのに役立ちます。


コアメソッドの解説

querystring.parse(str[, sep[, eq[, options]]])

クエリ文字列をJavaScriptオブジェクトに解析します。

パラメータの説明:

  • str:解析するクエリ文字列
  • sep(オプション):キーと値のペアを区切るための区切り文字。デフォルトは'&'
  • eq(オプション):キーと値を区切るための区切り文字。デフォルトは'='
  • options(オプション):設定オブジェクト
    • maxKeys:解析する最大キー数を指定します。デフォルトは1000
    • decodeURIComponent:デコードに使用する関数。デフォルトはquerystring.unescape()

サンプルコード:

例

const querystring = require('querystring');

const query = 'name=John&age=30&city=New+York';
const parsed = querystring.parse(query);

console.log(parsed);
// 出力: { name: 'John', age: '30', city: 'New York' }

querystring.stringify(obj[, sep[, eq[, options]]])

JavaScriptオブジェクトをクエリ文字列にシリアライズします。

パラメータの説明:

  • obj:シリアライズするオブジェクト
  • sep(オプション):キーと値のペアの区切り文字。デフォルトは'&'
  • eq(オプション):キーと値の区切り文字。デフォルトは'='
  • options(オプション):設定オブジェクト
    • encodeURIComponent:エンコードに使用する関数。デフォルトはquerystring.escape()

サンプルコード:

例

const querystring = require('querystring');

const obj = {
  name: 'John Doe',
  age: 25,
  occupation: 'Software Developer'
};

const stringified = querystring.stringify(obj);
console.log(stringified);
// 出力: 'name=John%20Doe&age=25&occupation=Software%20Developer'

querystring.escape(str) と querystring.unescape(str)

これらの2つのメソッドは、それぞれクエリ文字列内の特殊文字のエンコードとデコードに使用されます。

サンプルコード:

例

const querystring = require('querystring');

const str = 'Hello World!';
const escaped = querystring.escape(str);
console.log(escaped); // 出力: 'Hello%20World%21'

const unescaped = querystring.unescape(escaped);
console.log(unescaped); // 出力: 'Hello World!'

実際の適用シーン

1. GETリクエストパラメータの処理

例

const http = require('http');
const querystring = require('querystring');

http.createServer((req, res) => {
  if (req.url.includes('?')) {
    const queryString = req.url.split('?')[1];
    const params = querystring.parse(queryString);
   
    console.log(params);
    res.end(`Received parameters: ${JSON.stringify(params)}`);
  } else {
    res.end('No query parameters received');
  }
}).listen(3000);

2. APIクエリ文字列の構築

例

const querystring = require('querystring');

const apiParams = {
  q: 'node.js',
  page: 1,
  limit: 10,
  sort: 'desc'
};

const apiUrl = `https://api.example.com/search?${querystring.stringify(apiParams)}`;
console.log(apiUrl);
// 出力: 'https://api.example.com/search?q=node.js&page=1&limit=10&sort=desc'

注意事項

  1. エンコードの問題:デフォルトでは、querystring は特殊文字をエンコード/デコードします。エンコード方法をカスタマイズする必要がある場合は、encodeURIComponent 或 decodeURIComponent関数。

  2. データ型:解析されたすべての値は文字列型であるため、手動で他の型(数値、ブール値など)に変換する必要があります。

  3. ネストされたオブジェクト:querystring モジュールはネストされたオブジェクトの解析とシリアライズをサポートしていません。複雑なデータ構造を処理する必要がある場合は、JSON形式の使用を検討できます。

  4. URL安全文字:スペースは+ではなく%20としてエンコードされます。これはencodeURIComponentの動作とは異なります。


代替案

querystring モジュールは非常に実用的ですが、Node.js の新しいバージョンでは URL および URLSearchParams API の使用が推奨されています。これらはより現代的で、より包括的な URL 処理機能を提供します。

例

// URLSearchParams を使用した例
const params = new URLSearchParams('name=John&age=30');
console.log(params.get('name')); // 出力: 'John'

まとめ

querystring モジュールは Node.js でクエリ文字列を処理するための強力なツールであり、特に単純なキーと値のペアデータの処理に適しています。そのコアメソッド(parse、stringify、escape、unescape)を習得することで、開発効率を大幅に向上させることができます。より複雑なURL処理のニーズには、URL および URLSearchParams API の使用を検討できます。

Node.js 組み込みモジュール

その他の拡張機能