HexaGO (A simple ports & adapter architecture example)

HexaGO（シンプルなポート＆アダプターアーキテクチャの例）

これは、ポート＆アダプターアーキテクチャを使用した電卓アプリのシンプルな例です。

実行方法

1. リポジトリをクローンします
2. air をインストールします go install github.com/cosmtrek/air@latest
3. templ をインストールします go install github.com/a-h/templ/cmd/templ@latest
4. プロジェクトのルートで air を実行します
5. ブラウザーを開き、http://localhost:3000 にアクセスします

インスピレーション

このプロジェクトは、Alistair Cockburn と Juan Manuel Garrido de Paz による書籍『Hexagonal Architecture』（ご冥福をお祈りします）に着想を得ています。

このプロジェクトの目的は、Go プロジェクトでポート＆アダプターアーキテクチャを実装する方法を示すシンプルな例を紹介することです。

ライセンス

このプロジェクトは好きなようにお使いください。無料のオープンソースで、制約はありません。

はじめに

hexago とは？

これは、Go 言語でのヘキサゴナルアーキテクチャ（ポートとアダプター）の小規模な実装です。

ヘキサゴナルアーキテクチャとは？

ヘキサゴナルアーキテクチャは、アプリケーションを複数のレイヤーに分けるソフトウェア設計パターンです。このパターンは、ポート＆アダプターパターンとしても知られています。

ヘキサゴナルアーキテクチャの主な構成要素は次のとおりです。

• コア：アプリケーションの中心となる部分です。ビジネスロジックとドメインモデルを含みます。
• ポート：コアが外部と通信するために使用するインターフェースです。コアで定義され、アダプターで実装されます。
  • ドライバー：ポートの実装です。外部システム（データベース、API など）とのやり取りを担います。 -- 駆動アダプター：ドライバーの実装です。コアと外部システムの間でデータを変換します。
• アダプター：ポートの実装です。コアと外部システムの間でデータを変換します。

ヘキサゴナルアーキテクチャの主な利点は、アプリケーションのテストや保守がしやすくなることです。コアは外部システムから切り離されているため、単独でテストできます。ポートとアダプターは異なる実装に簡単に置き換えられるため、新しい要件にも容易に対応できます。

hexago の使い方

内部レイヤーを複数のヘキサゴンに分けるのが好きです。 各ヘキサゴンはそれぞれ独自のフォルダーに配置し、次のようなフォルダー構成にします。

<HexagonName>
├── core
│   ├── <HexagonName>.go
│   └── <HexagonName>_test.go
├── ports
│   ├── driven
│   │   ├── for<Verb><Action>.go // e.g forCreatingUser.go
│   │   └── for<Verb><Action>_test.go
│   └── driving
│       ├── for<Verb><Action>.go // e.g forCreatingUser.go
│       └── for<Verb><Action>_test.go
└── adapters
    ├── db.go
    └── calculatorHTTP.go

core フォルダーには、ヘキサゴンのビジネスロジックとドメインモデルが含まれます。

ports フォルダーには、コアが外部と通信するために使用するインターフェースが含まれます。

adapters フォルダーには、ポートの実装が含まれます。

ポートは、コアと外部システムとのやり取りを制限するインターフェースの集合です。

始め方

1. リポジトリをクローンします
2. air をインストールします go install github.com/cosmtrek/air@latest
3. templ をインストールします go install github.com/a-h/templ/cmd/templ@latest
4. プロジェクトのルートで air を実行します
5. ブラウザーを開き、http://localhost:3000 にアクセスします

Docker 化のための作業手順

1. compose.yml のイメージ名を、自分のイメージ名に変更します
2. nginx.conf のドメイン名を、自分のドメイン名に変更します
3. .github/workflows/deploy.yml の Docker イメージ名を、同じ名前に変更します