如何在Golang中打印首列固定宽度的自适应双列表格？

问题说明 #

需要实现双列打印功能，要求：

• 首列固定宽度，用于展示键名
• 第二列展示超长字符串时自动适配终端宽度换行，且换行后的内容对齐到首列右侧（首列位置留空）

期望输出 #

Key1                                  Value1Value1Value1Value1
Key2                                  Value2Value2Value2Value2Value2Value2Value2Value2Value2Value2Value2
                                      Value2Value2Value2Value2Value2Value2Value2Value2Value2Value2Value2
                                      Value2Value2Value2Value2Value2Value2

当前实现问题 #

使用lipgloss实现首列固定宽度后，超长字符串换行直接顶格，未对齐首列：

func PrintMetadata(metadata map[string]string, color string) {
    style := lipgloss.NewStyle().Width(32).Foreground(lipgloss.Color(color))
    for k, v := range metadata {
        fmt.Println(style.Render(k) + v)
    }
}

实际输出：

Key1                                  Value1Value1Value1Value1
Key2                                  Value2Value2Value2Value2Value2Value2Value2Value2Value2Value2Value2
Value2Value2Value2Value2Value2Value2Value2Value2Value2Value2Value2Value2Value2Value2Value2Value2Value2

解决方案 #

方案一：标准库+终端宽度适配 #

通过手动计算终端宽度、分割文本并填充空白实现对齐，无需额外UI库依赖。

import (
    "fmt"
    "os"
    "strings"

    "golang.org/x/term"
)

func PrintMetadata(metadata map[string]string, color string) {
    const keyColWidth = 32
    // 获取终端宽度，失败时默认80列
    termWidth, _, err := term.GetSize(int(os.Stdout.Fd()))
    if err != nil {
        termWidth = 80
    }
    valueColWidth := termWidth - keyColWidth
    if valueColWidth <= 0 {
        valueColWidth = 40 // 设置保底宽度避免负数
    }

    // 颜色处理：简单映射常用ANSI颜色码
    colorCode := ""
    resetCode := "\033[0m"
    colorMap := map[string]string{
        "red":   "\033[31m",
        "blue":  "\033[34m",
        "green": "\033[32m",
    }
    if c, ok := colorMap[color]; ok {
        colorCode = c
    }

    for k, v := range metadata {
        // 格式化带颜色的固定宽度键
        formattedKey := fmt.Sprintf("%s%-*s%s", colorCode, keyColWidth, k, resetCode)
        // 将值分割为指定宽度的多行
        valueLines := splitStringToWidth(v, valueColWidth)
        
        // 打印首行
        if len(valueLines) > 0 {
            fmt.Println(formattedKey + valueLines[0])
            // 打印后续行：填充首列宽度的空白
            for _, line := range valueLines[1:] {
                fmt.Printf("%*s%s\n", keyColWidth, "", line)
            }
        } else {
            fmt.Println(formattedKey)
        }
    }
}

// splitStringToWidth 将字符串按指定宽度分割，优先在空格处截断避免拆分单词
func splitStringToWidth(s string, width int) []string {
    var lines []string
    s = strings.TrimSpace(s)
    for len(s) > width {
        // 找到最后一个空格位置
        splitIdx := strings.LastIndex(s[:width], " ")
        if splitIdx == -1 {
            splitIdx = width // 无空格则强制截断
        }
        lines = append(lines, s[:splitIdx])
        s = strings.TrimSpace(s[splitIdx:])
    }
    if s != "" {
        lines = append(lines, s)
    }
    return lines
}

方案二：结合lipgloss库实现 #

利用lipgloss的样式系统处理宽度和换行，代码更简洁：

import (
    "fmt"
    "os"
    "strings"

    "github.com/charmbracelet/lipgloss"
    "golang.org/x/term"
)

func PrintMetadata(metadata map[string]string, color string) {
    const keyColWidth = 32
    // 获取终端宽度
    termWidth, _, err := term.GetSize(int(os.Stdout.Fd()))
    if err != nil {
        termWidth = 80
    }
    valueColWidth := termWidth - keyColWidth
    if valueColWidth <= 0 {
        valueColWidth = 40
    }

    // 定义首列样式：固定宽度+指定颜色
    keyStyle := lipgloss.NewStyle().
        Width(keyColWidth).
        Foreground(lipgloss.Color(color))
    
    // 定义第二列样式：自适应剩余宽度，自动换行
    valueStyle := lipgloss.NewStyle().
        Width(valueColWidth).
        MaxWidth(valueColWidth)

    for k, v := range metadata {
        // 渲染值为多行文本
        renderedValue := valueStyle.Render(v)
        valueLines := strings.Split(renderedValue, "\n")
        
        // 打印首行：键+第一行值
        if len(valueLines) > 0 {
            fmt.Println(keyStyle.Render(k) + valueLines[0])
            // 生成固定宽度的空白用于后续行对齐
            blankLine := keyStyle.Render("")
            for _, line := range valueLines[1:] {
                fmt.Println(blankLine + line)
            }
        } else {
            fmt.Println(keyStyle.Render(k))
        }
    }
}

核心要点 #

1. 终端宽度获取：使用golang.org/x/term库获取当前终端窗口宽度，确保第二列适配实际显示空间
2. 文本换行处理：无论是手动分割还是依赖lipgloss的样式换行，都要保证每行不超过第二列可用宽度
3. 对齐逻辑：后续行通过填充首列宽度的空白，实现与首行值的对齐效果

内容的提问来源于stack exchange，提问作者Baratz96