golang优雅打印任意变量数据的插件库godump的使用

godump 是一个多功能的 Go 库，旨在以结构化和彩色格式输出任何 Go 变量。当标准 fmt 库在有效显示任意数据方面不足时，这个库特别适用于调试和测试。它也可以作为一个强大的日志记录适配器，为开发和生产环境提供清晰可读的日志。

为什么选择 godump

• 能够漂亮地打印所有类型的值
• 格式良好的输出
• 也会转储未导出的结构体字段
• 跟踪指针，并考虑递归指针
• 可定制，您可以完全控制输出，甚至可以生成 HTML
• 零依赖

快速开始

安装库：

go get -u github.com/yassinebenaid/godump

然后使用 Dump 函数：

package main

import (
	"github.com/yassinebenaid/godump"
)

func main() {
	godump.Dump("Anything")
}

自定义

如果您需要更多控制输出，可以使用 Dumper：

package main

import (
	"os"

	"github.com/yassinebenaid/godump"
)

func main() {
	var v = "Foo Bar"
	var d = godump.Dumper{
		Indentation:       "  ",
		HidePrivateFields: false,
		ShowPrimitiveNamedTypes: false,
		Theme: godump.Theme{
			String: godump.RGB{R: 138, G: 201, B: 38},
			// ...
		},
	}

	d.Print(v)
	d.Println(v)
	d.Fprint(os.Stdout, v)
	d.Fprintln(os.Stdout, v)
	d.Sprint(v)
	d.Sprintln(v)
}

示例

示例 1

package main

import (
	"os"

	"github.com/yassinebenaid/godump"
)

func main() {
	godump.Dump(os.Stdout)
}

输出:

示例 2

package main

import (
	"net"

	"github.com/yassinebenaid/godump"
)

func main() {
	godump.Dump(net.Dialer{})
}

输出:

示例 3

这个例子展示了如何处理递归指针。

package main

import (
	"github.com/yassinebenaid/godump"
)

func main() {
	type User struct {
		Name       string
		age        int
		BestFriend *User
	}

	me := User{
		Name: "yassinebenaid",
		age:  22,
	}

	// 创建一个循环引用
	me.BestFriend = &me

	godump.Dump(me)
}

输出:

示例 4

这个例子强调如何生成HTML。

package main

import (
	"fmt"
	"net"
	"net/http"

	"github.com/yassinebenaid/godump"
)

// 定义自定义样式实现
type CSSColor struct {
	R, G, B int
}

func (c CSSColor) Apply(s string) string {
	return fmt.Sprintf(`<div style="color: rgb(%d, %d, %d); display: inline-block">%s</div>`, c.R, c.G, c.B, s)
}

func main() {
	var d godump.Dumper

	d.Theme = godump.Theme{
		String:        CSSColor{138, 201, 38}, // 编辑主题以使用您的实现
		Quotes:        CSSColor{112, 214, 255},
		Bool:          CSSColor{249, 87, 56},
		Number:        CSSColor{10, 178, 242},
		Types:         CSSColor{0, 150, 199},
		Address:       CSSColor{205, 93, 0},
		PointerTag:    CSSColor{110, 110, 110},
		Nil:           CSSColor{219, 57, 26},
		Func:          CSSColor{160, 90, 220},
		Fields:        CSSColor{189, 176, 194},
		Chan:          CSSColor{195, 154, 76},
		UnsafePointer: CSSColor{89, 193, 180},
		Braces:        CSSColor{185, 86, 86},
	}

	html := `<pre style="background: #111; padding: 10px; color: white">`
	html += d.Sprint(net.Dialer{})
	html += "</pre>"

	// 渲染到浏览器
	http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
		w.Header().Set("Content-Type", "text/html")
		fmt.Fprint(w, html)
	})

	http.ListenAndServe(":8000", nil)
}

输出:

更多示例，请查看 dumper_test 和 testdata 目录。