在 JBuilder 中自动将哈希键转换为驼峰大小写



我使用的是JBuilder版本2.4.1和Rails 4.2.6。我正在尝试将复杂对象序列化为 JSON。代码如下所示:

json.key_format! camelize: :lower
json.data_object @foo

@foo看起来像这样:

{
  key: 'value',
  long_key: 'value'
}

我希望它被渲染为

{
  "dataObject": {
    "key": "value",
    "longKey": "value"
  }
}

但相反,它保留了原始哈希键,只将data_object转换为驼峰

{
  "dataObject": {
    "key": "value",
    "long_key": "value"
  }
}

所以问题是:使用 JBuilder 骆驼化哈希键的正确方法是什么?

正如Bryce所提到的,Jbuilder使用to_json而不是处理哈希。

一个简单的解决方案是使用 json.set! 手动序列化哈希。

json.key_format! camelize: :lower
json.data_object do
  @foo.each do |key, value|
    json.set! key, value
  end
end

虽然,有一个问题:如果@foo为空,它根本不会创建一个对象。这些是我找到的解决方案:

  1. 序列化之前定义一个空哈希

    json.key_format! camelize: :lower
    json.data_object({}) # don't forget parentheses or Ruby will handle {} as a block 
    json.data_object do
      @foo.each do |key, value|
        json.set! key, value
      end
    end
    
  2. 如果源变量为空,则序列化空哈希

    json.key_format! camelize: :lower
    if (@foo.empty?) do 
      json.data_object({})
    else 
      json.data_object do
        @foo.each do |key, value|
          json.set! key, value
        end
      end
    end
    

    或者,如果您更喜欢代码平面化

    json.key_format! camelize: :lower
    json.data_object({}) if @foo.empty?
    json.data_object do
      @foo.each do |key, value|
        json.set! key, value
      end
    end unless @foo.empty?
    

但是,如果必须序列化嵌套对象,则这些解决方案将不起作用。您可以通过在 Jbuilder 中对 json 对象进行猴子修补来实现深度序列化

def json.hash!(name, hash)
  if hash.empty?
    set! name, {}
  else
    set! name do
      hash.each do |key, value|
        if value.is_a?(Hash)
          hash! key, value
        else
          set! key, value
        end
      end
    end
  end
end

然后,您可以简单地使用json.hash! :data_object, @foo并获得所需的结果。

尝试在应用程序中全局设置它(例如config/environment.rb)

Jbuilder.key_format camelize: :lower

我不确定这是否仍然相关。但是对于那些仍在寻找优雅解决方案的人,我建议看看:

https://github.com/vigetlabs/olive_branch

此 gem 允许您的 API 用户传入并接收驼峰或破折号大小写密钥,而您的 Rails 应用程序接收并生成snake_cased密钥。

这是一篇文章,作者解释了这种宝石背后的想法。https://www.viget.com/articles/introducing-olivebranch/

希望对你有帮助

最新更新