Go語言中用 os/exec 執行命令的五種姿勢

歲月崢嶸走過發表於2022-01-05
Go

Go語言中用 os/exec 執行命令的五種姿勢

完整系列教程詳見：http://golang.iswbm.com

在 Golang 中用於執行命令的庫是 os/exec，exec.Command 函式返回一個 Cmd 物件，根據不同的需求，可以將命令的執行分為三種情況

  1. 只執行命令，不獲取結果
  2. 執行命令，並獲取結果（不區分 stdout 和 stderr）
  3. 執行命令，並獲取結果（區分 stdout 和 stderr）

第一種：只執行命令，不獲取結果#

直接呼叫 Cmd 物件的 Run 函式，返回的只有成功和失敗，獲取不到任何輸出的結果。


package main

import (
    "log"
    "os/exec"
)

func main() {
    cmd := exec.Command("ls", "-l", "/var/log/")
    err := cmd.Run()
    if err != nil {
        log.Fatalf("cmd.Run() failed with %s\n", err)
    }
}

第二種：執行命令，並獲取結果#

有時候我們執行一個命令就是想要獲取輸出結果，此時你可以呼叫 Cmd 的 CombinedOutput 函式。


package main

import (
"fmt"
"log"
"os/exec"
)

func main() {
    cmd := exec.Command("ls", "-l", "/var/log/")
    out, err := cmd.CombinedOutput()
    if err != nil {
        fmt.Printf("combined out:\n%s\n", string(out))
        log.Fatalf("cmd.Run() failed with %s\n", err)
    }
    fmt.Printf("combined out:\n%s\n", string(out))
}

CombinedOutput 函式，只返回 out，並不區分 stdout 和 stderr。如果你想區分他們，可以直接看第三種方法。


$ go run demo.go 
combined out:
total 11540876
-rw-r--r--  2 root       root         4096 Oct 29  2018 yum.log
drwx------  2 root       root           94 Nov  6 05:56 audit
-rw-r--r--  1 root       root    185249234 Nov 28  2019 message
-rw-r--r--  2 root       root        16374 Aug 28 10:13 boot.log

不過在那之前，我卻發現一個小問題：有時候，shell 命令能執行，並不程式碼 exec 也能執行。

比如我只想檢視 /var/log/ 目錄下的 log 字尾名的檔案呢？有點 Linux 基礎的同學，都會用這個命令


$ ls -l /var/log/*.log
total 11540
-rw-r--r--  2 root       root         4096 Oct 29  2018 /var/log/yum.log
-rw-r--r--  2 root       root        16374 Aug 28 10:13 /var/log/boot.log

按照這個寫法將它放入到 exec.Command


package main

import (
"fmt"
"log"
"os/exec"
)

func main() {
    cmd := exec.Command("ls", "-l", "/var/log/*.log")
    out, err := cmd.CombinedOutput()
    if err != nil {
        fmt.Printf("combined out:\n%s\n", string(out))
        log.Fatalf("cmd.Run() failed with %s\n", err)
    }
    fmt.Printf("combined out:\n%s\n", string(out))
}

什麼情況？居然不行，報錯了。


$ go run demo.go 
combined out:
ls: cannot access /var/log/*.log: No such file or directory

2020/11/11 19:46:00 cmd.Run() failed with exit status 2
exit status 1

為什麼會報錯呢？shell 明明沒有問題啊

其實很簡單，原來 ls -l /var/log/*.log 並不等價於下面這段程式碼。


exec.Command("ls", "-l", "/var/log/*.log")

上面這段程式碼對應的 Shell 命令應該是下面這樣，如果你這樣子寫，ls 就會把引數裡的內容當成具體的檔名，而忽略萬用字元 *


$ ls -l "/var/log/*.log"
ls: cannot access /var/log/*.log: No such file or directory

第三種：執行命令，並區分stdout 和 stderr#

上面的寫法，無法實現區分標準輸出和標準錯誤，只要換成下面種寫法，就可以實現。


package main

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

func main() {
    cmd := exec.Command("ls", "-l", "/var/log/*.log")
    var stdout, stderr bytes.Buffer
    cmd.Stdout = &stdout  // 標準輸出
    cmd.Stderr = &stderr  // 標準錯誤
    err := cmd.Run()
    outStr, errStr := string(stdout.Bytes()), string(stderr.Bytes())
    fmt.Printf("out:\n%s\nerr:\n%s\n", outStr, errStr)
    if err != nil {
        log.Fatalf("cmd.Run() failed with %s\n", err)
    }
}

輸出如下，可以看到前面的報錯內容被歸入到標準錯誤裡


$ go run demo.go 
out:

err:
ls: cannot access /var/log/*.log: No such file or directory

2020/11/11 19:59:31 cmd.Run() failed with exit status 2
exit status 1

第四種：多條命令組合，請使用管道#

將上一條命令的執行輸出結果，做為下一條命令的引數。在 Shell 中可以使用管道符 | 來實現。

比如下面這條命令，統計了 message 日誌中 ERROR 日誌的數量。


$ grep ERROR /var/log/messages | wc -l
19

類似的，在 Golang 中也有類似的實現。


package main
import (
    "os"
    "os/exec"
)
func main() {
    c1 := exec.Command("grep", "ERROR", "/var/log/messages")
    c2 := exec.Command("wc", "-l")
    c2.Stdin, _ = c1.StdoutPipe()
    c2.Stdout = os.Stdout
    _ = c2.Start()
    _ = c1.Run()
    _ = c2.Wait()
}

輸出如下


$ go run demo.go 
19

第五種：設定命令級別的環境變數#

使用 os 庫的 Setenv 函式來設定的環境變數，是作用於整個程式的生命週期的。


package main
import (
    "fmt"
    "log"
    "os"
    "os/exec"
)
func main() {
    os.Setenv("NAME", "wangbm")
    cmd := exec.Command("echo", os.ExpandEnv("$NAME"))
    out, err := cmd.CombinedOutput()
    if err != nil {
        log.Fatalf("cmd.Run() failed with %s\n", err)
    }
    fmt.Printf("%s", out)
}

只要在這個程式裡，NAME 這個變數的值都會是 wangbm，無論你執行多少次命令


$ go run demo.go 
wangbm

如果想把環境變數的作用範圍再縮小到命令級別，也是有辦法的。

為了方便驗證，我新建個 sh 指令碼，內容如下


$ cat /home/wangbm/demo.sh
echo $NAME
$ bash /home/wangbm/demo.sh   # 由於全域性環境變數中沒有 NAME，所以無輸出

另外，demo.go 裡的程式碼如下

package main
import (
    "fmt"
    "os"
    "os/exec"
)


func ChangeYourCmdEnvironment(cmd * exec.Cmd) error {
    env := os.Environ()
    cmdEnv := []string{}

    for _, e := range env {
        cmdEnv = append(cmdEnv, e)
    }
    cmdEnv = append(cmdEnv, "NAME=wangbm")
    cmd.Env = cmdEnv

    return nil
}

func main() {
    cmd1 := exec.Command("bash", "/home/wangbm/demo.sh")
  ChangeYourCmdEnvironment(cmd1) // 新增環境變數到 cmd1 命令: NAME=wangbm
    out1, _ := cmd1.CombinedOutput()
    fmt.Printf("output: %s", out1)

    cmd2 := exec.Command("bash", "/home/wangbm/demo.sh")
    out2, _ := cmd2.CombinedOutput()
    fmt.Printf("output: %s", out2)
}

執行後，可以看到第二次執行的命令，是沒有輸出 NAME 的變數值。

 go run demo.go 
output: wangbm
output:

相關文章