使用Go构建商业应用: 关于DRY，你需要知道的

这篇文章是我们《使用Go构建商业应用》^[1]系列中的一篇。在此之前，我们介绍了Wild Workouts，这是一个以现代方式构建的、带有一些微妙反模式(anti-patterns)的应用示例。我们特意添加了这些内容，以介绍常见的陷阱和避免这些陷阱的技巧。

在这篇文章中，我们开始对Wild Workouts进行重构。之前的文章会给你更多的背景，但阅读它们并不是理解这篇文章的必要条件。

背景故事

苏珊是一名软件工程师，她对目前的工作感到厌倦，因为她的工作是与传统的企业软件打交道。于是苏珊开始寻找新的工作，她发现了使用无服务器(serverless) Go微服务的创业公司Wild Workouts，这似乎是一些新潮的东西，因此她选择加入了Wild Workouts并开始了她在新公司的生活。

团队里只有几个工程师，所以苏珊的入职速度非常快。第一天，她就被分配了第一个任务，目的是让她熟悉这个应用程序。

我们需要存储每个用户最后登录的IP地址。它将在未来实现新的安全功能，比如从新地点登录时的额外确认。现在，我们只想把它保存在数据库中。

苏珊熟悉了一段时间应用程序,她试图了解每个服务中发生了什么，以及在哪里添加一个新字段来存储IP地址。最后，她发现了一个她可以扩展的User结构体:

 // User defines model for User.
 type User struct {
        Balance     int     `json:"balance"`
        DisplayName string  `json:"displayName"`
        Role        string  `json:"role"`
+       LastIp      string  `json:"lastIp"`
 }

没过多久，苏珊就发起了她的第一个PR。高级工程师Dave在代码审查时添加了一条评论:

我认为我们不应该通过REST API公开这个字段。

苏珊很惊讶，因为她确信自己更新了数据库模型。她很困惑，问Dave这是否是添加新字段的正确位置。

Dave解释说，应用程序的数据库Firestore存储由Go结构体序列化后的数据。因此User结构体与前端响应和存储都兼容。

“多亏了这种方法，你不需要重复的代码，只需更改一次YAML定义并重新生成文件就足够了。” Dave热情地说道。

感谢这个提示，现在苏珊又添加了一个更改，以在API的响应中隐藏新字段。

diff --git a/internal/users/http.go b/internal/users/http.go
index 9022e5d..cd8fbdc 100644
--- a/internal/users/http.go
+++ b/internal/users/http.go
@@ -27,5 +30,8 @@ func (h HttpServer) GetCurrentUser(w http.ResponseWriter, r *http.Request) {
        user.Role = authUser.Role
        user.DisplayName = authUser.DisplayName

+       // Don't expose the user's last IP externally
+       user.LastIp = nil
+
        render.Respond(w, r, user)
}

一行代码解决了这个问题。对苏珊来说，这是非常有成效的第一天。

深思熟虑

尽管苏珊的解决方案被批准并合并了，但在回家的路上还是有一些事情困扰着她。对于API的响应和数据库模型，使用同一个模型定义是正确的做法吗？随着应用程序不断扩展，难道不会有意外暴露用户隐私细节的风险吗？如果我们只想更改API的响应而不想更改数据库字段，该怎么办？

把这两个结构体分开怎么样？苏珊在以前的工作中就是这么做的，但也许这些是不应该在Go微服务中使用的模式？此外，团队似乎很在意“不要重复自己”的原则。

重构

第二天，苏珊向Dave解释了她的疑虑，并征求了他的意见。起初，Dave不理解这种担忧，并告诉苏珊她可能需要习惯这种方式。

苏珊指出了Wild Workouts中的另一段代码，该代码使用了类似的特别解决方案。她分享说，根据她的经验，这样的代码很快就会失控:

user, err := h.db.GetUser(r.Context(), authUser.UUID)
if err != nil {
    httperr.InternalError("cannot-get-user", err, w, r)
    return
}

// HTTP Handler 似乎在适当的位置修改了User
user.Role = authUser.Role
user.DisplayName = authUser.DisplayName

render.Respond(w, r, user)

最终，他们同意通过一个新的PR再次讨论这个问题。不久，Susan准备了一个重构提案:

// 完整的代码在 https://github.com/ThreeDotsLabs/wild-workouts-go-ddd-example/commit/14d9e7badcf5a91811059d377cfa847ec7b4592f
diff --git a/internal/users/firestore.go b/internal/users/firestore.go
index 7f3fca0..670bfaa 100644
--- a/internal/users/firestore.go
+++ b/internal/users/firestore.go
@@ -9,6 +9,13 @@ import (
        "google.golang.org/grpc/status"
 )

+type UserModel struct {
+       Balance     int
+       DisplayName string
+       Role        string
+       LastIP      string
+}
+
diff --git a/internal/users/http.go b/internal/users/http.go
index 9022e5d..372b5ca 100644
--- a/internal/users/http.go
+++ b/internal/users/http.go
@@ -1,6 +1,7 @@
-       user.Role = authUser.Role
-       user.DisplayName = authUser.DisplayName

-       render.Respond(w, r, user)
+       userResponse := User{
+               DisplayName: authUser.DisplayName,
+               Balance:     user.Balance,
+               Role:        authUser.Role,
+       }
+
+       render.Respond(w, r, userResponse)
 }