web-dev-qa-db-ja.com

Ruby on RailsでJSON出力をどのように "きれいに"フォーマットできますか？

私のRuby on RailsでのJSON出力を「きれい」またはきれいにフォーマットしたいと思います。

今のところ、私はto_jsonと呼び、私のJSONはすべて1行になっています。 JSON出力ストリームに問題があるかどうかを確認するのが難しい場合があります。

私のJSONをRailsで「きれいに」またはきれいにフォーマットするための設定方法や方法はありますか？

ruby-on-railsrubyjsonpretty-print
578
JP Richardson

最新バージョンの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"
}
918
jpatokal

Rack Middleware and 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-Pretty-Json：true」ヘッダーなどの追加ロジックが導入される可能性があります。

（Rails 3.2.8-5.0.0、Ruby 1.9.3-2.2.0、Linuxでテスト済み）

70
gertas

<pre>とともに使用されるHTMLのJSON.pretty_generateタグは、ビュー内でJSONをきれいにレンダリングします。私の輝かしい上司が私にこれを見せてくれたとき、私はとても幸せでした：

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

あなたがしたい場合は：

  1. アプリからのすべての発信JSON応答を自動的に整理します。
  2. Object＃to_json /＃as_jsonの汚染を避ける
  3. ミドルウェアを使用してJSONの解析/再レンダリングを回避する
  4. それはレールをやりなさい！

それから... ActionController :: Renderer for 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
20
Ed Lebert

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はStack Overflowがあなたに見せない色も追加します:)

11
Synthead

<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>
10
oj5th

（Railsコンソールで）ActiveRecordオブジェクトをJSONにダンプします。

pp User.first.as_json

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

（私と同じように）RubyのJSONライブラリに組み込まれているpretty_generateオプションが十分に「きれい」ではないことに気付いた場合、私はあなたのフォーマットのために私自身の NeatJSON gemをお勧めします。

それを使用するにはgem install neatjsonを使用し、次にJSON.neat_generateの代わりにJSON.pretty_generateを使用します。

Rubyのppと同じように、オブジェクトと配列が収まるときは1行に収まりますが、必要に応じて複数にラップします。例えば：

{
  "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?"}
  ]
}

出力をさらにカスタマイズするために、さまざまな フォーマットオプション もサポートされています。たとえば、コロンの前後にいくつのスペースがありますか。カンマの前後配列とオブジェクトの括弧の内側？あなたのオブジェクトのキーをソートしますか？コロンをすべて並べて表示しますか。

10
Phrogz

これは、 から修正されたミドルウェアソリューションです。@ 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/environment/test.rbとconfig/environment/development.rbに追加します。

config.middleware.use "PrettyJsonResponse"

このソリューションの彼のバージョンでは@gertasが警告しているので、プロダクションでは使用しないでください。やや遅いです。

Railsでテスト済み4.1.6。

6
Wayne Conrad
#At Controller
def branch
    @data = Model.all
    render json: JSON.pretty_generate(@data.as_json)
end
5
Буянбат Чойжилсүрэн

私は宝石のCodeRayを使用しました、そしてそれはかなりうまくいきます。フォーマットは色を含み、それは多くの異なるフォーマットを認識します。

私はRails APIのデバッグに使用できるgemでそれを使用しました、そしてそれはかなりうまく機能します。

ちなみに、この宝石の名前は 'api_Explorer'（ http://www.github.com/toptierlabs/api_Explorer ）です。

2
Tony

JSONレスポンスを送信するためにこれをRailsコントローラーアクションにすばやく実装したい場合は、次のようにします。

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

これが私の検索中に他の投稿から導いた私の解決策です。

これにより、必要に応じて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
2
Christopher Mullins

私は、ヘッダ、ステータス、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
1
TheDadman

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
1
Jim Flood

# 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
1
Sergio Belevskij

きれいなプリントの変形：

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}}
0
SergA