Node.js socketaddress.familyとは？初心者向けにわかりやすく解説

2025-05-27

socketaddress.family は、ソケットアドレスオブジェクトのプロパティの一つで、そのソケットが使用しているアドレスファミリを示します。簡単に言うと、「どんな種類のネットワークアドレスを使っているか」を表す情報です。

具体的には、以下のいずれかの値を取ることが一般的です。

'Unix': これは、Unix ドメインソケットのアドレスファミリであることを示します。Unix ドメインソケットは、同じホスト上のプロセス間で通信を行うための仕組みで、ファイルシステムのパス名で識別されます。ネットワークインターフェースを介さずに高速なローカル通信を実現できます。
'IPv6': これは、インターネットプロトコルバージョン6 (Internet Protocol version 6) のアドレスファミリであることを示します。IPv6 アドレスは、例えば 2001:0db8:85a3:0000:0000:8a2e:0370:7334 のような形式で表現されます。IPv4 アドレスの枯渇問題に対応するために設計された、次世代のインターネットプロトコルです。
'IPv4': これは、インターネットプロトコルバージョン4 (Internet Protocol version 4) のアドレスファミリであることを示します。IPv4 アドレスは、例えば 192.168.1.1 のような形式で表現されます。Node.js でネットワーク通信を行う際に最も一般的に使用されるアドレスファミリの一つです。

この socketaddress.family プロパティは、主に以下のような場面で役立ちます。

アドレスに応じた処理を分岐させる
接続の種類に応じて異なる処理を行いたい場合に、このプロパティの値に基づいて条件分岐を行うことができます。例えば、IPv6 アドレスで接続してきたクライアントに対して特別な処理を行う、といったことが可能です。
接続されたソケットの種類を判別する
サーバー側でクライアントからの接続を受け付けた際に、そのクライアントが IPv4 アドレスで接続してきたのか、IPv6 アドレスで接続してきたのか、あるいは Unix ドメインソケットで接続してきたのかを socketaddress.family を参照することで知ることができます。

例

Node.js の net モジュールを使ってサーバーを作成し、接続されたソケットのアドレス情報をログ出力する簡単な例を見てみましょう。

const net = require('net');

const server = net.createServer((socket) => {
  const address = socket.address();
  console.log('クライアントが接続しました:', address);
  console.log('アドレスファミリ:', address.family);
  socket.end('接続ありがとうございます！\n');
});

server.listen(3000, () => {
  console.log('サーバーがポート 3000 で起動しました。');
});

このコードを実行してクライアントから接続すると、コンソールには接続したクライアントのアドレス情報とともに、address.family の値 ('IPv4' など) が表示されます。

アドレスファミリの不一致による接続エラー

トラブルシューティング
- サーバー側の設定確認
  サーバーが net.createServer() や http.createServer() などでリッスンする際のアドレスとポートの設定を確認してください。特に、アドレスを指定しない場合は、デフォルトで利用可能なすべての IPv4 および IPv6 インターフェースでリッスンすることが多いですが、明示的にアドレスを指定している場合はその設定が正しいか確認が必要です。例えば、IPv6 のみでリッスンする場合は '::' を指定します。
- クライアント側の設定確認
  クライアントが接続しようとしているアドレスが、サーバーがリッスンしているアドレスファミリと一致しているか確認してください。例えば、サーバーが IPv6 アドレスでリッスンしている場合は、クライアントも IPv6 アドレスを指定する必要があります。Node.js の net.connect() や http.request() などで接続先のアドレスを指定する部分を確認します。
- DNS の確認
  ホスト名で接続している場合、DNS サーバーが解決した IP アドレスが意図したアドレスファミリであるか確認してください。例えば、同じホスト名に対して IPv4 と IPv6 の両方のアドレスが登録されている場合があります。
エラー
サーバーとクライアントで期待するアドレスファミリが異なる場合に接続が確立できないことがあります。例えば、サーバーが IPv6 アドレスでしかリッスンしていないのに、クライアントが IPv4 アドレスで接続しようとする場合などです。この場合、ECONNREFUSED (接続拒否) や EADDRNOTAVAIL (要求されたアドレスは利用できません) などのエラーが発生することがあります。

Unix ドメインソケットのパスの問題

トラブルシューティング
- パスの存在確認
  サーバーとクライアントで指定している Unix ドメインソケットのパスが実際に存在するかどうかを確認してください。サーバー側でソケットファイルを作成している場合は、その処理が正しく行われているか確認します。
