【GO言語】init関数の使い方

# はじめに

Go言語のinit関数についてまとめました。

## init関数とは？

アプリケーションの状態を初期化するために用いられる関数。パッケージ変数の初期化などに使われる。引数を取らず、何も値を返さない。パッケージが初期化→パッケージ内の全ての定数と変数宣言が評価→init関数の実行。

```go
// 2番目に実行
func init() {
	fmt.Println("init")
}

// 一番最初に実行
var a = func() int {
	fmt.Println("var")
	return 0
}()

// 最後に実行
func main() {
	fmt.Println("main")
}
```

これを実行すると、以下のようになります。

```
var
init
main
```

他にも、実際の実行が始まる前にプログラムの状態が正しいかどうかを検証または修復する用途にも使用される。

```go
func init() {
    if user == "" {
        log.Fatal("$USER not set")
    }
    if home == "" {
        home = "/home/" + user
    }
    if gopath == "" {
        gopath = home + "/go"
    }
    // gopath may be overridden by --gopath flag on command line.
    flag.StringVar(&gopath, "gopath", gopath, "デフォルトのGOPATHをオーバライドする")
}
```

## mainが別パッケージに依存する場合


![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/156096/ec0ecf9a-b4c4-4776-c8e4-ecea2b6840c8.png)

### パッケージ内に複数のinit関数がある場合

ファイルのアルファベット順に実行される。
a.goのinit()　→ b.goのinit()の順に実行される。
ファイル名が変更されると、init()の実行順が変更される可能性があるので、init()の順序に依存してはいけない。

下図は複数パッケージの場合の実行順例。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/156096/d2d58e26-5b8c-e99c-0484-d44a9b355e94.png)


### 副作用のためのinit()

他パッケージのinit()だけを実行したい場合、importでブランク識別子`_`をつける。

```go
import (
	"fmt"
	_ "foo"
)
```

ちなみにmain関数の中でinit関数は実行できない。

```go
func main() {
	init() // コンパイルエラー
}
```

## init()を使ってはいけないとき

### データベースのコネクションプールの保持

データベースをオープンして、Pingができるか確認し、グローバル変数に代入している。

```go
var db *sql.DB
func init() {
    dataSourceName := os.Getenv("MYSQL_DATA_SOURCE_NAME")
    d, err := sql.Open("mysql", dataSourceName)
    if err != nil {
        log.Panic(err)
    }
    err = d.Ping()
    if err != nil {
        log.Panic(err)
    }
    db = d
}
```

上記は以下3つの問題がある。

1. init関数はエラーを返さない
    * パニックを起こし、アプリケーションを停止することでエラーを通知する。呼び出し元でリトライやフォールバックができなくなる
1. テストケースを実行する前にinit関数が実行される
    * DBへのコネクションを作成する必要ないユーティリティ関数に対する単体テストなど、テストが書きにくくなる
1. データベースのコネクションプールをグローバル変数に代入する必要がある
    * 変数は、グローバル変数よりカプセル化するべき
        * どの関数からでもパッケージ内のグローバル変数を変更できてしまう
        * グローバル変数に依存する関数は切り離されないので、単体テストが複雑になる可能性がある

先ほどのコードは、以下のように改善できる。

```go
func NewDbClient(dsn string) (*sql.DB, error) {
    db, err := sql.Open("mysql", dsn)
    if err != nil {
        return nil, err
    }
    if err = db.Ping(); err != nil {
        return nil, err
    }
    db.SetConnMaxLifetime(15 * time.Second)
    db.SetMaxIdleConns(10)
    db.SetMaxOpenConns(10)     
                                        
    return db, nil
}
```

## init()を使っていいとき

Goの[公式ブログ](http://mng.bz/PW6)では、以下のように静的なHTTP設定を行うためにinit関数を使用している。

```go
func init() {
	// Redirect "/blog/" to "/", because the menu bar link is to "/blog/"
	// but we're serving from the root.
	redirect := func(w http.ResponseWriter, r *http.Request) {
		http.Redirect(w, r, "/", http.StatusFound)
	}
	http.HandleFunc("/blog", redirect)
	http.HandleFunc("/blog/", redirect)

	// Keep these static file handlers in sync with app.yaml.
	static := http.FileServer(http.Dir("static"))
	http.Handle("/favicon.ico", static)
	http.Handle("/fonts.css", static)
	http.Handle("/fonts/", static)

	http.Handle("/lib/godoc/", http.StripPrefix("/lib/godoc/", http.HandlerFunc(staticHandler)))
}
```

このとき、以下3つを満たすので、上記のinit関数は有用である。

* initが失敗することはない(handlerがnilではないので、パニックにならない)
* グローバル変数を作る必要がない
* 単体テストに影響を与えることがない

# 参考文献

1. [Effective Go - The Go Programming Language](https://go.dev/doc/effective_go?source=post_page-----53d371d4500e--------------------------------#init)
1. [Golang Mistakes: #2 Misusing Init() Functions | Vivasoftltd](https://vivasoftltd.com/golang-mistakes-2-misusing-init-functions/)
1. [Go言語 100Tips ありがちなミスを把握し、実装を最適化する (impress top gear) : Teiva Harsanyi, 柴田 芳樹: 本](https://www.amazon.co.jp/Go%E8%A8%80%E8%AA%9E-100Tips-%E3%81%82%E3%82%8A%E3%81%8C%E3%81%A1%E3%81%AA%E3%83%9F%E3%82%B9%E3%82%92%E6%8A%8A%E6%8F%A1%E3%81%97%E3%80%81%E5%AE%9F%E8%A3%85%E3%82%92%E6%9C%80%E9%81%A9%E5%8C%96%E3%81%99%E3%82%8B-impress-gear/dp/4295017531)