Golang跨平台执行Shell命令插件库cmd的使用

在Go语言中，执行Shell命令是一个常见的需求，特别是在需要与操作系统交互的场景下。Go标准库提供了os/exec包来处理命令执行，但有时我们需要更高级的功能或更简洁的API。github.com/go-cmd/cmd是一个流行的第三方库，提供了跨平台的命令执行功能，并具有一些有用的特性。

cmd库的主要特点

1. 跨平台支持：在Windows、Linux和macOS上都能正常工作
2. 实时输出处理：可以实时获取命令的标准输出和错误输出
3. 状态监控：可以查询命令的执行状态
4. 超时控制：支持设置命令执行的超时时间
5. 简单易用：API设计简洁明了

安装cmd库

go get github.com/go-cmd/cmd

基本用法示例

简单命令执行

package main

import (
	"fmt"
	"time"
	
	"github.com/go-cmd/cmd"
)

func main() {
	// 创建一个新的Cmd，指定要执行的命令和参数
	cmdOptions := cmd.Options{
		Buffered:  false, // 非缓冲模式，实时获取输出
		Streaming: true,  // 启用流式输出
	}
	
	// 在Linux/macOS上执行ls命令
	// 在Windows上可以改为"cmd /c dir"
	command := cmd.NewCmdOptions(cmdOptions, "ls", "-l")
	
	// 启动命令
	statusChan := command.Start()
	
	// 等待命令完成并打印输出
	go func() {
		for {
			select {
			case <-statusChan:
				// 命令已完成
				return
			default:
				// 获取当前状态
				status := command.Status()
				// 打印标准输出
				for _, line := range status.Stdout {
					fmt.Println(line)
				}
				// 打印错误输出
				for _, line := range status.Stderr {
					fmt.Println("Error:", line)
				}
				time.Sleep(100 * time.Millisecond)
			}
		}
	}()
	
	// 等待命令完成
	finalStatus := <-statusChan
	fmt.Printf("命令执行完成，退出码: %d\n", finalStatus.Exit)
}

带缓冲的命令执行

package main

import (
	"fmt"
	
	"github.com/go-cmd/cmd"
)

func main() {
	// 使用缓冲模式执行命令
	cmdOptions := cmd.Options{
		Buffered:  true,  // 缓冲模式，命令完成后一次性获取输出
		Streaming: false, // 禁用流式输出
	}
	
	command := cmd.NewCmdOptions(cmdOptions, "echo", "Hello, World!")
	
	// 启动并等待命令完成
	status := <-command.Start()
	
	// 打印输出
	fmt.Println("输出:")
	for _, line := range status.Stdout {
		fmt.Println(line)
	}
	
	fmt.Printf("退出码: %d\n", status.Exit)
}

带超时的命令执行

package main

import (
	"context"
	"fmt"
	"time"
	
	"github.com/go-cmd/cmd"
)

func main() {
	// 创建一个带超时的context
	ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
	defer cancel()
	
	command := cmd.NewCmd("sleep", "5") // 这个命令会执行5秒
	
	// 启动命令
	statusChan := command.Start()
	
	select {
	case <-ctx.Done():
		// 超时发生，停止命令
		err := command.Stop()
		if err != nil {
			fmt.Println("停止命令时出错:", err)
		} else {
			fmt.Println("命令因超时被停止")
		}
	case status := <-statusChan:
		// 命令正常完成
		fmt.Printf("命令完成，退出码: %d\n", status.Exit)
	}
}

高级用法

环境变量设置

package main

import (
	"fmt"
	
	"github.com/go-cmd/cmd"
)

func main() {
	// 创建命令并设置环境变量
	command := cmd.NewCmd("printenv", "MY_VAR")
	
	// 设置环境变量
	command.Env = append(command.Env, "MY_VAR=Hello from env")
	
	// 执行命令
	status := <-command.Start()
	
	fmt.Println("输出:")
	for _, line := range status.Stdout {
		fmt.Println(line)
	}
}

工作目录设置

package main

import (
	"fmt"
	"os"
	"path/filepath"
	
	"github.com/go-cmd/cmd"
)

func main() {
	// 获取当前工作目录
	wd, err := os.Getwd()
	if err != nil {
		fmt.Println("获取工作目录失败:", err)
		return
	}
	
	// 创建命令并设置工作目录
	command := cmd.NewCmd("pwd")
	command.Dir = filepath.Join(wd, "..") // 设置为上级目录
	
	// 执行命令
	status := <-command.Start()
	
	fmt.Println("当前工作目录:")
	for _, line := range status.Stdout {
		fmt.Println(line)
	}
}

注意事项

1. 在Windows上执行命令时，可能需要使用cmd /c作为前缀
2. 对于长时间运行的命令，建议使用流式输出模式以避免内存问题
3. 命令执行可能会因为权限问题而失败，需要适当处理错误
4. 在并发环境下使用时，需要注意命令状态的同步访问

github.com/go-cmd/cmd库提供了比标准库os/exec更简洁的API和更多有用的功能，特别适合需要实时处理命令输出或需要更精细控制命令执行的场景。