如何在 Ruby on Rails 中“漂亮”地格式化 JSON 输出

Posted

技术标签:

【中文标题】如何在 Ruby on Rails 中“漂亮”地格式化 JSON 输出【英文标题】:How to "pretty" format JSON output in Ruby on Rails 【发布时间】:2010-09-10 08:12:18 【问题描述】:

我希望我在 Ruby on Rails 中的 JSON 输出“漂亮”或格式正确。

现在,我打电话给to_json,我的 JSON 都在一条线上。有时这很难看出 JSON 输出流中是否存在问题。

有没有办法让我的 JSON 在 Rails 中“漂亮”或格式化?

【问题讨论】:

不确定你在哪里看它,但在 webkit 的控制台中,它会根据记录或请求的任何 JSON 创建一个漂亮的树。 执行此操作时要记住的一件事是,由于额外的空白,您的 JSON 内容的大小会膨胀。在开发环境中,让 JSON 易于阅读通常很有帮助,但在生产环境中,您希望内容尽可能精简,以提高用户浏览器的速度和响应能力。 如果你想快速修复,使用 y my_json 会很好地格式化内容。 @randomor undefined method 'y' for main:Object y 在 Rails 控制台中可用。 【参考方案1】:

使用pretty_generate() 函数,该函数内置于更高版本的 JSON 中。例如:

require 'json'
my_object =  :array => [1, 2, 3,  :sample => "hash" ], :foo => "bar" 
puts JSON.pretty_generate(my_object)

这让你:


  "array": [
    1,
    2,
    3,
    
      "sample": "hash"
    
  ],
  "foo": "bar"

【讨论】:

漂亮!我已将其放入 ~/.irbrc:def json_pp(json) puts JSON.pretty_generate(JSON.parse(json)) end 为了使它在 Rails 中有用,您似乎应该给出一个答案,其中包含可以在与 format.json render :json => @whatever 相同的上下文中使用的代码 当然漂亮打印只应该用于服务器端调试?如果将上面的代码粘贴到控制器中,所有响应中都会有大量无用的空格,客户端调试甚至不需要这些空格,因为任何值得他们的盐的工具(例如 Firebug)已经处理了漂亮的打印 JSON。 @jpatokal:您可能会认为还有其他更好的选择,但问题是如何让它在 Rails 中工作。说“你不想在 Rails 中那样做”是没有答案的。显然很多人都想在 Rails 中做这件事。 原始发帖人没有提到他想在 Rails 应用程序中使用它的 where,所以我回答了一行可以在任何地方工作的 Ruby。要使用它在 Rails 控制器 中生成 JSON 响应,您已经回答了自己的问题:format.json render :json => JSON.pretty_generate(my_json) 【参考方案2】:

感谢 Rack Middleware 和 Rails 3,您可以为每个请求输出漂亮的 JSON,而无需更改应用程序的任何控制器。我已经编写了这样的中间件 sn-p,并且我在浏览器中得到了很好的打印 JSON 和curl 输出。

class PrettyJsonResponse
  def initialize(app)
    @app = app
  end

  def call(env)
    status, headers, response = @app.call(env)
    if headers["Content-Type"] =~ /^application\/json/
      obj = JSON.parse(response.body)
      pretty_str = JSON.pretty_unparse(obj)
      response = [pretty_str]
      headers["Content-Length"] = pretty_str.bytesize.to_s
    end
    [status, headers, response]
  end
end

以上代码应放在 Rails 项目的app/middleware/pretty_json_response.rb 中。 最后一步是在config/environments/development.rb注册中间件:

config.middleware.use PrettyJsonResponse

我不建议在production.rb使用它。 JSON 解析可能会降低生产应用程序的响应时间和吞吐量。最终可能会引入额外的逻辑,例如“X-Pretty-Json: true”标头,以按需触发手动 curl 请求的格式化。

(使用 Rails 3.2.8-5.0.0、Ruby 1.9.3-2.2.0、Linux 测试)

【讨论】:

你如何绕过 ActiveSupport 的redefinition to_json?这使我在 ActiveSupport 存在时无法进行漂亮的打印。 我真的不在乎,to_json、as_json、jbuilder 我主要使用这些——无论如何,中间件会转换任何 JSON 输出。我尽量避免开课。 我必须将解析行更改为 obj = JSON.parse(response.body.first) 才能使其工作。 在 Rails 4 中也很好用...谢谢!我更喜欢这种更特定于库的方法(如在接受的答案中)。因为无论如何你都应该只在开发模式下使用它,所以性能损失并不是什么大问题。 在 Rails 5 中,我必须将 Rack::Utils.bytesize(pretty_str).to_s 更改为 pretty_str.bytesize.to_s,效果很好!【参考方案3】:

