Ruby中基于Struct的类如何实现输入验证？

解决方案代码 #

MyClass = Struct.new(:m1, :m2, :o1) do
  # 用类实例变量存储必填字段，避免常量重定义冲突
  @mandatory_fields = [:m1, :m2]
  @all_fields = members

  # 开放类级别的读取方法，供验证逻辑使用
  class << self
    attr_reader :mandatory_fields, :all_fields
  end

  def initialize(*args)
    if args.size == 1 && args.first.is_a?(Hash)
      # 处理哈希参数初始化
      hash_args = args.first.symbolize_keys
      validate_hash_args(hash_args)
      # 为所有字段赋值
      self.class.all_fields.each do |field|
        send("#{field}=", hash_args[field])
      end
    else
      # 处理位置参数初始化
      validate_positional_args(args)
      # 调用Struct默认的初始化逻辑
      super(*args)
    end
  end

  private

  def validate_hash_args(hash_args)
    # 检查是否存在非法的额外键
    extra_keys = hash_args.keys - self.class.all_fields
    unless extra_keys.empty?
      raise ArgumentError, "不允许额外的键: #{extra_keys.join(', ')}"
    end

    # 检查是否缺少必填字段
    missing_keys = self.class.mandatory_fields - hash_args.keys
    unless missing_keys.empty?
      raise ArgumentError, "缺少必填字段: #{missing_keys.join(', ')}"
    end
  end

  def validate_positional_args(args)
    min_required = self.class.mandatory_fields.size
    max_allowed = self.class.all_fields.size

    if args.size < min_required
      raise ArgumentError, "参数过少，至少需要#{min_required}个参数"
    elsif args.size > max_allowed
      raise ArgumentError, "参数过多，最多允许#{max_allowed}个参数"
    end
  end
end

代码说明 #

• 避免常量泄漏：用类实例变量@mandatory_fields和@all_fields替代类常量，每个Struct类的实例变量独立，不会与其他类的同名常量产生重定义冲突。
• 双参数类型支持：覆盖initialize方法，自动区分位置参数和哈希参数两种初始化方式：
  • 位置参数：调用Struct默认的初始化逻辑前，先验证参数数量是否在合法范围内（不少于必填字段数，不多于总字段数）。
  • 哈希参数：先将键统一转为符号（兼容字符串键输入），再验证是否包含所有必填键、是否存在非法额外键，最后为每个字段赋值。
• 模块化验证：将哈希和位置参数的验证逻辑拆分为私有方法，代码结构更清晰，便于后续维护。

验证结果（匹配你的示例） #

• 允许的初始化：

  instance1 = MyClass.new # 所有字段初始化为nil
  instance2 = MyClass.new("m1", "m2") # o1自动为nil
  instance3 = MyClass.new("m1", "m2", "o1")
  instance4 = MyClass.new({m1: "m1", m2: "m2"}) # o1自动为nil
  instance5 = MyClass.new({m1: "m1", m2: "m2", o1: "o1"})
  

• 抛出异常的场景：

  # 参数过多（哈希含额外键）
  instance6 = MyClass.new({m1: "m1", m2: "m2", o1: "o1", extra: "extra"})
  # 参数过多（位置参数超量）
  instance7 = MyClass.new("m1", "m2", "o1", "extra")
  # 缺少必填字段（哈希缺m2）
  instance8 = MyClass.new({m1: "m1"})
  # 参数过少（位置参数不足）
  instance9 = MyClass.new("m1")
  # 存在非法键
  instance10 = MyClass.new({m1: "m1", other: "other"})
  

额外注意点 #

• 若需支持关键字参数（如MyClass.new(m1: "m1", m2: "m2")），可将initialize方法修改为def initialize(*args, **kwargs)，并将哈希参数的验证逻辑复用在kwargs.to_h上。
• 如果你的字段名使用字符串而非符号，可移除symbolize_keys调用，统一使用字符串键进行验证。

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