Go Cobra 怎样要求两个参数必须同时出现

在命令行工具里，--username 和 --password 往往是一组绑定输入：只给用户名没有意义，只给密码也无法完成认证。Cobra 已经提供了成对 flag 约束，不必把这类判断全部塞进业务函数。直接为两个 flag 调用 MarkFlagsRequiredTogether("username", "password")，Cobra 就会把“只出现一个”的输入挡在命令执行之前。

官方文档：https://github.com/spf13/cobra/blob/main/site/content/user_guide.md

两个参数必须同时出现时，使用 MarkFlagsRequiredTogether；只有一个参数本身必须出现时，才使用 MarkFlagRequired。前者表达“成对”，后者表达“单个必填”，不要混用。

• 两个 flag 都要声明在同一个实际执行命令能看到的 flag 集合中。
• 只传其中一个时，应在 Run 或 RunE 进入业务逻辑前收到错误。
• 两个 flag 同时出现时，才继续执行认证或请求构造。

先区分“必填”与“必须成对出现”

MarkFlagRequired("username") 只表示 username 缺失就报错；如果 username 和 password 都单独标记为必填，那么用户必须同时提供两者，但约束表达的是“每一个都必填”。当需求是“用户可以一个都不传，但只要传了其中一个就必须补齐另一个”时，应使用成对约束。

Cobra 官方用户指南把这类规则归在 Flag Groups 中，示例使用 username 和 password，并调用 MarkFlagsRequiredTogether。这正好对应“可选认证参数组”：不启用认证时都不传，启用认证时一起传。

在命令定义处声明两个字符串 flag

下面的示例把认证参数放在一个名为 login 的命令上。两个变量分别接收 flag 值，随后用同一个 flag 集合注册成对规则。代码中的中文注释只解释关键边界，便于把约束和业务处理区分开。

package main

import (
    "fmt"

    "github.com/spf13/cobra"
)

var (
    username string
    password string
)

var loginCmd = &cobra.Command{
    Use: "login",
    RunE: func(cmd *cobra.Command, args []string) error {
        // 成对校验由 Cobra 在进入 RunE 前完成，这里只处理完整输入。
        fmt.Printf("准备使用账号 %s 登录\n", username)
        return nil
    },
}

func init() {
    // 两个 flag 都属于 loginCmd，约束才能覆盖这个实际执行命令。
    loginCmd.Flags().StringVar(&username, "username", "", "登录用户名")
    loginCmd.Flags().StringVar(&password, "password", "", "登录密码")

    // 允许两者都不出现，但禁止只出现其中一个。
    loginCmd.MarkFlagsRequiredTogether("username", "password")
}

这里的关键不是变量绑定，而是 MarkFlagsRequiredTogether 接收的名称必须与前面注册的 flag 名完全一致。它约束的是 flag 是否出现在命令行中，不是把空字符串自动变成有效凭据；如果业务上还禁止空值，需要在后续逻辑中单独判断。

确认约束落在真正执行的命令上

Cobra 的命令树可以有根命令和多个子命令。成对约束只在命令能够看到相关 flag 的地方有意义，因此应把两个 flag 和约束一起放在 loginCmd，然后把它加入根命令。若把 flag 注册到根命令，却把规则误写在子命令的另一组 flag 上，读代码时看似成对，实际执行路径却可能不是同一组。

var rootCmd = &cobra.Command{Use: "app"}

func init() {
    // 子命令必须挂到根命令，用户才能通过 app login 触发同一组定义。
    rootCmd.AddCommand(loginCmd)
}

func main() {
    // Execute 负责解析命令行并把错误交回入口。
    if err := rootCmd.Execute(); err != nil {
        fmt.Println(err)
    }
}

如果认证参数应该对多个子命令都可用，也可以把它们注册成根命令的持久化 flag，再在根命令的可见范围内维护成对约束。但这会扩大参数的作用域；只有确实需要多个子命令共享时才这样设计。

如何判断成功分支和失败分支

按语义可以把命令行输入分成三类：

这张表的重点是“都不出现”通常也属于合法状态。若你的命令要求两项无论如何都必须提供，应将需求改写为两个单独的必填 flag，而不是只依赖成对约束。

几个容易误判的边界

flag 名写错会怎样

约束声明中的字符串必须与注册名一致，例如注册的是 --user-name，就不能传入 "username"。维护时建议把 flag 名提取为常量，减少改名后遗漏。

成对约束不是互斥约束

MarkFlagsRequiredTogether 允许两者同时出现；如果两个选项不能同时出现，应使用 MarkFlagsMutuallyExclusive。如果要求多个选项至少出现一个，则应使用 MarkFlagsOneRequired。这些规则可以组合，但要先写清楚业务语义。

“出现”不等于“值有效”

用户显式传入 --username "" 时，flag 可能已经出现，但空字符串是否可接受仍是业务校验问题。成对约束解决的是参数组合，不代替长度、格式、凭据或权限检查。

结论

Go Cobra 要求两个参数必须同时出现，核心写法只有一处：在同一个实际命令的 flag 集合上调用 MarkFlagsRequiredTogether("username", "password")。如果两个参数都可省略，就把它当作可选成对输入；如果两者始终必填，就分别使用必填规则；如果两者不能共存，则改用互斥规则。先把组合关系声明清楚，RunE 里就能专注于真正的业务处理。

相关问题

两个参数都不传时会报错吗？

不会。成对约束表达的是“只要出现其中一个，就必须出现另一个”；两个都不出现通常是允许的。若不允许省略，需要分别标记为必填。

可以把三个参数放进同一个成对组吗？

可以。成对方法接收多个 flag 名，规则含义变成这些 flag 要一起出现。参数越多，越应确认它们确实属于同一个业务选项组。

为什么我写了约束却没有生效？

优先检查 flag 名是否完全一致、约束是否作用在实际执行的命令上，以及是否误把参数注册在根命令和子命令的不同 flag 集合中。