go-isatty 库的使用指南

go-isatty 是一个用于检测 Golang 程序是否运行在终端(TTY)环境中的轻量级库。它可以帮助开发者判断标准输入/输出/错误是否连接到终端设备，从而决定是否启用彩色输出、交互式功能等。

基本用法

首先安装 go-isatty 库：

go get github.com/mattn/go-isatty

检查标准流是否连接到终端

package main

import (
	"fmt"
	"github.com/mattn/go-isatty"
	"os"
)

func main() {
	if isatty.IsTerminal(os.Stdout.Fd()) {
		fmt.Println("标准输出是终端")
	} else {
		fmt.Println("标准输出不是终端(可能是重定向到文件)")
	}

	if isatty.IsCygwinTerminal(os.Stdout.Fd()) {
		fmt.Println("标准输出是Cygwin终端")
	}

	if isatty.IsTerminal(os.Stdin.Fd()) {
		fmt.Println("标准输入是终端")
	}

	if isatty.IsTerminal(os.Stderr.Fd()) {
		fmt.Println("标准错误是终端")
	}
}

彩色输出示例

package main

import (
	"fmt"
	"github.com/mattn/go-isatty"
	"os"
)

const (
	colorRed   = "\033[31m"
	colorGreen = "\033[32m"
	colorReset = "\033[0m"
)

func main() {
	message := "Hello, World!"
	
	if isatty.IsTerminal(os.Stdout.Fd()) {
		// 如果是终端，输出彩色文本
		fmt.Println(colorRed + "红色文本" + colorReset)
		fmt.Println(colorGreen + message + colorReset)
	} else {
		// 如果不是终端(如重定向到文件)，输出普通文本
		fmt.Println(message)
	}
}

高级用法

检查文件描述符

package main

import (
	"fmt"
	"github.com/mattn/go-isatty"
	"os"
)

func main() {
	file, err := os.Open("/dev/tty")
	if err != nil {
		fmt.Println("无法打开终端设备:", err)
		return
	}
	defer file.Close()

	if isatty.IsTerminal(file.Fd()) {
		fmt.Println("这是一个终端设备")
	} else {
		fmt.Println("这不是一个终端设备")
	}
}

跨平台兼容性

go-isatty 在不同平台上有不同的实现，但提供了统一的接口：

package main

import (
	"fmt"
	"github.com/mattn/go-isatty"
	"os"
	"runtime"
)

func main() {
	fmt.Println("当前操作系统:", runtime.GOOS)
	
	if isatty.IsTerminal(os.Stdout.Fd()) {
		fmt.Println("终端检测通过")
	} else {
		fmt.Println("终端检测未通过")
	}
}

实际应用场景

1. 日志输出控制

package main

import (
	"github.com/mattn/go-isatty"
	"log"
	"os"
)

func initLogger() {
	if isatty.IsTerminal(os.Stderr.Fd()) {
		// 终端环境，使用带颜色的日志
		log.SetFlags(log.LstdFlags | log.Lshortfile)
	} else {
		// 非终端环境，使用简单日志格式
		log.SetFlags(log.LstdFlags)
	}
}

func main() {
	initLogger()
	log.Println("这是一条日志消息")
}

2. 进度条显示控制

package main

import (
	"fmt"
	"github.com/mattn/go-isatty"
	"os"
	"time"
)

func showProgress(progress int) {
	if isatty.IsTerminal(os.Stdout.Fd()) {
		// 终端环境，显示动态进度条
		fmt.Printf("\r进度: [%-50s] %d%%", string(make([]rune, progress/2)), progress)
	} else {
		// 非终端环境，只打印进度
		fmt.Printf("进度: %d%%\n", progress)
	}
}

func main() {
	for i := 0; i <= 100; i += 10 {
		showProgress(i)
		time.Sleep(300 * time.Millisecond)
	}
	fmt.Println() // 换行
}

注意事项

1. 在 Windows 上，go-isatty 可以正确检测 cmd.exe 和 PowerShell 等终端
2. 对于 Cygwin 和 MSYS2 等环境，需要使用 IsCygwinTerminal() 方法
3. 文件描述符检查后不应该关闭，否则可能导致不可预知的行为
4. 在容器环境中，终端检测可能会有所不同

go-isatty 是一个简单但非常实用的库，特别适合需要根据终端环境调整输出行为的命令行工具开发。