java自定义Gson生成json字符串的顺序

最新推荐文章于 2025-11-20 16:09:03 发布

原创最新推荐文章于 2025-11-20 16:09:03 发布 · 6.7k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#Gson #Java #Json #顺序 #继承

Java 专栏收录该内容

2 篇文章

订阅专栏

本文介绍如何通过自定义Gson TypeAdapter来控制JSON序列化时的字段顺序，实现父类属性在前，子类属性在后的排序，适用于需要特定字段顺序的场景。

版权声明：本文为原创文章，未经允许不得转载。 https://blog.youkuaiyun.com/pei19890521/article/details/85116507
背景：由于项目需求，需要实现一个将Java实体类转成json字符串，再将json字符串生成xml文件进行传输的需求。但是在生成xml之后发现xml字段顺序不正确，排查原因后发现是在生成json的时候顺序不正确，使用Gson生成json后顺序为：子类属性在前，父类属性在后然后根据属性顺序正序排序。如图：
在这里插入图片描述
而我需要的是父类属性在前，子类属性在后正序排序，于是在网上查询资料并实践后终于实现了，原理是写一个类继承Gson的TypeAdapter这个类，然后重写write方法即可，代码如下：

public class SensorTypeAdapter extends TypeAdapter<EBD> {
	@Override
	public void write(JsonWriter out, EBD value) throws IOException {
		Class<? extends BaseEBD> clazz = value.getEBD().getClass();
		//父类属性
		Field[] supfields = clazz.getSuperclass().getDeclaredFields();
		//子类属性
		Field[] subFields = clazz.getDeclaredFields();
		//按自定义顺序输出字段信息
		out.beginObject();
		out.name("EBD");
		out.beginObject();
		setWrite(supfields, out, value.getEBD());
		setWrite(subFields, out, value.getEBD());
		out.endObject();
		out.endObject();
	}
	@Override
	public EBD read(JsonReader in) throws IOException {
		// TODO Auto-generated method stub
		return null;
	}
	//递归写入属性
	public void setWrite(Field[] fields,JsonWriter out,Object object) {
		for(int i=0;i<fields.length;i++) {
			Field field = fields[i];
			field.setAccessible(true); 
			try {
				Object type = field.get(object);
				if(type==null) {
					continue;
				}
				if(!(type instanceof String)) {
					out.name(field.getName()).beginObject();
					Field[] subFields = type.getClass().getDeclaredFields();					
					setWrite(subFields, out, type);
					out.endObject();
				}else{
					out.name(field.getName()).value(type.toString());
				}
			} catch (Exception e) {
				e.printStackTrace();
			}
		}
	}
}

稍微解释下上面代码：上面的out.beginObject();和out.endObject();这两个方法可以理解为就是输出一个“{”和“}”符号，out.name(key).value(value);就相当于是json字符串中的key:value了，连起来就是{key:value}这种格式的字符串。使用的时候就不能直接new GsonBuilder().create()了，需要使用registerTypeAdapter()这个方法：

public class JsonUtil {
	 public static String toJson(Object object,Class<? extends EBD> clazz) {
		 Gson gson = new GsonBuilder().registerTypeAdapter(clazz,new SensorTypeAdapter()).create();
		 return gson.toJson(object);
	 }
}

测试效果如下：
默认输出结果：

		System.out.println(new GsonBuilder().create().toJson(check));
输出：
{"EBD":{"ConnectionCheck":{"RptTime":"2017-06-07 13:40:36"},"EBDVersion":"1","EBDID":"1","EBDType":"ConnectionCheck","SRC":{"EBRID":"22"},"DEST":{"EBRID":"33"},"EBDTime":"2017-06-07 13:40:36"}}

改变后：

System.out.println(toJson(check,EBD_ConnectionCheck.class));
输出：
{"EBD":{"EBDVersion":"1","EBDID":"1","EBDType":"ConnectionCheck","SRC":{"EBRID":"22"},"DEST":{"EBRID":"33"},"EBDTime":"2017-06-07 13:40:36","ConnectionCheck":{"RptTime":"2017-06-07 13:40:36"}}}

其中ConnectionCheck是子类属性，其他是父类属性，可以看见已经排在最后了！
上一篇：Spring boot项目读取自定义的config文件
下一篇：JS黄金分割法实现随机漂亮颜色!