godump - Go结构体优雅打印库

godump 是一个用于优雅打印Go结构体的第三方库，它能够以更可读的方式格式化输出结构体内容，特别适合调试和日志记录场景。

安装

go get github.com/hexdigest/godump

基本用法

package main

import (
	"fmt"
	"github.com/hexdigest/godump"
)

type User struct {
	ID       int
	Name     string
	Email    string
	IsActive bool
	Roles    []string
}

func main() {
	user := User{
		ID:       1,
		Name:     "张三",
		Email:    "zhangsan@example.com",
		IsActive: true,
		Roles:    []string{"admin", "user"},
	}

	// 基本打印
	fmt.Println("Default print:")
	fmt.Println(user)

	// 使用godump打印
	fmt.Println("\nGodump print:")
	godump.Dump(user)
}

输出对比：

Default print:
{1 张三 zhangsan@example.com true [admin user]}

Godump print:
(main.User) {
 ID: (int) 1,
 Name: (string) "张三",
 Email: (string) "zhangsan@example.com",
 IsActive: (bool) true,
 Roles: ([]string) (len=2 cap=2) {
  (string) "admin",
  (string) "user"
 }
}

高级特性

1. 自定义配置

func main() {
	config := godump.Config{
		ShowTypes:   true,    // 显示类型信息
		MaxDepth:    3,       // 最大递归深度
		Indent:      "    ",  // 缩进字符串
		FloatFormat: "%.2f",  // 浮点数格式
	}

	user := User{
		ID:       1,
		Name:     "张三",
		Email:    "zhangsan@example.com",
		IsActive: true,
		Roles:    []string{"admin", "user"},
	}

	godump.DumpWithConfig(config, user)
}

2. 格式化字符串

func main() {
	user := User{
		ID:       1,
		Name:     "张三",
		Email:    "zhangsan@example.com",
		IsActive: true,
		Roles:    []string{"admin", "user"},
	}

	// 获取格式化字符串而不直接打印
	formatted := godump.Sdump(user)
	fmt.Println("Formatted string:")
	fmt.Println(formatted)
}

3. 嵌套结构体处理

type Address struct {
	City    string
	Country string
}

type DetailedUser struct {
	UserInfo User
	HomeAddr Address
	WorkAddr *Address
}

func main() {
	addr := Address{City: "北京", Country: "中国"}
	user := DetailedUser{
		UserInfo: User{
			ID:       1,
			Name:     "李四",
			Email:    "lisi@example.com",
			IsActive: true,
		},
		HomeAddr: addr,
		WorkAddr: &addr,
	}

	godump.Dump(user)
}

实际应用示例

package main

import (
	"encoding/json"
	"github.com/hexdigest/godump"
	"log"
	"net/http"
)

type APIResponse struct {
	Status  int         `json:"status"`
	Data    interface{} `json:"data"`
	Message string      `json:"message"`
}

type Product struct {
	ID          int      `json:"id"`
	Name        string   `json:"name"`
	Price       float64  `json:"price"`
	Tags        []string `json:"tags"`
	IsAvailable bool     `json:"is_available"`
}

func main() {
	// 模拟API响应
	product := Product{
		ID:          1001,
		Name:        "Go语言编程",
		Price:       99.9,
		Tags:        []string{"编程", "Go", "计算机"},
		IsAvailable: true,
	}

	response := APIResponse{
		Status:  http.StatusOK,
		Data:    product,
		Message: "success",
	}

	// 调试打印
	log.Println("API Response:")
	godump.Dump(response)

	// 转换为JSON
	jsonData, err := json.MarshalIndent(response, "", "  ")
	if err != nil {
		log.Fatal(err)
	}

	log.Println("JSON Output:")
	log.Println(string(jsonData))
}

性能考虑

虽然godump提供了友好的输出格式，但在生产环境中频繁调用可能会影响性能。建议：

1. 仅在开发调试时使用
2. 对性能敏感的场景使用条件编译

// +build debug

package main

import "github.com/hexdigest/godump"

func debugDump(v interface{}) {
	godump.Dump(v)
}

// +build !debug

package main

func debugDump(v interface{}) {
	// 空实现，生产环境不执行任何操作
}

替代方案

如果godump不满足需求，也可以考虑以下替代方案：

• spew: https://github.com/davecgh/go-spew
• pretty: https://github.com/kr/pretty
• go-spew: https://github.com/davecgh/go-spew

godump以其简洁的API和清晰的输出格式，成为许多Go开发者在调试时的首选工具。合理使用可以大大提高开发效率。