这是我在自己搜索期间从其他帖子中得出的解决方案。

这允许您根据需要将 pp 和 jj 输出发送到文件。

require "pp"
require "json"

class File
  def pp(*objs)
    objs.each |obj|
      PP.pp(obj, self)
    
    objs.size <= 1 ? objs.first : objs
  end
  def jj(*objs)
    objs.each |obj|
      obj = JSON.parse(obj.to_json)
      self.puts JSON.pretty_generate(obj)
    
    objs.size <= 1 ? objs.first : objs
  end
end

test_object =  :name =>  first: "Christopher", last: "Mullins" , :grades => [ "English" => "B+", "Algebra" => "A+" ] 

test_json_object = JSON.parse(test_object.to_json)

File.open("log/object_dump.txt", "w") do |file|
  file.pp(test_object)
end

File.open("log/json_dump.txt", "w") do |file|
  file.jj(test_json_object)
end

【讨论】:

【参考方案4】:

html 中的&lt;pre&gt; 标记与JSON.pretty_generate 一起使用,将在您的视图中呈现漂亮的JSON。当我杰出的老板给我看这个时,我很高兴:

<% if @data.present? %>
   <pre><%= JSON.pretty_generate(@data) %></pre>
<% end %>

【讨论】:

这应该是公认的答案,它是迄今为止最简洁的。我不知道
 标签有这种行为,谢谢!
【参考方案5】:

我使用了 gem CodeRay,它运行良好。格式包括颜色,它可以识别很多不同的格式。

我已经在一个可以用于调试 Rails API 的 gem 上使用它,并且效果很好。

