分享一个用于打印复杂数据结构的库 gop

[ysmood]

项目地址 https://github.com/ysmood/got/tree/master/lib/gop

目的是把复杂的结构体打印成易于阅读的格式。输出的格式使用的 Go 原生语法，不需要学习任何额外的知识就可以阅读输出。不像其他库可能需要考猜测输出格式。

特性

• 使用原生 Go 语法输出
• 支持循环引用（比如 go-spew 的这个 bug, 而 gop 可以正常打印）
• 更好的 rune, []byte, time 等数据的可读性
• 字符串里的隐藏字符也会被打印
• 可配置的高亮打印
• 根据排序后的 key 输出一致的 map
• 自动将多行大段文字打印成多行以便于阅读
• 可扩展的 API

用法

通常你只需要用 gop.P 函数:

package main

import (
    "time"

    "github.com/ysmood/got/lib/gop"
)

func main() {
    val := map[string]interface{}{
        "bool":   true,
        "number": 1 + 1i,
        "bytes":  []byte{97, 98, 99},
        "lines":  "multiline string\nline two",
        "slice":  []interface{}{1, 2},
        "time":   time.Now(),
        "struct": struct{ test int32 }{
            test: 13,
        },
    }
    val["slice"].([]interface{})[1] = val["slice"]

    gop.P(val)
}

输出:

[tairan2006]

支持打印指针成员么？感觉平时%+v 最大的问题就是无法输出指针成员…要自己写 Stringer

[ysmood]

@tairan2006 支持

[eudore]

造过一个差不多的轮子，支持：godoc 链接跳转 层次路径访问 json/text/html 三种数据格式 html 显示对象折叠 设置显示私有和最大层数

[ysmood]

@eudore html 的问题主要是 CI 的 log 里 debug 比较麻烦。

[FlyingDough]

已 star

[rekulas]

cool

[Redamancy]

已 star

[guanhui07]

我在用的 是这个 https://github.com/gookit/goutil#examples-1

[ysmood]

@guanhui07 goutil 的 dump 还是比较初级的，比如打印循环引用的数据它直接 crash , 而且打印的数据也过于冗杂，对于字符串里的回车等特殊字符也打印的有歧义，这不但不有助于 debug 反而容易隐藏 bug 。你可以试着用它来打印我示例里的数据就懂了。gop 打印的数据比 dump 少一个数量级。

[knowckx]

哈哈这个我也想过，我有一个实用方案：

func PrintJson(in interface{}) {
res, err := json.MarshalIndent(in, "", "\t")
if err != nil {
fmt.Println("json marshal error", err)
return
}
fmt.Println(string(res))
}

直接借用 json 序列化打印就行~方便快捷

[ysmood]

@knowckx 这样无法打印私有变量，而且你用你这个方法打印我示例里的数据直接会 crash ，试试你就懂了。