gson flat json per oggetti nidificati ha bisogno di serializzatore/deserializzatore?

Question

Ho alcuni JSON in arrivo (non ho alcun controllo o possibilità di modificare la struttura e/o denominazione all'interno del JSON ... importante da tenere presente in questa domanda) che ha una struttura "piatta" simile a questo:

{ 
    "name": "...", 
    "email": "...", 
    "box_background_color": "...", 
    "box_border_color": "...", 
    "box_text_color": "...", 
    ... 
} 

Ora, posso solo creare un oggetto semplice che mantiene tutto piatta, in questo modo:

public class Settings { 

    @SerializedName("name") 
    private String _name; 

    @SerializedName("email") 
    private String _emailAddress; 

    @SerializedName("box_background_color") 
    private String _boxBackgroundColor; 

    @SerializedName("box_border_color") 
    private String _boxBorderColor; 

    @SerializedName("box_text_color") 
    private String _boxTextColor; 

    ... 
} 

Tuttavia, voglio che tutto associato alle impostazioni box sia nella sua classe (BoxSettings). Questo è più simile a quello che voglio:

public class Settings { 

    @SerializedName("name") 
    private String _name; 

    @SerializedName("email") 
    private String _emailAddress; 

    private BoxSettings _boxSettings 

    ... 
} 

public class BoxSettings { 

    @SerializedName("box_background_color") 
    private String _boxBackgroundColor; 

    @SerializedName("box_border_color") 
    private String _boxBorderColor; 

    @SerializedName("box_text_color") 
    private String _boxTextColor; 

    ... 
} 

so che se il JSON è stato strutturato in modo tale che le impostazioni della casella erano annidati allora sarebbe facile da realizzare quello che voglio, però, don Ho la possibilità di cambiare la struttura del JSON, quindi per favore non suggerire questo (lo farei se potessi).

mia domanda è questa: sta creando un'intera TypeAdapter l'unico modo per realizzare ciò che voglio o posso ancora realizzare la maggior parte di questo con annotazioni? Se non è l'unico modo, in quale altro modo posso ottenere questo risultato senza cambiare il JSON?

Il seguente è un esempio di ciò che intendo per "la creazione di un intero TypeAdapter":

public class SettingsTypeAdapter implements JsonDeserializer<Settings>, JsonSerializer<Settings> { 

    @Override 
    public JsonElement serialize(Settings src, Type typeOfSrc, JsonSerializationContext context) { 
    // Add _name 
    // Add _emailAddress 
    // Add BoxSettings._boxBackgroundColor 
    // Add BoxSettings._boxBorderColor 
    // Add BoxSettings._boxTextColor 
    return jsonElement; 
    } 

    @Override 
    public Settings deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException { 
    // Read _name 
    // Read _emailAddress 
    // Read BoxSettings._boxBackgroundColor 
    // Read BoxSettings._boxBorderColor 
    // Read BoxSettings._boxTextColor 
    return settings; 
    } 
} 

Answer 1

Il TypeAdapter non è l'unico modo, ma in questo caso sarebbe il modo migliore in quanto è possibile associare l'adattatore con un'istanza di Gson (o qualsiasi altra libreria tu stia usando) e hai lì tutto il tuo codice di mappatura.

Un altro modo è utilizzare la riflessione JAVA. Ho usato una versione del codice qui sotto nei miei progetti prima ma mai con JSON e mai con oggetti nidificati (principalmente quando non c'era altra scelta o se volevo mappare un set di risultati SQL su un oggetto Java senza chiamare lo resultSet.get... molto di volte).

Questo funzionerà in questo caso.

import java.lang.annotation.ElementType; 
import java.lang.annotation.Retention; 
import java.lang.annotation.RetentionPolicy; 
import java.lang.annotation.Target; 
import java.lang.reflect.Field; 
import java.util.HashMap; 
import java.util.Iterator; 
import java.util.Map; 

import org.json.JSONObject; 

public class Main { 

    public static void main(String[] args) { 

     try { 
      String json = "{\"name\": \"test name\", \"email\": \"email@email.com\", \"box_background_color\": \"red\", \"box_border_color\": \"orange\", \"box_text_color\": \"white\", \"test3_var2\":3}"; 

      JSONObject jsonObject = new JSONObject(json); 

      System.out.println(jsonObject); 
      System.out.println(); 

      /* 
      * need to parse JSON into a map of String, Object 
      */ 

      Map<String, Object> mapAll = new HashMap<String, Object>(); 
      Iterator<String> iter = jsonObject.keys(); 

      while (iter.hasNext()) { 
       String key = (String) iter.next(); 
       Object value = jsonObject.get(key); 

       mapAll.put(key, value); 

       System.out.println(key + "::::" + value); 
      } 

      System.out.println(); 

      /* 
      * use the mapper to generate the objects 
      */ 

      MyMapper<TestClass1> myMapper = new MyMapper<TestClass1>(); 
      TestClass1 result = myMapper.mapToObject(mapAll, TestClass1.class); 

      System.out.println(result); 
     } catch (Exception e) { 
      e.printStackTrace(); 
     } 
    } 
} 

    class MyMapper<T> { 

     @SuppressWarnings("unchecked") 
     public T mapToObject(Map<String, Object> flatStructure, Class<T> objectClass) { 
      T result = null; 
      Field[] fields = null; 

      try { 
       // new base object 
       result = objectClass.newInstance(); 

       // get all of its fields 
       fields = objectClass.getDeclaredFields(); 

       for (Field field : fields) { 
        // normal variable 
        if (field.isAnnotationPresent(MyColumn.class)) { 
         String variableKey = field.getAnnotation(MyColumn.class).variableKey(); 

         setJavaFieldValue(result, field.getName(), flatStructure.get(variableKey)); 
        } 
        // variable that is an object and itself has to be mapped 
        else if (field.isAnnotationPresent(MyInnerColumn.class)) { 
         String startsWith = field.getAnnotation(MyInnerColumn.class).startsWith(); 

         // reduce the map to only have attributes that are related to this field 
         Map<String, Object> reducedMap = reduceMap(startsWith, flatStructure); 

         // make sure that there are attributes for the inner object 
         if (reducedMap != null) { 
          // map the inner object 
          MyMapper<T> myMapper = new MyMapper<T>(); 
          T t2 = myMapper.mapToObject(reducedMap, (Class<T>) field.getType()); 

          // set the mapped object to the base objecct 
          setJavaFieldValue(result, field.getName(), t2); 
         } 
        } else { 
         // no annotation on the field so ignored 
        } 
       } 
      } catch (Exception e) { 
       e.printStackTrace(); 
      } 

      return result; 
     } 

     private Map<String, Object> reduceMap(String startsWith, Map<String, Object> mapToReduce) { 
      Map<String, Object> result = new HashMap<String, Object>(); 

      for (Map.Entry<String, Object> entry : mapToReduce.entrySet()) { 
       if (entry.getKey().toLowerCase().startsWith(startsWith.toLowerCase())) { 
        result.put(entry.getKey(), entry.getValue()); 
       } 
      } 

      return result.size() == 0 ? null : result; 
     } 

     private void setJavaFieldValue(Object object, String fieldName, Object fieldValue) { 
      try { 
       Field field = object.getClass().getDeclaredField(fieldName); 

       boolean fieldAccess = field.isAccessible(); 

       // make the field accessible 
       field.setAccessible(true); 
       field.set(object, fieldValue); 

       // put it back to the way it was 
       field.setAccessible(fieldAccess); 
      } catch (Exception e) { 
       e.printStackTrace(); 
      } 
     } 
    } 

    /* 
    * Annotation for a regular variable/field 
    */ 
    @Target(ElementType.FIELD) 
    @Retention(RetentionPolicy.RUNTIME) 
    @interface MyColumn { 

     // the variable's JSON key 
     String variableKey() default ""; 
    } 

    /* 
    * Annotation for an inner/nested variable/field 
    */ 
    @Target(ElementType.FIELD) 
    @Retention(RetentionPolicy.RUNTIME) 
    @interface MyInnerColumn { 

     /* 
     * JSON keys that start with this string will be 
     * associated with this nested field 
     */ 
     String startsWith() default ""; 
    } 

    class TestClass1 { 
     @MyColumn(variableKey = "name") 
     private String _name; 

     @MyColumn(variableKey = "email") 
     private String _emailAddress; 

     @MyInnerColumn(startsWith = "box_") 
     private TestClass2 innerClass; 

     @MyInnerColumn(startsWith = "test3_") 
     private TestClass3 innerClass2; 

     @Override 
     public String toString() { 
      return "TestClass1 [_name=" + _name + ", _emailAddress=" + _emailAddress + ", innerClass=" + innerClass + ", innerClass2=" + innerClass2 + "]"; 
     } 
    } 

    class TestClass2 { 
     @MyColumn(variableKey = "box_background_color") 
     private String _boxBackgroundColor; 

     @MyColumn(variableKey = "box_border_color") 
     private String _boxBorderColor; 

     @MyColumn(variableKey = "box_text_color") 
     private String _boxTextColor; 

     @Override 
     public String toString() { 
      return "TestClass2 [_boxBackgroundColor=" + _boxBackgroundColor + ", _boxBorderColor=" + _boxBorderColor 
        + ", _boxTextColor=" + _boxTextColor + "]"; 
     } 
    } 

    class TestClass3 { 
     @MyColumn(variableKey = "test3_var1") 
     private String _test3Var1; 

     @MyColumn(variableKey = "test3_var2") 
     private int _test3Var2; 

     @Override 
     public String toString() { 
      return "TestClass3 [_test3Var1=" + _test3Var1 + ", _test3Var2=" + _test3Var2 + "]"; 
     } 
    } 

uscita

{"box_background_color":"red","box_text_color":"white","test3_var2":3,"name":"test name","email":"email@email.com","box_border_color":"orange"} 

box_background_color::::red 
box_text_color::::white 
test3_var2::::3 
name::::test name 
email::::email@email.com 
box_border_color::::orange 

TestClass1 [_name=test name, _emailAddress=email@email.com, innerClass=TestClass2 [_boxBackgroundColor=red, _boxBorderColor=orange, _boxTextColor=white], innerClass2=TestClass3 [_test3Var1=null, _test3Var2=3]]