Come creare fluentemente JSON in Java?


107

Sto pensando a qualcosa del tipo:

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

Quale libreria Java JSON è la migliore per questo tipo di costruzione fluente?

Aggiornamento : ho avvolto GSON e ho ottenuto quasi il risultato desiderato ... con un intoppo .


1
Non credo di aver visto nessuna libreria JSON che segue quello stile. Forse potresti estendere una libreria esistente per fare quello che vuoi?
aroth

1
@aroth - Sto scrivendo un wrapper attorno a com.google.gson mentre parliamo.
ripper234


1
Costruisci il "nido" appropriato di mappe ed elenchi e serializzalo. Evita le affermazioni "polimero a catena lunga".
Hot Licks

Risposte:


141

Sto usando la libreria org.json e l' ho trovata carina e amichevole.

Esempio:

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);

PRODUZIONE:

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

15
Non è molto fluente.
Vlad

Il web che hai fornito non funziona più. Ti dispiacerebbe aggiornarlo?
Saša Zejnilović

13
@Vlad - questo è esattamente ciò che mi suggeriscono i costruttori fluenti. Puoi fornire un esempio di una configurazione che reputi migliore?
scubbo

3
Questa è ancora l'opzione più pulita. È ridicolo che gli sviluppatori Java debbano ancora fermarsi per capire l'opzione migliore per l'analisi / compilazione JSON nel 2020.
mtyson

113

Vedere la specifica Json di Java EE 7 . Questo è il modo giusto:

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

8
Questa dovrebbe essere contrassegnata come risposta corretta nel 2015 poiché fa parte di javax.jsonJava 7 e versioni successive.
Sridhar Sarnobat

42
È Java EE API, non Java SE.
igorp1024

Qualche idea su come creare un oggetto JsonString da un oggetto String nell'API javax.json?
Raymond

4
dipendenza maven
ankitkpd

12
La dipendenza di Maven per l'unico javax.jsonpacchetto è questo
JeanValjean

12

Di recente ho creato una libreria per creare fluentemente oggetti Gson:

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

Funziona così:

  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();

E attraverso la magia dei generici genera errori di compilazione se provi ad aggiungere un elemento a un array con una chiave di proprietà o un elemento a un oggetto senza un nome di proprietà:

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.

Infine c'è il supporto della mappatura nell'API che ti consente di mappare gli oggetti del tuo dominio su JSON. L'obiettivo è che quando verrà rilasciato Java8 sarai in grado di fare qualcosa del genere:

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

8

Se stai usando Jackson per JsonNodecostruire un sacco di codice, potresti essere interessante nel seguente set di utilità. Il vantaggio di usarli è che supportano uno stile di concatenamento più naturale che mostra meglio la struttura del JSON in costruzione.

Ecco un esempio di utilizzo:

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

...

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

Che è equivalente al seguente JSON:

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

Ecco le classi:

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

  }

}

Si noti che l'implementazione utilizza Lombok , ma è possibile rimuoverlo facilmente per compilare il boilerplate Java.


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

Se ritieni che la soluzione di cui sopra sia elegante, prova la mia libreria JsonBuilder . È stato creato per consentire un modo di creare strutture JSON per molti tipi di librerie Json. Le attuali implementazioni includono Gson, Jackson e MongoDB. Per es. Jackson si limita a scambiare:

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

Aggiungerò volentieri altri su richiesta, è anche abbastanza facile implementarne uno da soli.


sfortunatamente non in Maven Central in questo momento, vedi github.com/HknL/JsonBuilder/issues/8
dschulten

1

Sembra che probabilmente vorrai entrare in possesso di json-lib:

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

Douglas Crockford è il ragazzo che ha inventato JSON; la sua libreria Java è qui:

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

Sembra che i ragazzi di Json-lib abbiano ripreso da dove aveva interrotto Crockford. Entrambi supportano completamente JSON, entrambi usano (compatibile, per quanto ne so) JSONObject, JSONArray e JSONFunction costrutti.

'Spero che aiuti ..


Supporta una sintassi fluente?
ripper234


0

è molto più facile di quanto pensi scrivere il tuo, usa semplicemente un'interfaccia per JsonElementInterfacecon un metodo string toJson()e una classe astratta AbstractJsonElementche implementa quell'interfaccia,

quindi tutto ciò che devi fare è avere una classe JSONPropertyche implementa l'interfaccia e JSONValue(qualsiasi token), JSONArray([...]) e JSONObject({...}) che estendono la classe astratta

JSONObjectha una lista di JSONProperty's
JSONArrayha una lista di AbstractJsonElement' s

la tua funzione add in ognuna dovrebbe prendere un elenco vararg di quel tipo e restituire this

ora se non ti piace qualcosa puoi semplicemente modificarlo

il vantaggio dell'interfaccia e della classe astratta è che JSONArraynon può accettare proprietà, ma JSONPropertypuò accettare oggetti o array

Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.