Я бы хотел, чтобы мой вывод JSON в Ruby on Rails был "красивым" или красиво отформатированным.
Прямо сейчас я звоню 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 для каждого запроса без изменения какого-либо контроллера вашего приложения. Я написал такой фрагмент промежуточного программного обеспечения, и я получаю красиво напечатанный 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
Вышеуказанный код должен быть помещен в app/middleware/pretty_json_response.rb вашего проекта Rails.
И последний шаг - зарегистрировать промежуточное ПО в 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 [email protected]? %>
<pre><%= JSON.pretty_generate(@data) %></pre>
<% end %>
Если вы хотите:
Затем... замените 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 Hash, а затем отобразить ее с помощью awesome_print следующим образом:
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 также добавит цвет, который не будет отображаться в переполнении стека :)
Сбрасывание объекта ActiveRecord в JSON (в консоли Rails):
pp User.first.as_json
# => {
"id" => 1,
"first_name" => "Polar",
"last_name" => "Bear"
}
Если вы (как я) обнаружите, что опция pretty_generate, встроенная в библиотеку Ruby JSON, недостаточно "хороша", я рекомендую использовать NeatJSON для вашего форматирования.
Чтобы использовать его 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 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 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?"}
]
}
Он также поддерживает множество параметров форматирования для дальнейшей настройки вашего вывода. Например, сколько пробелов до/после двоеточий? До/после запятых? Внутри скобок массивов и объектов? Вы хотите отсортировать ключи своего объекта? Вы хотите, чтобы все двоеточия были выстроены?
Использование <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>
Это промежуточное решение, измененное из этого отличного ответа от @gertas. Это решение не является специфичным для Rails - оно должно работать с любым приложением Rack.
Используемый здесь метод промежуточного программного обеспечения с использованием #each объясняется в ASCIIcasts 151: промежуточное программное обеспечение стоек от Eifion Bedford.
Этот код идет в 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/environment/test.rb и config/environment/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
Я использовал gem CodeRay, и он работает очень хорошо. Формат включает цвета и распознает множество разных форматов.
Я использовал его на камне, который можно использовать для отладки API-интерфейсов rails, и он работает очень хорошо.
Кстати, камень называется "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
Я использую следующее: я считаю, что заголовки, статус и вывод 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
Если вы используете 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 больше не будут довольны вашими строками datetime. Вы можете исправить их в 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: "[email protected]", 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
Довольно печатный вариант:
my_object = { :array => [1, 2, 3, { :sample => "hash"}, 44455, 677778, 9900 ], :foo => "bar", rrr: {"pid": 63, "state": false}}
my_object.as_json.pretty_inspect.gsub('=>', ': ')
Результат:
{"array": [1, 2, 3, {"sample": "hash"}, 44455, 677778, 9900],
"foo": "bar",
"rrr": {"pid": 63, "state": false}}