第35课：命令行参数与环境变量

学习目标

理解 os.Args 与 flag 包在处理命令行参数时的区别和适用场景
掌握使用 os 包获取和设置环境变量的方法
能够编写接受命令行参数和读取环境变量的 Go 程序
了解命令行工具设计的基本规范

核心概念

命令行参数

当你在终端运行程序时，可以向程序传递参数。例如：./myapp -name=John --age=25 config.txt

在 Go 中，有两种主要方式处理命令行参数：

os.Args - 简单直接的参数切片
flag 包 - 提供更丰富的参数解析功能

环境变量

环境变量是操作系统级别的配置信息，程序可以读取这些变量来获取系统或用户配置。例如：数据库连接信息、API密钥等敏感信息通常通过环境变量传递。

代码示例

1. 使用 os.Args 获取原始参数

package main

import (
	"fmt"
	"os"
)

func main() {
	// os.Args 是一个字符串切片，包含程序名称和所有参数
	args := os.Args
	
	// 打印参数总数（包括程序名称）
	fmt.Println("参数总数:", len(args))
	
	// 打印程序名称（第一个参数）
	if len(args) > 0 {
		fmt.Println("程序名称:", args[0])
	}
	
	// 打印所有用户参数
	if len(args) > 1 {
		fmt.Println("用户提供的参数:")
		for i, arg := range args[1:] {
			fmt.Printf("  参数 %d: %s\n", i+1, arg)
		}
	}
}

运行示例：

go run main.go hello world 123
# 输出:
# 参数总数: 4
# 程序名称: /tmp/go-build.../main
# 用户提供的参数:
#   参数 1: hello
#   参数 2: world
#   参数 3: 123

2. 使用 flag 包解析命名参数

package main

import (
	"flag"
	"fmt"
	"strings"
)

func main() {
	// 定义命令行参数
	name := flag.String("name", "匿名用户", "用户姓名")
	age := flag.Int("age", 0, "用户年龄")
	debug := flag.Bool("debug", false, "是否开启调试模式")
	
	// 自定义参数使用
	var hobbies string
	flag.StringVar(&hobbies, "hobbies", "", "爱好列表，用逗号分隔")
	
	// 解析命令行参数
	flag.Parse()
	
	// 使用解析后的参数
	fmt.Printf("姓名: %s\n", *name)
	fmt.Printf("年龄: %d\n", *age)
	fmt.Printf("调试模式: %v\n", *debug)
	
	if hobbies != "" {
		fmt.Printf("爱好: %s\n", strings.Split(hobbies, ","))
	}
	
	// 打印剩余的非标志参数
	if flag.NArg() > 0 {
		fmt.Println("其他参数:", flag.Args())
	}
}

运行示例：

go run main.go -name="张三" -age=25 -debug -hobbies="编程,阅读"
# 输出:
# 姓名: 张三
# 年龄: 25
# 调试模式: true
# 爱好: [编程 阅读]

3. 环境变量操作

package main

import (
	"fmt"
	"os"
)

func main() {
	// 1. 读取环境变量
	home := os.Getenv("HOME")
	path := os.Getenv("PATH")
	
	fmt.Println("用户主目录:", home)
	fmt.Println("PATH 环境变量:", path)
	
	// 2. 检查环境变量是否存在
	if value, exists := os.LookupEnv("DATABASE_URL"); exists {
		fmt.Println("数据库连接:", value)
	} else {
		fmt.Println("DATABASE_URL 环境变量未设置")
	}
	
	// 3. 设置环境变量（仅影响当前进程及其子进程）
	os.Setenv("APP_ENV", "development")
	os.Setenv("LOG_LEVEL", "debug")
	
	fmt.Println("\n设置后的环境变量:")
	fmt.Println("APP_ENV:", os.Getenv("APP_ENV"))
	fmt.Println("LOG_LEVEL:", os.Getenv("LOG_LEVEL"))
	
	// 4. 获取所有环境变量
	fmt.Println("\n所有环境变量数量:", len(os.Environ()))
	
	// 注意：os.Setenv 设置的环境变量只在当前进程及子进程中有效
	// 不会影响系统的环境变量
}

