go执行命令并获取命令输出简要示例

背景：

不管使用哪种开发语言，我们在项目中总会面临一些需要再执行一些命令获取信息的场景，java提供了Runtime.getRuntime().exec， go语言也提供类似的功能 exec.Command。 这些执行都可以配置输入，并捕获输出信息。

代码：

代码地址

package main

import (
	"bytes"
	"fmt"
	"os"
	"os/exec"
	"strings"
)

func main() {
	fmt.Println("output to std1, cmd can run normally")
	printToStdNormal()

	fmt.Println("output to std2, cmd can't run normally for the cmd args is not right")
	printToStdError1()

	fmt.Println("output to std3, cmd can't run normally for the cmd dir does not exist")
	printToStdError2()

	fmt.Println("output to std2")
	printToStd2()

	fmt.Println("read from std")
	readFromStd()

	fmt.Println("run with multi args")
	execWithMultiArgs()

	fmt.Println("主函数执行完毕")
}

func printToStdNormal() {
	//设置需要执行的命令
	cmd := exec.Command("ls", "-sh")
	//将命令的输出和错误与标准的os.Stdout关联
	cmd.Stdout = os.Stdout
	cmd.Stderr = os.Stderr

	//设置该命令执行的上下文目录信息
	// 不设置dir时， dir默认值为当前程序启动的位置
	cmd.Dir = "/"

	err := cmd.Run()
	if err != nil {
		fmt.Printf("failed to call cmd.Run(): %v\n", err)
	}
	fmt.Println()
}

func printToStdError1() {
	cmd := exec.Command("ls", "aaaa-sh")
	cmd.Stdout = os.Stdout
	cmd.Stderr = os.Stderr
	cmd.Dir = "/"
	err := cmd.Run()
	if err != nil {
		//错误信息输出该cmd的参数
		fmt.Printf("failed to call cmd.Run() with args:%v,  err:%v\n", cmd.Args, err)
	}
	fmt.Println()
}

func printToStdError2() {
	cmd := exec.Command("ls", "-sh")
	cmd.Stdout = os.Stdout
	cmd.Stderr = os.Stderr
	cmd.Dir = "/not-exist"
	err := cmd.Run()
	if err != nil {
		//错误信息输出该cmd的执行的目录
		fmt.Printf("failed to call cmd.Run() with args:%v,  err:%v\n", cmd.Dir, err)
	}
	fmt.Println()
}

func printToStd2() {
	//Output runs the command and returns its standard output
	arg1 := os.ExpandEnv("${MY_ENV_VAR}")
	// 目前读取动态自定义的环境变量有问题，通过os.ExpandEnv读取os已有的的环境环境变量没问题
	//或者可以先通过os.Setenv("MY_ENV_VAR", "some_value1")， 然后os.ExpandEnv
	cmd := exec.Command("echo", arg1)
	cmd.Env = os.Environ()
	cmd.Env = append(cmd.Env, "MY_ENV_VAR=some_value")

	out, err := cmd.Output()
	if err != nil {
		fmt.Printf("failed to call cmd.Run() with args:%v, err:%v\n", cmd.Dir, err)
		return
	}

	fmt.Printf("cmd '%s' executed in dir '%s' (命令执行的默认目录), env:%s, out:'%s'\n",
		cmd.Args, cmd.Dir, cmd.Env, string(out))
}

func readFromStd() {
	// tr - translate or delete characters
	cmd := exec.Command("tr", "a-z", "A-Z")

	//设置执行命令的input信息
	cmd.Stdin = strings.NewReader("and old falcon")

	var out bytes.Buffer
	cmd.Stdout = &out

	err := cmd.Run()

	if err != nil {
		fmt.Printf("failed to call cmd.Run() with args:%v, err:%v\n", cmd.Args, err)
	}

	fmt.Printf("translated phrase: %q\n\n", out.String())
}
func execWithMultiArgs() {
	prg := "echo"

	arg1 := "there"
	arg2 := "are three"
	arg3 := os.ExpandEnv("${JAVA_HOME}")

	cmd := exec.Command(prg, arg1, arg2, arg3)
	stdout, err := cmd.Output()

	if err != nil {
		fmt.Println(err.Error())
		return
	}

	fmt.Printf("cmd '%s' executed in dir '%s' (命令执行的默认目录), env:%s, out:%s\n",
		cmd.Args, cmd.Dir, cmd.Env, string(stdout))
}

执行效果：

output to std1, cmd can run normally
total 10
 0 AppleInternal         0 Volumes               0 etc                               0 usr
 0 Applications          0 bin                   0 home                           0 var
 0 Library               0 coredata              0 opt                   
 0 System                0 cores                 0 sbin
 0 Users                10 dev                   0 tmp

output to std2, cmd can't run normally for the cmd args is not right
ls: aaaa-sh: No such file or directory （**这一句来自标准错误输出**）
failed to call cmd.Run() with args:[ls aaaa-sh],  err:exit status 1

output to std3, cmd can't run normally for the cmd dir does not exist
failed to call cmd.Run() with args:/not-exist,  err:chdir /not-exist: no such file or directory

output to std2
cmd '[echo ]' executed in dir '' (命 令 执 行 的 默 认 目 录 ), env:[ALACRITTY_WINDOW_ID=0 
...此处省略部分内容
 HOME=/Users/ericyang  USER=ericyang WINDOWID=0 XPC_FLAGS=0x0 XPC_SERVICE_NAME=0 __CFBundleIdentifier=Fleet.app __CF_USER_TEXT_ENCODING=0x1F5:0x19:0x34 _=/usr/local/go/bin/go MY_ENV_VAR=some_value], out:'
'
read from std
translated phrase: "AND OLD FALCON"

run with multi args
cmd '[echo there are three /Users/ericyang/.sdkman/candidates/java/current]' executed in dir '' (命 令 执 行 的 默 认 目 录 ), env:[], out:there are three /Users/ericyang/.sdkman/candidates/java/current

主 函 数 执 行 完 毕