Gson: Como excluir campos específicos da serialização sem anotações

Estou tentando aprender Gson e estou lutando com a exclusão de campo. Aqui estão minhas aulas

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

Posso usar o GsonBuilder e adicionar uma ExclusionStrategy para um nome de campo como firstNameou countrymas não consigo excluir propriedades de determinados campos como country.name.

Usando o método public boolean shouldSkipField(FieldAttributes fa), FieldAttributes não contém informações suficientes para combinar o campo com um filtro semelhante country.name.

PS: Quero evitar anotações, pois quero melhorar isso e usar o RegEx para filtrar os campos.

Edit : Estou tentando ver se é possível emular o comportamento do plugin JSON do Struts2

usando Gson

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

Editar: reabri a pergunta com a seguinte adição:

Eu adicionei um segundo campo com o mesmo tipo para esclarecer ainda mais esse problema. Basicamente, quero excluir, country.namemas não countrOfBirth.name. Também não quero excluir País como um tipo. Portanto, os tipos são os mesmos, é o local real no gráfico do objeto que eu quero identificar e excluir.

Quaisquer campos que você não queira serializar em geral, você deve usar o modificador "transitório", e isso também se aplica aos serializadores json (pelo menos para alguns que eu usei, incluindo o gson).

Se você não quiser que o nome seja exibido no json serializado, forneça uma palavra-chave transitória, por exemplo:

private transient String name;

Mais detalhes na documentação do Gson

Nishant forneceu uma boa solução, mas existe uma maneira mais fácil. Basta marcar os campos desejados com a anotação @Expose, como:

@Expose private Long id;

Deixe de fora todos os campos que você não deseja serializar. Em seguida, basta criar seu objeto Gson desta maneira:

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

Então, você deseja excluir firstName e country.name. Aqui está como ExclusionStrategydeve ser o seu

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

    }

Se você vê de perto, ele retorna truepara Student.firstNamee Country.name, que é o que você deseja excluir.

Você precisa aplicar isso ExclusionStrategyassim,

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

Isso retorna:

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

Presumo que o objeto do país seja inicializado id = 91Lna turma do aluno.

Você pode ser extravagante. Por exemplo, você não deseja serializar nenhum campo que contenha a cadeia "name" em seu nome. Faça isso:

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

Isso retornará:

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

EDIT: Adicionado mais informações, conforme solicitado.

Isso ExclusionStrategyfuncionará, mas você precisará passar "Nome do campo totalmente qualificado". Ver abaixo:

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

    }

Aqui está como podemos usá-lo genericamente.

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

Retorna:

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

Depois de ler todas as respostas disponíveis, descobri que a mais flexível, no meu caso, era usar @Excludeanotações personalizadas . Portanto, implementei uma estratégia simples para isso (não queria marcar todos os campos usando @Exposenem queria usar os transientque conflitavam com a Serializableserialização de aplicativos ):

Anotação:

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

Estratégia:

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

Uso:

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

Eu me deparei com esse problema, no qual eu tinha um pequeno número de campos que queria excluir apenas da serialização, então desenvolvi uma solução bastante simples que usa a @Exposeanotação de Gson com estratégias de exclusão personalizadas.

A única maneira interna de usar @Exposeé definindo GsonBuilder.excludeFieldsWithoutExposeAnnotation(), mas como o nome indica, os campos sem explícito @Exposesão ignorados. Como eu tinha apenas alguns campos que queria excluir, achei muito provável a possibilidade de adicionar a anotação a todos os campos.

Eu queria efetivamente o inverso, no qual tudo estava incluído, a menos que explicitamente o @Exposeexcluísse. Usei as seguintes estratégias de exclusão para fazer isso:

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

Agora, posso excluir facilmente alguns campos com @Expose(serialize = false)ou @Expose(deserialize = false)anotações (observe que o valor padrão para ambos os @Exposeatributos é true). É claro que você pode usar @Expose(serialize = false, deserialize = false), mas isso é feito de maneira mais concisa ao declarar o campo transient(o que ainda entra em vigor com essas estratégias de exclusão personalizadas).

Você pode explorar a árvore json com gson.

Tente algo como isto:

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

Você também pode adicionar algumas propriedades:

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

Testado com gson 2.2.4.

Eu vim com uma fábrica de classes para suportar essa funcionalidade. Passe em qualquer combinação de campos ou classes que você deseja excluir.

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

    }
}

Para usar, crie duas listas (cada uma é opcional) e crie seu objeto 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);
}

Resolvi esse problema com anotações personalizadas. Esta é minha classe de anotação "SkipSerialisation":

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

}

e este é o meu 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;
  }
});

Exemplo:

public class User implements Serializable {

  public String firstName;

  public String lastName;

  @SkipSerialisation
  public String email;
}

Ou pode dizer o que os campos não serão expostos com:

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

na sua classe no atributo:

private **transient** boolean nameAttribute;

Usei esta estratégia: excluí todos os campos que não estão marcados com a anotação @SerializedName , ou seja:

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

Retorna

{"VisibleValue": "Vou ver isso"}

Outra abordagem (especialmente útil se você precisar decidir excluir um campo em tempo de execução) é registrar um TypeAdapter na sua instância gson. Exemplo abaixo:

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

No caso abaixo, o servidor esperaria um dos dois valores, mas como os dois eram ints, o gson os serializaria. Meu objetivo era omitir qualquer valor que seja zero (ou menos) do json que é postado no servidor.

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

A @Transientanotação de Kotlin também faz o truque, aparentemente.

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

Resultado:

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

Estou trabalhando apenas colocando a @Exposeanotação, aqui minha versão que eu uso

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

Na Modelaula:

@Expose
int number;

public class AdapterRestApi {

Na Adapterclasse:

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

Eu tenho a versão 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
    }
}

e como você pode adicioná-lo ao 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)

É isso que eu sempre uso:

O comportamento padrão implementado no Gson é que os campos de objetos nulos são ignorados.

Significa que o objeto Gson não serializa campos com valores nulos para JSON. Se um campo em um objeto Java for nulo, o Gson o excluirá.

Você pode usar esta função para converter algum objeto em nulo ou bem definido por você mesmo.

     /**
   * 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);
  }