分享每一天-golang获取程序当前路径

golang获取程序当前路径

GoLang 1230 0 创建时间：2022-11-08 09:53:47

golang获取程序当前路径

#### golang获取程序当前路径

golang运行的方式共有3种、每种运行方式也会导致获取的路径有差

- go build main.go 编译成二进制程序
- go run main.go 直接运行源码
- go test main.go 调试模式下运行

#### 获取当前路径的方式
方式一：
```go
os.Args[0]
```
方式二：
```go
pwd, err := os.Getwd()
println("Getwd: ", pwd, err)
```

方式三：
```go
exePath, err := os.Executable()
if err != nil {
    log.Fatal(err)
}
res, _ := filepath.EvalSymlinks(filepath.Dir(exePath))
println(res)
```
方式四：
```go
var abPath string
_, filename, _, ok := runtime.Caller(0)
if ok {
    abPath = path.Dir(filename)
}
println(abPath)
```

#### 4种方式在不同模式下运行输出的结果
###### go run
```go
方式1 os.arg:  /var/folders/cn/tdmhdvk55xbgzfj9xhjlbff40000gn/T/go-build2612382668/b001/exe/main
方式2 Getwd:  /Users/jw/workspace/base/golang-example/eg-os (0x0,0x0)
方式3 getCurrentAbPathByExecutable:  /private/var/folders/cn/tdmhdvk55xbgzfj9xhjlbff40000gn/T/go-build2612382668/b001/exe
方式4 getCurrentAbPathByCaller:  /Users/jw/workspace/base/golang-example/util
```
###### go build
```go
方式1 os.arg:  ./main
方式2 Getwd:  /Users/jw/workspace/base/golang-example/eg-os (0x0,0x0)
方式3 getCurrentAbPathByExecutable:  /Users/jw/workspace/base/golang-example/eg-os
方式4 getCurrentAbPathByCaller:  /Users/jw/workspace/base/golang-example/util
```
#### go test 运行输出结果
```go
方式1 os.arg:  /var/folders/cn/tdmhdvk55xbgzfj9xhjlbff40000gn/T/go-build1715781360/b001/eg-os.test
方式2 Getwd:  /Users/jw/workspace/base/golang-example/eg-os (0x0,0x0)
方式3 getCurrentAbPathByExecutable:  /private/var/folders/cn/tdmhdvk55xbgzfj9xhjlbff40000gn/T/go-build1715781360/b001
方式4 getCurrentAbPathByCaller:  /Users/jw/workspace/base/golang-example/util
```

#### Go程序两种不同的执行方式

用Go编写的程序有两种执行方式，go run和go build

- 通常的做法是go run用于本地开发，用一个命令中快速测试代码确实非常方便；
- 在部署生产环境时，我们会通过go build构建出二进制文件然后上传到服务器再去执行。

#### 两种启动方式会产生什么问题？

那么两种启动方式下，获取到当前执行路径会产生什么问题？

我们编写获取当前可执行文件路径的方法：
```go
package main

import (
	"fmt"
	"log"
	"os"
	"path/filepath"
)

func main() {
	fmt.Println("getCurrentAbPathByExecutable = ", getCurrentAbPathByExecutable())
}

// 获取当前执行程序所在的绝对路径
func getCurrentAbPathByExecutable() string {
	exePath, err := os.Executable()
	if err != nil {
		log.Fatal(err)
	}
	res, _ := filepath.EvalSymlinks(filepath.Dir(exePath))
	return res
}
```

首先通过go run启动

```go
D:\Projects\demo>go run main.go
getCurrentAbPathByExecutable =  C:\Users\XXX\AppData\Local\Temp\go-build216571510\b001\exe
```
再尝试go build执行

```go
D:\Projects\demo>go build & demo.exe
getCurrentAbPathByExecutable =  D:\Projects\demo
```

通过对比执行结果，我们发现两种执行方式，我们获取到了不同的路径。而且很明显，go run获取到的路径是错误的。

#### 原因：
这是由于go run会将源代码编译到系统TEMP或TMP环境变量目录中并启动执行；而go build只会在当前目录编译出可执行文件，并不会自动执行。

我们可以简单理解为，go run main.go等价于go build & ./main

虽然两种执行方式最终都是一样的过程：源码->编译->可执行文件->执行输出，但他们的执行目录却完全不一样了。

#### 新的方案诞生

