Golang命令行交互库Liner使用指南

Liner是一个轻量级的Go库，用于创建具有readline功能的命令行交互界面。它提供了行编辑、历史记录、自动补全等功能，非常适合构建交互式命令行工具。

安装Liner

go get github.com/peterh/liner

基础使用示例

package main

import (
	"fmt"
	"log"
	"strings"
	
	"github.com/peterh/liner"
)

func main() {
	line := liner.NewLiner()
	defer line.Close()

	line.SetCtrlCAborts(true) // 允许Ctrl+C终止程序

	// 设置自动补全函数
	line.SetCompleter(func(line string) (c []string) {
		commands := []string{"help", "exit", "show", "list", "add"}
		for _, cmd := range commands {
			if strings.HasPrefix(cmd, strings.ToLower(line)) {
				c = append(c, cmd)
			}
		}
		return
	})

	// 加载历史记录
	if f, err := liner.NewHistoryFromFile("history.txt"); err == nil {
		line.ReadHistory(f)
	}

	for {
		// 读取用户输入
		if input, err := line.Prompt("> "); err == nil {
			input = strings.TrimSpace(input)
			if input == "" {
				continue
			}
			
			// 添加到历史记录
			line.AppendHistory(input)
			
			// 处理命令
			switch input {
			case "exit":
				return
			case "help":
				fmt.Println("Available commands: help, exit, show, list, add")
			default:
				fmt.Printf("You entered: %q\n", input)
			}
		} else if err == liner.ErrPromptAborted {
			fmt.Println("Aborted")
			break
		} else {
			log.Print("Error reading line: ", err)
			break
		}
	}

	// 保存历史记录
	if f, err := liner.NewHistoryFile("history.txt", 0644); err == nil {
		line.WriteHistory(f)
		f.Close()
	} else {
		log.Print("Error writing history file: ", err)
	}
}

主要功能特性

1. 行编辑功能

Liner提供了类似readline的行编辑功能：

• 左右箭头移动光标
• Home/End键跳转到行首/行尾
• Backspace/Delete删除字符
• Ctrl+U删除整行
• Ctrl+K删除光标到行尾

2. 历史记录

// 添加历史记录
line.AppendHistory("command")

// 保存历史记录到文件
if f, err := liner.NewHistoryFile("history.txt", 0644); err == nil {
    line.WriteHistory(f)
    f.Close()
}

// 从文件加载历史记录
if f, err := liner.NewHistoryFromFile("history.txt"); err == nil {
    line.ReadHistory(f)
}

3. 自动补全

line.SetCompleter(func(line string) (c []string) {
    // 返回匹配的补全选项
    if strings.HasPrefix("hello", strings.ToLower(line)) {
        c = append(c, "hello")
    }
    if strings.HasPrefix("world", strings.ToLower(line)) {
        c = append(c, "world")
    }
    return
})

4. 密码输入

password, err := line.PasswordPrompt("Enter password: ")
if err != nil {
    log.Fatal(err)
}
fmt.Printf("Your password is %d characters long\n", len(password))

5. 多行模式

line.SetMultiLineMode(true) // 启用多行模式
input, err := line.Prompt("multiline> ")

高级配置

// 自定义Tab键行为
line.SetTabCompletionStyle(liner.TabPrints)

// 设置最大历史记录数
line.SetHistoryLimit(1000)

// 自定义Ctrl+C行为
line.SetCtrlCAborts(true)

// 设置自定义提示符
prompt := func() string {
    return fmt.Sprintf("[%s] > ", time.Now().Format("15:04:05"))
}
input, err := line.PromptWithSuggestion(prompt(), "default", -1)

实际应用示例 - 简单的数据库CLI

package main

import (
	"fmt"
	"log"
	"strings"
	
	"github.com/peterh/liner"
)

type Database struct {
	data map[string]string
}

func NewDatabase() *Database {
	return &Database{
		data: make(map[string]string),
	}
}

func (db *Database) Set(key, value string) {
	db.data[key] = value
}

func (db *Database) Get(key string) (string, bool) {
	val, ok := db.data[key]
	return val, ok
}

func (db *Database) Delete(key string) {
	delete(db.data, key)
}

func (db *Database) Keys() []string {
	keys := make([]string, 0, len(db.data))
	for k := range db.data {
		keys = append(keys, k)
	}
	return keys
}

func main() {
	db := NewDatabase()
	line := liner.NewLiner()
	defer line.Close()

	line.SetCompleter(func(line string) (c []string) {
		commands := []string{"set", "get", "delete", "keys", "exit"}
		for _, cmd := range commands {
			if strings.HasPrefix(cmd, strings.ToLower(line)) {
				c = append(c, cmd)
			}
		}
		return
	})

	for {
		input, err := line.Prompt("db> ")
		if err != nil {
			if err == liner.ErrPromptAborted {
				fmt.Println("Bye!")
			} else {
				log.Printf("Error: %v", err)
			}
			break
		}

		input = strings.TrimSpace(input)
		parts := strings.Fields(input)
		if len(parts) == 0 {
			continue
		}

		cmd := strings.ToLower(parts[0])
		switch cmd {
		case "set":
			if len(parts) != 3 {
				fmt.Println("Usage: set <key> <value>")
				continue
			}
			db.Set(parts[1], parts[2])
			fmt.Println("OK")
		case "get":
			if len(parts) != 2 {
				fmt.Println("Usage: get <key>")
				continue
			}
			if val, ok := db.Get(parts[1]); ok {
				fmt.Println(val)
			} else {
				fmt.Println("(nil)")
			}
		case "delete":
			if len(parts) != 2 {
				fmt.Println("Usage: delete <key>")
				continue
			}
			db.Delete(parts[1])
			fmt.Println("OK")
		case "keys":
			keys := db.Keys()
			for _, k := range keys {
				fmt.Println(k)
			}
		case "exit":
			fmt.Println("Bye!")
			return
		default:
			fmt.Println("Unknown command. Available: set, get, delete, keys, exit")
		}

		line.AppendHistory(input)
	}
}

Liner是一个简单但功能强大的库，适合需要基本命令行交互功能的Go应用程序。它轻量级、易于使用，并且提供了足够的功能来构建复杂的CLI工具。