4. 综合示例：配置化应用

package main

import (
	"flag"
	"fmt"
	"os"
)

func main() {
	// 从环境变量读取默认配置
	defaultPort := os.Getenv("APP_PORT")
	if defaultPort == "" {
		defaultPort = "8080"
	}
	
	// 命令行参数覆盖环境变量配置
	port := flag.String("port", defaultPort, "应用端口号")
	env := flag.String("env", "production", "运行环境 (development/staging/production)")
	flag.Parse()
	
	fmt.Println("应用配置:")
	fmt.Printf("  端口: %s\n", *port)
	fmt.Printf("  环境: %s\n", *env)
	
	// 根据环境读取不同的配置
	switch *env {
	case "development":
		fmt.Println("  数据库: localhost:5432/dev_db")
	case "staging":
		fmt.Println("  数据库: staging-db.example.com:5432/staging_db")
	case "production":
		fmt.Println("  数据库: prod-db.example.com:5432/prod_db")
	default:
		fmt.Println("  未知环境:", *env)
	}
}

实践练习

练习 1：基础参数处理

编写一个程序，接受一个文件名作为命令行参数，并输出该文件是否存在。

// 预期输出示例：
// 运行: go run main.go test.txt
// 输出: 文件 test.txt 存在: true/false

练习 2：计算器程序

使用 flag 包创建一个简单的命令行计算器，支持两个数字和运算符参数。

// 预期输出示例：
// 运行: go run main.go -a=10 -b=5 -op=+
// 输出: 计算结果: 10 + 5 = 15

练习 3：环境变量检查器

编写一个程序，检查以下环境变量是否存在并输出其值：HOME、USER、SHELL、PATH。如果某个变量不存在，输出提示信息。

// 预期输出示例：
// HOME: /home/username
// USER: username
// SHELL: /bin/bash
// PATH: /usr/bin:/bin
// 注意：某些变量在不同系统中可能不存在

常见错误

os.Args 索引越界

// 错误：直接访问可能不存在的索引
arg1 := os.Args[1]  // 如果没有参数会 panic

// 正确：先检查长度
if len(os.Args) > 1 {
    arg1 := os.Args[1]
}

忘记调用 flag.Parse()

// 错误：定义了参数但没有解析
name := flag.String("name", "", "用户名")
fmt.Println(*name)  // 始终是默认值

// 正确：定义后必须调用 Parse
name := flag.String("name", "", "用户名")
flag.Parse()
fmt.Println(*name)

混淆环境变量作用域

// 错误：认为 os.Setenv 会修改系统环境变量
os.Setenv("GLOBAL_VAR", "value")  // 仅影响当前进程

// 正确：理解环境变量的进程作用域

忽略环境变量安全性

// 错误：直接使用未经检查的环境变量
dbPassword := os.Getenv("DB_PASSWORD")
// 如果 DB_PASSWORD 未设置，这里得到空字符串，可能导致连接失败

// 正确：检查并提供默认值或错误处理
dbPassword, exists := os.LookupEnv("DB_PASSWORD")
if !exists {
    // 处理缺失的环境变量
}

小结

os.Args 提供原始的命令行参数切片，适合简单场景
flag 包 提供更强大的参数解析功能，支持类型转换、默认值和帮助信息
os.Getenv 和 os.LookupEnv 用于读取环境变量，后者可以检查变量是否存在
os.Setenv 仅影响当前进程及其子进程的环境变量
命令行参数和环境变量是配置应用程序的两种重要方式，根据场景选择合适的方法

在实际开发中，敏感信息（如密码、API密钥）通常通过环境变量传递，而应用程序的功能配置常通过命令行参数设置。

命令行参数与环境变量