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

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

このコミットは、Go 1リリースに向けたドキュメントの更新であり、特にsyscallパッケージにおけるエラーハンドリングの変更と、strconvパッケージの大幅な再設計について記述しています。これらの変更は、Go言語のAPIをより一貫性のある「Goらしい」ものにするための重要なステップでした。

コミット

commit 71ccf73a74fdbc68f5449b1e2c94cc58e2886fbc
Author: Rob Pike <r@golang.org>
Date:   Fri Dec 9 14:12:51 2011 -0800

    doc/go1: syscalls, strconv
    
    R=rsc
    CC=golang-dev
    https://golang.org/cl/5472054

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

https://github.com/golang/go/commit/71ccf73a74fdbc68f5449b1e2c94cc58e2886fbc

元コミット内容

doc/go1: syscalls, strconv

R=rsc
CC=golang-dev
https://golang.org/cl/5472054

変更の背景

Go言語は、2012年3月に初の安定版であるGo 1をリリースしました。このGo 1リリースは、言語の安定性と互換性を保証するための重要なマイルストーンでした。それまでの開発版では、APIの変更が頻繁に行われていましたが、Go 1以降は後方互換性が厳密に維持されることになりました。

このコミットは、Go 1リリースノートの一部として、特にsyscallパッケージとstrconvパッケージにおける重要な変更点を開発者に周知するためのドキュメント更新です。これらの変更は、Go言語の設計思想である「シンプルさ」「安全性」「効率性」を追求し、よりGoらしいAPIを提供することを目的としていました。

具体的には、システムコールエラーの扱いをよりGoのエラーハンドリングの慣習に合わせること、そして文字列と数値の変換を行うstrconvパッケージのAPIをより直感的で柔軟なものにすることが背景にあります。

前提知識の解説

Go言語のエラーハンドリング

Go言語では、エラーは多値戻り値の最後の値としてerrorインターフェース型で返されるのが一般的です。これは例外処理とは異なり、エラーが発生したかどうかを明示的にチェックし、適切に処理することを開発者に促します。

syscallパッケージ

syscallパッケージは、オペレーティングシステムの低レベルなシステムコールに直接アクセスするための機能を提供します。これには、ファイル操作、プロセス管理、ネットワーク通信など、OSカーネルが提供する基本的な機能が含まれます。システムコールは通常、成功時には0を返し、エラー時には負の値を返すなど、C言語の慣習に従うことが多いです。

strconvパッケージ

strconvパッケージは、文字列と基本的なデータ型（整数、浮動小数点数、真偽値など）の間で変換を行うための機能を提供します。例えば、文字列"123"を整数123に変換したり、その逆を行ったりする際に使用されます。

gofixツール

gofixは、Go言語のツールチェーンに含まれるコマンドラインツールで、Go言語のAPI変更に伴うコードの自動修正を支援します。Go 1リリースでは、多くのAPI変更があったため、既存のコードベースを新しいAPIに適合させるためにgofixが重要な役割を果たしました。

技術的詳細

syscallパッケージのエラーハンドリングの変更

Go 1以前のsyscallパッケージでは、システムコールがエラーを返した場合、C言語の慣習に従って整数値のerrno（エラー番号）を直接返していました。しかし、Go言語の標準的なエラーハンドリングはerrorインターフェースを使用するため、この慣習はGoのエコシステムと整合性がありませんでした。

Go 1では、この不整合を解消するために、syscallパッケージがシステムコールエラーに対してerrorインターフェースを返すように変更されました。Unix系システムでは、このerrorはsyscall.Errno型によって実装されます。syscall.Errnoはerrorインターフェースを満たし、以前のos.Errnoを置き換えるものです。これにより、システムコールエラーも他のGoのエラーと同様に扱うことができるようになり、コードの一貫性と可読性が向上しました。

この変更に伴い、gofixツールが既存のコードを自動的に更新する機能が提供されました。ただし、ほとんどのアプリケーションコードはsyscallパッケージを直接使用するのではなく、より高レベルなosパッケージを使用するため、この変更による影響は限定的であるとされています。

strconvパッケージの大幅な再設計

strconvパッケージは、Go 1で「Goらしい」APIになるように大幅に再設計されました。Go 1以前のstrconvパッケージは、C言語の標準ライブラリの関数名（例: atoi, atof）に影響を受けている部分がありましたが、Go 1ではGoの命名規則と慣習に沿った形に変更されました。

