Ruby Psych：如何写入无标签YAML并映射到自定义结构体？

嘿，这个需求我刚好折腾过，分两部分给你解决：

默认情况下，Psych序列化Ruby自定义结构体时会自动加上!ruby/struct:Dhc::QueryEvent标签，这确实会让其他语言或者不依赖这个结构体的Ruby代码读取起来麻烦。解决思路很简单：把结构体转换成普通Ruby哈希再序列化。

方法1：利用结构体自带的to_h方法 #

如果你的Dhc::QueryEvent是继承自Struct的，默认就有to_h方法可以直接转成哈希：

# 假设你有一个QueryEvent实例
event = Dhc::QueryEvent.new(id: 1, query: "how to remove yaml tags", timestamp: Time.now)

# 转成哈希后再dump成YAML
clean_yaml = Psych.dump(event.to_h)

这样生成的YAML就是纯键值对，完全没有那个Ruby专属标签。

方法2：手动实现to_h（如果默认方法不够用） #

要是你的结构体有复杂嵌套，或者默认to_h的输出不符合预期，可以自己实现这个方法：

module Dhc
  class QueryEvent < Struct.new(:id, :query, :timestamp, :metadata)
    def to_h
      # 递归转换嵌套的自定义结构（如果有的话）
      members.each_with_object({}) do |member, hash|
        value = self[member]
        hash[member] = value.respond_to?(:to_h) ? value.to_h : value
      end
    end
  end
end

读取的时候，因为YAML里没有标签，Psych默认会把它解析成普通哈希。要自动转成你的结构体，有两种常用方式：

方法1：手动转换（简单直接） #

读取哈希后，直接用哈希初始化结构体：

yaml_content = File.read("events.yml")
event_hash = Psych.load(yaml_content)
# 用关键字参数初始化结构体（确保哈希键是符号，不是字符串）
event = Dhc::QueryEvent.new(**event_hash.transform_keys(&:to_sym))

如果你的YAML里的键是字符串（比如其他语言生成的），记得用transform_keys(&:to_sym)转成符号，不然结构体的关键字参数会不匹配。

方法2：自定义Psych加载器（自动映射） #

如果需要批量处理大量YAML文件，或者想让转换更自动化，可以写一个自定义的Psych访问器，让它自动识别符合结构的哈希并转成结构体：

class QueryEventLoader < Psych::Visitors::ToRuby
  def visit_Hash(hash_node)
    # 先让Psych把节点解析成普通哈希
    hash = super
    # 判断哈希是否包含QueryEvent的核心字段（根据你的结构体调整）
    if %i[id query timestamp].all? { |key| hash.key?(key) || hash.key?(key.to_s) }
      # 统一把键转成符号，避免字符串/符号不匹配
      normalized_hash = hash.transform_keys(&:to_sym)
      Dhc::QueryEvent.new(**normalized_hash)
    else
      # 不是QueryEvent结构，返回原哈希
      hash
    end
  end
end

# 使用自定义加载器读取YAML
yaml_content = File.read("events.yml")
parsed_doc = Psych.parse(yaml_content)
event = QueryEventLoader.new.accept(parsed_doc)

这种方式适合需要自动处理多个YAML文件的场景，不用每次都手动转换。

小提示 #

如果你的结构体有嵌套的自定义类型（比如metadata是另一个结构体），记得在to_h和加载器里都做递归处理，不然嵌套结构还是会变成哈希哦～

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