gson-注解

清疚 2022-02-19 04:21 215阅读 0赞

[资源贴][Link 1]

### 文章目录 ###

*   *   *  注解种类
         *  1. @SerializedName 别名
         *  2. @Expose 字段暴露
         *  3. @JsonAdapter 类型适配器
         *  4. @Since/@Util版本字段

### 注解种类 ###

gson2.8.5提供的注解有五个

*  @SerializedName 别名
 *  @Expose 指定需要序列化和反序列化的字段
 *  @JsonAdapter 指示要与类或字段一起使用的Gson类型适配器的注释。
 *  @Since与@Util用于指定版本信息

### 1. @SerializedName 别名 ###

属性：

*  value：序列化或反序列化时对象和json串key不同时可以通过该注解决；
 *  alternate：反序列化时字段的替代名称

例子01：

public class SomeObject { 
        // 为someField指定别名custom_naming
        @SerializedName("custom_naming")
        private final String someField;
        private final String someOtherField;
    
        public SomeObject(String a, String b) { 
            this.someField = a;
            this.someOtherField = b;
        }
    }
    
    SomeObject someObject = new SomeObject("first", "second");
            Gson gson = new Gson();
            String jsonRepresentation = gson.toJson(someObject);
            System.out.println(jsonRepresentation);
            
          // ==>{"custom_naming":"first","someOtherField":"second"}

反序列化也能将custtom\_naming转为someField

例子02：  
假设现在json串someField的名字不是固定为custom\_naming,它是和custom\_naming2二选一哪个有值选哪个，怎么办呢。

// alternate是一个字符串数组，在反序列化和序列化时someField和custom_naming对应（value指定）；在反序列化时，json中的key为custom_naming2和custom_naming3的值都会映射到someFileld
        @SerializedName(value = "custom_naming", alternate = { "custom_naming2", "custom_naming3"})
            private final String someField;
            private final String someOtherField;
        
        Gson gson = new Gson();
            String str = "{\"custom_naming3\":\"first\",\"someOtherField\":\"second\"}";
            SomeObject someObject = gson.fromJson(str,SomeObject.class);
            System.out.println(someObject.getSomeField());

--------------------

### 2. @Expose 字段暴露 ###

属性：

*  serialize 序列化默认为true 要序列化
 *  deserialize 反序列化默认为true

需要使用构造类排除没有使用此注解的字段

new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create();

例子：

@Expose
        private final String someField;
        private final String someOtherField;
        
        SomeObject someObject = new SomeObject("someField", "someOtherField");
        Gson gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create();
        System.out.println(gson.toJson(someObject));
        // ==>{"someField":"someField"}
        // 两个属性分别可以指定序列化和反序列化过程是否参与

--------------------

### 3. @JsonAdapter 类型适配器 ###

属性：

*  value 指定适配器类

可以使用四种适配器：JsonDeserializer,JsonSerializer,InstanceCreator,TypeAdapter

例子01：  
java时间属性在序列化时指定默认格式

private Date date;
        //默认转为一下格式
        // ==>{"date":"Apr 15, 2019 11:30:03 AM"}

例子02：格式化时间  
想转为yyyy-MM-dd hh:mm:ss格式

public class SomeObject { 
        @JsonAdapter(DateTimeSerializer.class)
        private Date date;
    
        public SomeObject(Date date) { 
            this.date = date;
        }
    
        public Date getDate() { 
            return date;
        }
    
        public void setDate(Date date) { 
            this.date = date;
        }
    }
    
    // JsonSerializer序列化接口
    // JsonDeserializer 反序列化接口
    class DateTimeSerializer implements JsonSerializer<Date>, JsonDeserializer<Date> { 
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd hh:mm:ss");
    
        @Override
        public JsonElement serialize(Date src, Type typeOfSrc, JsonSerializationContext context) { 
            return new JsonPrimitive(simpleDateFormat.format(src).toString());
        }
    
    
        @Override
        public Date deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException { 
            String str = json.getAsJsonPrimitive().getAsString();
            try { 
                return simpleDateFormat.parse(str);
            } catch (ParseException e) { 
                e.printStackTrace();
                return null;
            }
        }
    }
    
    public static void main(String[] args) throws Exception { 
            SomeObject someObject = new SomeObject(new Date());
            Gson gson = new Gson();
            System.out.println(gson.toJson(someObject));
            //==>{"date":"2019-04-15 11:31:39"}
        }

--------------------

### 4. @Since/@Util版本字段 ###

属性：

*  value：版本号

@Since 从版本号开始启用字段  
@Util 从版本号开始废弃字段

需要使用构造器类指定版本号

new GsonBuilder().setVersion(1.0).create();

例子：

public class SomeObject { 
        // since 从……启用
        // 1.0版本启用
        @Since(1.0)
        private String field1;
        // 2.0版本启用
        @Since(2.0)
        private String field2;
        // util 直到……废弃
        // 1.0版本开始废弃
        @Until(1.0)
        private String field3;
        // 2.0版本开始废弃
        @Until(2.0)
        private String field4;
    }
    
    public static void main(String[] args) throws Exception { 
            SomeObject someObject = new SomeObject();
            someObject.setField1("field1");
            someObject.setField2("field2");
            someObject.setField3("field3");
            someObject.setField4("field4");
            // 序列化1.9版本以前起用的字段和1.9以后废弃的字段
            Gson gson = new GsonBuilder().setVersion(1.9).create();
            System.out.println(gson.toJson(someObject));
        }
        
        // ==>{"field1":"field1","field4":"field4"}

[Link 1]: https://www.javadoc.io/doc/com.google.code.gson/gson/2.8.5