【Node.js】dnsPromises.resolve4() の代替手法：コールバック、Promisify、外部ライブラリ

2025-05-27

もう少し詳しく見ていきましょう。

dns モジュールと dnsPromises API

Node.js の dns モジュールは、オペレーティングシステムが持つ DNS（Domain Name System）解決機能を利用するためのAPIを提供します。従来のコールバックベースのAPIに加えて、よりモダンな非同期処理を実現するために、Promise ベースのAPI が dns.promises という名前空間で提供されています。dnsPromises.resolve4() は、この Promise ベースの API の一部です。

resolve4() の役割

resolve4() メソッドは、与えられたホスト名を DNS サーバーに問い合わせ、そのホスト名に関連付けられた IPv4 アドレスのリストを取得します。IPv4 は、インターネットプロトコルバージョン4 のアドレス形式であり、192.168.1.1 のようにピリオドで区切られた4つの数字で表現されます。

メソッドの構文

dnsPromises.resolve4(hostname[, options])

options: 省略可能なオブジェクトで、DNS クエリの詳細な設定を行うことができます。例えば、ttl（Time-To-Live）を制御したり、使用する DNS サーバーを指定したりできます。指定しない場合はデフォルトの設定が使用されます。
hostname: 解決したいホスト名の文字列です。（例: 'google.com', 'nodejs.org'）

戻り値

dnsPromises.resolve4() は Promise オブジェクトを返します。この Promise は、非同期処理が完了すると以下のいずれかの状態になります。

Rejected (失敗): ホスト名の解決に失敗した場合（例: ホスト名が存在しない、DNS サーバーに接続できないなど）、エラーオブジェクトで拒否（reject）されます。エラーオブジェクトには、エラーの種類を示すコード（例: ENOTFOUND）やエラーメッセージが含まれます。
Fulfilled (成功): ホスト名の解決に成功した場合、解決された IPv4 アドレスの配列が格納された値で解決（resolve）されます。例えば、['172.217.160.142'] のような配列です。一つのホスト名に複数の IPv4 アドレスが関連付けられている場合、配列にはそれらのすべてが含まれます。

使用例

以下は、dnsPromises.resolve4() を使用して 'example.com' の IPv4 アドレスを取得する簡単な例です。

const dns = require('node:dns').promises;

async function resolveIPv4() {
  try {
    const addresses = await dns.resolve4('example.com');
    console.log('IPv4 アドレス:', addresses);
  } catch (err) {
    console.error('IPv4 アドレスの解決に失敗しました:', err);
  }
}

resolveIPv4();

このコードを実行すると、example.com に関連付けられた IPv4 アドレスのリストがコンソールに表示されます。もし解決に失敗した場合は、エラーメッセージが表示されます。

一般的なエラー

Error: getaddrinfo ENOTFOUND <hostname>:
- 意味: 指定された <hostname> に対応する IP アドレスが見つからなかったことを示します。DNS サーバーがそのホスト名を解決できなかった場合に発生します。
- 原因:
  - ホスト名が間違っている、または存在しない。
  - ネットワーク接続に問題があり、DNS サーバーにアクセスできない。
  - DNS サーバーの設定に問題がある。
  - ファイアウォールが DNS クエリ（通常は UDP/TCP ポート 53）をブロックしている。
- トラブルシューティング:
  - ホスト名が正しく入力されているか再確認してください。タイプミスがないか、大文字・小文字が正しいかなどを確認します。
  - インターネット接続が正常であることを確認してください。他のウェブサイトにはアクセスできますか？
  - ローカルの DNS サーバーの設定を確認してください。OS のネットワーク設定やルーターの設定を確認します。
  - ファイアウォールやセキュリティソフトウェアの設定を確認し、DNS クエリがブロックされていないか確認してください。
  - 別の DNS サーバー（例えば、Google Public DNS の 8.8.8.8 や Cloudflare DNS の 1.1.1.1）を使用するように一時的に変更して、問題が DNS サーバー自体にあるかどうかを確認してみるのも有効です。
