Go os/exec使用方式實(shí)踐
os/exec 是 Go 提供的內(nèi)置包，可以用來(lái)執(zhí)行外部命令或程序。比如，我們的主機(jī)上安裝了 redis-server 二進(jìn)制文件，那么就可以使用 os/exec 在 Go 程序中啟動(dòng) redis-server 提供服務(wù)。當(dāng)然，我們也可以使用 os/exec 執(zhí)行 ls、pwd 等操作系統(tǒng)內(nèi)置命令。本文不求內(nèi)容多么深入，旨在帶大家極速入門(mén) os/exec 的常規(guī)使用。
os/exec 包結(jié)構(gòu)體與方法
func LookPath(file string) (string, error)
type Cmd
func Command(name string, arg ...string) *Cmd
func CommandContext(ctx context.Context, name string, arg ...string) *Cmd
func (c *Cmd) CombinedOutput() ([]byte, error)
func (c *Cmd) Environ() []string
func (c *Cmd) Output() ([]byte, error)
func (c *Cmd) Run() error
func (c *Cmd) Start() error
func (c *Cmd) StderrPipe() (io.ReadCloser, error)
func (c *Cmd) StdinPipe() (io.WriteCloser, error)
func (c *Cmd) StdoutPipe() (io.ReadCloser, error)
func (c *Cmd) String() string
func (c *Cmd) Wait() errorCmd 結(jié)構(gòu)體表示一個(gè)準(zhǔn)備或正在執(zhí)行的外部命令。
- 調(diào)用函數(shù)
Command或CommandContext可以構(gòu)造一個(gè)*Cmd對(duì)象。 - 調(diào)用
Run、Start、Output、CombinedOutput方法可以運(yùn)行*Cmd對(duì)象所代表的命令。 - 調(diào)用
Environ方法可以獲取命令執(zhí)行時(shí)的環(huán)境變量。 - 調(diào)用
StdinPipe、StdoutPipe、StderrPipe方法用于獲取管道對(duì)象。 - 調(diào)用
Wait方法可以阻塞等待命令執(zhí)行完成。 - 調(diào)用
String方法返回命令的字符串形式。LookPath函數(shù)用于搜索可執(zhí)行文件。
使用方法
package main
import (
"log"
"os/exec"
)
func main() {
// 創(chuàng)建一個(gè)命令
cmd := exec.Command("echo", "Hello, World!")
// 執(zhí)行命令并等待命令完成
err := cmd.Run() // 執(zhí)行后控制臺(tái)不會(huì)有任何輸出
if err != nil {
log.Fatalf("Command failed: %v", err)
}
}exec.Command函數(shù)用于創(chuàng)建一個(gè)命令，函數(shù)第一個(gè)參數(shù)是命令的名稱(chēng)，后面跟一個(gè)不定常參數(shù)作為這個(gè)命令的參數(shù)，最終會(huì)傳遞給這個(gè)命令。*Cmd.Run方法會(huì)阻塞等待命令執(zhí)行完成，默認(rèn)情況下命令執(zhí)行后控制臺(tái)不會(huì)有任何輸出：
# 執(zhí)行程序 $ go run main.go # 執(zhí)行完成后沒(méi)有任何輸出
可以在后臺(tái)運(yùn)行一個(gè)命令：
func main() {
cmd := exec.Command("sleep", "3")
// 執(zhí)行命令（非阻塞，不會(huì)等待命令執(zhí)行完成）
if err := cmd.Start(); err != nil {
log.Fatalf("Command start failed: %v", err)
return
}
fmt.Println("Command running in the background...")
// 阻塞等待命令完成
if err := cmd.Wait(); err != nil {
log.Fatalf("Command wait failed: %v", err)
return
}
log.Println("Command finished")
}
實(shí)際上 Run 方法就等于 Start + Wait 方法，如下是 Run 方法源碼的實(shí)現(xiàn)：
func (c *Cmd) Run() error {
if err := c.Start(); err != nil {
return err
}
return c.Wait()
}創(chuàng)建帶有 context 的命令
os/exec 還提供了一個(gè) exec.CommandContext 構(gòu)造函數(shù)可以創(chuàng)建一個(gè)帶有 context 的命令。那么我們就可以利用 context 的特性來(lái)控制命令的執(zhí)行了。
func main() {
ctx, cancel := context.WithTimeout(context.Background(), 100*time.Millisecond)
defer cancel()
cmd := exec.CommandContext(ctx, "sleep", "5")
if err := cmd.Run(); err != nil {
log.Fatalf("Command failed: %v\n", err) // signal: killed
}
}
執(zhí)行示例代碼，得到輸出如下：
$ go run main.go 2025/01/14 23:54:20 Command failed: signal: killed exit status 1
當(dāng)命令執(zhí)行超時(shí)會(huì)收到 killed 信號(hào)自動(dòng)取消。
獲取命令的輸出
無(wú)論是調(diào)用 *Cmd.Run 還是 *Cmd.Start 方法，默認(rèn)情況下執(zhí)行命令后控制臺(tái)不會(huì)得到任何輸出。
可以使用 *Cmd.Output 方法來(lái)執(zhí)行命令，以此來(lái)獲取命令的標(biāo)準(zhǔn)輸出：
func main() {
// 創(chuàng)建一個(gè)命令
cmd := exec.Command("echo", "Hello, World!")
// 執(zhí)行命令，并獲取命令的輸出，Output 內(nèi)部會(huì)調(diào)用 Run 方法
output, err := cmd.Output()
if err != nil {
log.Fatalf("Command failed: %v", err)
}
fmt.Println(string(output)) // Hello, World!
}
執(zhí)行示例代碼，得到輸出如下：
$ go run main.go Hello, World!
獲取組合的標(biāo)準(zhǔn)輸出和錯(cuò)誤輸出
*Cmd.CombinedOutput 方法能夠在運(yùn)行命令后，返回其組合的標(biāo)準(zhǔn)輸出和標(biāo)準(zhǔn)錯(cuò)誤輸出：
func main() {
// 使用一個(gè)命令，既產(chǎn)生標(biāo)準(zhǔn)輸出，也產(chǎn)生標(biāo)準(zhǔn)錯(cuò)誤輸出
cmd := exec.Command("sh", "-c", "echo 'This is stdout'; echo 'This is stderr' >&2")
// 獲取 標(biāo)準(zhǔn)輸出 + 標(biāo)準(zhǔn)錯(cuò)誤輸出 組合內(nèi)容
output, err := cmd.CombinedOutput()
if err != nil {
log.Fatalf("Command execution failed: %v", err)
}
// 打印組合輸出
fmt.Printf("Combined Output:\n%s", string(output))
}
執(zhí)行示例代碼，得到輸出如下：
$ go run main.go Combined Output: This is stdout This is stderr
設(shè)置標(biāo)準(zhǔn)輸出和錯(cuò)誤輸出
可以利用 *Cmd 對(duì)象的 Stdout 和 Stderr 屬性，重定向標(biāo)準(zhǔn)輸出和標(biāo)準(zhǔn)錯(cuò)誤輸出到當(dāng)前進(jìn)程：
func main() {
cmd := exec.Command("ls", "-l")
// 設(shè)置標(biāo)準(zhǔn)輸出和標(biāo)準(zhǔn)錯(cuò)誤輸出到當(dāng)前進(jìn)程，執(zhí)行后可以在控制臺(tái)看到命令執(zhí)行的輸出
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
if err := cmd.Run(); err != nil {
log.Fatalf("Command failed: %v", err)
}
}
這樣，使用 *Cmd.Run 執(zhí)行命令后控制臺(tái)就能看到命令執(zhí)行的輸出了。
執(zhí)行示例代碼，得到輸出如下：
$ go run main.go total 4824 -rw-r--r-- 1 jianghushinian staff 12 Jan 4 10:37 demo.log drwxr-xr-x 3 jianghushinian staff 96 Jan 13 09:41 examples -rwxr-xr-x 1 jianghushinian staff 2453778 Jan 1 15:09 main -rw-r--r-- 1 jianghushinian staff 6179 Jan 15 09:13 main.go
使用標(biāo)準(zhǔn)輸入傳遞數(shù)據(jù)
可以使用 grep 命令接收 stdin 的數(shù)據(jù)，然后在其中搜索包含指定模式的文本行：
func main() {
cmd := exec.Command("grep", "hello")
// 通過(guò)標(biāo)準(zhǔn)輸入傳遞數(shù)據(jù)給命令
cmd.Stdin = bytes.NewBufferString("hello world!\nhi there\n")
// 獲取標(biāo)準(zhǔn)輸出
output, err := cmd.Output()
if err != nil {
log.Fatalf("Command failed: %v", err)
return
}
fmt.Println(string(output)) // hello world!
}可以將一個(gè) io.Reader 對(duì)象賦值給 *Cmd.Stdin 屬性，來(lái)實(shí)現(xiàn)將數(shù)據(jù)通過(guò) stdin 傳遞給外部命令。
執(zhí)行示例代碼，得到輸出如下：
$ go run main.go hello world!
還可以將打開(kāi)的文件描述符傳給 *Cmd.Stdin 屬性：
func main() {
file, err := os.Open("demo.log") // 打開(kāi)一個(gè)文件
if err != nil {
log.Fatalf("Open file failed: %v\n", err)
return
}
defer file.Close()
cmd := exec.Command("cat")
cmd.Stdin = file // 將文件作為 cat 的標(biāo)準(zhǔn)輸入
cmd.Stdout = os.Stdout // 獲取標(biāo)準(zhǔn)輸出
if err := cmd.Run(); err != nil {
log.Fatalf("Command failed: %v", err)
}
}
只要是 io.Reader 對(duì)象即可。
設(shè)置和使用環(huán)境變量
*Cmd 的 Environ 方法可以獲取環(huán)境變量，Env 屬性則可以設(shè)置環(huán)境變量：
func main() {
cmd := exec.Command("printenv", "ENV_VAR")
log.Printf("ENV: %+v\n", cmd.Environ())
// 設(shè)置環(huán)境變量
cmd.Env = append(cmd.Environ(), "ENV_VAR=HelloWorld")
log.Printf("ENV: %+v\n", cmd.Environ())
// 獲取輸出
output, err := cmd.Output()
if err != nil {
log.Fatalf("Command failed: %v", err)
}
fmt.Println(string(output)) // HelloWorld
}
這段代碼輸出結(jié)果與執(zhí)行環(huán)境相關(guān)，此處不演示執(zhí)行結(jié)果了，你可以自行嘗試。
不過(guò)最終的 output 輸出結(jié)果一定是 HelloWorld。
使用管道
os/exec 支持管道功能，*Cmd 對(duì)象提供的 StdinPipe、StdoutPipe、StderrPipe 三個(gè)方法用于獲取管道對(duì)象。故名思義，三者分別對(duì)應(yīng)標(biāo)準(zhǔn)輸入、標(biāo)準(zhǔn)輸出、標(biāo)準(zhǔn)錯(cuò)誤輸出的管道對(duì)象。
使用示例如下：
func main() {
// 命令中使用了管道
cmdEcho := exec.Command("echo", "hello world\nhi there")
outPipe, err := cmdEcho.StdoutPipe()
if err != nil {
log.Fatalf("Command failed: %v", err)
}
// 注意，這里不能使用 Run 方法阻塞等待，應(yīng)該使用非阻塞的 Start 方法
if err := cmdEcho.Start(); err != nil {
log.Fatalf("Command failed: %v", err)
}
cmdGrep := exec.Command("grep", "hello")
cmdGrep.Stdin = outPipe
output, err := cmdGrep.Output()
if err != nil {
log.Fatalf("Command failed: %v", err)
}
fmt.Println(string(output)) // hello world
}首先創(chuàng)建一個(gè)用于執(zhí)行 echo 命令的 *Cmd 對(duì)象 cmdEcho，并調(diào)用它的 StdoutPipe 方法獲得標(biāo)準(zhǔn)輸出管道對(duì)象 outPipe；
然后調(diào)用 Start 方法非阻塞的方式執(zhí)行 echo 命令；
接著創(chuàng)建一個(gè)用于執(zhí)行 grep 命令的 *Cmd 對(duì)象 cmdGrep，將 cmdEcho 的標(biāo)準(zhǔn)輸出管道對(duì)象賦值給 cmdGrep.Stdin 作為標(biāo)準(zhǔn)輸入，這樣，兩個(gè)命令就通過(guò)管道串聯(lián)起來(lái)了；
最終通過(guò) cmdGrep.Output 方法拿到 cmdGrep 命令的標(biāo)準(zhǔn)輸出。
執(zhí)行示例代碼，得到輸出如下：
$ go run main.go hello world
使用bash -c執(zhí)行復(fù)雜命令
如果你不想使用 os/exec 提供的管道功能，那么在命令中直接使用管道符 |，也可以實(shí)現(xiàn)同樣功能。
不過(guò)此時(shí)就需要使用 sh -c 或者 bash -c 等 Shell 命令來(lái)解析執(zhí)行更復(fù)雜的命令了：
func main() {
// 命令中使用了管道
cmd := exec.Command("bash", "-c", "echo 'hello world\nhi there' | grep hello")
output, err := cmd.Output()
if err != nil {
log.Fatalf("Command failed: %v", err)
}
fmt.Println(string(output)) // hello world
}
這段代碼中的管道功能同樣生效。
指定工作目錄
可以通過(guò)指定 *Cmd 對(duì)象的的 Dir 屬性來(lái)指定工作目錄：
func main() {
cmd := exec.Command("cat", "demo.log")
cmd.Stdout = os.Stdout // 獲取標(biāo)準(zhǔn)輸出
cmd.Stderr = os.Stderr // 獲取錯(cuò)誤輸出
// cmd.Dir = "/tmp" // 指定絕對(duì)目錄
cmd.Dir = "." // 指定相對(duì)目錄
if err := cmd.Run(); err != nil {
log.Fatalf("Command failed: %v", err)
}
}捕獲退出狀態(tài)
上面講解了很多執(zhí)行命令相關(guān)操作，但其實(shí)還有一個(gè)很重要的點(diǎn)沒(méi)有講到，就是如何捕獲外部命令執(zhí)行后的退出狀態(tài)碼：
func main() {
// 查看一個(gè)不存在的目錄
cmd := exec.Command("ls", "/nonexistent")
// 運(yùn)行命令
err := cmd.Run()
// 檢查退出狀態(tài)
var exitError *exec.ExitError
if errors.As(err, &exitError) {
log.Fatalf("Process PID: %d exit code: %d", exitError.Pid(), exitError.ExitCode()) // 打印 pid 和退出碼
}
}
這里執(zhí)行 ls 命令來(lái)查看一個(gè)不存在的目錄 /nonexistent，程序退出狀態(tài)碼必然不為 0。
執(zhí)行示例代碼，得到輸出如下：
$ go run main.go 2025/01/15 23:31:44 Process PID: 78328 exit code: 1 exit status 1
搜索可執(zhí)行文件
最后要介紹的函數(shù)就只剩一個(gè) LookPath 了，它用來(lái)搜索可執(zhí)行文件。
搜索一個(gè)存在的命令：
func main() {
path, err := exec.LookPath("ls")
if err != nil {
log.Fatal("installing ls is in your future")
}
fmt.Printf("ls is available at %s\n", path)
}
執(zhí)行示例代碼，得到輸出如下：
$ go run main.go ls is available at /bin/ls
搜索一個(gè)不存在的命令：
func main() {
path, err := exec.LookPath("lsx")
if err != nil {
log.Fatal(err)
}
fmt.Printf("ls is available at %s\n", path)
}
執(zhí)行示例代碼，得到輸出如下：
$ go run main.go 2025/01/15 23:37:45 exec: "lsx": executable file not found in $PATH exit status 1
功能練習(xí)
介紹完了 os/exec 常用的方法和函數(shù)，我們現(xiàn)在來(lái)做一個(gè)小練習(xí)，使用 os/exec 來(lái)執(zhí)行外部命令 ls -l /var/log/*.log。
示例如下：
func main() {
cmd := exec.Command("ls", "-l", "/var/log/*.log")
output, err := cmd.CombinedOutput() // 獲取標(biāo)準(zhǔn)輸出和錯(cuò)誤輸出
if err != nil {
log.Fatalf("Command failed: %v", err)
}
fmt.Println(string(output))
}
執(zhí)行示例代碼，得到輸出如下：
$ go run main.go 2025/01/16 09:15:52 Command failed: exit status 1 exit status 1
執(zhí)行報(bào)錯(cuò)了，這里的錯(cuò)誤碼為 1，但錯(cuò)誤信息并不明確。
這個(gè)報(bào)錯(cuò)其實(shí)是因?yàn)?nbsp;os/exec 默認(rèn)不支持通配符參數(shù)導(dǎo)致的，exec.Command 不支持直接在參數(shù)中使用 Shell 通配符（如 *），因?yàn)樗粫?huì)通過(guò) Shell 來(lái)解析命令，而是直接調(diào)用底層的程序。
要解決這個(gè)問(wèn)題，可以通過(guò)顯式調(diào)用 Shell（例如 bash 或 sh），讓 Shell 來(lái)解析通配符。
比如使用 bash -c 執(zhí)行通配符命令 ls -l /var/log/*.log：
func main() {
// 使用 bash -c 來(lái)解析通配符
cmd := exec.Command("bash", "-c", "ls -l /var/log/*.log")
output, err := cmd.CombinedOutput() // 獲取標(biāo)準(zhǔn)輸出和錯(cuò)誤輸出
if err != nil {
log.Fatalf("Command failed: %v", err)
}
fmt.Println(string(output))
}
執(zhí)行示例代碼，得到輸出如下：
$ go run main.go -rw-r--r-- 1 root wheel 0 Oct 7 21:20 /var/log/alf.log -rw-r--r-- 1 root wheel 11936 Jan 13 11:36 /var/log/fsck_apfs.log -rw-r--r-- 1 root wheel 334 Jan 13 11:36 /var/log/fsck_apfs_error.log -rw-r--r-- 1 root wheel 19506 Jan 11 18:04 /var/log/fsck_hfs.log -rw-r--r--@ 1 root wheel 21015342 Jan 16 09:02 /var/log/install.log -rw-r--r-- 1 root wheel 1502 Nov 5 09:44 /var/log/shutdown_monitor.log -rw-r-----@ 1 root admin 3779 Jan 16 08:59 /var/log/system.log -rw-r----- 1 root admin 187332 Jan 16 09:05 /var/log/wifi.log
此外，我們還可以用 Go 標(biāo)準(zhǔn)庫(kù)提供的 filepath.Glob 來(lái)手動(dòng)解析通配符：
func main() {
// 匹配通配符路徑
files, err := filepath.Glob("/var/log/*.log")
if err != nil {
log.Fatalf("Glob failed: %v", err)
}
if len(files) == 0 {
log.Println("No matching files found")
return
}
// 將匹配到的文件傳給 ls 命令
args := append([]string{"-l"}, files...)
cmd := exec.Command("ls", args...)
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
if err := cmd.Run(); err != nil {
log.Fatalf("Command failed: %v", err)
}
}
filepath.Glob 函數(shù)會(huì)返回模式匹配的文件名列表，如果不匹配則返回 nil。這樣，我們就可以先解析文件名列表，再交給 exec.Command 來(lái)執(zhí)行 ls 命令了。
總結(jié)
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
這篇文章主要介紹了Golang通脈之流程控制，流程控制是每種編程語(yǔ)言控制邏輯走向和執(zhí)行次序的重要部分，Go語(yǔ)言中最常用的流程控制有if和for，而switch和goto主要是為了簡(jiǎn)化代碼，下面文章將詳細(xì)介紹改該內(nèi)容,需要的朋友可以參考一下2021-10-10
cobra既是一個(gè)用于創(chuàng)建強(qiáng)大現(xiàn)代CLI應(yīng)用程序的庫(kù)，也是一個(gè)生成應(yīng)用程序和命令文件的程序。cobra被用在很多go語(yǔ)言的項(xiàng)目中，比如 Kubernetes、Docker、Istio、ETCD、Hugo、Github CLI等等2022-12-12
Windows下Goland的環(huán)境搭建過(guò)程詳解
這篇文章主要介紹了Windows下Goland的環(huán)境搭建過(guò)程,本文通過(guò)圖文并茂的形式給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2020-10-10
今天小編就為大家分享一篇關(guān)于為什么Go語(yǔ)言把類(lèi)型聲明放在后面?，小編覺(jué)得內(nèi)容挺不錯(cuò)的，現(xiàn)在分享給大家，具有很好的參考價(jià)值，需要的朋友一起跟隨小編來(lái)看看吧2019-04-04
Go語(yǔ)言中兩個(gè)比較流行的緩存庫(kù)使用示例
緩存是計(jì)算機(jī)科學(xué)中的一個(gè)重要概念,設(shè)想某個(gè)組件需要訪問(wèn)外部資源,它向外部源請(qǐng)求資源,接收并使用資源,這些步驟都需要花費(fèi)時(shí)間,下面這篇文章主要給大家介紹了關(guān)于Go語(yǔ)言中兩個(gè)比較流行的緩存庫(kù)使用的相關(guān)資料,需要的朋友可以參考下2024-04-04
利用systemd部署golang項(xiàng)目的實(shí)現(xiàn)方法
這篇文章主要介紹了利用systemd部署golang項(xiàng)目的實(shí)現(xiàn)方法，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-11-11
go語(yǔ)言搬磚之go jmespath實(shí)現(xiàn)查詢(xún)json數(shù)據(jù)
這篇文章主要為大家介紹了go語(yǔ)言搬磚之go jmespath實(shí)現(xiàn)查詢(xún)json數(shù)據(jù)，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-06-06
這篇文章主要為大家詳細(xì)介紹了Golang中對(duì)切片Slice的append操作時(shí)會(huì)遇到的踩坑經(jīng)驗(yàn)分享，文中的示例代碼講解詳細(xì)，感興趣的小伙伴可以了解一下2023-03-03
Beego是一個(gè)基于Go語(yǔ)言的開(kāi)源框架,用于構(gòu)建Web應(yīng)用程序和API,本文主要介紹了golang中beego入門(mén),具有一定的參考價(jià)值,感興趣的可以了解一下2023-12-12
在Go語(yǔ)言中，new和make是兩個(gè)用于創(chuàng)建對(duì)象的內(nèi)建函數(shù)。本文將詳細(xì)介紹new和make的區(qū)別，并通過(guò)多個(gè)方面的分析和代碼示例，幫助大家理解它們的使用場(chǎng)景2023-05-05