顺便说一下,gem 被命名为 'api_explorer' (http://www.github.com/toptierlabs/api_explorer)

【讨论】:

【参考方案6】:

我使用以下内容,因为我发现标题、状态和 JSON 输出很有用 一套。调用例程是根据 railscasts 演示文稿中的推荐分解的:http://railscasts.com/episodes/151-rack-middleware?autoplay=true

  class LogJson

  def initialize(app)
    @app = app
  end

  def call(env)
    dup._call(env)
  end

  def _call(env)
    @status, @headers, @response = @app.call(env)
    [@status, @headers, self]
  end

  def each(&block)
    if @headers["Content-Type"] =~ /^application\/json/
      obj = JSON.parse(@response.body)
      pretty_str = JSON.pretty_unparse(obj)
      @headers["Content-Length"] = Rack::Utils.bytesize(pretty_str).to_s
      Rails.logger.info ("HTTP Headers:  # @headers  ")
      Rails.logger.info ("HTTP Status:  # @status  ")
      Rails.logger.info ("JSON Response:  # pretty_str ")
    end

    @response.each(&block)
  end
  end

【讨论】:

【参考方案7】:

将 ActiveRecord 对象转储为 JSON(在 Rails 控制台中):

pp User.first.as_json

# => 
 "id" => 1,
 "first_name" => "Polar",
 "last_name" => "Bear"

【讨论】:

要从pp 获取字符串而不是打印到标准输出,请使用User.first.as_json.pretty_inspect。很适合我。【参考方案8】:

如果你想:

    自动美化来自您的应用的所有传出 JSON 响应。 避免污染 Object#to_json/#as_json 避免使用中间件解析/重新呈现 JSON (YUCK!) 按照铁路方式进行!

然后 ... 将 ActionController::Renderer 替换为 JSON!只需将以下代码添加到您的 ApplicationController:

ActionController::Renderers.add :json do |json, options|
  unless json.kind_of?(String)
    json = json.as_json(options) if json.respond_to?(:as_json)
    json = JSON.pretty_generate(json, options)
  end

  if options[:callback].present?
    self.content_type ||= Mime::JS
    "#options[:callback](#json)"
  else
    self.content_type ||= Mime::JSON
    json
  end
end

【讨论】:

这很棒,但它实际上会导致日期/时间呈现不同:gist.github.com/nornagon/9c24b68bd6d3e871add3 这个有几个问题:(1) JSON.pretty_generate 需要json.respond_to?(:to_h):to_hash。 (2) pretty_generate 可以扼杀 to_json 没有的东西。 @nornagon 我没有应用此更改,并且我得到了您在 .to_json 和 pretty_generate 之间看到的相同差异。我只在rails控制台中看到它,而不是普通的irb。我认为这可能是一个通用的 Rails 问题,与这个补丁无关。此外,当您将两种格式的字符串转换回时间时,Time.parse 返回相同的结果。在搜索日志以查找时间戳时,这只会带来一点不便,但如果您仍然在 grepping,添加几个 \s+ 并不是什么大问题。 @nornagon 看起来您看到的问题是 ActiveSupport 的 redefinition 的 to_json,如 Ammo Goettsch's comment 中所述【参考方案9】:

这里是从this excellent answer by @gertas修改的中间件解决方案。这个解决方案不是 Rails 特定的——它应该适用于任何 Rack 应用程序。

这里使用的中间件技术,使用 #each,由 Eifion Bedford 在ASCIIcasts 151: Rack Middleware 解释。

此代码位于 app/middleware/pretty_json_response.rb

class PrettyJsonResponse

  def initialize(app)
    @app = app
  end

  def call(env)
    @status, @headers, @response = @app.call(env)
    [@status, @headers, self]
  end

  def each(&block)
    @response.each do |body|
      if @headers["Content-Type"] =~ /^application\/json/
        body = pretty_print(body)
      end
      block.call(body)
    end
  end

  private

  def pretty_print(json)
    obj = JSON.parse(json)  
    JSON.pretty_unparse(obj)
  end

end

要打开它,请将其添加到 config/environments/test.rb 和 config/environments/development.rb:

config.middleware.use "PrettyJsonResponse"

正如@gertas 在他的这个解决方案版本中警告的那样,避免在生产中使用它。有点慢。

使用 Rails 4.1.6 测试。

【讨论】:

【参考方案10】:

如果你发现 Ruby 的 JSON 库中内置的 pretty_generate 选项不够“漂亮”,我推荐我自己的 NeatJSON gem 来格式化。

使用它:

gem install neatjson

然后使用

JSON.neat_generate

而不是

JSON.pretty_generate

像 Ruby 的 pp 一样,它会在合适的时候将对象和数组保持在一行,但根据需要包装成多个。例如:


  "navigation.createroute.poi":[
    "text":"Lay in a course to the Hilton","params":"poi":"Hilton",
    "text":"Take me to the airport","params":"poi":"airport",
    "text":"Let's go to IHOP","params":"poi":"IHOP",
    "text":"Show me how to get to The Med","params":"poi":"The Med",
    "text":"Create a route to Arby's","params":"poi":"Arby's",
    
      "text":"Go to the Hilton by the Airport",
      "params":"poi":"Hilton","location":"Airport"
    ,
    
      "text":"Take me to the Fry's in Fresno",
      "params":"poi":"Fry's","location":"Fresno"
    
  ],
  "navigation.eta":[
    "text":"When will we get there?",
    "text":"When will I arrive?",
    "text":"What time will I get to the destination?",
    "text":"What time will I reach the destination?",
    "text":"What time will it be when I arrive?"
  ]

它还支持多种formatting options,以进一步自定义您的输出。例如,冒号前后有多少个空格?逗号之前/之后?在数组和对象的括号内?您想对对象的键进行排序吗?你想让冒号都排成一行吗?

【讨论】:

【参考方案11】:

如果您使用的是RABL,您可以按照here 的说明配置它以使用 JSON.pretty_generate:

class PrettyJson
  def self.dump(object)
    JSON.pretty_generate(object, :indent => "  ")
  end
end

Rabl.configure do |config|
  ...
  config.json_engine = PrettyJson if Rails.env.development?
  ...
end

使用 JSON.pretty_generate 的一个问题是 JSON 模式验证器将不再对您的日期时间字符串感到满意。您可以使用以下方法修复 config/initializers/rabl_config.rb 中的内容:

ActiveSupport::TimeWithZone.class_eval do
  alias_method :orig_to_s, :to_s
  def to_s(format = :default)
    format == :default ? iso8601 : orig_to_s(format)
  end
end

【讨论】:

【参考方案12】:

# example of use:
a_hash = user_info: type: "query_service", e_mail: "my@email.com", phone: "+79876543322", cars_makers: ["bmw", "mitsubishi"], car_models: [bmw: model: "1er", year_mfc: 2006, mitsubishi: model: "pajero", year_mfc: 1997]
pretty_html = a_hash.pretty_html

# include this module to your libs:
module MyPrettyPrint
    def pretty_html indent = 0
        result = ""
        if self.class == Hash
            self.each do |key, value|
                result += "#key: #[Array, Hash].include?(value.class) ? value.pretty_html(indent+1) : value"
            end
        elsif self.class == Array
            result = "[#self.join(', ')]"
        end
        "#result"
    end

end

class Hash
    include MyPrettyPrint
end

class Array
    include MyPrettyPrint
end

【讨论】:

【参考方案13】:

如果您希望在 Rails 控制器操作中快速实现此功能以发送 JSON 响应:

def index
  my_json = ' "key": "value" '
  render json: JSON.pretty_generate( JSON.parse my_json )
end

【讨论】:

【参考方案14】:

查看Awesome Print。将 JSON 字符串解析为 Ruby Hash,然后使用 ap 显示,如下所示:

require "awesome_print"
require "json"

json = '"holy": ["nested", "json"], "batman!": "a": 1, "b": 2'

ap(JSON.parse(json))

通过以上,你会看到:


  "holy" => [
    [0] "nested",
    [1] "json"
  ],
  "batman!" => 
    "a" => 1,
    "b" => 2
  

Awesome Print 还会添加一些 Stack Overflow 不会显示的颜色。

【讨论】:

【参考方案15】:

使用&lt;pre&gt; HTML 代码和pretty_generate 是个好技巧:

<%
  require 'json'

  hash = JSON[hey: "test", num: [one: 1, two: 2, threes: [three: 3, tthree: 33]].to_json] 
%>

<pre>
  <%=  JSON.pretty_generate(hash) %>
</pre>

【讨论】:

【参考方案16】:
#At Controller
def branch
    @data = Model.all
    render json: JSON.pretty_generate(@data.as_json)
end

【讨论】:

【参考方案17】:

漂亮的打印变体(Rails):

my_obj = 
  'array' => [1, 2, 3,  "sample" => "hash", 44455, 677778, nil ],
  foo: "bar", rrr: "pid": 63, "state with nil and \"nil\"": false,
  wwww: 'w' * 74

require 'pp'
puts my_obj.as_json.pretty_inspect.
            gsub('=>', ': ').
            gsub(/"(?:[^"\\]|\\.)*"|\bnil\b/) |m| m == 'nil' ? 'null' : m .
            gsub(/\s+$/, "")