Error: getaddrinfo ENODATA <hostname>:
- 意味: 指定された <hostname> は存在しますが、要求されたアドレスファミリ（この場合は IPv4）に対応するレコードが存在しないことを示します。
- 原因:
  - ホスト名は存在するものの、IPv4 アドレスが登録されていない（IPv6 のアドレスのみが登録されているなど）。
  - DNS サーバーの設定の問題。
- トラブルシューティング:
  - ホスト名が本当に IPv4 アドレスを持っているか確認してください。もし IPv6 アドレスしか持たない場合は、dnsPromises.resolve6() の使用を検討してください。
  - 別の DNS サーバーで同じホスト名を解決できるか試してみてください。問題が特定の DNS サーバーにある可能性があります。
Error: getaddrinfo EAI_AGAIN <hostname>:
- 意味: DNS サーバーが一時的に利用できない状態であることを示唆します。リトライすることで解決する可能性があります。
- 原因:
  - DNS サーバーが一時的に過負荷状態である。
  - ネットワークが一時的に不安定である。
- トラブルシューティング:
  - 数秒待ってから再度 dnsPromises.resolve4() を実行してみてください。
  - ネットワーク接続の状態を確認してください。
  - 問題が頻繁に発生する場合は、使用している DNS サーバーの安定性を確認することを検討してください。
TypeError: dnsPromises.resolve4 is not a function:
- 意味: dnsPromises オブジェクトに resolve4 という関数が存在しないことを示します。
- 原因:
  - Node.js のバージョンが古い可能性があります。dns.promises API は Node.js の比較的新しいバージョンで導入されました。
  - dns モジュールのインポート方法が間違っている可能性があります。
- トラブルシューティング:
  - 使用している Node.js のバージョンが dns.promises API をサポートしているか確認してください。Node.js v8.0.0 以降で利用可能です。
  - dns モジュールを正しくインポートしているか確認してください。正しいインポート方法は const dns = require('node:dns').promises; です。
Promise が返ってこない、またはハングする:
- 意味: dnsPromises.resolve4() を呼び出しても Promise が解決または拒否されず、処理が止まってしまうように見える。
- 原因:
  - ネットワーク接続が完全に途絶えている。
  - DNS サーバーが応答しない状態になっている。
  - 何らかの理由で Node.js のイベントループがブロックされている。
- トラブルシューティング:
  - ネットワーク接続を確認してください。
  - 別のネットワーク環境で試してみてください。
  - Node.js のイベントループがブロックされていないか、他の非同期処理が正常に完了しているかなどを確認してください。

トラブルシューティングの一般的なヒント

ファイアウォールやセキュリティソフトウェアの設定を確認: DNS クエリがブロックされていないか確認します。
Node.js のバージョンを確認: 古い Node.js のバージョンを使用している場合は、最新の安定版にアップデートすることを検討してください。
シンプルなコードで試す: 問題を特定するために、できるだけシンプルなコードで dnsPromises.resolve4() を実行してみます。
他の DNS 解決ツールを試す: nslookup や dig などのコマンドラインツールを使用して、同じホスト名を解決できるか試してみます。これにより、Node.js の問題なのか、ネットワークや DNS サーバーの問題なのかを切り分けることができます。
DNS サーバーの確認: 使用している DNS サーバーが正常に動作しているか、応答しているかを確認します。ping コマンドなどで DNS サーバーの IP アドレスに疎通確認をしてみるのも有効です。
ネットワーク接続の確認: DNS 解決はネットワークに依存するため、まずネットワーク接続が正常であることを確認します。
エラーメッセージを注意深く読む: エラーメッセージは問題の原因を示唆する重要な情報を含んでいます。

基本的な使用例：ホスト名の IPv4 アドレスを取得する

この例では、'example.com' というホスト名の IPv4 アドレスを取得し、成功した場合はそのアドレスを表示し、失敗した場合はエラーメッセージを表示します。

const dns = require('node:dns').promises;

async function getIPv4Address(hostname) {
  try {
    const addresses = await dns.resolve4(hostname);
    console.log(`${hostname} の IPv4 アドレス:`, addresses);
  } catch (err) {
    console.error(`${hostname} の IPv4 アドレスの解決に失敗しました:`, err);
  }
}

getIPv4Address('example.com');
getIPv4Address('invalid-hostname-that-does-not-exist.com');

