JavaでJSONを流暢に作成する方法


106

私は次のようなものを考えています:

String json = new JsonBuilder()
  .add("key1", "value1")
  .add("key2", "value2")
  .add("key3", new JsonBuilder()
    .add("innerKey1", "value3"))
  .toJson();

この種の流暢な建物に最適なJava JSONライブラリはどれですか。

アップデート:私はGSONを包んで...ほとんど望ましい結果を得た1つのヒッチで


1
そのスタイルに従うJSONライブラリを見たことがないと思います。多分あなたはあなたが望むことをするために既存のライブラリを拡張することができますか?
aroth

1
@aroth-私が話すとき、私はcom.google.gsonのラッパーを書いています。
ripper234 2012年

1
ほとんど準備ができて- stackoverflow.com/questions/8876271/...
ripper234

1
マップとリストの適切な「ネスト」を作成し、シリアル化します。「長鎖ポリマー」の記述は避けてください。
Hot Licks、2015年

回答:


140

私はorg.jsonライブラリーを使用していて、それが素晴らしくてフレンドリーであることがわかりました。

例:

String jsonString = new JSONObject()
                  .put("JSON1", "Hello World!")
                  .put("JSON2", "Hello my World!")
                  .put("JSON3", new JSONObject().put("key1", "value1"))
                  .toString();

System.out.println(jsonString);

出力:

{"JSON2":"Hello my World!","JSON3":{"key1":"value1"},"JSON1":"Hello World!"}

15
これはあまり流暢ではありません。
Vlad

ご提供いただいたウェブはご利用いただけなくなりました。更新していただけませんか?
ササZejnilović

13
@Vlad-これはまさしく流暢なビルダーが私に提案するものです。あなたがより良いと思うセットアップの例を提供できますか?
スキューボ

3
これはまだよりクリーンなオプションです。これは、Javaはまだ2020年にはJSONのパース/ビルドのための最良の選択肢を把握するために一時停止する必要がありDEVSというばかげ
mtyson

112

Java EE 7 Json仕様を参照してください。これは正しい方法です:

String json = Json.createObjectBuilder()
            .add("key1", "value1")
            .add("key2", "value2")
            .build()
            .toString();

8
これはjavax.json、Java 7 以降の一部であるため、2015年には正しい回答としてマークする必要があります。
Sridhar Sarnobat、2015

42
Java SEではなく、Java EE APIです。
igorp1024

javax.json APIでStringオブジェクトからJsonStringオブジェクトを作成する方法はありますか?
レイモンド


12
唯一のjavax.jsonパッケージのMaven依存関係これです
JeanValjean 2017年

12

最近、Gsonオブジェクトを流暢に作成するためのライブラリを作成しました。

http://jglue.org/fluent-json/

それはこのように動作します:

  JsonObject jsonObject = JsonBuilderFactory.buildObject() //Create a new builder for an object
  .addNull("nullKey")                            //1. Add a null to the object

  .add("stringKey", "Hello")                     //2. Add a string to the object
  .add("stringNullKey", (String) null)           //3. Add a null string to the object

  .add("numberKey", 2)                           //4. Add a number to the object
  .add("numberNullKey", (Float) null)            //5. Add a null number to the object

  .add("booleanKey", true)                       //6. Add a boolean to the object
  .add("booleanNullKey", (Boolean) null)         //7. Add a null boolean to the object

  .add("characterKey", 'c')                      //8. Add a character to the object
  .add("characterNullKey", (Character) null)     //9. Add a null character to the object

  .addObject("objKey")                           //10. Add a nested object
    .add("nestedPropertyKey", 4)                 //11. Add a nested property to the nested object
    .end()                                       //12. End nested object and return to the parent builder

  .addArray("arrayKey")                          //13. Add an array to the object
    .addObject()                                 //14. Add a nested object to the array
      .end()                                     //15. End the nested object
    .add("arrayElement")                         //16. Add a string to the array
    .end()                                       //17. End the array

    .getJson();                                  //Get the JsonObject

String json = jsonObject.toString();

そして、ジェネリックの魔法を通して、プロパティキーを持つ配列に要素を追加したり、プロパティ名のないオブジェクトに要素を追加しようとしたりすると、コンパイルエラーが発生します。

JsonObject jsonArray = JsonBuilderFactory.buildArray().addObject().end().add("foo", "bar").getJson(); //Error: tried to add a string with property key to array.
JsonObject jsonObject = JsonBuilderFactory.buildObject().addArray().end().add("foo").getJson(); //Error: tried to add a string without property key to an object.
JsonArray jsonArray = JsonBuilderFactory.buildObject().addArray("foo").getJson(); //Error: tried to assign an object to an array.
JsonObject jsonObject = JsonBuilderFactory.buildArray().addObject().getJson(); //Error: tried to assign an object to an array.

