Gson: วิธียกเว้นฟิลด์เฉพาะจากการทำให้เป็นอนุกรมโดยไม่มีคำอธิบายประกอบ

ฉันพยายามที่จะเรียนรู้ Gson และฉันกำลังดิ้นรนกับการกีดกันภาคสนาม นี่คือชั้นเรียนของฉัน

public class Student {    
  private Long                id;
  private String              firstName        = "Philip";
  private String              middleName       = "J.";
  private String              initials         = "P.F";
  private String              lastName         = "Fry";
  private Country             country;
  private Country             countryOfBirth;
}

public class Country {    
  private Long                id;
  private String              name;
  private Object              other;
}

ฉันสามารถใช้ GsonBuilder และเพิ่ม ExclusionStrategy สำหรับชื่อฟิลด์เหมือนfirstNameหรือแต่ฉันไม่สามารถดูเหมือนจะจัดการเพื่อยกเว้นคุณสมบัติของเขตข้อมูลบางอย่างเช่นcountrycountry.name

การใช้วิธีการpublic boolean shouldSkipField(FieldAttributes fa)นี้ FieldAttributes มีข้อมูลไม่เพียงพอที่จะจับคู่ฟิลด์กับตัวกรองcountry.nameดังนี้

PS: ฉันต้องการหลีกเลี่ยงคำอธิบายประกอบเนื่องจากฉันต้องการปรับปรุงเรื่องนี้และใช้ RegEx เพื่อกรองฟิลด์

แก้ไข : ฉันพยายามดูว่าเป็นไปได้ที่จะเลียนแบบพฤติกรรมของปลั๊กอิน Struts2 JSON

ใช้งาน Gson

<interceptor-ref name="json">
  <param name="enableSMD">true</param>
  <param name="excludeProperties">
    login.password,
    studentList.*\.sin
  </param>
</interceptor-ref>

แก้ไข: ฉันเปิดคำถามอีกครั้งด้วยการเพิ่มต่อไปนี้:

ฉันได้เพิ่มเขตข้อมูลที่สองที่มีประเภทเดียวกันเพื่ออธิบายปัญหานี้ให้ละเอียดยิ่งขึ้น โดยทั่วไปฉันต้องการยกเว้นแต่ไม่country.name countrOfBirth.nameฉันไม่ต้องการยกเว้นประเทศเป็นประเภท ดังนั้นประเภทจะเหมือนกันคือสถานที่จริงในกราฟวัตถุที่ฉันต้องการระบุและยกเว้น

ฟิลด์ใด ๆ ที่คุณไม่ต้องการให้เป็นอันดับโดยทั่วไปคุณควรใช้ตัวแก้ไข "ชั่วคราว" และสิ่งนี้ยังใช้กับ json serializers

หากคุณไม่ต้องการให้ชื่อปรากฏใน json ต่อเนื่องให้มันเป็นคำหลักชั่วคราวเช่น:

private transient String name;

รายละเอียดเพิ่มเติมในเอกสารประกอบของ Gson

Nishant เป็นทางออกที่ดี แต่มีวิธีที่ง่ายกว่า เพียงทำเครื่องหมายฟิลด์ที่ต้องการด้วยคำอธิบายประกอบ @Expose เช่น:

@Expose private Long id;

ปล่อยให้ฟิลด์ใด ๆ ที่คุณไม่ต้องการทำให้เป็นอันดับ จากนั้นเพียงสร้างวัตถุ Gson ของคุณด้วยวิธีนี้:

Gson gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create();

ดังนั้นคุณต้องการที่จะไม่รวม และfirstName country.nameนี่คือสิ่งที่คุณExclusionStrategyควรมีลักษณะเหมือน

    public class TestExclStrat implements ExclusionStrategy {

        public boolean shouldSkipClass(Class<?> arg0) {
            return false;
        }

        public boolean shouldSkipField(FieldAttributes f) {

            return (f.getDeclaringClass() == Student.class && f.getName().equals("firstName"))||
            (f.getDeclaringClass() == Country.class && f.getName().equals("name"));
        }

    }

ถ้าคุณเห็นอย่างใกล้ชิดก็จะส่งกลับtrueสำหรับStudent.firstNameและCountry.nameซึ่งเป็นสิ่งที่คุณต้องการยกเว้น

