GSON使用笔记(1) -- 序列化时排除字段的几种方式

http://blog.csdn.net/zxhoo/article/details/21471005

GSON是Google发布的JSON序列化/反序列化工具,非常容易使用。本文简要讨论在使用GSON将Java对象转成JSON时,如何排除某些字段。

最简单的用法

假设有下面这个类:

  1. class MyObj {
  2. public int x;
  3. public int y;
  4. public MyObj(int x, int y) {
  5. this.x = x;
  6. this.y = y;
  7. }
  8. }

最简单的GSON用法如下所示:

  1. @Test
  2. public void gson() {
  3. MyObj obj = new MyObj(1, 2);
  4. String json = new Gson().toJson(obj);
  5. Assert.assertEquals("{\"x\":1,\"y\":2}", json);
  6. }

方法1:排除null字段

null字段,默认就不会序列化的,如下所示:

  1. class MyObj {
  2. private int intField;
  3. private String strField;
  4. }
  1. @Test
  2. public void gson() {
  3. MyObj obj = new MyObj();
  4. Assert.assertEquals("{\"intField\":0}", new Gson().toJson(obj));
  5. }

要想序列化null字段,需要显示的进行设置:

  1. @Test
  2. public void serializeNulls() {
  3. MyObj obj = new MyObj();
  4. Gson gson = new GsonBuilder().serializeNulls().create();
  5. Assert.assertEquals("{\"intField\":0,\"strField\":null}", gson.toJson(obj));
  6. }

方法2:排除transient字段

这个方法最简单,给字段加上transient修饰符就可以了,如下所示:

  1. class MyObj {
  2. public transient int x; // <---
  3. public int y;
  4. public MyObj(int x, int y) {
  5. this.x = x;
  6. this.y = y;
  7. }
  8. }
  1. @Test
  2. public void gson() {
  3. MyObj obj = new MyObj(1, 2);
  4. String json = new Gson().toJson(obj);
  5. Assert.assertEquals("{\"y\":2}", json); // <---
  6. }

方法3:排除Modifier为指定类型的字段

这个方法需要用GsonBuilder定制一个GSON实例,如下所示:

  1. class MyObj {
  2. protected int x; // <---
  3. public int y;
  4. public MyObj(int x, int y) {
  5. this.x = x;
  6. this.y = y;
  7. }
  8. }
  1. @Test
  2. public void gson() {
  3. Gson gson = new GsonBuilder()
  4. .excludeFieldsWithModifiers(Modifier.PROTECTED) // <---
  5. .create();
  6. MyObj obj = new MyObj(1, 2);
  7. String json = gson.toJson(obj); // <---
  8. Assert.assertEquals("{\"y\":2}", json);
  9. }

方法4:使用@Expose注解

注意,没有被@Expose标注的字段会被排除,如下所示:

  1. class MyObj {
  2. public int x;
  3. @Expose public int y; // <---
  4. public MyObj(int x, int y) {
  5. this.x = x;
  6. this.y = y;
  7. }
  8. }
  1. @Test
  2. public void gson() {
  3. Gson gson = new GsonBuilder()
  4. .excludeFieldsWithoutExposeAnnotation() // <---
  5. .create();
  6. MyObj obj = new MyObj(1, 2);
  7. String json = gson.toJson(obj);
  8. Assert.assertEquals("{\"y\":2}", json);
  9. }

方法5:使用ExclusionStrategy定制字段排除策略

这种方式最灵活,下面的例子把所有以下划线开头的字段全部都排除掉:

  1. class MyObj {
  2. public int _x; // <---
  3. public int y;
  4. public MyObj(int x, int y) {
  5. this._x = x;
  6. this.y = y;
  7. }
  8. }
  1. @Test
  2. public void gson() {
  3. ExclusionStrategy myExclusionStrategy = new ExclusionStrategy() {
  4. @Override
  5. public boolean shouldSkipField(FieldAttributes fa) {
  6. return fa.getName().startsWith("_"); // <---
  7. }
  8. @Override
  9. public boolean shouldSkipClass(Class<?> clazz) {
  10. return false;
  11. }
  12. };
  13. Gson gson = new GsonBuilder()
  14. .setExclusionStrategies(myExclusionStrategy) // <---
  15. .create();
  16. MyObj obj = new MyObj(1, 2);
  17. String json = gson.toJson(obj);
  18. Assert.assertEquals("{\"y\":2}", json);
  19. }
上一篇:开发环境配置(netbeans+ant迁移到eclipse+maven)


下一篇:[Leetcode][021] Merge Two Sorted Lists (Java)