对于 REST API,您通常会处理至少三个不同的实现层:
- HTTP 处理程序
- 某种业务逻辑/用例
- 持久存储/数据库接口
您可以分别处理和构建它们中的每一个,这不仅可以将其解耦,还可以使其更易于测试。然后通过注入必要的位将这些部分组合在一起,因为它们符合您定义的接口。通常这会导致main 或单独的配置机制成为唯一知道what 被组合和注入how 的地方。
文章Applying The Clean Architecture to Go applications 很好地说明了如何分离各个部分。遵循这种方法的严格程度在一定程度上取决于项目的复杂性。
下面是一个非常基本的分解,将处理程序与逻辑和数据库层分开。
HTTP 处理程序
处理程序除了将请求值映射到局部变量或可能的自定义数据结构(如果需要)之外什么都不做。除此之外,它只是运行用例逻辑并在将结果写入响应之前映射结果。这也是将不同错误映射到不同响应对象的好地方。
type Interactor interface {
Bar(foo string) ([]usecases.Bar, error)
}
type MyHandler struct {
Interactor Interactor
}
func (handler MyHandler) Bar(w http.ResponseWriter, r *http.Request) {
foo := r.FormValue("foo")
res, _ := handler.Interactor.Bar(foo)
// you may want to map/cast res to a different type that is encoded
// according to your spec
json.NewEncoder(w).Encode(res)
}
单元测试是测试 HTTP 响应是否包含针对不同结果和错误的正确数据的好方法。
用例/业务逻辑
由于存储库只是被指定为一个接口,因此很容易为业务逻辑创建单元测试,由同样符合DataRepository 的模拟存储库实现返回不同的结果。
type DataRepository interface {
Find(f string) (Bar, error)
}
type Bar struct {
Identifier string
FooBar int
}
type Interactor struct {
DataRepository DataRepository
}
func (interactor *Interactor) Bar(f string) (Bar, error) {
b := interactor.DataRepository.Find(f)
// ... custom logic
return b
}
数据库接口
与数据库通信的部分实现了DataRepository 接口,但在其他方面完全独立于它将数据转换为预期类型的方式。
type Repo {
db sql.DB
}
func NewDatabaseRepo(db sql.DB) *Repo {
// config if necessary...
return &Repo{db: db}
}
func (r Repo)Find(f string) (usecases.Bar, error) {
rows, err := db.Query("SELECT id, foo_bar FROM bar WHERE foo=?", f)
if err != nil {
log.Fatal(err)
}
defer rows.Close()
for rows.Next() {
var id string, fooBar int
if err := rows.Scan(&id, &fooBar); err != nil {
log.Fatal(err)
}
// map row value to desired structure
return usecases.Bar{Identifier: id, FooBar: fooBar}
}
return errors.New("not found")
}
同样,这允许单独测试数据库操作而无需任何模拟 SQL 语句。
注意:上面的代码是伪代码,不完整。