このコードでは、まず require('node:dns').promises で dns.promises オブジェクトを取得しています。次に、非同期関数 getIPv4Address を定義し、その中で await dns.resolve4(hostname) を使用して指定されたホスト名の IPv4 アドレスを非同期的に取得しています。try...catch ブロックでエラーハンドリングを行い、成功時と失敗時の処理を分けています。

オプションを指定して DNS クエリを実行する

dnsPromises.resolve4() の第二引数には、オプションオブジェクトを指定できます。例えば、TTL（Time-To-Live）情報を取得する rrtypes オプションを使用する例です。

const dns = require('node:dns').promises;

async function getIPv4AddressWithOptions(hostname) {
  try {
    const result = await dns.resolve4(hostname, { rrtypes: ['A'] });
    console.log(`${hostname} の IPv4 アドレス (オプション付き):`, result);
  } catch (err) {
    console.error(`${hostname} の IPv4 アドレスの解決に失敗しました (オプション付き):`, err);
  }
}

getIPv4AddressWithOptions('example.com');

この例では、{ rrtypes: ['A'] } というオプションを指定しています。'A' は IPv4 アドレスのレコードタイプを表します。このオプションを指定すると、解決された IPv4 アドレスに加えて、関連する DNS レコードの情報（TTL など）が含まれる場合があります。ただし、resolve4 は主に IPv4 アドレスの配列を返すため、TTL などの追加情報は直接的には含まれないことが多いです。より詳細な情報を取得したい場合は、dns.resolve() メソッドを検討する必要があります。

複数のホスト名を同時に解決する

複数のホスト名の IPv4 アドレスを同時に取得したい場合は、Promise.all() を使用できます。

const dns = require('node:dns').promises;

async function resolveMultipleHosts(hostnames) {
  try {
    const results = await Promise.all(
      hostnames.map(hostname => dns.resolve4(hostname))
    );
    results.forEach((addresses, index) => {
      console.log(`${hostnames[index]} の IPv4 アドレス:`, addresses);
    });
  } catch (err) {
    console.error('一つ以上のホスト名の解決に失敗しました:', err);
  }
}

const hostsToResolve = ['example.com', 'nodejs.org', 'github.com'];
resolveMultipleHosts(hostsToResolve);

このコードでは、hostnames 配列に含まれる各ホスト名に対して dns.resolve4() を呼び出し、その結果を map 関数で Promise の配列に変換しています。そして、Promise.all() を使用して、すべての Promise が完了するのを待っています。すべての解決が成功した場合、各ホスト名に対応する IPv4 アドレスの配列が出力されます。一つでも失敗した場合は、catch ブロックでエラーが処理されます。

エラーハンドリングの例：特定の DNS エラーを処理する

DNS 解決が失敗した場合、エラーオブジェクトには特定のエラーコードが含まれます。例えば、ホスト名が見つからない場合は ENOTFOUND エラーが発生します。このエラーコードに基づいて、特定のエラー処理を行うことができます。

const dns = require('node:dns').promises;

async function resolveIPv4WithErrorHandling(hostname) {
  try {
    const addresses = await dns.resolve4(hostname);
    console.log(`${hostname} の IPv4 アドレス:`, addresses);
  } catch (err) {
    if (err.code === 'ENOTFOUND') {
      console.error(`${hostname} は見つかりませんでした。`);
    } else {
      console.error(`${hostname} の IPv4 アドレスの解決に失敗しました (エラーコード: ${err.code}):`, err);
    }
  }
}

resolveIPv4WithErrorHandling('nonexistent-domain-example123.com');
resolveIPv4WithErrorHandling('example.com');

コールバックベースの dns.resolve4()

Promise ベースの dnsPromises.resolve4() が導入される以前から存在していた、コールバック関数を使用する非同期 API です。

const dns = require('node:dns');

dns.resolve4('example.com', (err, addresses) => {
  if (err) {
    console.error('IPv4 アドレスの解決に失敗しました:', err);
    return;
  }
  console.log('example.com の IPv4 アドレス:', addresses);
});

