Как я могу "довольно" форматировать вывод JSON в Ruby on Rails?

Я хотел бы, чтобы мой вывод JSON в Ruby on Rails был "красивым" или красиво отформатирован.

прямо сейчас, я называю to_json и мой JSON все на одной линии. Иногда это может быть трудно увидеть, есть ли проблема в выходном потоке JSON.

есть ли способ настроить или метод, чтобы сделать мой JSON "красивым" или красиво отформатированным в Rails?

16 ответов


использовать 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", чтобы вызвать форматирование для ручных запросов curl по требованию.

(протестировано с Rails 3.2.8-5.0.0, Ruby 1.9.3-2.2.0, Linux)


на <pre> тег в HTML, используется с JSON.pretty_generate, сделает JSON довольно на ваш взгляд. Я был так счастлив, когда мой прославленный босс показал мне это:--4-->

<% if [email protected]? %>
   <pre><%= JSON.pretty_generate(@data) %></pre>
<% end %>

Если вы хотите:

  1. Prettify все исходящие ответы JSON из вашего приложения автоматически.
  2. во избежание polluting объект#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 в Рубиновый хэш, затем отобразите ее с помощью 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 опция, встроенная в библиотеку JSON Ruby, недостаточно" красива", я рекомендую свой собственный NeatJSON gem для форматирования.

использовать gem install neatjson и затем использовать JSON.neat_generate вместо JSON.pretty_generate.

как у Руби 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?"}
  ]
}

он также поддерживает различные параметры форматирования для дальнейшей настройки вывода. Например, сколько пробелов до / после двоеточий? До / после запятой? Внутри скобок массивов и объектов? Вы хотите отсортировать ключи вашего объекта? Ты хочешь, чтобы двоеточия выстроились в линию?


используя <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-оно должно работать с любым приложением стойки.

метод промежуточного программного обеспечения, используемый здесь, используя #each, объясняется в ASCIIcasts 151: "Прослойки" Rack по Eifion Бедфорд.

этот код идет в 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 / среды / разработка.rb:

config.middleware.use "PrettyJsonResponse"

как предупреждает @gertas в своей версии этого решения, избегайте его использования в производстве. Это довольно медленно.

испытано с рельсами 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, и он работает довольно хорошо. Формат включает в себя цвета и распознает множество различных форматов.

Я использовал его на драгоценном камне, который можно использовать для отладки rails API, и он работает довольно хорошо.

кстати, камень называется '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

Если вы используете РАБЛЬ вы можете настроить его, как описано здесь использовать 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.РБ с:

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