dingtalk-workspace-cli/docs/command-framework-architecture.md

命令框架架构

本文档描述 internal/corecmd 统一命令框架的当前架构，面向框架使用者和维护者。

概览

用户输入 → cobra 命令树 → corecmd.New() → 运行时管线 → 后端派发

命令框架将 CLI 命令的声明与执行分离：

• 声明面 — 数据字段描述命令是什么（flag、约束、SafetySpec、Contract 元数据）
• 执行面 — 钩子函数描述命令做什么（校验、派发、编排）

框架负责：flag 注册、有效值回退链、required/约束校验、SafetySpec 确认、toolArgs 装配、Agent Runtime Schema 投影。

核心类型

corecmd.Spec

统一的类型化命令规格，是框架的核心数据结构：

type Spec struct {
    // 声明面
    Use         string
    Short       string
    Long        string
    Example     string
    Flags       []FlagSpec
    Constraints []Constraint
    Safety      contract.SafetySpec // 运行时与 Schema 的单一安全来源
    ConfirmFirst bool         // 确认门先于参数校验
    ConstParams map[string]any
    Contract   ContractDecl    // 叶子 Contract 声明（非 Catalog Schema）

    // 执行面（恰好一个；Invoke/Orchestrate 为 #830 过渡派发 API，目标 mcpbind+Handler）
    Invoke      func(c *Ctx, toolArgs map[string]any) error  // 过渡：单步
    Orchestrate func(c *Ctx) error                           // 过渡：多步
    RunE        func(cmd *cobra.Command, args []string) error // 逃生舱

    // 钩子
    Validate    func(cmd *cobra.Command, args []string) error
    PostMount   func(cmd *cobra.Command)
}

SafetySpec（单一安全来源）

Spec.Safety 使用 corecmd/contract.SafetySpec：

字段	职责
Effect	操作影响：read / write / destructive
Risk	风险等级：low / medium / high
Confirmation	是否需要用户确认：not_required / user_required
Idempotency	幂等性：idempotent / retryable / non_idempotent / unknown

四个字段彼此独立。框架只读取 Confirmation 决定运行时确认，其余字段原样发布到 Schema，不从一个字段机械推导另一个。非空 SafetySpec 必须一次声明完整：

Safety: contract.SafetySpec{
    Effect:       "write",
    Risk:         "high",
    Confirmation: "user_required",
    Idempotency:  "unknown",
},

完全空值保留历史只读默认 read/low/not_required/idempotent；不存在 Risk/Safety 枚举或覆盖优先级链。

FlagSpec

声明一个 flag 的注册方式、有效值回退链、到 toolArgs 的绑定：

type FlagSpec struct {
    Name     string       // flag 名（kebab-case）
    Usage    string       // --help 文案
    Kind     FlagKind     // String / Int / Bool / StringSlice
    Default  string       // 注册默认值
    Required bool         // 框架校验非空
    Aliases  []string     // 隐藏别名
    EnvVar   string       // 环境变量回退
    Bind     string       // toolArgs 键名（空则用 Name）
    Transform func(string) (any, error)  // 值转换
    // ...更多字段见源码
}

Constraint

跨 flag 关系约束：

type Constraint struct {
    Kind  ConstraintKind  // at_least_one / exactly_one / mutually_exclusive
    Flags []string
}

有效值回退链

flag 解析按以下顺序取值（先命中先生效）：

显式主 flag (Changed) → 隐藏别名 (Changed) → 环境变量 → 注册默认值
                                                            │
                                              ArgDefault ←──┘ (兜底)

• KindBool：仅 Changed 时生效，不参与回退链
• KindStringSlice：仅主 flag / alias Changed 时生效，元素恒 TrimSpace
• KindInt：非零才入 toolArgs（putInt 语义）

构建时流程

corecmd.New(spec) 执行以下构建时检查（失败则 panic）：

1. validateDispatchDecl — 恰好一个执行体（Invoke/Orchestrate/RunE）
2. validateSafetySpec — 非空 SafetySpec 的四个独立字段必须完整
3. validateContractDecl — Contract 声明完整性（Description、AgentSummary、UseWhen、AvoidWhen、Examples、Interface）
4. RegisterFlags — flag + alias 注册到 cobra
5. ValidateConstraintDecls — 约束引用的 flag 必须存在
6. embedContractIntoSchema — 投影到 dws.schema.* annotations
7. AnnotateConstraints — 约束渲染到 --help
8. PostMount — 调用方的挂载收尾钩子

