ニュースレター用の記事です。ISSUEで実装した例を元にクリーアーキテクチャの説明をしていこうと思います。一気に書き上げるには時間がかかるので徐々に内容を埋めていきます。ぜひ購読ボタンを押していただけると書き上げるモチベーションになるのでよろしくお願いします。


![](https://storage.googleapis.com/zenn-user-upload/4e65ee0713fe-20220321.jpeg)

## 最終的なディレクトリ構造
ISSUEバックエンドでクリーンアーキテクチャを踏襲して実装したディレクトリ構造は以下のようになります。
![img](/mosaic-code.jpg)



## Frameworks & Drivers
![](https://storage.googleapis.com/zenn-user-upload/403d28ba4c6b-20220321.jpeg)

**一番外側のレイヤーでフレームワークやDB接続など技術的な実装を置く場所になります。**
DBで言うとMySQLやFrebase接続部分のhandlerとして実装する部分になります。clientを作成して、実際にDBへの永続化処理を行うためのDIするためなどに使われるケースが多い印象です。

|                      | 
| -------------------- | 
| DB                   | 
| External Interfaces 　　| 
| UI                   | 
| Web                  | 
| Devices              | 

下記はfirestoreへの接続とそのhandlerを作成している実装例になります。
![img](/mosaic-code.jpg)



## Interface Adapters
![](https://storage.googleapis.com/zenn-user-upload/d401a37f677f-20220321.jpeg)
UsecaseとEntityに便利な形からデータベースやWebなど一番外側のFrameworks & Driversで利用しやすい形に変換します。このレイヤーではMVCモデルを内包した形になります。

Interface Adaptersに登場する概念
|             |                                                            | 
| ----------- | ---------------------------------------------------------- | 
| Controllers | web等でユーザーが入力した内容をUsecase用に変換して渡します | 
| Presenters  | Usecaseの処理結果を出力します。                            | 
| Gateways    | repositoryなど永続化に関する処理が実装されます。           | 

**ControllersからUsecaseに変換したinputを渡す例**
![img](/mosaic-code.jpg)

**Gateway**
repositoryでusecaseで利用するFirebaseへの永続化処理の例
![img](/mosaic-code.jpg)



## Application Business Rules
![](https://storage.googleapis.com/zenn-user-upload/95e6b1514450-20220321.jpeg)
Layered Architectureにおけるapplication層です。参考著書によると以下になります。

> アプリケーション固有のビジネスルールが含まれており、システム全てのユースケースがカプセル化されて実装されています。
> -- Ｒｏｂｅｒｔ Ｃ．Ｍａｒｔｉｎ,角 征典,高木 正弘. Clean Architecture　達人に学ぶソフトウェアの構造と設計 (Japanese Edition) (Kindle の位置No.3161-3165). Kindle 版.

ここでは新たにたくさんの概念　が登場します。[クリーンアーキテクチャ完全に理解した](https://gist.github.com/mpppk/609d592f25cab9312654b39f1b357c60#application-business-rules)のテーブルの説明がわかりやすいので引用しました。

![](https://storage.googleapis.com/zenn-user-upload/f74fc679def2-20220321.png)

実際のinputとoutputを使った実装例
coming soon...




## Enterprise Business Rules
![](https://storage.googleapis.com/zenn-user-upload/b19ced16607a-20220321.jpeg)

Layered Architectureにおけるドメイン層になります。ここにはビジネスルールがカプセル化されたEntitiesという概念があります。このEntitiesも外部の実装が変更されても影響されないようなものがきます。

domain modelの実装例
![img](/mosaic-code.jpg)

簡単ではありますが、golangとfirebaseでのクリーンアーキテクチャ実装例をご紹介しました。ここがわからない、もっと詳しく書いて欲しいなどありましたらコメントお待ちしています！


ニュースレター用の記事です。ISSUEで実装した例を元にクリーアーキテクチャの説明をしていこうと思います。一気に書き上げるには時間がかかるので徐々に内容を埋めていきます。ぜひ購読ボタンを押していただけると書き上げるモチベーションになるのでよろしくお願いします。


![](https://storage.googleapis.com/zenn-user-upload/4e65ee0713fe-20220321.jpeg)

## 最終的なディレクトリ構造
ISSUEバックエンドでクリーンアーキテクチャを踏襲して実装したディレクトリ構造は以下のようになります。
```shell
.
├── cmd
│   └── api
│       └── main.go
├── domain
│   ├── model
│   │   └── survey.go   // entities
│   └── usecase
│       └── usecase.go  // ユースケースのinterface
├── infrastructure  
│   ├── firebase_handler.go  // firestoreとの接続
│   └── router.go
├── interfaces
│   ├── database  // 永続化処理
│   │   ├── firebase_handler.go  
│   │   └── survey.go
│   └── controller
│       └── survey.go
└── usecase
    ├── input   // usecaseでの入力で利用するinput
    ├── output  // usecaseでの出力で利用するoutput
    ├── repository  // interfaces/databaseのinterface
    │   └── survery.go
    └── survey_interactor.go // usecaseの実行処理が描かれるファイル
```



## Frameworks & Drivers
![](https://storage.googleapis.com/zenn-user-upload/403d28ba4c6b-20220321.jpeg)

**一番外側のレイヤーでフレームワークやDB接続など技術的な実装を置く場所になります。**
DBで言うとMySQLやFrebase接続部分のhandlerとして実装する部分になります。clientを作成して、実際にDBへの永続化処理を行うためのDIするためなどに使われるケースが多い印象です。

|                      | 
| -------------------- | 
| DB                   | 
| External Interfaces 　　| 
| UI                   | 
| Web                  | 
| Devices              | 

下記はfirestoreへの接続とそのhandlerを作成している実装例になります。
```go
package infrastructure

type FirebaseHandler struct {
	firestoreClient *firestore.Client
}

// NewFirebaseHandler
func NewFirebaseHandler(ctx context.Context, firebaseConfig config.Firebase) database.FirebaseHandler {
	var opts []option.ClientOption
	opts = append(opts, option.WithCredentialsJSON([]byte(firebaseConfig.Credential)))

	app, err := firebase.NewApp(ctx, &firebase.Config{ProjectID: firebaseConfig.ProjectID}, opts...)
	if err != nil {
		panic(err.Error)
	}
	fs, err := app.Firestore(ctx)
	if err != nil {
		panic(err.Error)
	}

	return &FirebaseHandler{
		firestoreClient: fs,
	}
}
```



## Interface Adapters
![](https://storage.googleapis.com/zenn-user-upload/d401a37f677f-20220321.jpeg)
UsecaseとEntityに便利な形からデータベースやWebなど一番外側のFrameworks & Driversで利用しやすい形に変換します。このレイヤーではMVCモデルを内包した形になります。

Interface Adaptersに登場する概念
|             |                                                            | 
| ----------- | ---------------------------------------------------------- | 
| Controllers | web等でユーザーが入力した内容をUsecase用に変換して渡します | 
| Presenters  | Usecaseの処理結果を出力します。                            | 
| Gateways    | repositoryなど永続化に関する処理が実装されます。           | 

**ControllersからUsecaseに変換したinputを渡す例**
```go
package controller

import (
	"fmt"
	"net/http"

	"github.com/gin-gonic/gin"
	"github.com/..../issue-backend/domain/usecase"
	"github.com/..../issue-backend/usecase/input"
)

// surveyController  represent the httphandler for survey
type surveyController struct {
	surveyInteractor usecase.Survey
}

// suveyControllerの初期化処理
func NewSurveyController(us usecase.Survey) *surveyController {
	return &surveyController{
		surveyController: us,
	}
}

// List
// `GET /v1/surveys`. 
func (h *surveyController) List(c *gin.Context) {
	surveys, err := h.surveyInteractor.List(c, input.ListSurvey{
		surveyID: 1,   // usecaseのInteractorに、使いやすいような形でinputに変換して渡す
	})
	if err != nil {
		fmt.Println(err)
		return
	}

	c.JSON(http.StatusOK, surveys)
}

```

**Gateway**
repositoryでusecaseで利用するFirebaseへの永続化処理の例
```go
package database

import (
	"context"

	"github.com/pkg/errors"
	"google.golang.org/api/iterator"

	"github.com/..../issue-backend/domain/model"
	"github.com/..../issue-backend/usecase/repository"
)

const surveyPath = "surveys"

type surveryRepository struct {
	firebaseHandler FirebaseHandler
}

// NewSurveyRepository will create an object that represent the survey.Repository interface
func NewSurveyRepository(firebaseHandler FirebaseHandler) repository.SurveyRepository {
	return &surveryRepository{firebaseHandler}
}

// Listはfirestoreからsurveyというデータを取得している
func (r *surveryRepository) List(ctx context.Context) ([]*model.Survey, error) {
	iter := r.firebaseHandler.Collection(surveyPath).Documents(ctx)
	surveys := []*model.Survey{}
	for {
		doc, err := iter.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			return nil, errors.Wrap(err, "failed to iterate survey")
		}

		survey := &model.Survey{ID: doc.Ref.ID}
		if err := doc.DataTo(survey); err != nil {
			return nil, errors.Wrap(err, "failed to store survey")
		}
		surveys = append(surveys, survey)
	}
	return surveys, nil
}

```



## Application Business Rules
![](https://storage.googleapis.com/zenn-user-upload/95e6b1514450-20220321.jpeg)
Layered Architectureにおけるapplication層です。参考著書によると以下になります。

> アプリケーション固有のビジネスルールが含まれており、システム全てのユースケースがカプセル化されて実装されています。
> -- Ｒｏｂｅｒｔ Ｃ．Ｍａｒｔｉｎ,角 征典,高木 正弘. Clean Architecture　達人に学ぶソフトウェアの構造と設計 (Japanese Edition) (Kindle の位置No.3161-3165). Kindle 版.

ここでは新たにたくさんの概念　が登場します。[クリーンアーキテクチャ完全に理解した](https://gist.github.com/mpppk/609d592f25cab9312654b39f1b357c60#application-business-rules)のテーブルの説明がわかりやすいので引用しました。

![](https://storage.googleapis.com/zenn-user-upload/f74fc679def2-20220321.png)

実際のinputとoutputを使った実装例
coming soon...




## Enterprise Business Rules
![](https://storage.googleapis.com/zenn-user-upload/b19ced16607a-20220321.jpeg)

Layered Architectureにおけるドメイン層になります。ここにはビジネスルールがカプセル化されたEntitiesという概念があります。このEntitiesも外部の実装が変更されても影響されないようなものがきます。

domain modelの実装例
```go
package model

type Survey struct {
	ID          string `json:"id" firestore:"-"`
	Title       string `json:"title" firestore:"title"`
	Page        int    `json:"page" firestore:"page"`
	SubTitle    string `json:"subTitle" firestore:"subTitle"`
	Description string `json:"description" firestore:"description"`
	AnswerCount int    `json:"answerCount" firestore:"answerCount"`
}
```

簡単ではありますが、golangとfirebaseでのクリーンアーキテクチャ実装例をご紹介しました。ここがわからない、もっと詳しく書いて欲しいなどありましたらコメントお待ちしています！


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