Golang 现代化 Shell 交互式命令行 UI 开发 - readline 库使用指南

在 Go 中开发交互式命令行应用时，readline 是一个功能强大的库，它提供了类似 Bash 的行编辑功能、历史记录、自动补全等特性。下面我将详细介绍如何使用这个库来构建现代化的命令行界面。

readline 库简介

readline 库是 Go 中一个流行的命令行交互库，主要特点包括：

• 行编辑功能（移动光标、删除字符等）
• 历史记录管理
• 自动补全支持
• 自定义提示符
• 支持彩色输出

安装

go get github.com/chzyer/readline

基础用法

package main

import (
	"fmt"
	"strings"
	
	"github.com/chzyer/readline"
)

func main() {
	// 创建 readline 实例
	rl, err := readline.New("> ")
	if err != nil {
		panic(err)
	}
	defer rl.Close()

	for {
		// 读取用户输入
		line, err := rl.Readline()
		if err != nil { // io.EOF 或其他错误
			break
		}

		line = strings.TrimSpace(line)
		if line == "" {
			continue
		}

		// 处理命令
		switch line {
		case "exit", "quit":
			fmt.Println("Bye!")
			return
		default:
			fmt.Printf("You typed: %q\n", line)
		}
	}
}

高级功能实现

1. 添加历史记录功能

func main() {
	// 配置 readline
	rl, err := readline.NewEx(&readline.Config{
		Prompt:          "> ",
		HistoryFile:     "/tmp/readline-history.tmp", // 历史记录文件
		HistoryLimit:    1000,                        // 历史记录最大条数
		AutoComplete:    completer,                   // 自动补全器
		InterruptPrompt: "^C",                        // Ctrl+C 提示
		EOFPrompt:       "exit",                      // EOF 提示
	})
	if err != nil {
		panic(err)
	}
	defer rl.Close()

	// 使用方式与之前相同
}

2. 实现自动补全

var completer = readline.NewPrefixCompleter(
	readline.PcItem("mode",
		readline.PcItem("vi"),
		readline.PcItem("emacs"),
	),
	readline.PcItem("login"),
	readline.PcItem("say",
		readline.PcItem("hello"),
		readline.PcItem("world"),
	),
	readline.PcItem("set"),
	readline.PcItem("exit"),
	readline.PcItem("quit"),
	readline.PcItem("help"),
)

3. 自定义提示符（带颜色）

func dynamicPrompt() string {
	return fmt.Sprintf("\033[31m> \033[32m%s\033[0m ", time.Now().Format("15:04:05"))
}

func main() {
	rl, err := readline.NewEx(&readline.Config{
		Prompt:          dynamicPrompt(),
		HistoryFile:     "/tmp/readline-history.tmp",
		AutoComplete:    completer,
		InterruptPrompt: "^C",
		EOFPrompt:       "exit",
		// 启用动态提示
		FuncFilterInputRune: func(r rune) (rune, bool) {
			if r == readline.CharCtrlZ {
				return r, false
			}
			return r, true
		},
	})
	if err != nil {
		panic(err)
	}
	defer rl.Close()

	// 每行输入后更新提示
	rl.Config.Listener = &readline.DefaultListener{}
	
	// 使用方式与之前相同
}

4. 密码输入（隐藏输入）

func passwordInput(prompt string) (string, error) {
	rl, err := readline.NewEx(&readline.Config{
		Prompt:          prompt,
		EnableMask:      true,
		MaskRune:       '*',
		HistoryLimit:   -1, // 不记录历史
	})
	if err != nil {
		return "", err
	}
	defer rl.Close()
	
	line, err := rl.Readline()
	if err != nil {
		return "", err
	}
	return strings.TrimSpace(line), nil
}

实际应用示例

下面是一个更完整的示例，模拟一个简单的 shell：

package main

import (
	"fmt"
	"strings"
	"time"

	"github.com/chzyer/readline"
)

var completer = readline.NewPrefixCompleter(
	readline.PcItem("help"),
	readline.PcItem("time"),
	readline.PcItem("echo"),
	readline.PcItem("exit"),
)

func main() {
	rl, err := readline.NewEx(&readline.Config{
		Prompt:          "\033[31m»\033[0m ",
		HistoryFile:     "/tmp/readline-demo.tmp",
		AutoComplete:    completer,
		InterruptPrompt: "^C",
		EOFPrompt:       "exit",
	})
	if err != nil {
		panic(err)
	}
	defer rl.Close()

	fmt.Println("Simple Shell v0.1")
	fmt.Println("Type 'help' for more information")

	for {
		line, err := rl.Readline()
		if err != nil { // io.EOF, readline.ErrInterrupt
			break
		}

		line = strings.TrimSpace(line)
		switch line {
		case "":
			continue
		case "help":
			fmt.Println("Available commands:")
			fmt.Println("  help - show this help")
			fmt.Println("  time - show current time")
			fmt.Println("  echo - echo back the input")
			fmt.Println("  exit - exit the program")
		case "time":
			fmt.Println(time.Now().Format("2006-01-02 15:04:05"))
		case "echo":
			fmt.Println("You said: " + line)
		case "exit":
			fmt.Println("Goodbye!")
			return
		default:
			fmt.Println("Unknown command:", line)
		}
	}
}

最佳实践

1. 错误处理：始终检查 readline 初始化错误
2. 资源清理：使用 defer 关闭 readline 实例
3. 历史记录：合理设置历史记录大小和存储位置
4. 性能考虑：对于频繁更新的提示，考虑性能影响
5. 跨平台：测试在不同终端下的表现

readline 库为 Go 命令行应用提供了强大的交互能力，结合其他库如 termui 或 tview 可以构建更丰富的终端界面。