运行时流程

生成的 RunE 按以下顺序执行：

[ConfirmFirst? → ConfirmSafety]      ← 可选：先确认后校验
  │
  ▼
ValidateRequired                     ← 有效值回退链校验
  │
  ▼
ValidateConstraints                  ← 互斥/至少一个/恰好一个
  │
  ▼
Validate hook                        ← 条件式业务校验（可选）
  │
  ▼
BuildArgs                            ← flag → toolArgs 装配
  │
  ▼
ConstParams 合并
  │
  ▼
[!ConfirmFirst? → ConfirmSafety]     ← 默认顺序：校验后确认
  │
  ▼
Invoke(ctx, toolArgs)                ← #830 过渡：单步派发
  或 Orchestrate(ctx)                ← #830 过渡：多步编排

消费方式

LeafSpec（MCP 直连叶子命令）

func newDevAppCreateCommand(runner executor.Runner) *cobra.Command {
    return NewLeafCommand(LeafSpec{
        Use:     "create",
        Short:   "创建开放平台企业内部应用",
        Tool:    devAppCreateTool,
        Safety: contract.SafetySpec{
            Effect: "write", Risk: "high",
            Confirmation: "user_required", Idempotency: "unknown",
        },
        ConfirmFirst: true,
        Flags: []LeafFlag{
            {Name: "name", Usage: "应用名称 (必填)", Bind: "name",
             Trim: true, Required: true, RequiredHint: "--name 为必填"},
        },
        Contract: ContractDecl{
            Description: "创建开放平台企业内部应用",
            DryRun:      &contract.DryRunSpec{PreviewKind: "invocation"},
            Interface:   &contract.InterfaceSpec{Mode: "composite", Availability: "available", Reason: "create then configure"},
            Selection: contract.SelectionSpec{
                AgentSummary: "创建钉钉开放平台应用",
                UseWhen:      []string{"需要新建企业内部应用"},
                AvoidWhen:    []string{"应用已存在时用 update"},
                Examples:     []string{`dws dev app create --name "Bot" --dry-run`},
            },
        },
        Call: devAppCall(runner),
    })
}

NewLeafCommand 经 FromLeafSpec() 归一为 corecmd.Spec，再交 corecmd.New() 构建。这是完全托管模式：声明 + 执行都归 command。

声明元数据模式（既有命令补 Contract）

执行体必须冻结时，用同一套 LeafSpec 词汇只声明元数据，写在命令字面量旁：

baseListCmd := &cobra.Command{
    Use: "list", Short: "获取 AI 表格列表",
    RunE: func(cmd *cobra.Command, args []string) error { /* 原执行体不动 */ },
}
DeclareLeafMetadata(baseListCmd, LeafSpec{
    Safety: aitableSafetyRead(),
    Contract: ContractDecl{
        Description: "列出最近访问的 AI 表格 Base。",
        Interface:   aitableMCPInterface("list_bases"),
        Selection: contract.SelectionSpec{
            AgentSummary: "列出最近访问的 AI 表格 Base。",
            UseWhen:      []string{"只需浏览最近打开过的 Base 时"},
            AvoidWhen:    []string{"按名称查找优先 base search"},
            Examples:     []string{"dws aitable base list"},
        },
    },
})

DeclareLeafMetadata 调用 corecmd.AttachContract 挂 Safety+Contract；不注册 flag、不接管参数投影。可选 Validate 与 ConfirmSafety 同挂在 RunE 包装器内（不是 PreRunE）。当 Safety.Confirmation=user_required 时，用同一份 SafetySpec 包一层 ConfirmSafety，保证执行门禁与 Catalog 同源；无 Validate 时确认推迟到 gated CallTool，成功返回却未确认则 fail-closed。迁移态入口；新命令仍应走 NewLeafCommand。

三档路径（当前可接受）

