Golang中共享结构体的最佳存放位置探讨

使用最后一个。

在Go语言项目中，共享结构体的最佳实践是将其放在独立的模块中，然后从客户端和服务器端分别导入。这种方式避免了代码重复，提高了可维护性，并遵循了Go模块化设计原则。以下是详细解释和示例代码。

为什么选择独立项目？

• 单一职责：共享代码独立于客户端或服务器逻辑，便于管理。
• 版本控制：可以独立版本化共享模块，客户端和服务器端通过版本号引用，避免破坏性变更。
• 依赖清晰：客户端和服务器端显式依赖共享模块，减少耦合。

实现步骤

1. 创建独立GitHub仓库：例如 github.com/yourusername/shared-models。
2. 定义共享结构体：在独立项目中创建Go模块。
3. 客户端和服务器端导入：通过Go模块系统引用共享模块。

示例代码

假设共享结构体用于用户数据。

在独立项目 shared-models 中：

• 文件结构：

  shared-models/
  ├── go.mod
  └── models/
      └── user.go
  

• go.mod 内容：

  module github.com/yourusername/shared-models
  
  go 1.21
  

• models/user.go 内容：

  package models
  
  type User struct {
      ID    int    `json:"id"`
      Name  string `json:"name"`
      Email string `json:"email"`
  }
  

在服务器端项目中：

• 导入共享模块：

  import "github.com/yourusername/shared-models/models"
  
  func handleUserRequest() {
      user := models.User{
          ID:    1,
          Name:  "Alice",
          Email: "alice@example.com",
      }
      // 处理用户逻辑...
  }
  

• 在 go.mod 中添加依赖：

  require github.com/yourusername/shared-models v0.1.0
  

在客户端项目中：

• 同样导入共享模块：

  import "github.com/yourusername/shared-models/models"
  
  func displayUser() {
      user := models.User{
          ID:    1,
          Name:  "Alice",
          Email: "alice@example.com",
      }
      // 使用用户数据...
  }
  

• 在 go.mod 中添加相同依赖。

其他方案的问题

• 放在服务器端或客户端：会导致一端主导共享代码，可能引入不相关依赖，违反关注点分离。
• 重复代码：违反DRY原则，维护困难，容易产生不一致。

通过独立模块，您可以确保结构体定义一致，且易于测试和扩展。使用Go模块的版本管理（如 go get github.com/yourusername/shared-models@v1.0.0）可以进一步控制依赖。