[Golang] 1行加えるだけで interface の実装を強制するテクニック

interfaceの実装を強制する簡単なテクニックを紹介

Goのinterfaceを使って抽象的にオブジェクトを扱いたいときにメソッドの実装漏れってないでしょうか?

抽象化したい構造体が多かったり、interfaceのメソッド定義を変更した場合に簡単に発生しますよね。 今回は、それを起こさないために、Goコンパイラにinterfaceの実装漏れを伝える簡単なテクニックを共有します。

導入

DoerというDo()を実装するだけで使えるinterfaceを定義しました。 下記のコードのPersonDo()を実装しているので、Doerとして扱うことができます。

https://play.golang.org/p/W9Gd3gZKY2z

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
type Doer interface {
    Do()    
}

type Person struct {
    Name string    
}

func (p Person) Do() {
    fmt.Printf("My name is %s. I am Doer!!!!\n", p.Name)
}

func main() {
    p := Person{Name: "John"}
    p.Do()
}
実行結果
My name is John. I am Doer!!!!

ここまで問題は無いと思います。 それでは、DoerにメソッドGreet()を追加してみましょう。 今までDo()を実装するだけで、Doerとして扱うことができていたのに、Greet()も実装する必要が発生しました。

なので、Do()しか実装していない構造体Personは、Doerとして扱うことができませんが、プログラムは正しいです。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
type Doer interface {
    Do()    
    Greet() // 追加!!!
}

type Person struct {
    Name string    
}

func (p Person) Do() {
    fmt.Printf("My name is %s. I am Doer!!!!\n", p.Name)
}

func main() {
    p := Person{Name: "John"}
    p.Do()
}

このように1ファイルに収まるシンプルさなら実装漏れにすぐに気づくはずですが、 interfaceを実装したい構造体がたくさんあったら…ファイルが分けられていたら…パッケージが分けられていたら… なかなか気づくのは難しいと思います。

それを探すのってかなり面倒ではありませんか….?

テクニックを紹介

var _ Doer = Person{} というコードを追加するだけです。 _ は省略を表しているので、メモリも無駄になりません。

これを加えるだけで、コンパイルエラーが発生し、さらにエラーが発生しているファイル名、行列数まで教えてくれるのですぐに見つけることができます。

https://play.golang.org/p/XvFkqetQ-Df

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
type Doer interface {
	Do()
	Greet()
}

var _ Doer = Person{} // たったこれだけ!

type Person struct {
	Name string
}

func (p Person) Do() {
	fmt.Printf("My name is %s. I am Doer!!!!\n", p.Name)
}

func main() {
	p := Person{Name: "John"}
	p.Do()
}
./prog.go:5:5: cannot use composite literal (type Person) as type Doer in assignment:
	Person does not implement Doer (missing Greet method)

最後に

たった1行追加するだけでinterfaceの実装漏れをふせぐことができるこのテクニックを是非使ってみてください!!

実はこれUberがおすすめしているテクニックでもあります。

https://github.com/uber-go/guide/blob/master/style.md#verify-interface-compliance

他にもGoのテクニックや、Uberで推奨されているスタイルがまとまっているので気になる方はチェックしてみてください。

コードレビューをする際にめちゃくちゃ使えます! 「Uberで使われているんですよ〜」といえば、納得できそうではないでしょうか?笑

updatedupdated2020-05-212020-05-21