JsonWriter Classe

Définition

[Android.Runtime.Register("android/util/JsonWriter", DoNotGenerateAcw=true)]
public sealed class JsonWriter : Java.Lang.Object, IDisposable, Java.IO.ICloseable

[<Android.Runtime.Register("android/util/JsonWriter", DoNotGenerateAcw=true)>]
type JsonWriter = class
    inherit Object
    interface ICloseable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Héritage

Object

JavaObject

Object

JsonWriter

Attributs

RegisterAttribute

Implémente

IJavaObject IJavaPeerable ICloseable IDisposable

Remarques

Écrit une valeur encodée JSON (RFC 4627) dans un flux, un jeton à la fois. Le flux inclut les deux valeurs littérales (chaînes, nombres, valeurs booléennes et null), ainsi que les délimiteurs de début et de fin d’objets et de tableaux.

<h3>Encodage JSON/h3< Pour encoder vos données au format JSON>, créez-en un JsonWriter. Chaque document JSON doit contenir un tableau ou un objet de niveau supérieur. Appelez les méthodes sur l’enregistreur lorsque vous parcourez le contenu de la structure, imbrication de tableaux et d’objets selon les besoins : ul<li Pour écrire >des< tableaux forts/forts><, premier appel >.<>#beginArray() Écrivez chacun des éléments du tableau avec les méthodes appropriées #value ou en imbrication d’autres tableaux et objets. Enfin, fermez le tableau à l’aide #endArray()de . <li>Pour écrire <des objets> forts/forts<>, premier appel #beginObject(). Écrivez chacune des propriétés de l’objet en remplaçant les appels vers #name la valeur de la propriété. Écrivez des valeurs de propriété avec la méthode appropriée #value ou en imbrication d’autres objets ou tableaux. Enfin, fermez l’objet à l’aide #endObject()de . </ul>

<Exemple> h3</h3> Supposons que nous aimerions encoder un flux de messages comme suit :

{@code
            [
              {
                "id": 912345678901,
                "text": "How do I write JSON on Android?",
                "geo": null,
                "user": {
                  "name": "android_newb",
                  "followers_count": 41
                 }
              },
              {
                "id": 912345678902,
                "text": "@android_newb just use android.util.JsonWriter!",
                "geo": [50.454722, -104.606667],
                "user": {
                  "name": "jesse",
                  "followers_count": 2
                }
              }
            ]}

Ce code encode la structure ci-dessus :

{@code
              public void writeJsonStream(OutputStream out, List<Message> messages) throws IOException {
                JsonWriter writer = new JsonWriter(new OutputStreamWriter(out, "UTF-8"));
                writer.setIndent("  ");
                writeMessagesArray(writer, messages);
                writer.close();
              }

              public void writeMessagesArray(JsonWriter writer, List<Message> messages) throws IOException {
                writer.beginArray();
                for (Message message : messages) {
                  writeMessage(writer, message);
                }
                writer.endArray();
              }

              public void writeMessage(JsonWriter writer, Message message) throws IOException {
                writer.beginObject();
                writer.name("id").value(message.getId());
                writer.name("text").value(message.getText());
                if (message.getGeo() != null) {
                  writer.name("geo");
                  writeDoublesArray(writer, message.getGeo());
                } else {
                  writer.name("geo").nullValue();
                }
                writer.name("user");
                writeUser(writer, message.getUser());
                writer.endObject();
              }

              public void writeUser(JsonWriter writer, User user) throws IOException {
                writer.beginObject();
                writer.name("name").value(user.getName());
                writer.name("followers_count").value(user.getFollowersCount());
                writer.endObject();
              }

              public void writeDoublesArray(JsonWriter writer, List<Double> doubles) throws IOException {
                writer.beginArray();
                for (Double value : doubles) {
                  writer.value(value);
                }
                writer.endArray();
              }}

Chacun JsonWriter peut être utilisé pour écrire un seul flux JSON. Les instances de cette classe ne sont pas thread-safe. Les appels qui entraîneraient un échec d’une chaîne JSON incorrecte avec un IllegalStateException.

Java documentation pour android.util.JsonWriter.

Les parties de cette page sont des modifications basées sur le travail créé et partagé par le projet Android Open Source et utilisés en fonction des termes décrits dans la licence d’attribution Creative Commons 2.5.