通过runtime.Caller()实现的，其实所有Golang日志库都会有runtime.Caller()这个调用。

```go
package main

import (
	"fmt"
	"path"
	"runtime"
)

func main() {
	fmt.Println("getCurrentAbPathByCaller = ", getCurrentAbPathByCaller())

}

// 获取当前执行文件绝对路径（go run）
func getCurrentAbPathByCaller() string {
	var abPath string
	_, filename, _, ok := runtime.Caller(0)
	if ok {
		abPath = path.Dir(filename)
	}
	return abPath
}
```

首先在windows下面go run 和go build试一下

```go
D:\Projects\demo>go run main.go
getCurrentAbPathByCaller =  D:/Projects/demo

D:\Projects\demo>go build & demo.exe
getCurrentAbPathByCaller =  D:/Projects/demo
```

然后我再把构建好的程序扔到linux再运行后，它把我windows的路径给打印出来了 --！

```go
[root@server app]# chmod +x demo 
[root@server app]# ./demo 
getCurrentAbPathByCaller =  D:/Projects/demo
```
芭比Q了。。。。
这个时候我就在想，既然go run时可以通过runtime.Caller()获取到正确的结果，go build时也可以通过 os.Executable()来获取到正确的路径；

那如果我能判定当前程序是通过go run还是go build执行的，选择不同的路径获取方法，所有问题不就迎刃而解了吗。

#### 区分程序是go run还是go build执行
Go没有提供接口让我们区分程序是go run还是go build执行，但我们可以换个思路来实现：

根据go run的执行原理，我们得知它会源代码编译到系统TEMP或TMP环境变量目录中并启动执行；

那我们可以直接在程序中对比os.Executable()获取到的路径是否与环境变量TEMP设置的路径相同， 如果相同，说明是通过go run启动的，因为当前执行路径是在TEMP目录；不同的话自然是go build 的启动方式。

```go
package main

import (
	"fmt"
	"log"
	"os"
	"path"
	"path/filepath"
	"runtime"
	"strings"
)

func main() {
	fmt.Println("getTmpDir（当前系统临时目录） = ", os.TempDir())
	fmt.Println("getCurrentAbPathByExecutable（仅支持go build） = ", getCurrentAbPathByExecutable())
	fmt.Println("getCurrentAbPathByCaller（仅支持go run） = ", getCurrentAbPathByCaller())
	fmt.Println("getCurrentAbPath（最终方案-全兼容） = ", getCurrentAbPath())
}

// 最终方案-全兼容
func getCurrentAbPath() string {
	dir := getCurrentAbPathByExecutable()
	tmpDir, _ := filepath.EvalSymlinks(os.TempDir())
	if strings.Contains(dir, tmpDir) {
		return getCurrentAbPathByCaller()
	}
	return dir
}

// 获取当前执行文件绝对路径
func getCurrentAbPathByExecutable() string {
	exePath, err := os.Executable()
	if err != nil {
		log.Fatal(err)
	}
	res, _ := filepath.EvalSymlinks(filepath.Dir(exePath))
	return res
}

```go
D:\Projects\demo>go run main.go
getTmpDir（当前系统临时目录） =  C:\Users\XXX\AppData\Local\Temp
getCurrentAbPathByExecutable（仅支持go build） =  C:\Users\XXX\AppData\Local\Temp\go-build456189690\b001\exe
getCurrentAbPathByCaller（仅支持go run） =  D:/Projects/demo
getCurrentAbPath（最终方案-全兼容） =  D:/Projects/demo

D:\Projects\demo>go build & demo.exe
getTmpDir（当前系统临时目录） =  C:\Users\XXX\AppData\Local\Temp
getCurrentAbPathByExecutable（仅支持go build） =  D:\Projects\demo
getCurrentAbPathByCaller（仅支持go run） =  D:/Projects/demo
getCurrentAbPath（最终方案-全兼容） =  D:\Projects\demo
```

在windows编译后上传到Linux执行
```go

[root@server app]# pwd
/data/app
[root@server app]# ./demo 
getTmpDir（当前系统临时目录） =  .
getCurrentAbPathByExecutable（仅支持go build） =  /data/app
getCurrentAbPathByCaller（仅支持go run） =  D:/Projects/demo
getCurrentAbPath（最终方案-全兼容） =  /data/app
```

#### 参考资料：
https://tehub.com/a/44BceBfRK0

golang获取程序当前路径

商品推荐

广告推荐

推荐文章