原文：https://medium.com/@eminetto/clean-architecture-using-golang-b63587aa5e3f
什么是簡潔架構(gòu)？
著名作者Robert “Uncle Bob” Martin 在他的著作“簡潔架構(gòu)：軟件結(jié)構(gòu)和設(shè)計的工匠指南*”中提出了一個架構(gòu)吊趾，其中包含可測試性和框架獨立性蹦浦，數(shù)據(jù)庫和接口等重要方面行施。
Clean Architecture中的約束條件是：
- 獨立于框架详幽。該體系結(jié)構(gòu)不依賴于某些功能強(qiáng)大的軟件庫的存在露懒。這使您可以使用這樣的框架作為工具寡具，而不必將系統(tǒng)塞進(jìn)有限的約束中牍汹。
- 可測試铐维。業(yè)務(wù)規(guī)則可以在沒有UI，數(shù)據(jù)庫慎菲，Web服務(wù)器或任何其他外部元素的情況下進(jìn)行測試嫁蛇。
- 獨立于用戶界面。用戶界面可以輕松更改钧嘶，而無需更改系統(tǒng)的其余部分棠众。例如，Web UI可以替換為控制臺UI有决，而無需更改業(yè)務(wù)規(guī)則闸拿。
- 獨立于數(shù)據(jù)庫。您可以替換Oracle或SQL Server书幕，而使用Mongo新荤，BigTable，CouchDB或其他台汇。您的業(yè)??務(wù)規(guī)則不綁定到數(shù)據(jù)庫苛骨。
- 獨立于任何外部機(jī)構(gòu)篱瞎。事實上，你的業(yè)??務(wù)規(guī)則根本就不了解外面的世界痒芝。
更多https://8thlight.com/blog/uncle-bob/2012/08/13/the-clean-architecture.html
所以俐筋，基于這個約束，每個層必須是獨立的和可測試的严衬。
根據(jù)Uncle Bob的體系結(jié)構(gòu)設(shè)計澄者，我們可以將代碼分為四層：
- Entities實體：封裝企業(yè)范圍的業(yè)務(wù)規(guī)則。Go中的實體是一組數(shù)據(jù)結(jié)構(gòu)和功能请琳。
- Use Cases用例：該層中的軟件包含特定于應(yīng)用程序的業(yè)務(wù)規(guī)則粱挡。它封裝并實現(xiàn)了系統(tǒng)的所有用例。
- Controller控制器：該層中的軟件是一組適配器俄精，可將數(shù)據(jù)從用例和實體最方便的格式轉(zhuǎn)換為最適合某些外部機(jī)構(gòu)（如數(shù)據(jù)庫或Web）的格式
- Framework & Driver 框架和驅(qū)動程序：該層通常由框架和工具組成询筏，如數(shù)據(jù)庫，Web框架等竖慧。
Golang的簡潔架構(gòu)
讓我們以包用戶為例：
ls -ln pkg/user
-rw-r?—?r?—?1 501 20 5078 Feb 16 09:58 entity.go
-rw-r?—?r?—?1 501 20 3747 Feb 16 10:03 mongodb.go
-rw-r?—?r?—?1 501 20 509 Feb 16 09:59 repository.go
-rw-r?—?r?—?1 501 20 2403 Feb 16 10:30 service.go
在文件entity.go中嫌套，我們有我們的實體：
//User data
type User struct {
ID entity.ID `json:"id" bson:"_id,omitempty"`
Picture string `json:"picture" bson:"picture,omitempty"`
Email string `json:"email" bson:"email"`
Password string `json:"password" bson:"password,omitempty"`
Type Type `json:"type" bson:"type"`
Company []*Company `json:"company" bson:"company,omitempty"`
CreatedAt time.Time `json:"created_at" bson:"created_at"`
ValidatedAt time.Time `json:"validated_at" bson:"validated_at,omitempty"`
}
在文件repository.go中，我們有定義存儲庫的接口测蘑，其中實體將被存儲灌危。在這種情況下，存儲庫意味著Bob的Uncle Bob體系結(jié)構(gòu)中的Framework＆Driver層碳胳。他的內(nèi)容是：
package user
import "github.com/thecodenation/stamp/pkg/entity"
//Repository repository interface
type Repository interface {
Find(id entity.ID) (*User, error)
FindByEmail(email string) (*User, error)
FindByChangePasswordHash(hash string) (*User, error)
FindByValidationHash(hash string) (*User, error)
FindAll() ([]*User, error)
Update(user *User) error
Store(user *User) (entity.ID, error)
AddCompany(id entity.ID, company *Company) error
AddInvite(userID entity.ID, companyID entity.ID) error
}
這個接口可以在任何類型的存儲層中實現(xiàn)，比如MongoDB沫勿，MySQL等等挨约。在我們的例子中，我們使用MongoDB來實現(xiàn)产雹，如mongodb.go中所示：
package user
import (
"errors"
"os"
"github.com/juju/mgosession"
"github.com/thecodenation/stamp/pkg/entity"
mgo "gopkg.in/mgo.v2"
"gopkg.in/mgo.v2/bson"
)
type repo struct {
pool *mgosession.Pool
}
//NewMongoRepository create new repository
func NewMongoRepository(p *mgosession.Pool) Repository {
return &repo{
pool: p,
}
}
func (r *repo) Find(id entity.ID) (*User, error) {
result := User{}
session := r.pool.Session(nil)
coll := session.DB(os.Getenv("MONGODB_DATABASE")).C("user")
err := coll.Find(bson.M{"_id": id}).One(&result)
if err != nil {
return nil, err
}
return &result, nil
}
func (r *repo) FindByEmail(email string) (*User, error) {
}
func (r *repo) FindByChangePasswordHash(hash string) (*User, error) {
}
func (r *repo) FindAll() ([]*User, error) {
}
func (r *repo) Update(user *User) error {
}
func (r *repo) Store(user *User) (entity.ID, error) {
}
func (r *repo) AddCompany(id entity.ID, company *Company) error {
}
func (r *repo) AddInvite(userID entity.ID, companyID entity.ID) error {
}
func (r *repo) FindByValidationHash(hash string) (*User, error) {
}
文件service.go代表由Uncle Bob定義的用例層诫惭。在文件中我們有接口Service和他的實現(xiàn)。該service接口是：
//Service service interface
type Service interface {
Register(user *User) (entity.ID, error)
ForgotPassword(user *User) error
ChangePassword(user *User, password string) error
Validate(user *User) error
Auth(user *User, password string) error
IsValid(user *User) bool
GetRepo() Repository
}
最后一層蔓挖，我們架構(gòu)中的Controller實現(xiàn)在api的內(nèi)容中：
cd api ; tree
.
|____handler
| |____company.go
| |____user.go
| |____address.go
| |____skill.go
| |____invite.go
| |____position.go
|____rice-box.go
|____main.go
在下面的代碼中夕土，從api / main.go中，我們可以看到如何使用這些服務(wù)：
session, err := mgo.Dial(os.Getenv("MONGODB_HOST"))
if err != nil {
elog.Error(err)
}
mPool := mgosession.NewPool(nil, session, 1)
queueService, err := queue.NewAWSService()
if err != nil {
elog.Error(err)
}
userRepo := user.NewMongoRepository(mPool)
userService := user.NewService(userRepo, queueService)
現(xiàn)在我們可以輕松的為我們的軟件包創(chuàng)建測試瘟判，例如：
package user
import (
"testing"
"time"
"github.com/thecodenation/stamp/pkg/entity"
"github.com/thecodenation/stamp/pkg/queue"
)
func TestIsValidUser(t *testing.T) {
u := User{
ID: entity.NewID(),
FirstName: "Bill",
LastName: "Gates",
}
userRepo := NewInmemRepository()
queueService, _ := queue.NewInmemService()
userService := NewService(userRepo, queueService)
if userService.IsValid(&u) == true {
t.Errorf("got %v want %v",
true, false)
}
u.ValidatedAt = time.Now()
if userService.IsValid(&u) == false {
t.Errorf("got %v want %v",
false, true)
}
}
使用Clean Architecture怨绣，我們可以將數(shù)據(jù)庫從MongoDB更改為Neo4j，而不用改寫其他應(yīng)用層拷获。我們可以在不損失質(zhì)量和開發(fā)效率的情況下進(jìn)行迭代篮撑。
References
https://hackernoon.com/golang-clean-archithecture-efd6d7c43047
https://8thlight.com/blog/uncle-bob/2012/08/13/the-clean-architecture.html
