こんにちはISSUEの寒河江です。

バックエンド側の実装が肥大化してきたので、DI管理ツールの[dig](https://github.com/uber-go/dig)を利用することにしました。以前はgoogle製の[wire](https://github.com/google/wire)を使っていたのですが、今回は流行っているということもあり、digを採用してみました。詳細な比較記事は後ほど書いてみようと思います。

## digは何をしてくれているか
digはDI情報を保持するcontainerを管理してくれます。今まではベタがきで実装していたDI処理を簡単に管理することができます。すごく簡単にいうと

- **Provide**で依存関係をセット
- **Invoke**でDIオブジェクトの取得

というイメージになります。

## 全体の実装イメージ
クリーンアーキテクチャで実装しており、Controller、Interactor、Repositoryにそれぞれ依存性を注入します。
![img](/mosaic-code.jpg)
routerの作成処理です。
![img](/mosaic-code.jpg)

コントローラの生成処理です。
![img](/mosaic-code.jpg)

処理順序は
①DIされたcontainer情報を作成
②containerからDI情報をInvokeで呼び出す
③routerに呼び出すhandlerを設定する

です。

1つずつの処理を見ていきます。

## ①DIされたcontainer情報を作成
`NewContainer`でDIコンテナを作成しています。
![img](/mosaic-code.jpg)

`NewContainer`では**Provide**で依存関係をセットしています。
![img](/mosaic-code.jpg)
ポイントはProvideの引数の`NewBookRepository`、`NewBookInteractor`、`NewBookController`に引数が設定されていないところです。一度ProvideでDIオブジェクトが設定されていればはdigが自動で引数の値を推測してくれます。

NewBookControllerのProvideを省略しない場合下記のようになります。
![img](/mosaic-code.jpg)
![img](/mosaic-code.jpg)

## ②containerからDI情報をInvokeで呼び出す
**Invoke**を使うとcontainerに登録した、情報を呼び出すことができます。呼び出した情報はInvokeのスコープ内でのみ利用できます。
![img](/mosaic-code.jpg)

### dig.Inとdig.OutでInvokeで利用しやすい情報を取得する
`dig.Out`を埋め込んだ構造体`ControllerResult`の情報は、`dig.In`を埋め込んだ構造体`ControllerParams`から取得することができます。
![img](/mosaic-code.jpg)

`Controller`情報をInvokeの中で取得したいので`ControllerResult`にControllerをセットします。
![img](/mosaic-code.jpg)

Invoke内でControllerParamsを取得することでbookControllerがDIされたControllerを取得できます
![img](/mosaic-code.jpg)


## ③routerに呼び出すControllerを設定する
最後にルーティングにcontroller関数を設定します。引数で渡された`*controller.Controller`からDIされた`BookController`を呼び出し、List関数を呼び出しています。
![img](/mosaic-code.jpg)

これで完了です！ポイントは`dig.In`と`dig.Out`を利用することでサーバー起動時の処理を綺麗にかけるところだと思いました。wireだとこの辺の設定はどうなっているんだろうか...

また今後digの応用的な使い方、wireとの比較について書いてみようと思います。
ご一読ありがとうございました！

## 参考
https://github.com/uber-go/dig
[Golang dependency injection: dig](https://blog.fearcat.in/a?ID=00001-0b4454fb-e367-4acb-b516-40958030138e)
[GoのおすすめDIツール](https://tech.raksul.com/2019/06/21/golang-favorite-di-tool/)
https://pkg.go.dev/go.uber.org/dig#section-readme

こんにちはISSUEの寒河江です。

バックエンド側の実装が肥大化してきたので、DI管理ツールの[dig](https://github.com/uber-go/dig)を利用することにしました。以前はgoogle製の[wire](https://github.com/google/wire)を使っていたのですが、今回は流行っているということもあり、digを採用してみました。詳細な比較記事は後ほど書いてみようと思います。

## digは何をしてくれているか
digはDI情報を保持するcontainerを管理してくれます。今まではベタがきで実装していたDI処理を簡単に管理することができます。すごく簡単にいうと

- **Provide**で依存関係をセット
- **Invoke**でDIオブジェクトの取得

というイメージになります。

## 全体の実装イメージ
クリーンアーキテクチャで実装しており、Controller、Interactor、Repositoryにそれぞれ依存性を注入します。
```go
package main

import (
	"fmt"
	"log"
	"net/http"
	
	"go.uber.org/dig"
)

//
// Controller
//
type bookController struct {
	bookInteractor Book
}

func NewBookController(us Book) *bookController {
	return &bookController{
		bookInteractor: us,
	}
}

//
// Interactor
//
type Book interface{}

type bookInteractor struct {
	bookRepo BookRepository
}

func NewBookInteractor(bookRepo BookRepository) Book {
	return &bookInteractor{
		bookRepo: bookRepo,
	}
}

//
// Repository
//
type BookRepository interface{}

type bookRepository struct {
	firebaseHandler FirebaseHandler
}

func NewBookRepository(firebaseHandler FirebaseHandler) BookRepository {
	return &bookRepository{firebaseHandler}
}


// container情報の作成
func NewContainer() (*dig.Container, error) {
	c := dig.New()

	// Book
	if err := c.Provide(NewBookRepository); err != nil {
		return nil, err
	}
	if err := c.Provide(NewBookInteractor); err != nil {
		return nil, err
	}
	if err := c.Provide(NewBookController); err != nil {
		return nil, err
	}

	// Controller
	if err := c.Provide(controller.NewController); err != nil {
		return nil, err
	}

	return c, nil
}

func main() {
        // ①DIされたcontainer情報を作成
	container, err := NewContainer()
	if err != nil {
		log.Fatal(err)
	}
	// ②containerからDI情報をInvokeで呼び出す
	err = container.Invoke(func(p controller.ControllerParams) {
		// ③routerに呼び出すhandlerを設定する
		log.Fatal(http.ListenAndServe(":8080", router.NewRouter(&p.Controller)))
	})
	if err != nil {
		log.Fatal(err)
	}
}
```
routerの作成処理です。
```go
package router

func NewRouter(c *controller.Controller) http.Handler {
	router := gin.Default()
	router.GET("/ping", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "ping",
		})
	})

	// corsやloggerの設定など

	book := router.Group("/book")
	book.GET("/", c.BookController.List)

	return router
}

```

コントローラの生成処理です。
```go
package controller

import "go.uber.org/dig"

type Controller struct {
        BookController   *bookController
}

type ControllerParams struct {
	dig.In

	Controller Controller
}

type ControllerResult struct {
	dig.Out

	Controller Controller
}

// NewController
func NewController(bookController *bookController) ControllerResult {
	return ControllerResult{
		Controller: Controller{
			BookController:  bookController,
		},
	}
}

```

処理順序は
①DIされたcontainer情報を作成
②containerからDI情報をInvokeで呼び出す
③routerに呼び出すhandlerを設定する

です。

1つずつの処理を見ていきます。

## ①DIされたcontainer情報を作成
`NewContainer`でDIコンテナを作成しています。
```go
func main() {
　　　　　　　　　　　　　　　　// ①DIされたcontainer情報を作成
	container, err := NewContainer()
	if err != nil {
		log.Fatal(err)
	}
}
```

`NewContainer`では**Provide**で依存関係をセットしています。
```go
// container情報の作成
func NewContainer() (*dig.Container, error) {
	c := dig.New()

	// Book
	if err := c.Provide(NewBookRepository); err != nil {
		return nil, err
	}
	if err := c.Provide(NewBookInteractor); err != nil {
		return nil, err
	}
	if err := c.Provide(NewBookController); err != nil {
		return nil, err
	}

	// Controller
	if err := c.Provide(controller.NewController); err != nil {
		return nil, err
	}

	return c, nil
}
```
ポイントはProvideの引数の`NewBookRepository`、`NewBookInteractor`、`NewBookController`に引数が設定されていないところです。一度ProvideでDIオブジェクトが設定されていればはdigが自動で引数の値を推測してくれます。

NewBookControllerのProvideを省略しない場合下記のようになります。
```go
// Book型のusは↓で事前にProvideしておくと勝手に推測してくれます
err := c.Provide(func (us Book) *bookController {
    return &bookController{
		bookInteractor: us,
	}
});
```
```go
// レスポンスでBook interfaceがコンテナに登録される
err := c.Provide(func (bookRepo BookRepository) Book {
    return &bookInteractor{
		bookRepo: bookRepo,
	}
});
```

## ②containerからDI情報をInvokeで呼び出す
**Invoke**を使うとcontainerに登録した、情報を呼び出すことができます。呼び出した情報はInvokeのスコープ内でのみ利用できます。
```go
func main() {
　　　　　　　　　　　　　　　　・
　　　　　　　　　　　　　　　　・
	// ②containerからDI情報をInvokeで呼び出す
	err = container.Invoke(func(p controller.ControllerParams) {
		log.Fatal(http.ListenAndServe(":8080", router.NewRouter(&p.Controller)))
	})

}
```

### dig.Inとdig.OutでInvokeで利用しやすい情報を取得する
`dig.Out`を埋め込んだ構造体`ControllerResult`の情報は、`dig.In`を埋め込んだ構造体`ControllerParams`から取得することができます。
```go
package controller

import "go.uber.org/dig"

type Controller struct {
        BookController   *bookController
}

type ControllerParams struct {
	dig.In

	Controller Controller
}

type ControllerResult struct {
	dig.Out

	Controller Controller
}

// NewController
func NewController(bookController *bookController) ControllerResult {
	return ControllerResult{
		Controller: Controller{
			BookController:  bookController,
		},
	}
}
```

`Controller`情報をInvokeの中で取得したいので`ControllerResult`にControllerをセットします。
```go
// NewController
func NewController(bookController *bookController) ControllerResult {
	return ControllerResult{
		Controller: Controller{
			BookController:  bookController,
		},
	}
}
```

Invoke内でControllerParamsを取得することでbookControllerがDIされたControllerを取得できます
```go
func main() {
　　　　　　　　　　　　　　　　・
　　　　　　　　　　　　　　　　・
	// ControllerParamsを取得できる
	err = container.Invoke(func(p controller.ControllerParams) {
	　　　　　　　　　　　　　　　　// p.ControllerでDIされたControllerをNewRouterに渡す
		log.Fatal(http.ListenAndServe(":8080", router.NewRouter(&p.Controller)))
	})

}
```


## ③routerに呼び出すControllerを設定する
最後にルーティングにcontroller関数を設定します。引数で渡された`*controller.Controller`からDIされた`BookController`を呼び出し、List関数を呼び出しています。
```go
package router

func NewRouter(c *controller.Controller) http.Handler {
	router := gin.Default()
	router.GET("/ping", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "ping",
		})
	})

	// corsやloggerの設定など

	book := router.Group("/book")
	book.GET("/", c.BookController.List)

	return router
}
```

これで完了です！ポイントは`dig.In`と`dig.Out`を利用することでサーバー起動時の処理を綺麗にかけるところだと思いました。wireだとこの辺の設定はどうなっているんだろうか...

また今後digの応用的な使い方、wireとの比較について書いてみようと思います。
ご一読ありがとうございました！

## 参考
https://github.com/uber-go/dig
[Golang dependency injection: dig](https://blog.fearcat.in/a?ID=00001-0b4454fb-e367-4acb-b516-40958030138e)
[GoのおすすめDIツール](https://tech.raksul.com/2019/06/21/golang-favorite-di-tool/)
https://pkg.go.dev/go.uber.org/dig#section-readme

続きを読むには単価診断を受けてください（30秒）