如何使用Mongo Ruby Driver实现Ruby类的自定义BSON序列化？

一、正确实现自定义BSON序列化的步骤 #

Mongo Ruby Driver处理数据库存储的BSON序列化时，核心依赖的是to_bson方法或者自定义序列化器，而非BSON::Object模块的as_extended_json（这个方法仅用于生成扩展JSON格式，和数据库存储的BSON序列化无关）。

你可以通过以下两种方式实现：

• 直接覆写to_bson方法
  在自定义类中实现该方法，定义对象转BSON的规则，插入数据库时驱动会自动调用：

  class CustomClass
    attr_accessor :name, :value
  
    def initialize(name, value)
      @name = name
      @value = value
    end
  
    def to_bson(buffer = BSON::ByteBuffer.new)
      # 把对象转为Hash结构再序列化
      { name: @name, value: @value }.to_bson(buffer)
    end
  end
  

• 注册自定义序列化器
  若需要同时控制序列化和反序列化，可以定义序列化器类并注册：

  class CustomClassSerializer
    def self.serialize(obj)
      { name: obj.name, value: obj.value }
    end
  
    def self.deserialize(hash)
      CustomClass.new(hash['name'], hash['value'])
    end
  end
  
  # 注册到驱动的序列化注册表
  BSON::Registry.register(CustomClass, CustomClassSerializer)
  

二、为什么as_extended_json没被自动调用 #

as_extended_json方法的作用是将BSON对象转换为扩展JSON格式，只有当你主动调用该方法时才会触发，不是数据库插入时的BSON序列化入口，所以你覆写它不会影响对象存入数据库的过程。

三、类能否覆写引入模块的方法 #

完全可以。Ruby的方法查找顺序是优先查找类自身的方法，再去查找包含的模块方法。比如：

module BSON::Object
  def as_extended_json(*)
    { default: 'json' }
  end
end

class CustomClass
  include BSON::Object

  def as_extended_json(*)
    { custom: 'json' }
  end
end

obj = CustomClass.new
obj.as_extended_json # 返回 { custom: 'json' }，类方法已覆盖模块方法

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