คุณต้องสมัครExclusionStrategyแบบนี้

    Gson gson = new GsonBuilder()
        .setExclusionStrategies(new TestExclStrat())
        //.serializeNulls() <-- uncomment to serialize NULL fields as well
        .create();
    Student src = new Student();
    String json = gson.toJson(src);
    System.out.println(json);

ผลตอบแทนนี้:

{ "middleName": "J.", "initials": "P.F", "lastName": "Fry", "country": { "id": 91}}

ฉันคิดว่าวัตถุของประเทศนั้นเริ่มต้นได้id = 91Lในชั้นเรียนของนักเรียน

คุณอาจได้รับแฟนซี ตัวอย่างเช่นคุณไม่ต้องการซีเรียลไลซ์ฟิลด์ใด ๆ ที่มีสตริง "name" ในชื่อ ทำเช่นนี้:

public boolean shouldSkipField(FieldAttributes f) {
    return f.getName().toLowerCase().contains("name"); 
}

สิ่งนี้จะส่งคืน:

{ "initials": "P.F", "country": { "id": 91 }}

แก้ไข:เพิ่มข้อมูลเพิ่มเติมตามที่ร้องขอ

สิ่งนี้ExclusionStrategyจะทำสิ่งนี้ แต่คุณต้องผ่าน "ชื่อฟิลด์ที่ผ่านการรับรองโดยสมบูรณ์" ดูด้านล่าง:

    public class TestExclStrat implements ExclusionStrategy {

        private Class<?> c;
        private String fieldName;
        public TestExclStrat(String fqfn) throws SecurityException, NoSuchFieldException, ClassNotFoundException
        {
            this.c = Class.forName(fqfn.substring(0, fqfn.lastIndexOf(".")));
            this.fieldName = fqfn.substring(fqfn.lastIndexOf(".")+1);
        }
        public boolean shouldSkipClass(Class<?> arg0) {
            return false;
        }

        public boolean shouldSkipField(FieldAttributes f) {

            return (f.getDeclaringClass() == c && f.getName().equals(fieldName));
        }

    }

นี่คือวิธีที่เราสามารถใช้มันโดยทั่วไป

    Gson gson = new GsonBuilder()
        .setExclusionStrategies(new TestExclStrat("in.naishe.test.Country.name"))
        //.serializeNulls()
        .create();
    Student src = new Student();
    String json = gson.toJson(src);
    System.out.println(json); 

มันกลับมา:

{ "firstName": "Philip" , "middleName": "J.", "initials": "P.F", "lastName": "Fry", "country": { "id": 91 }}

หลังจากอ่านคำตอบทั้งหมดที่ฉันพบพบว่าในกรณีของฉันมีความยืดหยุ่นมากที่สุดคือการใช้@Excludeคำอธิบายประกอบที่กำหนดเอง ดังนั้นฉันจึงใช้กลยุทธ์ง่าย ๆ สำหรับเรื่องนี้ (ฉันไม่ต้องการทำเครื่องหมายทุกฟิลด์โดยใช้@Exposeหรือไม่ต้องการใช้transientซึ่งขัดแย้งกับในการSerializableทำให้เป็นอันดับแอป):

คำอธิบายประกอบ:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Exclude {
}

กลยุทธ์:

public class AnnotationExclusionStrategy implements ExclusionStrategy {

    @Override
    public boolean shouldSkipField(FieldAttributes f) {
        return f.getAnnotation(Exclude.class) != null;
    }

    @Override
    public boolean shouldSkipClass(Class<?> clazz) {
        return false;
    }
}

การใช้งาน:

new GsonBuilder().setExclusionStrategies(new AnnotationExclusionStrategy()).create();

ฉันพบปัญหานี้ซึ่งฉันมีฟิลด์จำนวนน้อยที่ฉันต้องการแยกออกจากการทำให้เป็นอนุกรมเท่านั้นดังนั้นฉันจึงพัฒนาโซลูชันที่ค่อนข้างง่ายซึ่งใช้การเพิ่มความคิดเห็นของ Gson @Exposeด้วยกลยุทธ์การยกเว้นแบบกำหนดเอง

วิธีการใช้งานแบบบิวด์อินเท่านั้น@Exposeโดยการตั้งค่าGsonBuilder.excludeFieldsWithoutExposeAnnotation()แต่ตามชื่อบ่งชี้ฟิลด์ที่ไม่มีการแจ่มชัด@Exposeจะถูกละเว้น เนื่องจากฉันมีเพียงไม่กี่ฟิลด์ที่ฉันต้องการยกเว้นฉันพบว่าโอกาสที่จะเพิ่มคำอธิบายประกอบให้กับทุกฟิลด์นั้นยุ่งยากมาก

