Go语言中将常量值转换为其名称字符串的实践指南-Golang-PHP中文网

Go语言中将常量值转换为其名称字符串的实践指南

本文探讨了在go语言中如何将整数常量值转换为其对应的字符串名称，特别是在处理如`crypto/tls`包中的密码套件（ciphersuite）等场景。通过定义自定义类型并实现`string()`方法，可以实现值的字符串表示。此外，文章还介绍了go 1.4及更高版本中`stringer`工具的使用，以自动化生成此类转换代码，从而提高开发效率和代码可维护性。

在Go语言开发中，我们经常会遇到需要将数值型常量（例如uint16、int等）转换为其对应的可读性更高的字符串名称的场景。这对于日志记录、用户界面显示或调试都至关重要。以crypto/tls包为例，TLS握手成功后，我们可以通过ConnectionState().Ciphersuite获取当前连接使用的密码套件。然而，这个值是一个uint16类型，例如0x000a，它代表TLS_RSA_WITH_3DES_EDE_CBC_SHA。直接显示数字值不利于理解，我们更希望能够直接获取到其常量名称字符串。

手动实现 String() 方法进行常量名称转换

Go语言提供了一种优雅的方式来解决这个问题：为自定义类型实现fmt.Stringer接口，即定义一个String() string方法。当一个类型实现了这个接口后，fmt包中的打印函数（如fmt.Print, fmt.Println, fmt.Printf的%s格式符）会自动调用该方法来获取对象的字符串表示。

以下是针对crypto/tls密码套件的具体实现步骤：

定义自定义类型： 首先，我们需要为常量定义一个底层类型相同的自定义类型。这样做的好处是我们可以为这个自定义类型绑定方法，而不会影响到原始包中的常量定义。
```
type Ciphersuite uint16
```
登录后复制

重新声明常量： 接下来，将crypto/tls包中我们关心的密码套件常量重新声明为我们自定义的Ciphersuite类型。这使得这些常量成为我们自定义类型的值，从而可以使用我们为其定义的方法。

import "crypto/tls"

const (
    TLS_RSA_WITH_RC4_128_SHA            = Ciphersuite(tls.TLS_RSA_WITH_RC4_128_SHA)
    TLS_RSA_WITH_3DES_EDE_CBC_SHA       = Ciphersuite(tls.TLS_3DES_EDE_CBC_SHA) // 修正：tls.TLS_RSA_WITH_3DES_EDE_CBC_SHA
    TLS_RSA_WITH_AES_128_CBC_SHA        = Ciphersuite(tls.TLS_RSA_WITH_AES_128_CBC_SHA)
    TLS_RSA_WITH_AES_256_CBC_SHA        = Ciphersuite(tls.TLS_RSA_WITH_AES_256_CBC_SHA)
    TLS_ECDHE_RSA_WITH_RC4_128_SHA      = Ciphersuite(tls.TLS_ECDHE_RSA_WITH_RC4_128_SHA)
    TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA = Ciphersuite(tls.TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA)
    TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA  = Ciphersuite(tls.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA)
    TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA  = Ciphersuite(tls.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA)
)

登录后复制

注意： 上述代码中TLS_RSA_WITH_3DES_EDE_CBC_SHA的赋值应为Ciphersuite(tls.TLS_RSA_WITH_3DES_EDE_CBC_SHA)。

立即学习“go语言免费学习笔记（深入）”；

实现 String() 方法： 为Ciphersuite类型实现String()方法。在这个方法中，我们使用switch语句根据Ciphersuite的值返回其对应的字符串名称。

func (cs Ciphersuite) String() string {
    switch cs {
    case TLS_RSA_WITH_RC4_128_SHA:
        return "TLS_RSA_WITH_RC4_128_SHA"
    case TLS_RSA_WITH_3DES_EDE_CBC_SHA:
        return "TLS_RSA_WITH_3DES_EDE_CBC_SHA"
    case TLS_RSA_WITH_AES_128_CBC_SHA:
        return "TLS_RSA_WITH_AES_128_CBC_SHA"
    case TLS_RSA_WITH_AES_256_CBC_SHA:
        return "TLS_RSA_WITH_AES_256_CBC_SHA"
    case TLS_ECDHE_RSA_WITH_RC4_128_SHA:
        return "TLS_ECDHE_RSA_WITH_RC4_128_SHA"
    case TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA:
        return "TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA"
    case TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA:
        return "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"
    case TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA:
        return "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA"
    default:
        return fmt.Sprintf("Unknown Ciphersuite (0x%04x)", uint16(cs)) // 处理未知值
    }
}