最後に、APIにマッピングサポートがあり、ドメインオブジェクトをJSONにマッピングできます。目標は、Java8がリリースされたときに、次のようなことができるようになることです。

Collection<User> users = ...;
JsonArray jsonArray = JsonBuilderFactory.buildArray(users, { u-> buildObject()
                                                                 .add("userName", u.getName())
                                                                 .add("ageInYears", u.getAge()) })
                                                                 .getJson();

8

Jacksonを使用している場合はJsonNode、コードで多くのビルドを行うので、次のユーティリティセットに興味があるかもしれません。それらを使用する利点は、作成中のJSONの構造をより適切に示す、より自然な連鎖スタイルをサポートすることです。

次に使用例を示します。

import static JsonNodeBuilders.array;
import static JsonNodeBuilders.object;

...

val request = object("x", "1").with("y", array(object("z", "2"))).end();

これは、次のJSONと同等です。

{"x":"1", "y": [{"z": "2"}]}

ここにクラスがあります:

import static lombok.AccessLevel.PRIVATE;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.JsonNodeFactory;
import com.fasterxml.jackson.databind.node.ObjectNode;

import lombok.NoArgsConstructor;
import lombok.NonNull;
import lombok.RequiredArgsConstructor;
import lombok.val;

/**
 * Convenience {@link JsonNode} builder.
 */
@NoArgsConstructor(access = PRIVATE)
public final class JsonNodeBuilders {

  /**
   * Factory methods for an {@link ObjectNode} builder.
   */

  public static ObjectNodeBuilder object() {
    return object(JsonNodeFactory.instance);
  }

  public static ObjectNodeBuilder object(@NonNull String k1, boolean v1) {
    return object().with(k1, v1);
  }

  public static ObjectNodeBuilder object(@NonNull String k1, int v1) {
    return object().with(k1, v1);
  }

  public static ObjectNodeBuilder object(@NonNull String k1, float v1) {
    return object().with(k1, v1);
  }

  public static ObjectNodeBuilder object(@NonNull String k1, String v1) {
    return object().with(k1, v1);
  }

  public static ObjectNodeBuilder object(@NonNull String k1, String v1, @NonNull String k2, String v2) {
    return object(k1, v1).with(k2, v2);
  }

  public static ObjectNodeBuilder object(@NonNull String k1, String v1, @NonNull String k2, String v2,
      @NonNull String k3, String v3) {
    return object(k1, v1, k2, v2).with(k3, v3);
  }

  public static ObjectNodeBuilder object(@NonNull String k1, JsonNodeBuilder<?> builder) {
    return object().with(k1, builder);
  }

  public static ObjectNodeBuilder object(JsonNodeFactory factory) {
    return new ObjectNodeBuilder(factory);
  }

  /**
   * Factory methods for an {@link ArrayNode} builder.
   */

  public static ArrayNodeBuilder array() {
    return array(JsonNodeFactory.instance);
  }

  public static ArrayNodeBuilder array(@NonNull boolean... values) {
    return array().with(values);
  }

  public static ArrayNodeBuilder array(@NonNull int... values) {
    return array().with(values);
  }

  public static ArrayNodeBuilder array(@NonNull String... values) {
    return array().with(values);
  }

  public static ArrayNodeBuilder array(@NonNull JsonNodeBuilder<?>... builders) {
    return array().with(builders);
  }

  public static ArrayNodeBuilder array(JsonNodeFactory factory) {
    return new ArrayNodeBuilder(factory);
  }

  public interface JsonNodeBuilder<T extends JsonNode> {

    /**
     * Construct and return the {@link JsonNode} instance.
     */
    T end();

  }

  @RequiredArgsConstructor
  private static abstract class AbstractNodeBuilder<T extends JsonNode> implements JsonNodeBuilder<T> {

    /**
     * The source of values.
     */
    @NonNull
    protected final JsonNodeFactory factory;

    /**
     * The value under construction.
     */
    @NonNull
    protected final T node;

    /**
     * Returns a valid JSON string, so long as {@code POJONode}s not used.
     */
    @Override
    public String toString() {
      return node.toString();
    }

  }

  public final static class ObjectNodeBuilder extends AbstractNodeBuilder<ObjectNode> {

    private ObjectNodeBuilder(JsonNodeFactory factory) {
      super(factory, factory.objectNode());
    }

    public ObjectNodeBuilder withNull(@NonNull String field) {
      return with(field, factory.nullNode());
    }

    public ObjectNodeBuilder with(@NonNull String field, int value) {
      return with(field, factory.numberNode(value));
    }

    public ObjectNodeBuilder with(@NonNull String field, float value) {
      return with(field, factory.numberNode(value));
    }