ฉันต้องการการผกผันอย่างมีประสิทธิภาพซึ่งทุกอย่างถูกรวมไว้เว้นแต่ฉัน@Exposeจะใช้อย่างชัดเจนเพื่อแยกออก ฉันใช้กลยุทธ์การยกเว้นต่อไปนี้เพื่อทำสิ่งนี้:

new GsonBuilder()
        .addSerializationExclusionStrategy(new ExclusionStrategy() {
            @Override
            public boolean shouldSkipField(FieldAttributes fieldAttributes) {
                final Expose expose = fieldAttributes.getAnnotation(Expose.class);
                return expose != null && !expose.serialize();
            }

            @Override
            public boolean shouldSkipClass(Class<?> aClass) {
                return false;
            }
        })
        .addDeserializationExclusionStrategy(new ExclusionStrategy() {
            @Override
            public boolean shouldSkipField(FieldAttributes fieldAttributes) {
                final Expose expose = fieldAttributes.getAnnotation(Expose.class);
                return expose != null && !expose.deserialize();
            }

            @Override
            public boolean shouldSkipClass(Class<?> aClass) {
                return false;
            }
        })
        .create();

ตอนนี้ฉันสามารถยกเว้นบางฟิลด์ด้วย@Expose(serialize = false)หรือใส่@Expose(deserialize = false)คำอธิบายประกอบได้อย่างง่ายดาย(โปรดทราบว่าค่าเริ่มต้นสำหรับ@Exposeแอตทริบิวต์ทั้งสองคือtrue) คุณสามารถใช้งานได้แน่นอน@Expose(serialize = false, deserialize = false)แต่สามารถทำได้อย่างกระชับโดยการประกาศฟิลด์transientแทน (ซึ่งยังคงมีผลกับกลยุทธ์การยกเว้นแบบกำหนดเองเหล่านี้)

คุณสามารถสำรวจต้นไม้ json ด้วย gson

ลองสิ่งนี้:

gson.toJsonTree(student).getAsJsonObject()
.get("country").getAsJsonObject().remove("name");

คุณสามารถเพิ่มคุณสมบัติบางอย่างเช่น:

gson.toJsonTree(student).getAsJsonObject().addProperty("isGoodStudent", false);

ทดสอบกับ gson 2.2.4

ฉันมากับโรงงานคลาสเพื่อรองรับฟังก์ชั่นนี้ ผ่านการรวมกันของฟิลด์หรือคลาสใด ๆ ที่คุณต้องการยกเว้น

public class GsonFactory {

    public static Gson build(final List<String> fieldExclusions, final List<Class<?>> classExclusions) {
        GsonBuilder b = new GsonBuilder();
        b.addSerializationExclusionStrategy(new ExclusionStrategy() {
            @Override
            public boolean shouldSkipField(FieldAttributes f) {
                return fieldExclusions == null ? false : fieldExclusions.contains(f.getName());
            }

            @Override
            public boolean shouldSkipClass(Class<?> clazz) {
                return classExclusions == null ? false : classExclusions.contains(clazz);
            }
        });
        return b.create();

    }
}

หากต้องการใช้ให้สร้างสองรายการ (แต่ละรายการเป็นทางเลือก) และสร้างวัตถุ GSON ของคุณ:

static {
 List<String> fieldExclusions = new ArrayList<String>();
 fieldExclusions.add("id");
 fieldExclusions.add("provider");
 fieldExclusions.add("products");

 List<Class<?>> classExclusions = new ArrayList<Class<?>>();
 classExclusions.add(Product.class);
 GSON = GsonFactory.build(null, classExclusions);
}

private static final Gson GSON;

public String getSomeJson(){
    List<Provider> list = getEntitiesFromDatabase();
    return GSON.toJson(list);
}

ฉันแก้ไขปัญหานี้ด้วยคำอธิบายประกอบที่กำหนดเอง นี่คือคลาสคำอธิบายประกอบ "SkipSerialisation" ของฉัน:

@Target (ElementType.FIELD)
public @interface SkipSerialisation {

}

และนี่คือ GsonBuilder ของฉัน:

gsonBuilder.addSerializationExclusionStrategy(new ExclusionStrategy() {

  @Override public boolean shouldSkipField (FieldAttributes f) {

    return f.getAnnotation(SkipSerialisation.class) != null;

  }

  @Override public boolean shouldSkipClass (Class<?> clazz) {

    return false;
  }
});