登录后复制

在default分支中处理未知值是一种良好的实践，可以提供更好的错误信息或调试便利。

使用示例： 一旦String()方法实现完成，就可以像使用普通字符串一样使用Ciphersuite类型的值了。

package main

import (
    "fmt"
    "crypto/tls" // 引入tls包以获取原始常量
)

// 定义自定义类型
type Ciphersuite uint16

// 重新声明常量，映射到tls包的常量值
const (
    TLS_RSA_WITH_RC4_128_SHA            = Ciphersuite(tls.TLS_RSA_WITH_RC4_128_SHA)
    TLS_RSA_WITH_3DES_EDE_CBC_SHA       = Ciphersuite(tls.TLS_RSA_WITH_3DES_EDE_CBC_SHA)
    TLS_RSA_WITH_AES_128_CBC_SHA        = Ciphersuite(tls.TLS_RSA_WITH_AES_128_CBC_SHA)
    TLS_RSA_WITH_AES_256_CBC_SHA        = Ciphersuite(tls.TLS_RSA_WITH_AES_256_CBC_SHA)
    TLS_ECDHE_RSA_WITH_RC4_128_SHA      = Ciphersuite(tls.TLS_ECDHE_RSA_WITH_RC4_128_SHA)
    TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA = Ciphersuite(tls.TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA)
    TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA  = Ciphersuite(tls.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA)
    TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA  = Ciphersuite(tls.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA)
)

// 实现String()方法
func (cs Ciphersuite) String() string {
    switch cs {
    case TLS_RSA_WITH_RC4_128_SHA:
        return "TLS_RSA_WITH_RC4_128_SHA"
    case TLS_RSA_WITH_3DES_EDE_CBC_SHA:
        return "TLS_RSA_WITH_3DES_EDE_CBC_SHA"
    case TLS_RSA_WITH_AES_128_CBC_SHA:
        return "TLS_RSA_WITH_AES_128_CBC_SHA"
    case TLS_RSA_WITH_AES_256_CBC_SHA:
        return "TLS_RSA_WITH_AES_256_CBC_SHA"
    case TLS_ECDHE_RSA_WITH_RC4_128_SHA:
        return "TLS_ECDHE_RSA_WITH_RC4_128_SHA"
    case TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA:
        return "TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA"
    case TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA:
        return "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"
    case TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA:
        return "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA"
    default:
        return fmt.Sprintf("Unknown Ciphersuite (0x%04x)", uint16(cs))
    }
}

func main() {
    // 假设我们从tls连接中获取到一个密码套件值
    // 这里为了演示，直接使用定义的常量
    cipherValueFromTLS := tls.TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA

    // 将其转换为我们的自定义类型
    cs := Ciphersuite(cipherValueFromTLS)
    fmt.Printf("原始值: 0x%04x, 转换后的名称: %s\n", uint16(cs), cs)

    cs = TLS_RSA_WITH_RC4_128_SHA
    fmt.Printf("原始值: 0x%04x, 转换后的名称: %s\n", uint16(cs), cs)

    cs = TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
    fmt.Printf("原始值: 0x%04x, 转换后的名称: %s\n", uint16(cs), cs)

    // 演示未知值
    unknownCipher := Ciphersuite(0xFFFF)
    fmt.Printf("原始值: 0x%04x, 转换后的名称: %s\n", uint16(unknownCipher), unknownCipher)
}

登录后复制

运行上述代码将输出常量值及其对应的字符串名称，包括对未知值的处理。

使用 stringer 工具自动化生成 String() 方法

手动为大量常量编写switch语句是繁琐且容易出错的。Go语言生态系统提供了一个强大的工具stringer（golang.org/x/tools/cmd/stringer），可以自动为自定义的整数常量类型生成String()方法。stringer在Go 1.4及更高版本中可用，极大地简化了这一过程。

NameGPT名称生成器

免费AI公司名称生成器，AI在线生成企业名称，注册公司名称起名大全。

查看详情