    public ObjectNodeBuilder with(@NonNull String field, boolean value) {
      return with(field, factory.booleanNode(value));
    }

    public ObjectNodeBuilder with(@NonNull String field, String value) {
      return with(field, factory.textNode(value));
    }

    public ObjectNodeBuilder with(@NonNull String field, JsonNode value) {
      node.set(field, value);
      return this;
    }

    public ObjectNodeBuilder with(@NonNull String field, @NonNull JsonNodeBuilder<?> builder) {
      return with(field, builder.end());
    }

    public ObjectNodeBuilder withPOJO(@NonNull String field, @NonNull Object pojo) {
      return with(field, factory.pojoNode(pojo));
    }

    @Override
    public ObjectNode end() {
      return node;
    }

  }

  public final static class ArrayNodeBuilder extends AbstractNodeBuilder<ArrayNode> {

    private ArrayNodeBuilder(JsonNodeFactory factory) {
      super(factory, factory.arrayNode());
    }

    public ArrayNodeBuilder with(boolean value) {
      node.add(value);
      return this;
    }

    public ArrayNodeBuilder with(@NonNull boolean... values) {
      for (val value : values)
        with(value);
      return this;
    }

    public ArrayNodeBuilder with(int value) {
      node.add(value);
      return this;
    }

    public ArrayNodeBuilder with(@NonNull int... values) {
      for (val value : values)
        with(value);
      return this;
    }

    public ArrayNodeBuilder with(float value) {
      node.add(value);
      return this;
    }

    public ArrayNodeBuilder with(String value) {
      node.add(value);
      return this;
    }

    public ArrayNodeBuilder with(@NonNull String... values) {
      for (val value : values)
        with(value);
      return this;
    }

    public ArrayNodeBuilder with(@NonNull Iterable<String> values) {
      for (val value : values)
        with(value);
      return this;
    }

    public ArrayNodeBuilder with(JsonNode value) {
      node.add(value);
      return this;
    }

    public ArrayNodeBuilder with(@NonNull JsonNode... values) {
      for (val value : values)
        with(value);
      return this;
    }

    public ArrayNodeBuilder with(JsonNodeBuilder<?> value) {
      return with(value.end());
    }

    public ArrayNodeBuilder with(@NonNull JsonNodeBuilder<?>... builders) {
      for (val builder : builders)
        with(builder);
      return this;
    }

    @Override
    public ArrayNode end() {
      return node;
    }

  }

}

実装はLombokを使用しますが、Javaボイラープレートを埋めるために簡単にデ糖を除去できることに注意してください。


2
String json = new JsonBuilder(new GsonAdapter())
  .object("key1", "value1")
  .object("key2", "value2")
  .object("key3")
    .object("innerKey1", "value3")
    .build().toString();

上記のソリューションがエレガントであると思われる場合は、私のJsonBuilder lib を試してください。これは、さまざまなタイプのJsonライブラリのjson構造を構築する1つの方法を可能にするために作成されました。現在の実装には、Gson、Jackson、MongoDBが含まれます。つまり ジャクソンは交換するだけです:

String json = new JsonBuilder(new JacksonAdapter()).

要望があれば喜んで追加します。自分で実装するのも非常に簡単です。


残念ながら、現時点
HknL /

1

あなたはおそらくjson-libを手に入れたいようです:

http://json-lib.sourceforge.net/

ダグラス・クロックフォードは、JSONを発明した人物です。彼のJavaライブラリはここにあります:

http://www.json.org/java/

json-libの人々がCrockfordがやめたところから立ち上がったようです。どちらもJSONを完全にサポートしています。どちらも、JSONObject、JSONArray、JSONFunctionの各コンストラクトを使用しています(私が知る限り、互換性があります)。

「それが役に立てば幸い。


流暢な構文をサポートしていますか?
ripper234 2012年


0

自分で書くよりもはるかに簡単です。JsonElementInterfaceメソッドとのインターフェースを使用し、そのインターフェースを実装string toJson()する抽象クラスを使用するだけですAbstractJsonElement

次にJSONProperty、インターフェースを実装するためのクラスと、JSONValue(任意のトークン)、JSONArray([...])、およびJSONObject、抽象クラスを拡張する({...})をです。

JSONObjectリストがあるJSONPropertyのは、
JSONArrayのリストを持っていますAbstractJsonElement s 'を

それぞれのadd関数は、そのタイプの可変引数リストを受け取り、返す必要があります this

今あなたが何かが気に入らないなら、あなたはそれを微調整することができます

インターフェースと抽象クラスのJSONArray利点は、プロパティを受け入れることはできませんJSONPropertyが、オブジェクトまたは配列を受け入れることです

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.