Go 环境变量

在操作系统中,环境变量(Environment Variable)是保存在程序外部的一组 “键值对” 配置信息。在实际项目开发中,数据库密码、接口密钥等配置通常不会直接写死在 .go 源代码里。把这些信息通过环境变量从外部传入,更换服务器部署时就不需要修改代码重新编译了。

在 Go 语言中,我们可以直接使用标准库 os 包来读取和管理环境变量,常用的函数如下表所示。

常用环境变量函数
函数 返回值 说明
os.Getenv() string 读取环境变量的值
os.Setenv() error 设置或修改环境变量
os.LookupEnv() (string, bool) 读取值并判断是否已设置
os.Unsetenv() error 删除指定的环境变量
os.Environ() []string 获取所有环境变量列表

读取与设置环境变量

在日常开发中,用得最多的就是设置变量值的 os.Setenv() 和读取变量值的 os.Getenv(),其中 env 是英文 “environment(环境)” 的缩写。

语法:

err := os.Setenv(key, value)
val := os.Getenv(key)

说明:

os.Setenv(key, value) 用于在当前程序进程中设置一个环境变量,key 和 value 都是 string 类型。os.Getenv(key) 则根据键名读取对应的变量值。如果环境中还没有设置该变量,它不会报错,而是直接返回空字符串 ""。

示例 1:设置并读取环境变量

package main

import (
    "fmt"
    "os"
)

func main() {
    // 设置当前进程的环境变量
    os.Setenv("APP_ENV", "production")
    os.Setenv("DB_HOST", "127.0.0.1")

    // 读取已设置的环境变量
    env := os.Getenv("APP_ENV")
    host := os.Getenv("DB_HOST")

    // 读取未设置的环境变量
    port := os.Getenv("DB_PORT")

    fmt.Printf("运行环境:%s\n", env)
    fmt.Printf("数据库地址:%s\n", host)
    fmt.Printf("数据库端口:%q\n", port)
}

运行结果如下。

运行环境:production
数据库地址:127.0.0.1
数据库端口:""

分析:

为了方便在线运行观察效果,我们先调用 os.Setenv() 设置了 "APP_ENV" 和 "DB_HOST" 两个变量,随后通过 os.Getenv() 读出了它们的值。

对于没有设置过的 "DB_PORT",os.Getenv() 会返回空字符串 "",配合格式化占位符 %q 可以把空字符串两侧的双引号清晰打印出来。

在实际开发中,我们经常希望外部配置了环境变量就优先采用外部配置,没配置时就自动回退到一个默认值。利用未设置时返回 "" 的特点,我们可以封装一个简短的辅助函数,请看下面例子。

示例 2:读取环境变量并提供默认值

package main

import (
    "fmt"
    "os"
)

// 读取环境变量或返回默认值
func getEnvDefault(key, defaultVal string) string {
    val := os.Getenv(key)
    if val == "" {
        return defaultVal
    }
    return val
}

func main() {
    os.Setenv("SERVER_PORT", "9000")

    port := getEnvDefault("SERVER_PORT", "8080")
    host := getEnvDefault("SERVER_HOST", "localhost")
    fmt.Println("监听地址:" + host + ":" + port)
}

运行结果如下。

监听地址:localhost:9000

分析:

当我们第 1 次调用 getEnvDefault() 读取 "SERVER_PORT" 时,由于前面已经将其设为了 "9000",函数直接返回 "9000"。第 2 次读取尚未设置的 "SERVER_HOST" 时,os.Getenv() 返回 "",函数便自动返回默认值 "localhost"。

需要注意的是,从环境变量中读取出来的数据全部都是 string 字符串类型,哪怕里面的内容是 "9000" 或 "true"。如果后续需要把它当作整数参与运算,小伙伴们可以借助后面将要学习的字符串转为整数方法先做转换,然后再计算。

注意: 在代码中调用 os.Setenv() 设置或修改的环境变量,只对当前正在运行的这一个 Go 程序进程有效。一旦程序运行结束退出,这些临时设置就会自动消失,不会改动电脑系统原有的全局环境变量,小伙伴们可以放心运行测试。

如何判断环境变量是否已设置?

使用 os.Getenv() 读取配置时,如果返回了空字符串 "",我们其实是没法分清到底是 “没有设置这个环境变量”,还是 “故意把它的值设成了空字符串”。

比如在本地调试免密服务时,我们可能会把密码环境变量 DB_PASS 显式设为空字符串 ""。如果只判断 os.Getenv("DB_PASS") == "",程序就会误判为漏配了密码而报错退出。遇到需要区分这两种情况的场景,我们可以使用 os.LookupEnv() 函数。

语法:

val, ok := os.LookupEnv(key)

说明:

os.LookupEnv(key) 的用法与前面学过的 Map 判断键是否存在的双返回值写法非常相似,它会同时返回以下 2 个值:

  • val:环境变量对应的字符串值,未设置时返回空字符串 ""。
  • ok:布尔值(bool)。只要该变量被设置过,哪怕值本身是 "",ok 依然为 true。只有当变量完全未设置时,ok 才为 false。

示例 3:区分 “未设置” 与 “空字符串”

package main

import (
    "fmt"
    "os"
)

func checkEnv(key string) {
    if val, ok := os.LookupEnv(key); ok {
        fmt.Printf("%s 已设置,值为:%q\n", key, val)
    } else {
        fmt.Printf("%s 未设置\n", key)
    }
}

