golang project architecture-202301071505

Last updated Jan 7, 2023 Edit Source

# golang project architecture-202301071505

# Summary

結構化的 Golang project 設計

# Notes

這是個老議題了, 但最近在網路上看到滿多教學文在講 project setup

還是來分享一下自己目前的理解跟設計

# 專案架構

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
.
├── assets
├── bin
├── build
├── CHANGELOG.md
├── cmd
│   ├── demo1
│   │   └── main.go
│   └── demo2
│       └── main.go
├── configs
├── deployment
├── docs
├── entity
├── go.mod
├── go.sum
├── infra
├── Makefile
├── pkg
├── README.md
├── repository
├── scripts
└── usecase

# Entity Layer

# /entity

在說明 entity 放什麼之前, 先看一下 entity 的解釋
Entities encapsulate Enterprise wide business rules. An entity can be an object with methods, or it can be a set of data structures and functions. It doesn’t matter so long as the entities could be used by many different applications in the enterprise. If you don’t have an enterprise, and are just writing a single application, then these entities are the business objects of the application. They encapsulate the most general and high-level rules. They are the least likely to change when something external changes. For example, you would not expect these objects to be affected by a change to page navigation, or security. No operational change to any particular application should affect the entity layer.
所以 entity 是什麼 ?
- 是最高級的實體, 包含一些針對實體的 function
- 變動最小 (你不會希望你到處引用的 struct 一直被修改)
- 因為是最高層的, 不會引用別人, 會被各個 application 引用
- entity 並不包含 database/service/application, 是最簡單的封裝

# Drivers

# /repository

Repository Pattern
通常都是定義好對應的 interface 再用某個 Datebase 去實做, 好處是可以隔離 db & service. 例如 usecase 使用 repository, 對他來說就看不見下層的 Database.
個人覺得有個麻煩的地方就是雖然有辦法抽換 Database, 但如果初期沒有規劃好 interface 的話, 有可能會變成看似隔開了但其實沒有. 比較好的訣竅可能是在設計 Repository 時不應該針對特定 Database. 自己是覺得這方面自己做的不太好就是了.
- 另外就是抽換真的很麻煩, 需要實做 interface, 評估效能..etc.

# Usecase Layer

# /usecase

基本上業務邏輯會被集中在這層, 通常是放 Service
改動程度最大

# Interface Adopters Layer

# /cmd

Main application package
相較有些 project 會把 main.go 放在根目錄, 如果你的 application 需要多個 binary(只有一個也沒關係), 個人認為 cmd 是更好的選擇.
這邊通常不會有太多 business logic, 主要都只有CLI, 讀取設定, Dependency injection 和 service 啟動的簡單邏輯
編譯完的 binary 都會放到 /bin