Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

[インデックス 15170] ファイルの概要

このコミットは、Go言語の標準ライブラリである net パッケージにおけるネットワーク接続確立（Dial）、リッスン（Listen）、パケットリッスン（ListenPacket）およびそれらのヘルパー関数の簡素化を目的としています。具体的には、冗長な処理の削除と、より直接的な関数呼び出しへの変更が行われています。

コミット

commit 6dfd3860050282fb440d9ae9f6dbe49ece6af5a0
Author: Mikio Hara <mikioh.mikioh@gmail.com>
Date:   Fri Feb 8 21:53:10 2013 +0900

    net: simplify Dial, Listen, ListenPacket and those helpers
    
    R=golang-dev, dave, bradfitz
    CC=golang-dev
    https://golang.org/cl/7300065

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/6dfd3860050282fb440d9ae9f6dbe49ece6af5a0

元コミット内容

net: simplify Dial, Listen, ListenPacket and those helpers

このコミットは、Go言語の net パッケージ内の Dial、Listen、ListenPacket 関数および関連するヘルパー関数を簡素化することを目的としています。

変更の背景

この変更の主な背景は、コードの冗長性を排除し、net パッケージの主要なネットワーク操作関数の内部実装をより効率的かつ理解しやすくすることにあります。特に、アドレス解決のロジックが重複していたり、不必要に複雑なパスを辿っていた部分が簡素化されています。これにより、コードの保守性が向上し、将来的な機能追加やバグ修正が容易になることが期待されます。

前提知識の解説

Go言語の net パッケージは、ネットワークI/Oのためのポータブルなインターフェースを提供します。TCP/IP、UDP、Unixドメインソケットなど、様々なネットワークプロトコルを扱うことができます。

  • net.Dial(network, address string) (Conn, error): この関数は、指定された network (例: "tcp", "udp", "tcp4", "udp4", "ip", "unix") と address (例: "golang.org:80", "localhost:8080") を使用して、リモートサーバーへの発信接続を確立するために使用されます。クライアントとして機能し、net.Conn インターフェースを実装した接続オブジェクトを返します。net.Conn は Read(), Write(), Close() などのメソッドを提供し、データの送受信と接続の終了を可能にします。

  • net.Listen(network, address string) (Listener, error): この関数は、ローカルネットワークアドレスで着信接続をリッスンするサーバーを作成するために使用されます。network はストリーム指向のプロトコル（例: "tcp", "tcp4", "tcp6", "unix", "unixpacket"）を指定し、address はリッスンするローカルアドレス（例: ":8080"）を指定します。net.Listener オブジェクトを返し、その Accept() メソッドは新しい接続が確立されるまでブロックし、各クライアントに対して net.Conn を返します。

  • net.ListenPacket(network, laddr string) (PacketConn, error): この関数は、パケット指向の接続（UDPなど）のために、ローカルネットワークアドレスで着信パケットをリッスンするために使用されます。network はパケット指向のプロトコル（例: "udp", "udp4", "udp6", "ip", "ip4", "ip6", "unixgram"）を指定し、laddr はリッスンするローカルアドレスを指定します。net.PacketConn オブジェクトを返し、その ReadFrom() および WriteTo() メソッドは、永続的な接続なしに個々のパケットを送受信するために使用されます。

  • net.Addr インターフェース: ネットワークアドレスを表すインターフェースです。Network() メソッドと String() メソッドを持ちます。具体的な実装として *net.TCPAddr, *net.UDPAddr, *net.IPAddr, *net.UnixAddr などがあります。

  • net.OpError: ネットワーク操作中に発生したエラーをラップするための構造体です。操作の種類 (Op)、ネットワークタイプ (Net)、アドレス (Addr)、および元のエラー (Err) を含みます。

  • parseDialNetwork と parseNetwork: ネットワークタイプ文字列（例: "tcp", "udp", "ip4"）を解析し、内部で使用されるアドレスファミリーネットワークタイプ（afnet）とプロトコル番号を返す関数です。このコミットでは parseDialNetwork が parseNetwork にリネームされ、より汎用的な役割を果たすようになっています。

  • resolveNetAddr と resolveAddr: ネットワークアドレス文字列を解析し、具体的な net.Addr オブジェクトに解決する関数です。このコミットでは resolveNetAddr が resolveAddr に簡素化され、冗長な afnet の戻り値が削除されています。

技術的詳細

