goutil/dump - 列印漂亮易讀的go資料

Inhere發表於2022-02-23

gookit/goutil/dump - 是一個golang資料列印工具包,可以列印出漂亮易讀的go slice, map, struct資料。

主要功能:

  • 使用簡單,直接呼叫 dump.P(vars...) 即可
  • 支援所有的基礎資料型別
  • 支援slice, map, struct資料結構
  • 支援傳入列印多個變數
  • 預設輸出呼叫位置,方便使用
  • 支援自定義部分能力,如 縮排,色彩主題等

效果預覽:

image.png

Git Repo:

列印基礎型別

package main

import "github.com/gookit/goutil/dump"

// rum demo:
//     go run ./dump/_examples/basic_types.go
func main() {
    dump.P(
        nil, true,
        12, int8(12), int16(12), int32(12), int64(12),
        uint(22), uint8(22), uint16(22), uint32(22), uint64(22),
        float32(23.78), float64(56.45),
        'c', byte('d'),
        "string",
    )
}

輸出效果:

image

列印slice

列印 array, slice 都會一行一個元素輸出,同時會在最後輸出長度。

package main

import "github.com/gookit/goutil/dump"

// rum demo:
//     go run ./dump/_examples/slice.go
func main() {
    dump.P(
        []byte("abc"),
        []int{1, 2, 3},
        []string{"ab", "cd"},
        []interface{}{
            "ab",
            234,
            []int{1, 3},
            []string{"ab", "cd"},
        },
    )
}

輸出效果:

image

列印map

列印map資料結構,會一行一個元素輸出,同時會在最後輸出map長度。

package main

import "github.com/gookit/goutil/dump"

// rum demo:
//     go run ./map.go
//     go run ./dump/_examples/map.go
func main() {
    dump.P(
        map[string]interface{}{
            "key0": 123,
            "key1": "value1",
            "key2": []int{1, 2, 3},
            "key3": map[string]string{
                "k0": "v0",
                "k1": "v1",
            },
        },
    )
}

輸出效果:

image

列印struct

列印struct資料,指標型別會自動列印底層真實資料

package main

import (
    "fmt"

    "github.com/gookit/color"
    "github.com/gookit/goutil/dump"
)

// rum demo:
//     go run ./struct.go
//     go run ./dump/_examples/struct.go
func main() {
    s1 := &struct {
        cannotExport map[string]interface{}
    }{
        cannotExport: map[string]interface{}{
            "key1": 12,
            "key2": "abcd123",
        },
    }

    s2 := struct {
        ab string
        Cd int
    }{
        "ab", 23,
    }

    color.Infoln("- Use fmt.Println:")
    fmt.Println(s1, s2)

    color.Infoln("\n- Use dump.Println:")
    dump.P(
        s1,
        s2,
    )
}

輸出效果:

image

自定義dumper

支援自定義dumper一些選項。如 縮排,色彩主題等

// Options for dump vars
type Options struct {
    // Output the output writer
    Output io.Writer
    // NoType dont show data type TODO
    NoType bool
    // NoColor don't with color
    NoColor bool
    // IndentLen width. default is 2
    IndentLen int
    // IndentChar default is one space
    IndentChar byte
    // MaxDepth for nested print
    MaxDepth int
    // ShowFlag for display caller position
    ShowFlag int
    // MoreLenNL array/slice elements length > MoreLenNL, will wrap new line
    // MoreLenNL int
    // CallerSkip skip for call runtime.Caller()
    CallerSkip int
    // ColorTheme for print result.
    ColorTheme Theme
}

Git Repo

本作品採用《CC 協議》,轉載必須註明作者和本文連結

相關文章