定数を定義する (const, iota)

2017-08-31

Go 言語の定数は、変数を定義するのと同じ感覚で定義することができます。

定数定義の基本 (const)

Go 言語の定数は、const キーワードを使用して定義します。

func main() {
	const foo = 100
	fmt.Println(foo)
}

次のように複数の定数をまとめて定義することもできます。

const (
	hoge = 100
	fuga = 200
)

定数値をパッケージ外に公開する

パッケージ外に公開する定数値は、名前を大文字で始めます（関数や変数と同様です）。逆に、小文字で始まる定数値は、同じパッケージ内からのみ参照可能です。

mypkg/mypkg.go

package mypkg

const PublicConst = 100   // 別のパッケージから mypkg.PublicConst で参照可能
const privateConst = 200  // mypkg 内からのみ参照可能

main.go

package main

import "fmt"
import "mypkg"

func main() {
	fmt.Println(mypkg.PublicConst)  //=> 100
}

標準パッケージの math パッケージも、円周率πを math.Pi という大文字で始まる定数名で公開しています。

package main

import "fmt"
import "math"

func main() {
	fmt.Println(math.Pi)  //=> 3.141592653589793
}

定数には型を指定しない

Go 言語で定数を定義するときは、const Foo int = 100 のように型を明示することもできますが、通常は型を指定せずに const Foo = 100 とだけ記述します。こうして untyped なままで定義しておくことで、実際にその定数値を使用するときに適切な型の値として扱ってくれるようになります。例えば、定数 Foo を int 型と明示して定義すると、下記の 3 行目で型のミスマッチが発生してエラーになってしまいます。

const Foo int = 100
var a uint = 100
a += Foo  // invalid operation: a += Foo (mismatched types uint and int)

定数の型を指定しないようにしておけば、その定数が使用されるときに適切な型の定数として扱ってくれるのでエラーが発生しません。

const Foo = 100
var a uint = 100
a += Foo  // OK

このように、定数を定義するときは型を指定しない方が便利に（かつ直感的に）使用できます。必ず特定の型でしか使って欲しくない場合のみ、定数の型を明示するようにしましょう。

連番の定数を定義する (iota)

定数ジェネレータの iota を使用すると、連番からなる定数を簡単に定義することができます。

const (
	FAST   = iota  //=> 0
	NORMAL         //=> 1
	SLOW           //=> 2
)

iota は呼び出されるごとに 0、1、2 という連番を返しますが、2 つ目以降の呼び出しは上記のように省略することができます。つまり、上記のコードは下記のコードと同等です。

const (
	FAST   = iota  //=> 0
	NORMAL = iota  //=> 1
	SLOW   = iota  //=> 2

0 始まりではなく、1 始まりの連番が欲しい場合は、次のように最初の値を _ で無視します。

const (
	_      = iota  //=> 0
	FAST           //=> 1
	NORMAL         //=> 2
	SLOW           //=> 3
)

あるいは、次のように記述することもできます。

const (
	FAST   = iota + 1  //=> 1
	NORMAL             //=> 2
	SLOW               //=> 3
)

iota が返す値は、次の const キーワードが出現したときに 0 にリセットされます。

const (
	a = iota  //=> 0
	b         //=> 1
	c         //=> 2
)

const (
	d = iota  //=> 0
	e         //=> 1
	f         //=> 2
)

次のようにシフトと組み合わせて使用することもできます。

const (
	a = 1 << iota  //=> 1
	b = 1 << iota  //=> 2
	c = 1 << iota  //=> 4
	d = 1 << iota  //=> 8
)

上記のように計算を組み合わせた定義も、下記のように省略することができます（代入式が暗黙的に繰り返されます）。

const (
	a = 1 << iota  //=> 1
	b              //=> 2
	c              //=> 4
	d              //=> 8
)

参考記事

Constants - The Go Blog

2017-08-31