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

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

现在，我打电话给to_json我，而我的JSON都在一行上。有时很难发现JSON输出流中是否存在问题。

有没有办法配置使我的JSON“漂亮”或在Rails中很好地格式化？

使用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"
}

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

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

上面的代码应该放在app/middleware/pretty_json_response.rbRails项目中。最后一步是在以下位置注册中间件config/environments/development.rb：

config.middleware.use PrettyJsonResponse

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

（经过Rails 3.2.8-5.0.0，Ruby 1.9.3-2.2.0，Linux的测试）

<pre>与结合使用的HTML中的标记JSON.pretty_generate将在您的视图中呈现JSON。当我杰出的老板向我展示这一点时，我感到非常高兴：

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

如果你想：

1. 自动美化应用程序中的所有传出JSON响应。
2. 避免污染Object＃to_json /＃as_json
3. 避免使用中间件来解析/重新渲染JSON（YUCK！）
4. 做它的铁路方式！

然后...将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

请查看Awesome Print。将JSON字符串解析为Ruby哈希，然后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
  }
}

超赞的打印效果还将添加一些颜色，这些颜色会使Stack Overflow无法显示。

将ActiveRecord对象转储为JSON（在Rails控制台中）：

pp User.first.as_json

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

使用<pre>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>

如果您发现pretty_generateRuby的JSON库中内置的选项不够“漂亮”，我建议使用自己的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?"}
  ]
}

它还支持各种格式设置选项，以进一步自定义输出。例如，冒号之前/之后有多少空格？逗号之前/之后？在数组和对象的括号内？您想对对象的键进行排序吗？您是否希望所有结肠都排成一列？

这是@gertas的出色回答所修改的中间件解决方案。该解决方案不是特定于Rails的，它可以与任何Rack应用程序一起使用。

Eifion Bedford 在ASCIIcasts 151：Rack Middleware中解释了此处使用的使用#each的中间件技术。

这段代码在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的测试。

#At Controller
def branch
    @data = Model.all
    render json: JSON.pretty_generate(@data.as_json)
end

这是我在自己的搜索过程中从其他帖子中获得的解决方案。

这使您可以根据需要将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

我使用了宝石CodeRay，效果很好。格式包括颜色，并且可以识别许多不同的格式。

我已经在可用于调试Rails API的gem上使用了它，并且效果很好。

顺便说一下，该宝石被命名为'api_explorer'（http://www.github.com/toptierlabs/api_explorer）

如果您希望在Rails控制器操作中快速实现此功能以发送JSON响应，请执行以下操作：

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

如果您使用的是RABL，则可以按此处所述配置它以使用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

# 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

我使用以下命令，因为我发现标头，状态和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

漂亮的印刷版本：

my_object = { :array => [1, 2, 3, { :sample => "hash"}, 44455, 677778, 9900 ], :foo => "bar", rrr: {"pid": 63, "state": false}}
puts my_object.as_json.pretty_inspect.gsub('=>', ': ')

结果：

{"array": [1, 2, 3, {"sample": "hash"}, 44455, 677778, 9900],
 "foo": "bar",
 "rrr": {"pid": 63, "state": false}}

最简单的例子，我想到：

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