我正在努力学习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并为firstName或country等字段名称添加ExclusionStrategy，但我似乎无法排除某些字段的属性，例如country.name。< / p>
使用方法public boolean shouldSkipField(FieldAttributes fa)，FieldAttributes不包含足够的信息以使字段与country.name等过滤器匹配。
对于这个问题的解决方案，我将不胜感激。
P.S：我想避免注释，因为我想对此进行改进，并使用RegEx来过滤字段。
谢谢
修改：我正试图看看是否可以模仿Struts2 JSON plugin的行为
使用Gson
<interceptor-ref name="json">
<param name="enableSMD">true</param>
<param name="excludeProperties">
login.password,
studentList.*\.sin
</param>
</interceptor-ref>
修改 我重新提出了以下补充问题：
我添加了第二个相同类型的字段，以进一步澄清这个问题。基本上我想排除country.name但不排除countrOfBirth.name。我也不想将Country排除在类型之外。
因此，类型是相同的，它是我想要精确定位和排除的对象图中的实际位置。
答案 0 :(得分：596)
你不希望序列化的任何字段你应该使用“transient”修饰符，这也适用于json序列化程序（至少它对我使用的一些，包括gson）。
如果您不想在序列化的json中显示名称，请为其提供一个临时关键字，例如：
private transient String name;
答案 1 :(得分：304)
Nishant提供了一个很好的解决方案，但有一种更简单的方法。只需使用@Expose注释标记所需的字段，例如：
@Expose private Long id;
省略您不想序列化的任何字段。然后以这种方式创建你的Gson对象：
Gson gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create();
答案 2 :(得分：223)
因此，您希望排除 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的{{1}}，这是您要排除的内容。
您需要像这样应用此Country.name，
ExclusionStrategy返回：
{ “中间名”： “J”， “首字母”： “疟原虫”， “姓氏”： “油炸”， “国家”：{ “ID”：91}}
我假设在学生班中使用 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);
初始化国家/地区对象。
你可能会喜欢。例如，您不希望序列化名称中包含“name”字符串的任何字段。这样做：
id = 91L这将返回：
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);
答案 3 :(得分：198)
在阅读了我发现的所有可用答案之后，在我的情况下，最灵活的是使用自定义@Exclude注释。所以，我为此实现了简单的策略（我不想使用@Expose标记所有字段，也不想使用与app 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();
答案 4 :(得分：76)
我遇到了这个问题，其中我只想从序列化中删除少量字段，因此我开发了一个相当简单的解决方案，它使用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（使用这些自定义排除策略仍会生效），可以更简洁地完成此操作。
答案 5 :(得分：17)
您可以使用gson探索json树。
尝试这样的事情：
gson.toJsonTree(student).getAsJsonObject()
.get("country").getAsJsonObject().remove("name");
您还可以添加一些属性：
gson.toJsonTree(student).getAsJsonObject().addProperty("isGoodStudent", false);
使用gson 2.2.4测试。
答案 6 :(得分：16)
我想出了一个类工厂来支持这个功能。传递您要排除的字段或类的任意组合。
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);
}
答案 7 :(得分：13)
我用自定义注释解决了这个问题。 这是我的“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;
}
答案 8 :(得分：8)
或者可以说什么字段不会暴露：
Gson gson = gsonBuilder.excludeFieldsWithModifiers(Modifier.TRANSIENT).create();
关于属性的课程：
private **transient** boolean nameAttribute;
答案 9 :(得分：7)
我使用了这个策略： 我排除了 标记 @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);
返回
{＆＃34; VisibleValue＆＃34;：＆＃34;我会看到这个＆＃34;}
答案 10 :(得分：6)
另一种方法（如果您需要决定在运行时排除字段，尤其有用）是使用您的gson实例注册TypeAdapter。示例如下：
Gson gson = new GsonBuilder()
.registerTypeAdapter(BloodPressurePost.class, new BloodPressurePostSerializer())
在下面的情况中，服务器会期望两个值中的一个，但由于它们都是int，因此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;
}
}
答案 11 :(得分：2)
科特林的settings.gradle注释显然也可以解决问题。
@Transient输出：
data class Json(
@field:SerializedName("serialized_field_1") val field1: String,
@field:SerializedName("serialized_field_2") val field2: String,
@Transient val field3: String
)
答案 12 :(得分：1)
我只是将@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);
}
答案 13 :(得分：1)
我有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)
答案 14 :(得分：0)
这就是我经常使用的：
Gson中实现的默认行为是忽略空对象字段。
意味着Gson对象不会将具有空值的字段序列化为JSON。如果Java对象中的字段为null，则Gson会将其排除。
您可以使用此功能将某些对象转换为null或由您自己设置好
/**
* 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);
}
答案 15 :(得分：0)