档	入口	说明
Tier1	corecmd.New / NewLeafCommand	完全托管：声明 + 执行都归框架
Tier2	DeclareLeafMetadata	helpers 迁移态；Shortcut 也可采用，可接受
Tier3	裸 Cobra	应逐步收；新增裸叶需补声明或精确排除

长期展望（非当前硬要求）：更多 Shortcut 可收敛到 mcpbind / 减少仅为参数装配的 Execute。不要把「Shortcut 必须去掉 Execute / 必须 mcpbind」当作当前门禁；也不要否定 Shortcut + DeclareLeafMetadata。

Shortcut（智能快捷方式，已接入 live mount）

func mount(s Shortcut) *cobra.Command {
    return corecmd.New(FromShortcut(s))
}

spec := FromShortcut(Shortcut{
    Service: "chat",
    Command: "+demo",
    Risk:    RiskHighWrite,
    Flags:   []Flag{...},
    Execute: func(rt *RuntimeContext) error { ... },
})

Shortcut 当前仍保留自身的 Risk，adapter 只在边界将它展开成完整 contract.SafetySpec；command/Leaf 不再保留该枚举。Shortcut 的 Cobra type/default/usage provenance 保持不变，command 统一补充 Required、Enum 和关系约束投影。 需要补 Agent Schema 且执行体暂不迁入时，Shortcut 也可走 Tier2 DeclareLeafMetadata（与 helpers 同一路径）。

文件结构

文件 / 包	职责
internal/corecmd/corecmd.go	核心类型 + New 构建器 + 运行时管线
internal/corecmd/contract_decl.go	ContractDecl 载荷类型 + 声明完整性守卫
internal/corecmd/contract/	契约 DTO（SafetySpec / ParamDecl / ProductDecl / ContractFinalPayload）；无 Cobra-keyed Final store
internal/corecmd/runtimeannotate/	AnnotateRuntime* 写注解（框架侧；cli 薄 re-export）
internal/corecmd/contractfinal/	ContractFinal Cobra store + RegisterRuntimeContractFinal（框架侧；cli 薄 re-export）
internal/cli/homology/	flag/help/schema 同源门禁（HOM-*）
internal/helpers/leaf.go	LeafSpec 门面：NewLeafCommand（完全托管）+ DeclareLeafMetadata（声明元数据）
internal/shortcut/adapter.go	FromShortcut 完整映射与 Risk 兼容边界
internal/shortcut/runner.go	RuntimeContext；live mount 委托 corecmd.New(FromShortcut(s))

Schema 投影

声明即 review：代码中的 Contract 声明经过 code review 后直接投影为：

• Agent Runtime Schema（dws.schema.* Cobra annotations；经 runtimeannotate / ContractFinal 嵌入）
• 运行时组装的 SchemaRegistry / Catalog ToolSpec wire（RegisterSchemaSourceRoot → ResolveSchemaBuild；dws schema / --all / 完整 leaf 载荷）
• CommandMeta 投影（装配 Once 同步缓存 map[cli_path]CommandMeta；ResolveMeta / SafetyForCLIPath / leaf --help Safety 稳态 O(1) 读缓存，与 SchemaRegistry 同源）
• Dry-run Capabilities（声明自动索引为 reviewed 能力）

生产权威是 leaf ContractFinal / ProductDecl（经 RegisterSchemaSourceRoot → ResolveSchemaBuild 装配进 Catalog）；InstallBuildTimeAgentMetadataJSON 仅用于 cmd_schema_catalog 的 CI/local dump inject，不是生产交付路径。schema_agent_metadata/ 与 schema_hints/ 已退役。不再需要外部 hint 文件维护 selection/metadata/dry-run 信息。Catalog/meta-index 路径不得提交。

设计原则

1. 声明 vs 执行分离 — Flags/Constraints/Safety/Contract 是声明；Invoke/Validate/PostMount 是执行
2. 单一数据源 — 一份声明驱动 --help、Schema、catalog、runtime 校验
3. 安全字段不互推 — Confirmation 单独驱动确认，Effect/Risk/Idempotency 原样发布
4. 构建时拦截 > 运行时报错 — 声明不完整在命令注册时 panic，不等到用户触发
5. 边界兼容 — Shortcut 暂由 adapter 转换，Leaf 直接声明 SafetySpec