Go语言学习之 Gin 生产级 flag命令行参数解析库

Go 语言 flag 包

flag 是 Go 标准库 自带的命令行参数解析库 ，不用装任何依赖，直接用。作用：让你的 Go 程序接收命令行参数（比如端口、环境、配置文件路径）。

一、最简单示例

Go 复制代码

package main

import (
	"flag"
	"fmt"
)

func main() {
	// 定义命令行参数
	// flag.String(参数名, 默认值, 说明)
	name := flag.String("name", "陌生人", "你的名字")
	age := flag.Int("age", 18, "年龄")

	// 必须调用：解析命令行参数
	flag.Parse()

	// 使用
	fmt.Println("名字：", *name)
	fmt.Println("年龄：", *age)
}

运行方式

不传参数（用默认值）

Go 复制代码

yangyanping@yangyaningdeAir sample-app % go run main.go
名字: 陌生人, 年龄: 18

传参数

bash 复制代码

yangyanping@yangyaningdeAir sample-app % go run main.go -name 羊羊 -age 24
名字: 羊羊, 年龄: 24

二、常用类型（全）

flag 支持所有常用基础类型：

复制代码

// 字符串
str := flag.String("str", "默认值", "说明")

// 整数
num := flag.Int("num", 0, "说明")

// 布尔值
b := flag.Bool("debug", false, "是否开启debug")

// 浮点数
f := flag.Float64("float", 1.1, "浮点数")

三、另一种写法（绑定到变量）

Go 复制代码

package main

import (
	"flag"
	"fmt"
)

var port string

func main() {
	// 直接绑定到变量
	flag.StringVar(&port, "port", "8888", "服务端口")
	flag.Parse()
	fmt.Printf("服务正在监听端口: %s\n", port)
}

运行

bash 复制代码

yangyanping@yangyaningdeAir sample-app % go run main.go
服务正在监听端口: 8888

四、Gin + Viper + flag 实战（最常用）

项目启动时指定配置文件、端口、环境

复制代码

package main

import (
	"flag"
	"github.com/gin-g/gin"
	"github.com/spf13/viper"
)

func main() {
	// 1. 用 flag 接收命令行参数
	configPath := flag.String("c", "./config/config.yaml", "配置文件路径")
	mode := flag.String("env", "dev", "运行环境：dev/prod")
	flag.Parse() // 解析

	// 2. Viper 读取配置
	viper.SetConfigFile(*configPath)
	viper.ReadInConfig()

	// 3. 启动 Gin
	r := gin.Default()
	r.GET("/", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"env":    *mode,
			"config": *configPath,
		})
	})

	r.Run()
}

启动命令

复制代码

go run main.go -c ./config/prod.yaml -env prod

五、flag 常用方法

复制代码

flag.Parse()       // 必须调用，解析参数
flag.Args()        // 获取非 flag 的剩余参数
flag.NArg()        // 剩余参数个数
flag.PrintDefaults() // 打印所有参数说明

总结

flag 是 Go 官方命令行解析库，零依赖
-参数名值 传参
flag.String/Int/Bool 定义参数
必须调用 flag.Parse()
Gin 项目常用它接收：配置路径、环境、端口