主な変更点としては、以下が挙げられます。

  • 関数名の変更: 多くの関数がより記述的でGoらしい名前に変更されました。例えば、AtobはParseBoolに、Atof32はParseFloat(x, 32)に、Ftoa32はFormatFloat(x, float64(f), p, 32)に変更されました。
  • 型変換の明示化: 浮動小数点数や符号なし整数への変換において、ビットサイズを明示的に指定する引数が追加されました（例: ParseFloat(x, 32)）。
  • バイトスライスへの追加: 新しい関数バリアントとして、結果を文字列として返すのではなく、バイトスライスに追加する形式の関数が導入されました。これにより、メモリ割り当てをより細かく制御できるようになり、パフォーマンスが向上する可能性があります。
  • AtoiとItoaの存続: Atoi（文字列から整数への変換）とItoa（整数から文字列への変換）は、その利便性からGo 1でも引き続き提供されますが、より汎用的なParseIntやFormatIntの使用が推奨されます。

このstrconvパッケージの変更もgofixツールによってほとんどのコードが自動的に更新されますが、AtouiやAtof32のように完全に置き換えられない関数もあり、その場合は手動での型キャストが必要となる場合があります。gofixはこのような手動での修正が必要な箇所について警告を発します。

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

このコミットは、doc/go1.htmlとdoc/go1.tmplという2つのドキュメントファイルに対する変更です。これらはGo 1のリリースノートの一部であり、Go言語のAPI変更を説明するためのHTMLドキュメントと、そのテンプレートファイルです。

具体的な変更箇所は以下の通りです。

  • doc/go1.html および doc/go1.tmpl:
    • syscallパッケージのエラーハンドリングに関するセクションが追加され、errorインターフェースを返すようになったこと、syscall.Errnoの導入、およびgofixによる更新について説明されています。
    • strconvパッケージに関するセクションが大幅に拡張され、Go 1での再設計、主要な関数名の変更、および新しいAPIの概要を示すテーブルが追加されています。
    • gofixに関するTODOコメントが更新され、削除されたパッケージやサブリポジトリに移動したパッケージについても警告すべきである旨が追記されています。

これらの変更は、Go 1のリリースに伴うAPIの変更点を開発者に明確に伝えるためのドキュメントの追加・修正であり、実際のGo言語のランタイムやライブラリのコード自体を変更するものではありません。

コアとなるコードの解説

このコミットの「コード」は、Go 1のリリースノートを構成するHTMLドキュメントとテンプレートファイルです。これらのファイルは、Go言語のユーザーがGo 1への移行をスムーズに行えるように、APIの変更点、特にsyscallとstrconvパッケージの変更について詳細な情報を提供することを目的としています。

  • syscallに関する記述:

    • システムコールがerror型を返すようになったことの重要性が強調されています。これはGoのエラーハンドリングの慣習に沿ったものであり、コードの一貫性を高めます。
    • syscall.Errnoがerrorインターフェースを満たす型として導入され、以前のos.Errnoを置き換えることが明記されています。
    • gofixがこの変更のほとんどを自動的に更新すること、そしてほとんどのコードがosパッケージを使用するため影響が少ないことが述べられています。

  • strconvに関する記述:

    • strconvパッケージが「Goらしく、Cらしくない」ように大幅に再設計されたことが強調されています。これは、Go言語の設計哲学を反映したものです。
    • AtoiとItoaが引き続き利用可能であるものの、より汎用的なParseIntやFormatIntの使用が推奨されることが示唆されています。
    • バイトスライスに結果を追加する新しい関数バリアントが導入されたことが説明されており、これはパフォーマンス最適化の選択肢を提供します。
    • 旧APIと新APIの対応関係を示す詳細なテーブルが提供されており、開発者が既存のコードを新しいAPIに移行する際のガイドとなります。
    • gofixがほとんどの変更を自動的に更新するものの、AtouiやAtof32のように手動での型キャストが必要なケースがあること、そしてgofixがその際に警告を発することが明記されています。

これらのドキュメントは、Go 1の互換性保証の基盤となる情報であり、開発者が新しいGoのバージョンにスムーズに移行するための重要なリソースです。

関連リンク

参考にした情報源リンク