- 権限の確認
  ソケットファイルに対する読み書きの権限が、サーバーとクライアントのプロセスを実行しているユーザーにあるか確認してください。必要に応じて chmod コマンドなどで権限を変更します。
- パスの競合
  複数のプロセスが同じパスの Unix ドメインソケットを使用しようとしていないか確認してください。
エラー
socketaddress.family が 'Unix' の場合、指定されたパスが存在しない、権限がないなどの理由で接続に失敗することがあります。エラーメッセージとしては、ENOENT (そのようなファイルやディレクトリはありません) や EACCES (許可がありません) などが表示されることがあります。

socket.address() が null や期待しない値を返す場合

トラブルシューティング
- イベントのタイミング
  ソケット関連のイベント ('connect', 'listening') が発生した後で socket.address() を呼び出すようにしてください。接続が確立する前や、サーバーがリッスンを開始する前に呼び出すと、正しい情報が得られないことがあります。
- エラーハンドリング
  ソケットの 'error' イベントを監視し、エラーが発生していないか確認してください。エラーが発生している場合は、その原因を特定し、対処する必要があります。
- ソケットの状態確認
  ソケットオブジェクトの状態 (socket.readyState など) を確認し、接続が正常に確立されているか確認してください。
状況
ソケットがまだ完全に確立されていないタイミングや、何らかの理由でアドレス情報が取得できない場合に、socket.address() が null を返したり、family プロパティが期待しない値 (例えば undefined) になることがあります。

IPv6 アドレスの扱いに関する注意点

トラブルシューティング
- アドレスの表記確認
  IPv6 アドレスをコードに直接記述する場合は、RFC 5952 などの仕様に従って正しい形式で記述されているか確認してください。
- ネットワークインターフェースの確認
  サーバーまたはクライアントが動作している環境のネットワークインターフェースが IPv6 を有効にしているか確認してください。OS の設定やネットワーク構成を確認する必要があります。
- ファイアウォールの設定
  IPv6 を使用する場合は、ファイアウォールが IPv6 の通信を許可するように設定されているか確認してください。
エラー
IPv6 アドレスを使用する場合、アドレスの表記ミス (コロンの数や位置など) や、ネットワークインターフェースが IPv6 をサポートしていないなどの理由で接続に失敗することがあります。

トラブルシューティングの一般的なアプローチ

ネットワークツールの利用
ping6 や netstat などのネットワークツールを使用して、ネットワークの状態やソケットの状態を確認します。
簡単なテスト
問題を切り分けるために、最小限のコードで接続テストを行ってみます。
ログ出力
サーバーとクライアントの双方で、アドレス情報 (socket.address()) や関連する設定値をログ出力するようにして、実行時の状態を確認します。
エラーメッセージの確認
発生したエラーメッセージを注意深く読み、何が問題なのか手がかりを探します。

例1: 接続されたソケットのアドレスファミリをログ出力するサーバー

この例では、TCP サーバーを作成し、クライアントが接続してきた際に、そのソケットのアドレス情報とアドレスファミリをログに出力します。

const net = require('net');

const server = net.createServer((socket) => {
  const address = socket.address();
  console.log('クライアントが接続しました:', address);
  console.log('アドレスファミリ:', address.family);
  socket.write('接続ありがとうございます！\n');
  socket.end();
});

server.listen(3000, () => {
  console.log('サーバーがポート 3000 で起動しました。');
});

説明

net.createServer() で TCP サーバーを作成し、接続を受け付けるとコールバック関数が実行されます。
コールバック関数の引数 socket は、クライアントとの接続を表すソケットオブジェクトです。
socket.address() を呼び出すと、接続されたリモートアドレスに関する情報を持つオブジェクトが返されます。このオブジェクトには、port (リモートポート番号)、address (リモート IP アドレスまたは Unix ドメインソケットのパス)、そして family (アドレスファミリ: 'IPv4', 'IPv6', または 'Unix') のプロパティが含まれます。
console.log('アドレスファミリ:', address.family); で、接続してきたクライアントが使用しているアドレスファミリをログに出力します。

このコードを実行し、IPv4 アドレスまたは IPv6 アドレスを持つクライアントから接続すると、コンソールにそれぞれ 'IPv4' または 'IPv6' が表示されます。Unix ドメインソケットで接続した場合は 'Unix' が表示されます（Unix ドメインソケットで接続するには、サーバーとクライアントの両方で特別な設定が必要です）。

