Як вільно побудувати JSON на Java?


107

Я думаю про щось на кшталт:

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

Яка бібліотека Java JSON найкраще підходить для такого типу вільних будівель?

Оновлення : я завернув GSON і отримав майже бажаний результат ... однією зачіпкою .


1
Я не думаю, що я бачив будь-яку бібліотеку JSON, яка б відповідала цьому стилю. Можливо, ви могли б розширити існуючу бібліотеку, щоб робити те, що ви хочете?
aroth

1
@aroth - я пишу обгортку навколо com.google.gson під час розмови.
ripper234


1
Побудуйте відповідне "гніздо" Карт і Списків і серіалізуйте його. Уникайте тверджень про "полімер довгого ланцюга".
Гарячий лизає

Відповіді:


141

Я використовую бібліотеку 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
Це не сильно вільно.
Влад

Надана вами мережа більше не працює. Ви б не хотіли його оновити?
Saša Zejnilović

13
@Vlad - саме це мені пропонують вільні будівельники. Чи можете ви навести приклад налаштування, яке, на вашу думку, є кращим?
scubbo

3
Це все-таки більш чистий варіант. Смішно, що Java-розробникам все ж доводиться робити паузу, щоб визначити найкращий варіант для розбору / побудови JSON у 2020 році.
mtyson

113

Див . Специфікацію Java EE 7 Json . Це правильний шлях:

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

8
Це слід позначити правильною відповіддю у 2015 році, оскільки це є частиною програми javax.jsonJava 7 та пізніших версій.
Шрідхар Сарнобат

42
Це Java EE API, а не Java SE.
igorp1024

Будь-яка ідея, як створити об’єкт JsonString з об’єкта String в API javax.json?
Реймонд

4
залежність від maven: mvnrepository.com/artifact/javax/javaee-api/7.0
ankitkpd

12
Maven залежність для єдиного javax.jsonпакету це один
Жан Вальжан

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 . Він був створений, щоб дозволити один спосіб побудови структур json для багатьох типів бібліотек Json. Поточні реалізації включають Gson, Jackson та MongoDB. Бо тобто. Джексон просто поміняє місцями:

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

Я із задоволенням додаю інших за запитом, це також досить просто реалізувати самостійно.


на жаль, не в Maven Central
dschulten

1

Це здається, що ви, мабуть, хочете отримати json-lib:

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

Дуглас Крокфорд - хлопець, який винайшов JSON; його бібліотека Java тут:

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

Це здається, що люди в json-lib підхопили там, де Крокфорд зупинився. Обидва повністю підтримують JSON, обидва використовують (сумісні, наскільки я можу сказати) конструкції JSONObject, JSONArray та JSONFunction.

"Сподіваюся, що це допомагає ..


Він підтримує вільний синтаксис?
ripper234


0

набагато простіше, ніж ви думаєте написати свій власний, просто використовуйте інтерфейс для JsonElementInterfaceметоду string toJson()та абстрактний клас, що AbstractJsonElementреалізує цей інтерфейс,

то все, що вам потрібно зробити, - це мати клас для JSONPropertyреалізації інтерфейсу та JSONValue(будь-який маркер), JSONArray([...]) та JSONObject({...}), що розширюють абстрактний клас

JSONObjectмає список JSONProperty's
JSONArrayмає список AbstractJsonElement' s

Ваша функція додавання в кожному повинна приймати список вараггів цього типу та повертатися this

тепер якщо вам щось не подобається, ви можете просто підправити це

корисність інтерфейсу та абстрактного класу полягає в тому, що він JSONArrayне може приймати властивості, але JSONPropertyможе приймати об'єкти чи масиви

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.