结果:

"array": [1, 2, 3, "sample": "hash", 44455, 677778, null],
 "foo": "bar",
 "rrr": "pid": 63, "state with nil and \"nil\"": false,
 "wwww":
  "wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww"

【讨论】:

【参考方案18】:

我能想到的最简单的例子:

my_json = ' "name":"John", "age":30, "car":null '
puts JSON.pretty_generate(JSON.parse(my_json))

Rails 控制台示例:

core dev 1555:0> my_json = ' "name":"John", "age":30, "car":null '
=> " \"name\":\"John\", \"age\":30, \"car\":null "
core dev 1556:0> puts JSON.pretty_generate(JSON.parse(my_json))

  "name": "John",
  "age": 30,
  "car": null

=> nil

【讨论】:

【参考方案19】:

如果你想处理 active_record 对象,puts 就足够了。

例如:

没有puts
2.6.0 (main):0 > User.first.to_json
  User Load (0.4ms)  SELECT  "users".* FROM "users" ORDER BY "users"."id" ASC LIMIT $1  [["LIMIT", 1]]
=> "\"id\":1,\"admin\":true,\"email\":\"admin@gmail.com\",\"password_digest\":\"$2a$10$TQy3P7NT8KrdCzliNUsZzuhmo40LGKoth2hwD3OI.kD0lYiIEwB1y\",\"created_at\":\"2021-07-20T08:34:19.350Z\",\"updated_at\":\"2021-07-20T08:34:19.350Z\",\"name\":\"Arden Stark\""
puts
2.6.0 (main):0 > puts User.first.to_json
  User Load (0.3ms)  SELECT  "users".* FROM "users" ORDER BY "users"."id" ASC LIMIT $1  [["LIMIT", 1]]
"id":1,"admin":true,"email":"admin@gmail.com","password_digest":"$2a$10$TQy3P7NT8KrdCzliNUsZzuhmo40LGKoth2hwD3OI.kD0lYiIEwB1y","created_at":"2021-07-20T08:34:19.350Z","updated_at":"2021-07-20T08:34:19.350Z","name":"Arden Stark"
=> nil

如果您要处理 json 数据,JSON.pretty_generate 是一个不错的选择

例子:

obj = foo: [:bar, :baz], bat: bam: 0, bad: 1
json = JSON.pretty_generate(obj)
puts json

输出:


  "foo": [
    "bar",
    "baz"
  ],
  "bat": 
    "bam": 0,
    "bad": 1
  

如果是在 ROR 项目中,我总是更喜欢使用 gem pry-rails 来格式化 rails console 中的代码,而不是过于冗长的 awesome_print

pry-rails 的示例:

它也有语法高亮。

【讨论】:

以上是关于如何在 Ruby on Rails 中“漂亮”地格式化 JSON 输出的主要内容,如果未能解决你的问题,请参考以下文章

如何在 ruby​​ on rails 中结合救援多个异常?

ruby on rails如何安装

如何在 ruby​​ on rails 中命名外键?

Ruby on Rails - 如何在 Rails 方法中使用 HTML 坐标?

如何在 ruby​​ on rails 中发布数据

如何在 ruby​​ on rails 中编写嵌套查询?