Stringer: Go 语言的字符串生成工具——Golang stringer 命令行工具详解

文章目录 

• 使用 Stringer 接口自定义类型的字符串表示

  • 自定义字符串表示的优势
  • 可能存在的问题

• 使用 stringer 命令行工具自动生成 String() 方法 方法")

  • 安装 stringer 命令行工具
  • stringer 工具用法示例
  • go:generate：简化 stringer 的使用
• 总结

本文将介绍 Golang 中的 stringer 工具，它可以帮助你自动生成 String() 方法，从而使代码更易于维护和理解。我们将从 Stringer 接口的基本用法入手，展示如何自定义类型的字符串表示，然后介绍 stringer 命令行工具，包括安装、使用方法和一些高级技巧。

使用 Stringer 接口自定义类型的字符串表示

在 Golang 开发中，我们经常需要将代码中的标识符，例如枚举常量，转换成易于理解的字符串形式。例如，你可能有一个表示状态码的整数类型，但你希望在日志或者用户界面上显示更友好的文本，例如 “Status OK” 而不是 “200”。

这时，fmt 包提供了一个名为 Stringer 的通用接口，它可以帮助我们自定义类型的字符串表示。许多包都会用到它，该接口只有一个 String() 方法。任何需要字符串形式标识符的包通常会寻找此接口的实现。

type Stringer interface {
    String() string
}

因此，在打印任何标识符时，你可以通过为其定义一个 String() 方法来控制实际打印的内容。

自定义字符串表示的优势

假设你有一个名为 StatusCode 的整数类型和一些该类型的常量。如果使用 Println（来自 fmt 或 log）打印这些常量，你将看到打印的是状态码（200, 500 等）。

type StatusCode int

const (
    statusOK              StatusCode = 200
    statusInternalServerErr StatusCode = 500
)

func main() {
    fmt.Println(statusOK)
    fmt.Println(statusInternalServerErr)
    // Output:
    // 200
    // 500
}

但如果你想看到这些状态码的字符串表示，你可以通过简单地为 StatusCode 定义一个 String() 方法来实现 Stringer 接口。现在，Println 将打印 String() 函数返回的任何内容。

type StatusCode int

func (c StatusCode) String() string {
    switch c {
    case 200:
        return "Status OK"
    case 500:
        return "Internal server error"
    default:
        return "Unknown status"
    }
}

const (
    statusOK              StatusCode = 200
    statusInternalServerErr StatusCode = 500
)

func main() {
    fmt.Println(statusOK)
    fmt.Println(statusInternalServerErr)
    // Output:
    // Status OK
    // Internal server error
}

Stringer 在以下用例中非常有用：

1. 遥测/日志记录：代码中的标识符（尤其是数字和结构体）很难在日志语句和指标标签中表示。数字可以直接使用，但对于那些对代码上下文了解较少或没有上下文的人来说，可能难以理解。String() 方法可以帮助你为日志/指标标签中的这些标识符定义一个合理的表示形式。
2. 用户侧：类似地，代码可能处理某些与用户看到或输入的值不同的值。Stringer 接口在这方面也能提供帮助。

可能存在的问题

手动维护 String() 方法中的 switch case 语句非常繁琐。你创建的每个常量都需要一个 case。如果你忘记添加一个，可能会导致不一致的行为。

使用 stringer 命令行工具自动生成 String() 方法

为了解决手动维护 String() 方法可能存在的问题，Go 的标准工具链提供了 stringer 命令行工具，它可以自动生成这些 String() 方法。默认情况下，常量名称将用作字符串值，但也提供了一些标志来控制它。

阅读全文：Stringer: Go 语言的字符串生成工具 - 阿小信的博客