google-gson 使用及GsonBuilder设置

Json是一种类似于XML的通用数据交换格式,具有比XML更高的传输效率.

 

从结构上看，所有的数据（data）最终都可以分解成三种类型：

第一种类型是标量（scalar），也就是一个单独的字符串（string）或数字（numbers），比如"北京"这个单独的词。

第二种类型是序列（sequence），也就是若干个相关的数据按照一定顺序并列在一起，又叫做数组（array）或列表（List），比如"北京，上海"。

第三种类型是映射（mapping），也就是一个名/值对（Name/value），即数据有一个名称，还有一个与之相对应的值，这又称作散列（hash）或字典（dictionary），比如"首都：北京"。

 

 

Json的规格非常简单，只用一个页面几百个字就能说清楚，而且Douglas Crockford声称这个规格永远不必升级，因为该规定的都规定了。

 

1） 并列的数据之间用逗号（"，"）分隔。

2） 映射用冒号（"："）表示。

3） 并列数据的集合（数组）用方括号("[]")表示。

4） 映射的集合（对象）用大括号（"{}"）表示。

 

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

 

最快速入门贴:

 

1. 对象的序列化和反序列化

 

Type listType = new TypeToken<List<String>>() {}.getType(); 

List<String> target = new LinkedList<String>(); 

target.add("blah");

Gson gson = new Gson(); 

String json = gson.toJson(target, listType); 

List<String> target2 = gson.fromJson(json, listType);

 

 OK,最简方案打完收工.

 

2.使用GsonBuilder.

 

GsonBuilder用来生成Gson对象. 规定Gson的序列化和返序列化时的格式等内容.

如:

 Gson gson = new GsonBuilder()     

            .registerTypeAdapter(Id.class, new IdTypeAdapter())   

            .enableComplexMapKeySerialization() 

            .serializeNulls()   

            .setDateFormat(DateFormat.LONG)  

            .setFieldNamingPolicy(FieldNamingPolicy.UPPER_CAMEL_CASE)//会把字段首字母大写

            .setPrettyPrinting() 

            .setVersion(1.0)    

            .create();

 

3. 使用注解,定制序列化字段.

 

默认情况下@Expose注解是不起作用的,除非你用GsonBuilder创建Gson的时候调用了GsonBuilder.excludeFieldsWithoutExposeAnnotation()方法

 

来个例子:

public class User { 

    @Expose private String firstName; 

    @Expose(serialize = false) private String lastName;

    @Expose (serialize = false, deserialize = false) 

    private String emailAddress; 

    private String password;

 }

 

如果你创建Gson对象的时候使用的是new Gson(),toJson()和fromJson()方法将会对全部的字段生效.但是如果你使用的是GsonBuilder并且调用了excludeFieldsWithoutExposeAnnotation()方法.那么:toJson()和fromJson()将不会包括password.因为password没有包含@Expose注解.

序列化的时候将不包括 lastName和emailAddress,因为注解中标明不进行序列化.同样的道理,反序列化时将不包括emailAddress.

注:如果仅仅是想把某些特定的字段包含在外和话,可以使用transient 关键字声明字段.

 

4. 使用注解对序列化名称进行声明

这个简单,上例子都能懂,不解释:

 public class SomeClassWithFields {

   @SerializedName("name")

   private final String someField;  

   private final String someOtherField;  

 

   public SomeClassWithFields(String a, String b) {   

    this.someField = a; 

    this.someOtherField = b; 

  } 

}

 

 ===== OUTPUT =====

 

 {"name":"a","someOtherField":"b"}

 

5. 例用注解,根据版本进行序列化

有的字段不是一开始就有的,会随着版本的升级添加进来,那么在进行序列化和返序列化的时候就会根据版本号来选择是否要序列化.

@Since(版本号)能完美地实现这个功能.

当然,GsonBuilder.setVersion(double)方法需要调用.

例程如下:

 public class User {  

 private String firstName;  

 private String lastName;   

 @Since(1.0) private String emailAddress;  

 @Since(1.0) private String password;

 @Since(1.1) private Address address;

 }

 

还的字段可能,随着版本的升级而删除,那么

@Until(版本号)也能实现这个功能,GsonBuilder.setVersion(double)方法需要调用.

public class User {   

    private String firstName;   

    private String lastName; 

    @Until(1.1) private String emailAddress;   

    @Until(1.1) private String password;

 }

 

 

maven pom.xml 设置

  <dependency>

   <groupId>com.google.code.gson</groupId>

   <artifactId>gson</artifactId>

   <version>2.1</version>

  </dependency>