func main() {
    // 将 DB_PASS 显式设为空字符串
    os.Setenv("DB_PASS", "")

    checkEnv("DB_PASS")
    checkEnv("API_KEY")
}

运行结果如下。

DB_PASS 已设置,值为:""
API_KEY 未设置

分析:

从运行结果可以看出,虽然 "DB_PASS" 和 "API_KEY" 读出来的值都是 "",但 os.LookupEnv() 返回的 ok 完全不同。其中 "DB_PASS" 经过了显式设置,因此 ok 为 true;而 "API_KEY" 从未设置过,因此 ok 为 false。

回头对比一下示例 2 的 getEnvDefault() 函数:如果某个配置项允许用户显式留空,我们可以把里面的 os.Getenv() 换成 val, ok := os.LookupEnv(key)。只在 !ok 时才返回默认值,这样就不会误把主动设定的空字符串覆盖掉了。

此外,不同操作系统对环境变量名的大小写规则有所差异。Linux 和 macOS 严格区分大小写,"Path" 和 "PATH" 会被当作两个不同的变量,而 Windows 则不区分大小写。为了保证跨平台部署不出错,对于下面 2 种命名方式,我们更推荐方式 1。

// 方式 1(推荐)
os.Getenv("APP_PORT")

// 方式 2
os.Getenv("app_port")

在实际开发中,我们给自定义环境变量起名时,统一使用全大写英文字母配合下划线连接单词。像 APP_PORT、DB_HOST 就是后端开发中的通用写法。

删除与遍历环境变量

除了设置和读取单个变量之外,os 包还提供了删除指定环境变量的 os.Unsetenv() 函数,以及一次性获取当前所有环境变量的 os.Environ() 函数。

语法:

err := os.Unsetenv(key)
all := os.Environ()

说明:

os.Unsetenv(key) 用于从当前程序进程中移除名称为 key 的环境变量。os.Environ() 不需要传入参数,它会返回一个 []string 字符串切片,里面每一项都是类似 "APP_ENV=dev" 的 "键=值" 格式字符串。

在拆分 "键=值" 字符串时,除了使用前面学过的 strings.Split() 之外,我们也可以使用 strings.Cut(s, "=") 函数。它会沿着第 1 个等号切分字符串,并依次返回 “等号左边的键”、“等号右边的值” 以及 “是否找到等号” 共 3 个值。

示例 4:删除与遍历环境变量

package main

import (
    "fmt"
    "os"
    "strings"
)

func main() {
    os.Setenv("DEMO_USER", "Mike")
    os.Setenv("DEMO_ROLE", "admin")

    // 删除 DEMO_USER 环境变量
    os.Unsetenv("DEMO_USER")
    _, ok := os.LookupEnv("DEMO_USER")
    fmt.Printf("删除后 DEMO_USER 是否存在:%v\n", ok)

    // 遍历并筛选以 DEMO_ 开头的环境变量
    for _, item := range os.Environ() {
        key, val, found := strings.Cut(item, "=")
        if found && strings.HasPrefix(key, "DEMO_") {
            fmt.Printf("键:%s,值:%s\n", key, val)
        }
    }
}

运行结果如下。

删除后 DEMO_USER 是否存在:false
键:DEMO_ROLE,值:admin

分析:

调用 os.Unsetenv("DEMO_USER") 移除变量后,我们再次通过 os.LookupEnv() 检查时,ok 已经变成了 false。

由于操作系统自带的环境变量通常有几十个,这里我们通过 strings.HasPrefix() 只筛选打印了以 "DEMO_" 开头的变量。同时,strings.Cut() 只按第 1 个等号切分,哪怕变量值内部还包含其他等号,也不会被意外切碎。

常见问题

1. 示例里是在代码中调用 os.Setenv(),实际运行时怎么从外部终端传入环境变量?

在本地终端或服务器上启动 Go 程序时,我们不需要修改代码,直接在运行命令中指定环境变量即可:

  • macOS / Linux 终端:直接在命令前写 变量名=值,例如执行 APP_ENV=prod go run main.go,该设置只对本次运行的命令生效。
  • Windows PowerShell 终端:先使用 $env: 赋值再运行,例如执行 $env:APP_ENV="prod"; go run main.go。注意这样赋值后,该变量在关闭当前 PowerShell 窗口前会一直生效。如需清除,可执行 Remove-Item Env:APP_ENV。
  • Windows CMD 终端:先执行 set APP_ENV=prod 设置变量,再执行 go run main.go。

2. 环境变量和命令行参数都能给程序传递配置,实际开发中应该怎么选择?

在日常开发中,环境变量经常与前一节学过的命令行参数配合使用,两者的分工非常清晰:

  • 优先使用环境变量:适合保存数据库密码、接口密钥等敏感信息,避免在终端历史记录中明文暴露,也适合在服务器和容器中管理随环境变化的部署配置。当本地开发需要配置十几个环境变量时,团队通常会把它们统一写进项目根目录的 .env 文件中加载。记得把 .env 加入 .gitignore,防止敏感密钥被误传到代码仓库。
  • 优先使用命令行参数:适合手动启动程序时临时指定的开关、端口或文件路径,比如 -port 9000 或 -h 查看帮助,终端交互更加直观。
给站长反馈

绿叶网正在不断完善中,小伙伴们如果发现任何问题,还望多多给站长反馈,谢谢!

邮箱:lvyenet@vip.qq.com

「绿叶网」服务号
绿叶网服务号放大
关注服务号,微信也能看教程。
绿叶网服务号