Ruby on Rails で JSON 出力を「きれいな」形式にするにはどうすればよいですか?

Question

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

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

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

Answer 1

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

Answer 2

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 でテスト済み)

Answer 3

の <pre> HTML のタグ。一緒に使用されます。 JSON.pretty_generate, 、ビュー内で JSON がきれいに表示されます。私の高名な上司が私にこれを見せてくれたとき、私はとてもうれしかったです。

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

Answer 4

あなたがしたい場合は：

1. アプリから送信されるすべての JSON 応答を自動的に整形します。
2. Object#to_json/#as_json を汚染しないようにする
3. ミドルウェアを使用して JSON を解析/再レンダリングすることは避けてください (YUCK!)
4. それをRAILS WAYでやってみよう！

それから ...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

Answer 5

チェックアウト 素晴らしいプリント. 。JSON 文字列を Ruby ハッシュに解析し、次のように 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 では表示されない色も追加します :)

Answer 6

ActiveRecord オブジェクトを JSON にダンプします (Rails コンソール内):

pp User.first.as_json

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

Answer 7

もしあなたが (私と同じように) pretty_generate Ruby の JSON ライブラリに組み込まれているオプションは十分に「きれい」ではないため、独自のオプションをお勧めします NeatJSON 書式設定用の gem。

使用するには gem install neatjson そして使用します JSON.neat_generate の代わりに JSON.pretty_generate.

ルビーちゃんみたいに 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?"}
  ]
}

色々な事にも対応してくれます 書式設定オプション 出力をさらにカスタマイズするには、たとえば、コロンの前後にスペースは何個ありますか?コンマの前/後?配列やオブジェクトの括弧内でしょうか?オブジェクトのキーを並べ替えますか?コロンをすべて並べますか?

Answer 8

使用する <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>

Answer 9

これは、から変更されたミドルウェア ソリューションです。 @gertasによるこの素晴らしい回答. 。このソリューションは Rails に特化したものではありません。どの Rack アプリケーションでも動作するはずです。

ここで使用されている #each を使用したミドルウェア手法については、次の場所で説明されています。 アスキーキャスト 151:ラックミドルウェア エフィオン・ベッドフォード著。

このコードが入ります app/ミドルウェア/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 でテストされました。

Answer 10

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

Answer 11

これは、私自身の検索中に他の投稿から導き出した私の解決策です。

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

Answer 12

私は宝石の CodeRay を使用しましたが、非常にうまく機能します。この形式には色が含まれており、さまざまな形式を認識します。

Rails API のデバッグに使用できる gem でこれを使用しましたが、非常にうまく機能します。

ちなみに、この gem の名前は「api_explorer」です (http://www.github.com/toptierlabs/api_explorer)

Answer 13

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

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

Answer 14

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

Answer 15

使用している場合 ラブル 説明どおりに設定できます ここ 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

Answer 16

# 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

Answer 17

きれいな印刷バリエーション:

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