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

使用JSON更高版本中内置的pretty_generate()函数。例如：

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

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

config.middleware.use PrettyJsonResponse

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

（使用Rails 3.2.8-5.0.0，Ruby 1.9.3-2.2.0，Linux测试）

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

这允许您根据需要将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

超文本标记语言中的<pre>标记，与JSON.pretty_generate一起使用，将使JSON在您的视图中变得漂亮。当我杰出的老板给我看这个时，我很高兴：

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

我用过宝石CodeRay，它工作得很好。格式包括颜色，它可以识别很多不同的格式。

我在一个可用于调试rails API的gem上使用过它，它运行得很好。

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

我使用以下内容，因为我发现标题、状态和JSON输出很有用 一个集合。调用例程是根据铁路广播演示文稿的建议打破的：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

将ActiveRecords对象转储到JSON（在Rails控制台中）：

pp User.first.as_json


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

如果你想：

1. 自动对应用程序中的所有传出JSON响应进行校验。
2. 避免污染对象#to_json/#as_json
3. 避免使用中间件解析/重新渲染JSON（YUCK！）
4. 用铁路的方式！

然后…替换JSON的ActionController::渲染器！只需将以下代码添加到您的Application ationController：

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

这是一个从@gertas的精彩回答修改的中间件解决方案。这个解决方案不是Rails特有的——它应该适用于任何Rack应用程序。

这里使用的中间件技术，使用#each，由Eifion Bedford在ASCIIcast 151：机架中间件中解释。

这段代码在应用/中间件/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/环境/test.rb和config/环境/development.rb：

config.middleware.use "PrettyJsonResponse"

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

使用Rails 4.1.6进行测试。

如果您发现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?"}
]
}

它还支持各种格式选项来进一步自定义您的输出。例如，冒号之前/之后有多少空格？逗号之前/之后？数组和对象的括号内？是否要对对象的键进行排序？是否希望冒号全部排列？

如果您使用的是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模式验证器将不再满意您的日期时间字符串。您可以通过以下方式修复配置/初始化器/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

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

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

查看真棒打印。将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
}
}

令人敬畏的打印也会添加一些堆栈溢出不会显示给你的颜色。

使用<pre>超文本标记语言代码和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>

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

漂亮的打印变体（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"}

最简单的例子，我能想到的：

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

如果你想处理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项目中，我总是更喜欢使用gempry-rails来格式化我在rails console中的代码，而不是太冗长的awesome_print。

pry-rails的例子：

它还具有语法高亮显示。

我在rails控制台中有一个JSON对象，并希望在控制台中很好地显示它（而不是像一个巨大的串联字符串一样显示），它就像这样简单：

data.as_json