dns.resolve4('invalid-hostname-that-does-not-exist.com', (err, addresses) => {
  if (err) {
    console.error('IPv4 アドレスの解決に失敗しました (存在しないホスト名):', err);
    return;
  }
  console.log('存在しないホスト名の IPv4 アドレス:', addresses); // ここは実行されない
});

この方法では、dns.resolve4() 関数の第三引数としてコールバック関数を渡します。DNS 解決が完了すると、Node.js はこのコールバック関数を呼び出します。コールバック関数の最初の引数 err はエラーオブジェクト（エラーが発生しなかった場合は null）、二番目の引数 addresses は解決された IPv4 アドレスの配列です。

利点:

Promise を使用しないため、シンプルなコールバック処理で済む場合があります。
Node.js の古いバージョンでも利用可能です。

欠点:

エラーハンドリングが Promise よりも複雑になる場合があります。
複数の非同期処理を連鎖させる場合に、コールバック地獄（ネストが深くなる）に陥りやすいです。

util.promisify() を使用してコールバックベースの API を Promise に変換する

Node.js の util モジュールにある promisify() 関数を使うと、コールバックベースの dns.resolve4() を Promise ベースの関数として利用できます。

const dns = require('node:dns');
const util = require('node:util');

const resolve4Promise = util.promisify(dns.resolve4);

async function getIPv4AddressWithPromisify(hostname) {
  try {
    const addresses = await resolve4Promise(hostname);
    console.log(`${hostname} の IPv4 アドレス (promisify 使用):`, addresses);
  } catch (err) {
    console.error(`${hostname} の IPv4 アドレスの解決に失敗しました (promisify 使用):`, err);
  }
}

getIPv4AddressWithPromisify('example.com');
getIPv4AddressWithPromisify('another-invalid-hostname.com');

この例では、util.promisify(dns.resolve4) によって、コールバックベースの dns.resolve4 関数が Promise を返す resolve4Promise 関数に変換されています。これにより、async/await 構文を使って非同期処理をよりシンプルに記述できます。

利点:

async/await を使用して、より読みやすく、管理しやすいコードを書くことができます。
コールバックベースの API を Promise ベースで扱えるため、非同期処理の制御が容易になります。

欠点:

基本的な dnsPromises.resolve4() と比較すると、わずかに記述量が増えます。
util モジュールをインポートする必要があります。

他のサードパーティ製ライブラリの使用

Node.js の標準モジュール以外にも、DNS 解決機能を提供するサードパーティ製のライブラリが存在する可能性があります。これらのライブラリは、より高度な機能や異なる API を提供している場合があります。

例:

ネットワークユーティリティ系のライブラリ: 特定のネットワーク操作に関連して DNS 解決機能を提供していることがあります。
node-resolve: モジュール解決アルゴリズムの一部として DNS 解決を行う機能を提供している場合があります。

利点:

より使いやすい API を提供している場合があります。
標準モジュールにはない追加機能や柔軟性を提供することがあります。

欠点:

ライブラリのメンテナンス状況や信頼性を考慮する必要があります。
外部ライブラリへの依存関係が増えます。

dns.lookup(): ホスト名を IP アドレスに解決する別の関数ですが、resolve4() とは動作が異なります。lookup() はオペレーティングシステムの基盤となるシステム設定を使用し、必ずしも DNS プロトコルを使用するとは限りません。また、IPv4 と IPv6 の両方のアドレスを返す可能性があります。特定の IPv4 アドレスのみを取得したい場合は、resolve4() の方が適しています。

Node.js dns.lookupService()とは？日本語解説とプログラミング例

callback (Function): 非同期処理が完了した後に呼び出されるコールバック関数です。このコールバック関数は3つの引数を受け取ります。 err (Error | null): エラーが発生した場合、エラーオブジェクトが渡されます。成功した場合は null が渡されます。 hostname (string): IPアドレスに対応するホスト名です。逆引きに失敗した場合や情報がない場合は、IPアドレスがそのまま返されることがあります。 service (string): ポート番号に対応するサービス名です。例えば、ポート 80 なら 'http'、ポート 443 なら 'https' のような文字列が返されます。サービス名が特定できない場合は、ポート番号が文字列として返されることがあります。