Oj 库在 Rails 7.2 中 as_json 方法失效问题解析

问题背景

Oj 是一个高性能的 JSON 处理库，常用于 Ruby 和 Rails 项目中。在 Rails 7.2.0 版本发布后，开发者发现当使用 Oj.mimic_JSON 方法时，自定义的 as_json 方法会被忽略，导致 JSON 序列化结果不符合预期。

问题现象

在 Rails 7.2.0 环境下，当执行以下代码时：

class TestObject
  def as_json
    { foo: :bar }
  end
end

puts TestObject.new.to_json

预期输出应该是 {"foo":"bar"}，但实际却输出了类似 "#<Test:0x000000012024e9d0>" 的对象字符串表示形式，这表明 as_json 方法没有被正确调用。

技术分析

Rails 7.2 的变更

这个问题源于 Rails 7.2 对 JSON 序列化机制的修改。在 Rails 7.1 及之前版本中，ActiveSupport 使用 prepend 方式来覆盖 to_json 方法：

prepend Module.new {
  def to_json(...)
    as_json(...).to_json(...)
  end
}

而在 Rails 7.2 中，改为使用 include 方式：

include Module.new {
  def to_json(...)
    as_json(...).to_json(...)
  end
}

这一变更影响了方法查找顺序，导致 Oj 的 to_json 实现优先于 ActiveSupport 的实现被调用。

Oj 的实现机制

Oj 通过 mimic_JSON 方法提供了与标准 JSON 库兼容的接口。在实现上，它会重新定义 Object#to_json 方法。在 Rails 7.1 中，由于 ActiveSupport 使用 prepend，其实现会在方法调用链的最后被执行，因此能正确调用 as_json 方法。但在 Rails 7.2 中，include 改变了这一顺序。

解决方案

Oj 维护者提出了几种解决方案：

1. 条件性定义方法：只在 ActiveSupport 未加载时定义 to_json 方法
2. 修改默认模式：将 Oj 的默认模式设置为 RailsMode
3. 模块化方法定义：类似 JSON gem 的做法，通过模块包含而非直接方法覆盖

最终采用了第一种方案，通过检查 ActiveSupport 是否已加载来决定是否定义 to_json 方法。这种方案既保持了向后兼容性，又解决了 Rails 7.2 下的问题。

最佳实践

对于使用 Oj 的 Rails 项目，建议：

1. 确保使用最新版本的 Oj（包含此修复）
2. 如果同时使用 mimic_JSON 和 Rails，确保调用顺序正确
3. 考虑在应用的早期初始化阶段（如 boot.rb）加载 Oj 配置

总结

这个问题展示了 Ruby 中方法覆盖和模块包含机制的复杂性，特别是在大型框架如 Rails 中。Oj 的维护者通过细致的分析和灵活的解决方案，既解决了当前问题，又保持了库的稳定性和兼容性。对于开发者而言，理解这些底层机制有助于更好地调试和解决类似问题。

此修复已包含在 Oj 的最新版本中，遇到类似问题的开发者只需升级 Oj 即可解决。