编写命令行工具必备知识—Golang中获取和返回状态码

命令行返回值

之前的文章《编写命令行工具必备知识—Linux终端执行命令后的返回值》讲了终端执行命令后会有对应的返回值，这一点非常重要。当在程序中调用系统命令行命令时，可以根据返回值来知道命令执行的结果并执行不同的策略，所以编写命令行工具时一定要返回对应的状态码。

Golang中获取调用系统命令状态码

golang的标准库os/exec可以用于执行系统命令行命令，举一个调用系统的cp命令的例子，代码如下：

err := exec.Command("cp", "./test.go", "../test/test.go").Run()
if err != nil {
    println(err.Error())
}

如果没有copy成功，error信息会输出执行命令的状态码。假如要copy的文件不存在，运行代码后输出如下:

$ go run main.go
exit status 1

其中错误信息 exit status 1 中的 1 就是执行命令后返回的状态码。

Golang编写命令行程序如何返回状态码

可能很多同学都写过命令行工具，但知道给返回值的同学可能不多。没有设置返回值的话默认返回值就是0，也就意味着程序即使出错，从返回值来看依然是执行成功的，这样就会带来意想不到的问题。

Golang中可以调用 os.Exit() 方法设置返回状态码，先看下官方的注释：

// Exit causes the current program to exit with the given status code.
// Conventionally, code zero indicates success, non-zero an error.
// The program terminates immediately; deferred functions are not run.
//
// For portability, the status code should be in the range [0, 125].

即：

// Exit 使当前程序停止运行，返回给定的状态码。
// 按照惯例，0表示成功，非0表示错误。
// 程序立即停止运行；之后的defer函数不再被运行。
//
// 为了可移植性，状态码的范围应该是[0,125]。

看个例子，假如程序检测到操作系统是macOS时就停止运行，提示不支持当前系统并返回对应的状态码2：

package main

import (
  "os"
  "runtime"
)

func main() {
  recode := 0
  defer func() { os.Exit(recode) }()

  goos := runtime.GOOS
  if goos == "darwin" {
    recode = 2
    println("unsupported platform")
    return
  }
  println("success")
}