例2: アドレスファミリに基づいて処理を分岐するサーバー

この例では、接続してきたクライアントのアドレスファミリに応じて異なるメッセージを送信するサーバーを作成します。

const net = require('net');

const server = net.createServer((socket) => {
  const address = socket.address();
  console.log('クライアントが接続しました:', address);
  console.log('アドレスファミリ:', address.family);

  if (address.family === 'IPv6') {
    socket.write('IPv6 での接続ありがとうございます！\n');
  } else if (address.family === 'IPv4') {
    socket.write('IPv4 での接続ありがとうございます！\n');
  } else if (address.family === 'Unix') {
    socket.write('Unix ドメインソケットでの接続ありがとうございます！\n');
  } else {
    socket.write('不明なアドレスファミリでの接続です。\n');
  }
  socket.end();
});

server.listen(3000, () => {
  console.log('サーバーがポート 3000 で起動しました。');
});

説明

この例では、接続されたソケットのアドレスファミリ (address.family) を if-else if 文で評価し、その値に応じて異なるメッセージをクライアントに送信しています。このように、アドレスファミリに基づいて特定の処理を行いたい場合に address.family を利用できます。

例3: Unix ドメインソケットを使用するサーバーとクライアント

この例では、socketaddress.family が 'Unix' になるケースを示します。同じホスト上で動作するプロセス間で通信を行うために Unix ドメインソケットを使用します。

サーバー (unix_server.js)

const net = require('net');
const socketPath = '/tmp/my_unix_socket';

// ソケットファイルが既に存在する場合は削除する
try {
  require('fs').unlinkSync(socketPath);
} catch (err) {
  if (err.code !== 'ENOENT') {
    console.error('ソケットファイルの削除に失敗しました:', err);
    process.exit(1);
  }
}

const server = net.createServer((socket) => {
  const address = socket.address();
  console.log('クライアントが接続しました:', address);
  console.log('アドレスファミリ:', address.family); // 'Unix' と表示されます
  socket.write('Unix ドメインソケット経由での接続ありがとうございます！\n');
  socket.end();
});

server.listen(socketPath, () => {
  console.log(`Unix ドメインソケットサーバーが ${socketPath} で起動しました。`);
});

server.on('error', (err) => {
  console.error('サーバーエラー:', err);
});

クライアント (unix_client.js)

const net = require('net');
const socketPath = '/tmp/my_unix_socket';

const client = net.connect({ path: socketPath }, () => {
  console.log('サーバーに接続しました。');
  console.log('ローカルアドレス:', client.localAddress);
  console.log('ローカルアドレスファミリ:', client.localFamily); // 'Unix' と表示されます
});

client.on('data', (data) => {
  console.log('サーバーからのデータ:', data.toString());
  client.end();
});

client.on('end', () => {
  console.log('サーバーとの接続を閉じました。');
});

client.on('error', (err) => {
  console.error('クライアントエラー:', err);
});

サーバー
net.createServer() でサーバーを作成し、server.listen() の第一引数にファイルパスを指定することで、Unix ドメインソケットでリッスンします。接続されたソケットの address.family は 'Unix' になります。
クライアント
net.connect() のオプションとして path プロパティにサーバーと同じファイルパスを指定することで、Unix ドメインソケットに接続します。接続後のソケットの client.localFamily (ローカルアドレスファミリ) も 'Unix' になります。

net.connect() および server.listen() でアドレスファミリを明示的に指定する

net.connect() でクライアントソケットを作成する際や、server.listen() でサーバーがリッスンするアドレスを指定する際に、アドレスファミリを間接的に制御することができます。

Unix ドメインソケットを使用する場合
net.connect() や server.listen() のオプションで path プロパティにソケットファイルのパスを指定します。
IPv6 のみに接続/リッスンする場合
IPv6 アドレス ('::1' や '::') を明示的に指定します。
IPv4 のみに接続/リッスンする場合
IPv4 アドレス ('127.0.0.1' や '0.0.0.0') を明示的に指定します。

この方法では、socketaddress.family の値を直接確認するのではなく、接続またはリッスンする際に使用するアドレスの種類を限定することで、意図したアドレスファミリでの通信を確立します。