ตัวอย่าง:

public class User implements Serializable {

  public String firstName;

  public String lastName;

  @SkipSerialisation
  public String email;
}

หรือสามารถพูดได้ว่าฟิลด์ใดจะไม่เปิดเผยด้วย:

Gson gson = gsonBuilder.excludeFieldsWithModifiers(Modifier.TRANSIENT).create();

ในชั้นเรียนของคุณเกี่ยวกับคุณลักษณะ:

private **transient** boolean nameAttribute;

ฉันใช้กลยุทธ์นี้: ฉันยกเว้นทุกฟิลด์ที่ไม่ได้ทำเครื่องหมายด้วยคำอธิบายประกอบ@SerializedNameเช่น:

public class Dummy {

    @SerializedName("VisibleValue")
    final String visibleValue;
    final String hiddenValue;

    public Dummy(String visibleValue, String hiddenValue) {
        this.visibleValue = visibleValue;
        this.hiddenValue = hiddenValue;
    }
}


public class SerializedNameOnlyStrategy implements ExclusionStrategy {

    @Override
    public boolean shouldSkipField(FieldAttributes f) {
        return f.getAnnotation(SerializedName.class) == null;
    }

    @Override
    public boolean shouldSkipClass(Class<?> clazz) {
        return false;
    }
}


Gson gson = new GsonBuilder()
                .setExclusionStrategies(new SerializedNameOnlyStrategy())
                .create();

Dummy dummy = new Dummy("I will see this","I will not see this");
String json = gson.toJson(dummy);

มันกลับมา

{"VisibleValue": "ฉันจะเห็นสิ่งนี้"}

วิธีการอื่น (มีประโยชน์โดยเฉพาะอย่างยิ่งถ้าคุณจำเป็นต้องตัดสินใจที่จะยกเว้นเขตข้อมูลที่รันไทม์) คือการลงทะเบียน TypeAdapter กับอินสแตนซ์ gson ของคุณ ตัวอย่างด้านล่าง:

Gson gson = new GsonBuilder()
.registerTypeAdapter(BloodPressurePost.class, new BloodPressurePostSerializer())

ในกรณีด้านล่างเซิร์ฟเวอร์จะคาดหวังหนึ่งในสองค่า แต่เนื่องจากพวกเขาทั้งคู่ ints แล้ว gson จะทำให้พวกเขาทั้งสองเป็นอันดับ เป้าหมายของฉันคือละเว้นค่าใด ๆ ที่เป็นศูนย์ (หรือน้อยกว่า) จาก json ที่โพสต์ไปยังเซิร์ฟเวอร์

public class BloodPressurePostSerializer implements JsonSerializer<BloodPressurePost> {

    @Override
    public JsonElement serialize(BloodPressurePost src, Type typeOfSrc, JsonSerializationContext context) {
        final JsonObject jsonObject = new JsonObject();

        if (src.systolic > 0) {
            jsonObject.addProperty("systolic", src.systolic);
        }

        if (src.diastolic > 0) {
            jsonObject.addProperty("diastolic", src.diastolic);
        }

        jsonObject.addProperty("units", src.units);

        return jsonObject;
    }
}

@Transientคำอธิบายประกอบของ Kotlin ยังทำเคล็ดลับที่เห็นได้ชัด

data class Json(
    @field:SerializedName("serialized_field_1") val field1: String,
    @field:SerializedName("serialized_field_2") val field2: String,
    @Transient val field3: String
)

เอาท์พุท:

{"serialized_field_1":"VALUE1","serialized_field_2":"VALUE2"}

ฉันทำงานเพียงแค่ใส่@Exposeคำอธิบายประกอบนี่คือรุ่นที่ฉันใช้

compile 'com.squareup.retrofit2:retrofit:2.0.2'
compile 'com.squareup.retrofit2:converter-gson:2.0.2'

ในModelชั้นเรียน:

@Expose
int number;

