go项目zero中自定义sdk的引用与使用规范

在 Go 项目中，`go mod tidy` 命令会自动删除没有直接引用的依赖。如果你的项目中某个 SDK 被引用但是没有在业务代码中直接使用，`go mod tidy` 可能会将其清理掉，因为它被认为是"未使用"的依赖。

如果你希望保留这些依赖（例如某些 SDK），可以采取以下几种方法：

### 1. 显式调用 SDK 中的功能

确保你的代码中至少有一个地方使用了该 SDK 中的某个功能或方法。即使只是调用它的初始化函数或一些简单的接口，也能让 Go 判断该依赖是被使用的，避免它在执行 `go mod tidy` 时被清理掉。

go mod tidy

例如：```go

package main

import (
    "fmt"
    "example.com/some-sdk"
)

func main() {
    // 触发 SDK 的初始化或调用其功能
    sdk.Init()  // 这行代码可以确保 SDK 不会被清理掉
    fmt.Println("SDK Initialized!")
}

```

### 2. 使用 Go 语言的 `//go:build` 标记
如果你希望某些代码仅在特定条件下编译（例如在某些构建标签下才使用该 SDK），你可以使用 `//go:build` 标记，确保 SDK 在特定条件下被引用。```go

//go:build sdk_needed

package main

import (
    "fmt"
    "example.com/some-sdk"
)

func main() {
    sdk.Init()
    fmt.Println("SDK Initialized!")
}

```

然后在执行 `go build` 时，指定 `-tags` 来包含该构建标签：

```bash

go build -tags sdk_needed

```

### 3. 使用 `replace` 来强制保留依赖
在 `go.mod` 文件中，你可以通过 `replace` 指令强制 Go 保留某些依赖。例如：```go

module your-module-name

go 1.18

require (
    example.com/some-sdk v1.0.0
)

replace example.com/some-sdk => example.com/some-sdk v1.0.0

```

虽然这种方法不常见，但它可以确保 Go 保留该依赖，即使它在代码中没有被直接使用。

### 4. 临时保留 SDK
如果你暂时不想执行 `go mod tidy` 干预该 SDK 的依赖，可以通过以下方法手动避免清理它：

1. 在业务代码中，至少保留一个对该 SDK 的引用。
2. 在 `go.mod` 中手动锁定版本，确保该依赖不会被清理。

### 5. 手动编辑 go.mod
作为一种最后的手段，虽然不推荐，但你可以直接在 `go.mod` 文件中保留某个依赖，防止它被自动清理。确保该依赖在 `require` 部分存在，并且版本被锁定。

### 总结
- 确保 SDK 在业务代码中被直接引用，这样 `go mod tidy` 就不会清理它。
- 使用 `//go:build` 或构建标签，确保 SDK 只有在特定场景下才会被清理。
- 如果 SDK 没有直接使用，可以手动通过 `replace` 强制 Go 保留该依赖。

这些方法可以帮助你避免 SDK 被 `go mod tidy` 清理掉，同时又保持项目的整洁性。