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

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

2025-06-25 07:56:02作者:曹令琨Iris

问题背景

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 即可解决。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8