例
IPv6 のみでリッスンするサーバー

const net = require('net');

const server = net.createServer((socket) => {
  console.log('クライアントが接続しました:', socket.remoteAddress, socket.remotePort);
  console.log('ローカルアドレス:', socket.localAddress, socket.localPort);
  console.log('アドレスファミリ (接続時):', socket.address().family); // 接続してきたクライアントのアドレスファミリ
  socket.end('IPv6 のみのサーバーへようこそ！\n');
});

server.listen({
  port: 3000,
  host: '::' // IPv6 のすべてのアドレスでリッスン
}, () => {
  console.log('IPv6 のみでリッスンしているサーバーがポート 3000 で起動しました。');
});

server.on('error', (err) => {
  console.error('サーバーエラー:', err);
});

この例では、server.listen() のオプションで host: '::' を指定することで、サーバーは IPv6 のアドレスでのみ接続を受け付けます。接続してきたクライアントのアドレスファミリは socket.address().family で確認できます。

dns モジュールを使用してアドレスファミリを意識した名前解決を行う

ホスト名で接続する場合、DNS サーバーは IPv4 と IPv6 の両方のアドレスを返す可能性があります。dns モジュールを使用することで、特定のアドレスファミリのアドレスのみを取得したり、解決されたアドレスファミリに基づいて処理を分岐させたりできます。

dns.resolve(hostname[, rrtype], callback)
指定したレコードタイプ ('A' は IPv4, 'AAAA' は IPv6) のアドレスを解決します。
dns.resolve6(hostname, callback)
ホスト名の IPv6 アドレスを解決します。
dns.resolve4(hostname, callback)
ホスト名の IPv4 アドレスを解決します。

例
ホスト名を IPv6 アドレスに解決して接続するクライアント

const net = require('net');
const dns = require('dns').promises;

const hostname = 'example.com'; // IPv6 アドレスが登録されているホストを指定

async function connectIPv6() {
  try {
    const addresses = await dns.resolve6(hostname);
    if (addresses.length > 0) {
      const ipv6Address = addresses[0];
      const client = net.connect({ host: ipv6Address, port: 80 }, () => {
        console.log(`IPv6 アドレス ${ipv6Address} に接続しました。`);
        console.log('ローカルアドレスファミリ:', client.localFamily);
        console.log('リモートアドレスファミリ:', client.remoteFamily);
        client.end();
      });

      client.on('error', (err) => {
        console.error('クライアントエラー:', err);
      });
    } else {
      console.log(`${hostname} に IPv6 アドレスが見つかりませんでした。`);
    }
  } catch (err) {
    console.error('DNS 解決エラー:', err);
  }
}

connectIPv6();

この例では、dns.resolve6() を使用して example.com の IPv6 アドレスを解決し、そのアドレスを使ってサーバーに接続しています。接続後のソケットの remoteFamily プロパティが 'IPv6' になることが期待されます。

環境変数や設定ファイルに基づいてアドレスファミリを切り替える

アプリケーションの設定や実行環境に基づいて、使用するアドレスファミリを切り替えることができます。例えば、環境変数 IPV6_ENABLED が true の場合は IPv6 を使用し、そうでない場合は IPv4 を使用するといったロジックを実装できます。

例
環境変数に基づいてリッスンするアドレスファミリを切り替えるサーバー

const net = require('net');
const useIPv6 = process.env.IPV6_ENABLED === 'true';
const listenOptions = {};

if (useIPv6) {
  listenOptions.host = '::';
  listenOptions.port = 3001;
  console.log('IPv6 でリッスンします。');
} else {
  listenOptions.host = '0.0.0.0';
  listenOptions.port = 3000;
  console.log('IPv4 でリッスンします。');
}

const server = net.createServer((socket) => {
  console.log('クライアントが接続しました:', socket.remoteAddress, socket.remotePort);
  console.log('アドレスファミリ (接続時):', socket.address().family);
  socket.end('接続ありがとうございます！\n');
});

server.listen(listenOptions, () => {
  console.log(`サーバーが ${listenOptions.host}:${listenOptions.port} で起動しました。`);
});

server.on('error', (err) => {
  console.error('サーバーエラー:', err);
});

この例では、環境変数 IPV6_ENABLED の値に基づいて、サーバーが IPv6 ('::') または IPv4 ('0.0.0.0') のいずれのアドレスでリッスンするかを決定しています。