このコミットの主要な変更点は、net パッケージ内のアドレス解決ロジックの統合と簡素化です。

  1. parseDialNetwork の parseNetwork へのリネームと統合:

    • 以前は Dial 関連の関数でのみ使用されていた parseDialNetwork が、parseNetwork というより汎用的な名前に変更されました。
    • これにより、Dial、Listen、ListenPacket のすべてのアドレス解析でこの単一の関数が使用されるようになり、コードの重複が削減されました。

  2. resolveNetAddr の resolveAddr への簡素化:

    • resolveNetAddr 関数は、ネットワークタイプとアドレス文字列を受け取り、アドレスファミリーネットワークタイプ (afnet) と具体的な net.Addr オブジェクトを返していました。
    • このコミットでは、resolveNetAddr が resolveAddr に変更され、afnet の戻り値が削除されました。これは、parseNetwork がすでに afnet を返しており、resolveAddr の内部でその情報が利用できるため、冗長な戻り値が不要になったためです。
    • また、resolveAfnetAddr というヘルパー関数が削除され、そのロジックが resolveAddr に直接統合されました。これにより、アドレス解決のパスが短縮され、より直接的になりました。

  3. Dial, Listen, ListenPacket の内部呼び出しの変更:

    • これらの高レベル関数は、内部で resolveNetAddr を呼び出していましたが、変更後は簡素化された resolveAddr を呼び出すようになりました。
    • 特に Dial 関数では、dialAddr というヘルパー関数が dial にリネームされ、resolveAddr から返される Addr オブジェクトを直接受け取るようになりました。これにより、net と addr の文字列を再度渡す必要がなくなり、引数が簡素化されました。
    • Listen と ListenPacket も同様に、resolveAddr から返される Addr オブジェクトを直接利用するように変更され、冗長な型アサーションや nil チェックが削減されました。

これらの変更により、net パッケージのアドレス解決と接続確立のフローがより線形になり、関数の役割が明確化されました。

コアとなるコードの変更箇所

  • src/pkg/net/dial.go:

    • parseDialNetwork 関数が parseNetwork にリネーム。
    • resolveNetAddr 関数が resolveAddr に簡素化され、afnet の戻り値が削除。
    • resolveAfnetAddr 関数が削除され、そのロジックが resolveAddr に統合。
    • Dial 関数が resolveAddr を呼び出すように変更。
    • dialAddr 関数が dial にリネームされ、引数が簡素化。
    • dialTimeoutRace 関数内で resolveNetAddr の代わりに resolveAddr を使用。
    • Listen および ListenPacket 関数内で resolveNetAddr の代わりに resolveAddr を使用し、内部の型アサーションと変数宣言を簡素化。

  • src/pkg/net/fd_unix.go, src/pkg/net/fd_windows.go:

    • dialTimeout 関数内で resolveNetAddr の代わりに resolveAddr を使用し、dialAddr の代わりに dial を使用。

  • src/pkg/net/ipraw_test.go, src/pkg/net/iprawsock.go, src/pkg/net/iprawsock_posix.go:

    • parseDialNetwork の代わりに parseNetwork を使用。

コアとなるコードの解説

このコミットの核心は、net パッケージにおけるアドレス解決の共通化と効率化です。

変更前は、parseDialNetwork と resolveNetAddr という関数が Dial 系の処理に特化して存在し、afnet (アドレスファミリーネットワークタイプ) の情報が複数の場所で扱われていました。また、resolveAfnetAddr という別のヘルパー関数が存在し、アドレス解決のロジックが分散していました。

変更後は、以下の点が改善されました。

  1. parseNetwork の汎用化: parseDialNetwork を parseNetwork にリネームし、Dial だけでなく Listen や ListenPacket からも利用されるようにすることで、ネットワークタイプ文字列の解析ロジックが一元化されました。これにより、コードの重複が排除され、将来的なネットワークタイプの追加や変更が容易になります。

  2. resolveAddr への統合と簡素化: resolveNetAddr と resolveAfnetAddr の機能を resolveAddr に統合し、afnet の戻り値を削除しました。これは、parseNetwork がすでに afnet を返しているため、resolveAddr がその情報を内部で利用できるようになったためです。これにより、関数のシグネチャが簡素化され、呼び出し元での冗長な変数宣言や型アサーションが不要になりました。

  3. dial 関数の導入: dialAddr を dial にリネームし、resolveAddr から返された net.Addr オブジェクトを直接引数として受け取るようにしました。これにより、Dial 関数がアドレス解決と実際の接続確立のロジックをより明確に分離できるようになり、コードの可読性が向上しました。

これらの変更は、net パッケージの内部構造をよりクリーンで効率的なものにし、Go言語の「シンプルさ」という設計哲学に沿ったものです。ユーザーが net.Dial や net.Listen を呼び出す際の外部APIには変更はありませんが、内部的にはより堅牢で保守しやすいコードベースになっています。

関連リンク

  • Go Change-ID 7300065: https://golang.org/cl/7300065
    • 注記: このコミットメッセージに記載されている golang.org/cl/7300065 は、Web検索の結果、別のコミット（cmd/go: fix go mod tidy -compat=1.17 with go.mod with no go line）を指しているようです。これは、GoのChange-IDシステムが時間とともに変化したか、あるいは単にコミットメッセージの参照が古くなっている可能性があります。このコミットの実際の変更は、提供されたコミットハッシュ 6dfd3860050282fb440d9ae9f6dbe49ece6af5a0 に基づいています。

参考にした情報源リンク