今回は、Go言語のパッケージについて学びます。
パッケージって何?卵を包むやつ?
はい、私のイメージもB男君と同じです。
Go言語では関連し合うGoファイルを「一箇所に組織立って」格納する方法があります。それが、パッケージです。
言っている意味がわかりませんよね？大丈夫です。これから学んでいきましょう。
学習履歴
パッケージ化が必要な理由
まず、次のコードを見てください。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
omikuzi.go package main import ( "bufio" "fmt" "log" "os" "strconv" "strings" ) func getNumber() (int, error) { reader := bufio.NewReader(os.Stdin) input, err := reader.ReadString('\n') if err != nil { return 0, err } input = strings.TrimSpace(input) number, err := strconv.Atoi(input) if err != nil { return 0, err } return number, nil } func main() { uranai := []string{"大凶", "中吉", "小吉", "大吉", "凶"} fmt.Println("1 ~ 4までの数値を入力してください。") num, err := getNumber() if err != nil { log.Fatal(uranai[num]) } fmt.Println(uranai[num]) } |
このコードは、getNumberの戻り値を受け取って、おみくじを引いています。ユーザーがターミナルから打ち込んだ文字は、例え数字であっても文字列として見なされます。そのため、Atoi関数で文字列を数値に変換しているわけです。
このgetNumber関数は、他の関数でも利用できる気がしませんか？
例えば、以下のプログラムも実装できそうです。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
otenki.go package main import ( "bufio" "fmt" "log" "os" "strconv" "strings" ) func getNumber() (int, error) { reader := bufio.NewReader(os.Stdin) input, err := reader.ReadString('\n') if err != nil { return 0, err } input = strings.TrimSpace(input) number, err := strconv.Atoi(input) if err != nil { return 0, err } return number, nil } func main() { tenki := []string{"世界の終わり", "曇り", "雨", "雪", "晴れ"} fmt.Println("1 ~ 4までの数値を入力してください。") num, err := getNumber() if err != nil { log.Fatal(tenki[num]) } fmt.Println(tenki[num]) } |
同じ様な処理ですが、使用用途が違いますよね?
二つのサンプルコードに共通して使用されているgetNumberは、共通関数としてくくりだせそうです。
|
1 2 3 4 5 6 7 8 |
make number touch number/number.go $ tree . ├── main.go ├── number └── number.go |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
number/number.go package number import ( "bufio" "os" "strconv" "strings" ) func GetNumber() (int, error) { reader := bufio.NewReader(os.Stdin) input, err := reader.ReadString('\n') if err != nil { return 0, err } input = strings.TrimSpace(input) number, err := strconv.Atoi(input) if err != nil { return 0, err } return number, nil } |
サンプルを見てわかるように、パッケージに所属させる場合は、ソースファイルの先頭に「pcakge <フォルダ名>」と宣言します。
また、前に学習しましたが、関数の先頭を大文字(GetNumber)にすることで、外部ファイルからの読み込みが可能になります。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
main.go package main import ( "fmt" "log" "github.com/<gitrepozitory>/headfirstgo/number" ) func main() { tenki := []string{"世界の終わり", "曇り", "雨", "雪", "晴れ"} fmt.Println("1 ~ 4までの数値を入力してください。") num, err := number.GetNumber() if err != nil { log.Fatal(tenki[num]) } fmt.Println(tenki[num]) } |
外部ファイルの関数を呼び出すときは、「パッケージ名.関数名」で呼び出すことができます。上記のサンプルは、otenki.goのコードを流用したものです。
今回の例では、getNumber関数一つだけであるため、パッケージ化の利点をあまり感じないかもしれません。しかし、扱うソースファイルが増えていくほどパッケージの利便性を感じられるようになるでしょう。
Go Workspace
Go言語は、Workspaceと呼ばれる特別なディレクトリからソースファイルの存在をチェックします。このWorkSpaceは、私たちのPCにGo言語をインストールした時に作成されます。
デフォルトだとユーザーのホームディレクトリ配下の「goディレクトリ」がWorkspaceになるかと思います。
|
1 2 3 4 5 |
$ tree -L 2 go ├── bin ├── pkg └── src |
Workspaceには、基本的に3つのサブディレクトリが格納されています。
| サブディレクトリ名 | 用途 |
|---|---|
| bin | コンパイル済みのバイナリファイルを格納する |
| pkg | コンパイル済みのパッケージファイルを格納する |
| src | Goのソースファイルを格納する |
srcディレクトリには、更にサブディレクトリを配置していくことで、パッケージ化させていくわけですが、慣習的にサブディレクトリ名とパッケージ名は同一の名前にします。
|
1 2 3 4 5 6 7 |
go ├── bin ├── pkg └── src └──number # サブディレクトリ名 └── otenki.go // 先頭に package number と入力し、numberパッケージとする └── uranai.go // 先頭に package number と入力し、numberパッケージとする |
パッケージ名について
パッケージにも命名規則があります。
・ 小文字で名付ける
・ 意味が捉えやすい省略形を用いる(例、format -> fmt)
・ 可能な限り、1単語で名付ける
・ アンダースコアや 大文字小文字が混ざった名前にはしない
・ 2単語以上の場合は、わかりやすい省略形を用いて1単語にする(string conversion -> strconv)
・ 開発者がローカル変数として宣言しそうな名前は避ける(名前衝突を防ぐため)
Constキーワード
Go言語も定数を定義できる言語です。その際は、次の通り「const」 キーワードを使って宣言します。
|
1 |
const firstNumber int = 10 |
ほとんどが、変数の宣言と同じですが、異なる点もあります。
・ varキーワードの代わりに、constキーワードを用いる
・ 一度格納した値は、変更することができない
・ Short Variable Declaration(:=)が使えない
type(intなど)の指定は省略することも可能です。この場合は、Go言語が型を推論します。
|
1 |
const firstNumber = 10 |
また、一度格納した値は変更することができません。
|
1 2 3 4 5 6 7 8 |
main.go package main func main() { const firstNumber = 5 firstNumber = 10 } |
|
1 2 3 4 |
$ go run main.go # command-line-arguments ./main.go:5:14: cannot assign to firstNumber |
constも先頭大文字で宣言すると外部ファイルからの読み込みが可能になります。
|
1 |
const FirstName int = 10 |
go installコマンド
「go install」コマンドを使うとプログラムを実行形式のバイナリファイルにしてワークスペース内のbinファイルに保存してくれます。
このコマンドは、srcディレクトリ内の実行ファイル(package mainから始まるファイル)が格納されているサブディレクトリに対して実行します。
|
1 |
go install <directory name> |
実際に試してみましょう。
まずは、以下の構成のフォルダとファイルを用意します。※環境によっては、srcディレクトリ配下にgithub.comフォルダなどがあると思いますが、適宜読み替えて作業してください
|
1 2 3 4 5 6 7 8 |
go ├── bin ├── pkg └── src └── greeting └── greeting.go └── person └── main.go |
|
1 2 3 4 5 6 7 8 9 10 11 |
greeting/greeting.go package greeting func Hello() string { return "Hello Everyone!" } func GoodBye() string { return "GoodBye! Boys & Girls!" } |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
person/main.go package main import ( "fmt" "github.com/hoge/greeting" ) func main() { fmt.Println(greeting.Hello()) fmt.Println(greeting.GoodBye()) } |
|
1 2 3 |
$ go run person/main.go Hello Everyone! GoodBye! Boys & Girls! |
簡単なプログラムですね。この構成の場合、実行ファイルは、personディレクトリのmain.goになります。
それでは、go installコマンドを実行しましょう。
|
1 2 3 4 5 6 7 |
$ pwd /Users/username/go/src/ $ go install person $ ls ../bin/ person |
go installコマンドの実行に成功するとbinディレクトリの中にpersonの実行ファイルが生成されます。
このファイルを実行してみましょう。
|
1 2 3 |
$ ../bin/person Hello Everyone! GoodBye! Boys & Girls! |
GOPATH
GOPAHを設定するWorkSpaceを変更できます。
GOPAHは、環境変数です。goコマンド実行時に、GoによりWorkSpaceの場所を特定する時などに使用されます。
最近のGoバージョンでは、GOPATHの設定は不要なのですが、前述の通り、WorkSpaceの場所を変更したいときなどは、この環境変数を変更してください。
とはいえ、言葉だけではわからないと思いますので、サンプルをお見せします。まずは、GOPATH設定前です。
|
1 2 3 4 5 6 7 8 9 10 11 12 |
$ cd ~/Desktop/ $ mkdir gopath_sample $ cd gopath_sample/ $ mkdir -p src/greeting $ touch src/greeting/greeting.go $ touch src/main.go $ tree . └── src ├── greeting │ └── greeting.go └── main.go |
|
1 2 3 4 5 6 7 8 9 10 |
greeting.go package greeting import "fmt" func Hello() { fmt.Println("Hello") } |
|
1 2 3 4 5 6 7 8 9 |
main.go package main import "greeting" func main() { greeting.Hello() } |
デスクトップ上にディレクトリを作成して、Goのサンプルコードを格納しました。それでは、実行してみましょう。
|
1 2 3 4 5 |
$ go run main.go src/main.go:3:8: cannot find package "greeting" in any of: /usr/local/Cellar/go/1.12.5/libexec/src/greeting (from $GOROOT) /Users/username/go/src/greeting (from $GOPATH) |
greetingパッケージへのパスが見つからない旨のエラーが出ましたね。
デフォルトのパス以外の場所にコードを格納し、実行した場合は、上記のエラーが発生してしまいます。
それでは、GOPATHを変更してみましょう。
Macの場合は、terminal上からGOPATHを変更できます。
|
1 |
$ export GOPATH="/Users/username/Desktop/gopath_sample" |
ちなみに、この設定変更は「実行したターミナル上でのみ有効」となります。設定を恒久的にしたい場合は、.bashrcなどに書き込むといいと思います。
ちなみに、Windowsの場合では、setコマンドを使います。
|
1 |
set GOPATH="C:\XXXX" |
GOPATHを設定できたらもう一度、プログラムを実行してみましょう。
|
1 2 |
$ go run src/main.go Hello |
WorkSpaceを変更したい場合は、GOAPHで設定する。覚えましたでしょうか？
go getコマンド
go getコマンドについて、少しだけ紹介しておきます。
go getコマンドは、Goの外部ライブラリをインストールする時に使用します。
|
1 |
go get パッケージ名 |
例えば、「https://github.com/headfirstgo/greeting」をインストールしたい場合は、terminal上から次の様に実行します。
|
1 |
go get https://github.com/headfirstgo/greeting |
ちなみに、gitをインストールしていないとコマンド実行時にエラーになるかもしれないので、そこだけは注意してください。※未検証
go doc コマンド
パッケージがGo言語にとって大切なのは分かったけど、開発が進むに連れて「このパッケージってなんだっけ？」ってなりそう。
はい、現場でもそういったケースは頻繁に起こりますw
私は、3日前に自分で書いたコードの意味がわからなくなることがあり、病気かな?と心配していた時期がありました。しかし、周りのエンジニアもだいたいそんな感じだったので安心した記憶があります。
「自分で書いたコードすら意味がわからなくなる。パッケージも然り」ですね。
対処方法の一つは、「go docコマンドの活用」になります。
go docコマンドを実行するとパッケージや関数のドキュメントを取得することができるのです。
|
1 2 |
go doc <package name> go doc <package name func name> |
論より証拠。実際に取得してみましょう。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
$ go doc strconv package strconv // import "strconv" Package strconv implements conversions to and from string representations of basic data types. Numeric Conversions The most common numeric conversions are Atoi (string to int) and Itoa (int to string). i, err := strconv.Atoi("-42") s := strconv.Itoa(-42) These assume decimal and the Go int type. ParseBool, ParseFloat, ParseInt, and ParseUint convert strings to values: b, err := strconv.ParseBool("true") f, err := strconv.ParseFloat("3.1415", 64) i, err := strconv.ParseInt("-42", 10, 64) u, err := strconv.ParseUint("42", 10, 64) The parse functions return the widest type (float64, int64, and uint64), but if the size argument specifies a narrower width the result can be converted to that narrower type without data loss: s := "2147483647" // biggest int32 i64, err := strconv.ParseInt(s, 10, 32) ... i := int32(i64) FormatBool, FormatFloat, FormatInt, and FormatUint convert values to strings: s := strconv.FormatBool(true) s := strconv.FormatFloat(3.1415, 'E', -1, 64) s := strconv.FormatInt(-42, 16) s := strconv.FormatUint(42, 16) AppendBool, AppendFloat, AppendInt, and AppendUint are similar but append the formatted value to a destination slice. ... |
パッケージのドキュメントが取得できましたね。次は、関数のドキュメントです。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
$ go doc strconv ParseFloat func ParseFloat(s string, bitSize int) (float64, error) ParseFloat converts the string s to a floating-point number with the precision specified by bitSize: 32 for float32, or 64 for float64. When bitSize=32, the result still has type float64, but it will be convertible to float32 without changing its value. If s is well-formed and near a valid floating point number, ParseFloat returns the nearest floating point number rounded using IEEE754 unbiased rounding. The errors that ParseFloat returns have concrete type *NumError and include err.Num = s. If s is not syntactically well-formed, ParseFloat returns err.Err = ErrSyntax. If s is syntactically well-formed but is more than 1/2 ULP away from the largest floating point number of the given size, ParseFloat returns f = ±Inf, err.Err = ErrRange. |
まぁ、ドキュメントは英語なので、英語力がないと相当厳しいのですが(苦笑)
よかったらこちらもどうぞ。下の記事は、ITエンジニアの英語力の必要性について個人的な見解を述べています。
もちろん、自作のパッケージや関数のドキュメントも取得できます。
やり方は簡単で、単純に「doc コメントを追加する」だけになります。
|
1 2 3 4 5 6 7 8 9 10 11 12 |
// Package greeting returns greeting to user package greeting // Return hello message func Hello() string { return "Hello Everyone!" } // Return GoodBye message func GoodBye() string { return "GoodBye! Boys & Girls!" } |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
$ go doc greeting package greeting // import "github.com/username/greeting" Package greeting returns greeting to user func GoodBye() string func Hello() string $ go doc greeting Hello package greeting // import "github.com/username/greeting" func Hello() string Return hello message $ go doc greeting GoodBye package greeting // import "github.com/username/greeting" func GoodBye() string Return GoodBye message |
上記の例では、”簡単な”ドキュメントを書きましたが、実際の開発現場では詳細なコメントの方がいいでしょうね。
<良いコメント>
・ コメントは、完全な文章でなければならない
・ パッケージのコメントは、Package <package nam>から始めるべき
// Package personal enables widget management.
・ 関数コメントは、関数名から始めるべき
// MyFunction converts widgets to gizmos.
・ コメントには、サンプルコードを載せるのもあり(インデント付きで)
私の様に「コマンドラインからでは、ドキュメントが見にくい」という方は、公式サイトからドキュメントを参照してください。
あとは、全く使わないのですが、次の方法でもドキュメントを読むことができます。
|
1 |
$ godoc -http=:6060 |
localhost:6060にアクセスしてみます。
全く使わないのですがね。
まとめ
今回、学んだことをまとめておきます。
・ GoのWorkSpaceは、ホームディレクトリ配下のgoディレクトリ
・ GOPATHを設定することで、任意の場所をWorkSpaceにすることができる
・ WorkSpace内には、bin、src、pkgディレクトリが存在する
– bin ・・・ コンパイル済みの実行ファイルを格納
– src ・・・ Goのソースファイルを格納
– pkg ・・・ コンパイルしたパッケージコードを格納
・ パッケージ名は全て小文字で、なるべく一単語になるように命名する
・ パッケージ外から関数を呼び出したい場合は、関数名の先頭を大文字にする
・ constに一度値を格納したら、値の変更は不可
・ go installコマンドは、Goのソースコードをコンパイルし、bin及びpkgにそれぞれコンパルしたファイルを格納する
・go getコマンドで、外部パッケージをローカルにインストールする
・go doc コマンドで、パッケージ及び関数のドキュメントを取得できる
参考書籍
次回
次回は、Arrayについて学びます^^
にほんブログ村
コメントを残す
コメントを投稿するにはログインしてください。