public class AdapterRestApi {

ในAdapterชั้นเรียน:

public EndPointsApi connectRestApi() {
    OkHttpClient client = new OkHttpClient.Builder()
            .connectTimeout(90000, TimeUnit.SECONDS)
            .readTimeout(90000,TimeUnit.SECONDS).build();

    Retrofit retrofit = new Retrofit.Builder()
            .baseUrl(ConstantRestApi.ROOT_URL)
            .addConverterFactory(GsonConverterFactory.create())
            .client(client)
            .build();

    return retrofit.create  (EndPointsApi.class);
}

ฉันมีรุ่น Kotlin

@Retention(AnnotationRetention.RUNTIME)
@Target(AnnotationTarget.FIELD)
internal annotation class JsonSkip

class SkipFieldsStrategy : ExclusionStrategy {

    override fun shouldSkipClass(clazz: Class<*>): Boolean {
        return false
    }

    override fun shouldSkipField(f: FieldAttributes): Boolean {
        return f.getAnnotation(JsonSkip::class.java) != null
    }
}

และวิธีที่คุณสามารถเพิ่มสิ่งนี้ลงใน Retrofit GSONConverterFactory:

val gson = GsonBuilder()
                .setExclusionStrategies(SkipFieldsStrategy())
                //.serializeNulls()
                //.setDateFormat(DateFormat.LONG)
                //.setFieldNamingPolicy(FieldNamingPolicy.UPPER_CAMEL_CASE)
                //.setPrettyPrinting()
                //.registerTypeAdapter(Id.class, IdTypeAdapter())
                .create()
        return GsonConverterFactory.create(gson)

นี่คือสิ่งที่ฉันมักจะใช้:

พฤติกรรมเริ่มต้นที่นำมาใช้ใน Gson คือฟิลด์วัตถุ null จะถูกละเว้น

หมายถึงวัตถุ Gson ไม่ทำให้เป็นอันดับเขตข้อมูลที่มีค่าเป็นศูนย์ถึง JSON ถ้าเขตข้อมูลในวัตถุ Java เป็นโมฆะ Gson จะแยกออก

คุณสามารถใช้ฟังก์ชั่นนี้เพื่อแปลงวัตถุให้เป็นโมฆะหรือตั้งค่าได้เอง

     /**
   * convert object to json
   */
  public String toJson(Object obj) {
    // Convert emtpy string and objects to null so we don't serialze them
    setEmtpyStringsAndObjectsToNull(obj);
    return gson.toJson(obj);
  }

  /**
   * Sets all empty strings and objects (all fields null) including sets to null.
   *
   * @param obj any object
   */
  public void setEmtpyStringsAndObjectsToNull(Object obj) {
    for (Field field : obj.getClass().getDeclaredFields()) {
      field.setAccessible(true);
      try {
        Object fieldObj = field.get(obj);
        if (fieldObj != null) {
          Class fieldType = field.getType();
          if (fieldType.isAssignableFrom(String.class)) {
            if(fieldObj.equals("")) {
              field.set(obj, null);
            }
          } else if (fieldType.isAssignableFrom(Set.class)) {
            for (Object item : (Set) fieldObj) {
              setEmtpyStringsAndObjectsToNull(item);
            }
            boolean setFielToNull = true;
            for (Object item : (Set) field.get(obj)) {
              if(item != null) {
                setFielToNull = false;
                break;
              }
            }
            if(setFielToNull) {
              setFieldToNull(obj, field);
            }
          } else if (!isPrimitiveOrWrapper(fieldType)) {
            setEmtpyStringsAndObjectsToNull(fieldObj);
            boolean setFielToNull = true;
            for (Field f : fieldObj.getClass().getDeclaredFields()) {
              f.setAccessible(true);
              if(f.get(fieldObj) != null) {
                setFielToNull = false;
                break;
              }
            }
            if(setFielToNull) {
              setFieldToNull(obj, field);
            }
          }
        }
      } catch (IllegalAccessException e) {
        System.err.println("Error while setting empty string or object to null: " + e.getMessage());
      }
    }
  }

  private void setFieldToNull(Object obj, Field field) throws IllegalAccessException {
    if(!Modifier.isFinal(field.getModifiers())) {
      field.set(obj, null);
    }
  }

  private boolean isPrimitiveOrWrapper(Class fieldType)  {
    return fieldType.isPrimitive()
        || fieldType.isAssignableFrom(Integer.class)
        || fieldType.isAssignableFrom(Boolean.class)
        || fieldType.isAssignableFrom(Byte.class)
        || fieldType.isAssignableFrom(Character.class)
        || fieldType.isAssignableFrom(Float.class)
        || fieldType.isAssignableFrom(Long.class)
        || fieldType.isAssignableFrom(Double.class)
        || fieldType.isAssignableFrom(Short.class);
  }