go-output-format 使用指南

go-output-format 是一个用于 Golang 命令行应用的结构体多格式输出插件库，它允许开发者轻松地将结构体数据以多种格式（如 JSON、YAML、XML、表格等）输出。

安装

go get github.com/golobby/output/v3

基本用法

1. 定义结构体

首先定义一个需要输出的结构体：

type User struct {
    ID       int    `json:"id" yaml:"id" xml:"id"`
    Name     string `json:"name" yaml:"name" xml:"name"`
    Email    string `json:"email" yaml:"email" xml:"email"`
    IsActive bool   `json:"is_active" yaml:"is_active" xml:"is_active"`
}

2. 初始化输出器

import "github.com/golobby/output/v3"

func main() {
    user := User{
        ID:       1,
        Name:     "John Doe",
        Email:    "john@example.com",
        IsActive: true,
    }

    // 创建输出器实例
    out := output.New()
}

3. 不同格式输出

JSON 格式输出

err := out.PrintJSON(user)
if err != nil {
    log.Fatal(err)
}

YAML 格式输出

err := out.PrintYAML(user)
if err != nil {
    log.Fatal(err)
}

XML 格式输出

err := out.PrintXML(user)
if err != nil {
    log.Fatal(err)
}

表格格式输出

err := out.PrintTable(user)
if err != nil {
    log.Fatal(err)
}

4. 根据用户输入动态选择格式

func printUser(user User, format string) error {
    out := output.New()
    
    switch format {
    case "json":
        return out.PrintJSON(user)
    case "yaml":
        return out.PrintYAML(user)
    case "xml":
        return out.PrintXML(user)
    case "table":
        return out.PrintTable(user)
    default:
        return fmt.Errorf("unsupported format: %s", format)
    }
}

高级用法

自定义表格输出

err := out.PrintTable(user, output.TableConfig{
    Title:       "User Information",
    Border:      true,
    BorderStyle: output.BorderStyleSingle,
    Columns: []output.TableColumn{
        {Header: "ID", Field: "ID"},
        {Header: "Full Name", Field: "Name"},
        {Header: "Email Address", Field: "Email"},
        {Header: "Status", Field: "IsActive", Formatter: func(val interface{}) string {
            if val.(bool) {
                return "Active"
            }
            return "Inactive"
        }},
    },
})

输出到文件

file, err := os.Create("output.json")
if err != nil {
    log.Fatal(err)
}
defer file.Close()

err = out.FprintJSON(file, user)
if err != nil {
    log.Fatal(err)
}

输出切片数据

users := []User{
    {ID: 1, Name: "John Doe", Email: "john@example.com", IsActive: true},
    {ID: 2, Name: "Jane Smith", Email: "jane@example.com", IsActive: false},
}

err := out.PrintTable(users)
if err != nil {
    log.Fatal(err)
}

与 Cobra 集成示例

如果你使用 Cobra 构建 CLI 应用，可以这样集成：

var format string

var cmd = &cobra.Command{
    Use:   "show-user",
    Short: "Display user information",
    Run: func(cmd *cobra.Command, args []string) {
        user := getUser() // 获取用户数据
        
        out := output.New()
        var err error
        
        switch format {
        case "json":
            err = out.PrintJSON(user)
        case "yaml":
            err = out.PrintYAML(user)
        case "xml":
            err = out.PrintXML(user)
        case "table":
            err = out.PrintTable(user)
        default:
            err = fmt.Errorf("unsupported format: %s", format)
        }
        
        if err != nil {
            log.Fatal(err)
        }
    },
}

func init() {
    cmd.Flags().StringVarP(&format, "format", "f", "table", "Output format (json, yaml, xml, table)")
}

总结

go-output-format 提供了简单易用的 API 来格式化输出结构体数据，主要特点包括：

1. 支持多种输出格式：JSON、YAML、XML、表格
2. 易于与现有 CLI 应用集成
3. 提供表格输出的自定义选项
4. 支持输出到文件或标准输出
5. 良好的错误处理

这个库特别适合需要提供多种输出格式选择的命令行工具，让用户可以自由选择最适合他们需求的格式。