关于Golang获取当前项目绝对路径的问题

更新时间：2022年04月22日 10:36:24 作者：快乐的GTD吧

这篇文章主要介绍了Golang获取当前项目绝对路径的问题，通常的做法是go run用于本地开发，用一个命令中快速测试代码确实非常方便；在部署生产环境时，我们会通过go build构建出二进制文件然后上传到服务器再去执行，那么会产生什么问题呢？感兴趣的朋友一起看看吧

导读

由于Golang是编译型语言（非脚本型语言），如果你想在Golang程序中获取当前执行目录将是一件非常蛋疼的事情。以前大家最折中的解决方案就是通过启动传参或是环境变量将路径手动传递到程序，而今天我在看日志库的时候发现了一种新的解决方案。
Go程序两种不同的执行方式

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

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

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

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

话不多说，我们直接上代码

我们编写获取当前可执行文件路径的方法

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启动

D:\Projects\demo>go run main.go
getCurrentAbPathByExecutable = C:\Users\XXX\AppData\Local\Temp\go-build216571510\b001\exe

再尝试go build执行

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

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

这是在我今天查看服务日志(zap库)的时候，突然反应过来一件事情。比如下面是一条简单的日志，而服务是通过go run启动的，但日志库却把我正确的程序路径D:/Projects/te-server/modules/es/es.go:139给打印出来了

2021-03-26 17:47:06 D:/Projects/te-server/modules/es/es.go:139 update es index {"index": "tags", "data": "[200 OK] {"acknowledged":true}"}

于是我马上去翻看zap源码，发现是通过runtime.Caller()实现的，其实所有Golang日志库都会有runtime.Caller()这个调用。

我开心的以为找到了最终答案，然后写代码试了下：

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试一下

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

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

嗯~~ 结果完全正确！

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

[root@server app]# chmod +x demo
[root@server app]# ./demo
getCurrentAbPathByCaller = D:/Projects/demo

没想到白白高兴一场，这个时候我就在想，既然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的启动方式。

下面是完整代码：

package main

import (
"fmt"
"log"
"os"
"path"
"path/filepath"
"runtime"
"strings"
)
func main() {
fmt.Println("getTmpDir（当前系统临时目录） = ", getTmpDir())
fmt.Println("getCurrentAbPathByExecutable（仅支持go build） = ", getCurrentAbPathByExecutable())
fmt.Println("getCurrentAbPathByCaller（仅支持go run） = ", getCurrentAbPathByCaller())
fmt.Println("getCurrentAbPath（最终方案-全兼容） = ", getCurrentAbPath())
}
// 最终方案-全兼容
func getCurrentAbPath() string {
dir := getCurrentAbPathByExecutable()
if strings.Contains(dir,getTmpDir()) {
return getCurrentAbPathByCaller()
return dir
// 获取系统临时目录，兼容go run
func getTmpDir() string {
dir := os.Getenv("TEMP")
if dir == "" {
dir = os.Getenv("TMP")
res, _ := filepath.EvalSymlinks(dir)
return res
// 获取当前执行文件绝对路径
func getCurrentAbPathByExecutable() string {
exePath, err := os.Executable()
if err != nil {
log.Fatal(err)
res, _ := filepath.EvalSymlinks(filepath.Dir(exePath))
// 获取当前执行文件绝对路径（go run）
func getCurrentAbPathByCaller() string {
var abPath string
_, filename, _, ok := runtime.Caller(0)
if ok {
abPath = path.Dir(filename)
return abPath

在windows执行

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执行

[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

对比结果，我们可以看到，在不同的系统中，不同的执行方式，我们封装的getCurrentAbPath方法最终都输出的正确的结果，perfect！

到此这篇关于关于Golang获取当前项目绝对路径的问题的文章就介绍到这了,更多相关Golang绝对路径内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Golang基于epoll实现最简单网络通信框架
这篇文章主要为大家详细介绍了Golang如何基于epoll实现最简单网络通信框架，文中的示例代码讲解详细，感兴趣的小伙伴可以跟随小编一起学习学习
2023-06-06
浅谈Go数组比切片好在哪
Go1.17 会正式支持切片转换到数据，不再需要用以前那种骚办法了，本文就谈谈Go数组比切片好在哪，感兴趣的可以了解一下
2021-09-09
go如何优雅关闭Graceful Shutdown服务
这篇文章主要为大家介绍了go优雅关闭Graceful Shutdown服务详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-05-05
Go读取文件与写入文件的三种方法操作指南
在 Go 语言中也经常会遇到操作文件的需求,下面这篇文章主要给大家介绍了关于Go读取文件与写入文件的三种方法操作,文中通过代码介绍的非常详细,需要的朋友可以参考下
2022-09-09
Go语言实现的树形结构数据比较算法实例
这篇文章主要介绍了Go语言实现的树形结构数据比较算法,实例分析了树形结构数据比较算法的实现技巧,具有一定参考借鉴价值,需要的朋友可以参考下
2015-02-02
一步步教你打造高效可靠的Go库
这篇文章主要介绍了一步步教你打造高效可靠的Go库的相关资料,需要的朋友可以参考下
2023-11-11
关于go-micro与其它gRPC框架之间的通信问题及解决方法
在之前的文章中分别介绍了使用gRPC官方插件和go-micro插件开发gRPC应用程序的方式，都能正常走通。不过当两者混合使用的时候，互相访问就成了问题，下面通过本文给大家讲解下go-micro与gRPC框架通信问题，一起看看吧
2022-04-04
使用Go goroutine实现并发的Clock服务
这篇文章主要为大家详细介绍了如何使用Go goroutine实现并发的Clock服务，文中的示例代码讲解详细，感兴趣的小伙伴可以跟随小编一起学习一下
2023-06-06
Go语言中常用的基础方法总结
这篇文章主要为大家详细介绍了Go语言中常用的一些基础方法，例如：使用正则表达式验证字符串、格式化字符串、时间的比较等等，需要的可以参考一下
2022-09-09
Golang字符串的拼接方法汇总
字符串拼接在日常开发中是很常见的需求，今天我们来探讨下如何用golang来实现字符串的拼接
2018-10-10

关于Golang获取当前项目绝对路径的问题

导读

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具