stringer 的工作原理：stringer通过分析源代码中定义了常量集合的自定义类型，并根据这些常量的名称和值自动生成一个String()方法。它通常与go generate命令结合使用。

使用步骤：

安装 stringer： 如果尚未安装，可以通过以下命令安装stringer工具：
```
go install golang.org/x/tools/cmd/stringer@latest
```
登录后复制

定义需要生成 String() 方法的类型和常量： 在你的Go源文件中，像往常一样定义自定义类型和常量。例如：

// ciphersuite.go
package main

import "crypto/tls"

//go:generate stringer -type=Ciphersuite
type Ciphersuite uint16

const (
    TLS_RSA_WITH_RC4_128_SHA            Ciphersuite = Ciphersuite(tls.TLS_RSA_WITH_RC4_128_SHA)
    TLS_RSA_WITH_3DES_EDE_CBC_SHA       Ciphersuite = Ciphersuite(tls.TLS_RSA_WITH_3DES_EDE_CBC_SHA)
    TLS_RSA_WITH_AES_128_CBC_SHA        Ciphersuite = Ciphersuite(tls.TLS_RSA_WITH_AES_128_CBC_SHA)
    TLS_RSA_WITH_AES_256_CBC_SHA        Ciphersuite = Ciphersuite(tls.TLS_RSA_WITH_AES_256_CBC_SHA)
    TLS_ECDHE_RSA_WITH_RC4_128_SHA      Ciphersuite = Ciphersuite(tls.TLS_ECDHE_RSA_WITH_RC4_128_SHA)
    TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA Ciphersuite = Ciphersuite(tls.TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA)
    TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA  Ciphersuite = Ciphersuite(tls.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA)
    TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA  Ciphersuite = Ciphersuite(tls.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA)
)

登录后复制

注意： //go:generate stringer -type=Ciphersuite 是一个特殊的注释，它告诉go generate命令在执行时运行stringer工具，并指定要处理的类型是Ciphersuite。

运行 go generate： 在包含上述文件的目录下运行go generate命令：
```
go generate
```
登录后复制
stringer工具将会在当前目录下生成一个名为ciphersuite_string.go（或[文件名]_string.go）的新文件，其中包含了Ciphersuite类型的String()方法实现。

使用生成的代码： 生成的_string.go文件会自动成为包的一部分，你就可以像手动实现一样直接使用Ciphersuite类型的值，并享受其自动转换的便利。

// main.go (与ciphersuite.go在同一个包中)
package main

import (
    "fmt"
    "crypto/tls"
)

func main() {
    cipherValueFromTLS := tls.TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
    cs := Ciphersuite(cipherValueFromTLS)
    fmt.Printf("原始值: 0x%04x, 转换后的名称: %s\n", uint16(cs), cs)

    cs = TLS_RSA_WITH_RC4_128_SHA
    fmt.Printf("原始值: 0x%04x, 转换后的名称: %s\n", uint16(cs), cs)
}

登录后复制

这种方式的优势在于，当常量列表发生变化时，只需修改常量定义并重新运行go generate，String()方法就会自动更新，大大减少了维护成本。

注意事项与总结

错误处理： 无论手动实现还是使用stringer，都应考虑如何处理传入的未知常量值。手动实现时可以在switch的default分支中返回一个描述性的字符串；stringer默认会返回TypeName(Value)的格式，例如Ciphersuite(65535)。
可维护性： 对于常量数量较少且不常变动的情况，手动实现String()方法是可行的。但对于常量数量庞大或经常需要增删改的情况，强烈推荐使用stringer工具，它能有效避免因手动修改而引入的错误。
接口满足： 实现了String() string方法的类型会自动满足fmt.Stringer接口。Go语言的fmt包在打印时会检查对象是否实现了这个接口，如果实现了，就会调用它来获取字符串表示。
通用性： 这种将数值常量转换为字符串名称的模式不仅适用于crypto/tls包，也适用于Go语言中任何需要将枚举值转换为可读字符串的场景。

通过上述方法，无论是手动编写还是利用stringer工具，我们都能够高效且优雅地在Go语言中实现常量值到其名称字符串的转换，从而提升代码的可读性和可维护性。

以上就是Go语言中将常量值转换为其名称字符串的实践指南的详细内容，更多请关注php中文网其它相关文章！