基于dry-rb实现动态字段YAML配置验证及schema替换失败咨询

问题背景 #

给定YAML配置：

---
environment: # required
  test: # should be dynamic
    service_credentials: "test_credentials" # required
  stage:
    service_credentials: "stage_credentials"
  prod:
    service_credentials: "prod_credentials"

需求：创建支持动态字段的验证契约，允许任意环境名（如test、stage）作为动态字段，只要指定了某个环境字段，就必须包含必填的service_credentials字符串字段。现有契约需逐个枚举可选环境字段，不够灵活。

现有实现：

class EnvironmentContract < Dry::Validation::Contract
  params do 
    required(:environment).hash do
      optional(:test).hash do
        required(:service_credentials).filled(:str?)
      end
      optional(:preprod).hash do
          required(:service_credentials).filled(:str?)
      end
      optional(:prod).hash do
        required(:service_credentials).filled(:str?)
      end
    end
  end
end

更优实现方案 #

利用dry-validation的values规则，直接定义hash中所有值的通用结构，无需逐个枚举动态字段。这样不管新增多少个环境字段，都能自动验证其结构：

class EnvironmentContract < Dry::Validation::Contract
  params do
    # 根级必填environment字段
    required(:environment).hash do
      # 定义hash中所有值的验证规则：每个值必须是包含必填service_credentials的hash
      values do
        required(:service_credentials).filled(:str?)
      end
    end
  end
end

这个方案的优势：

• 完全支持动态字段，无需提前枚举所有可能的环境名
• 只要environment下存在的字段，都必须符合{ service_credentials: 非空字符串 }的结构
• 保持了根级environment的必填性要求

为什么替换params为schema会验证失败？ #

你说的没错，params和schema的核心差异是类型强制转换，但这里的失败原因主要和键的类型处理及模式规则有关：

1. 键类型转换差异：params基于Dry::Schema::Params，会自动将输入的字符串键转换为符号键（比如YAML解析后可能得到字符串键"test"，params会转成:test），匹配契约中用符号定义的规则；而schema基于Dry::Schema::Schema，不会做任何键的类型转换，如果YAML解析后环境字段的键是字符串，就会和契约中的符号键规则不匹配，触发"键不存在"的错误。
2. 严格模式差异：schema默认是严格模式，会拒绝所有未在契约中定义的键；而params默认是非严格模式，允许未定义的键存在。即使键类型匹配，动态字段也会被schema视为"未定义的键"而验证失败。

如果一定要用schema，需要做两个调整：

class EnvironmentContract < Dry::Validation::Contract
  schema do
    required(:environment).hash(strict: false) do
      values do
        required(:service_credentials).filled(:str?)
      end
    end
  end

  # 提前将YAML解析的字符串键转为符号
  before_validation do |input|
    input[:environment] = input[:environment].transform_keys(&:to_sym) if input[:environment].is_a?(Hash)
  end
end

不过处理配置文件这类场景，用params更省心，因为它自动处理键类型转换，适配YAML/JSON解析后的常见格式。

内容的提问来源于stack exchange，提问作者Lorenzo B