GSON主干流程略论

GSON:

由谷歌开发的实现Java对象和JSON表达式相互转换的框架。

GSON简析

我们先来分析一下官方给出的框架使用代码:

 Gson gson = new Gson(); // 或用建造者模式构建Gson对象GsonBuilder().create();
 MyType target = new MyType();
 String json = gson.toJson(target); // 序列化为Json
 MyType target2 = gson.fromJson(json, MyType.class); // 反序列化为 target2

简要分析一下从这段代码可以看出的设计模式。一、建造者模式(GsonBuilder),二、门面模式(Gson类就是Gson框架的门面)。另外,作为Gson框架的核心类TypeAdapter里有两个设计模式:三、工厂模式(TypeAdapterFactory),四、适配器模式(TypeAdapter)。后续的文章我们将从这四个设计模式入手对Gson进行剖析。


GSON.png

GSON框架使用套路

作为一个最经典最常用的JSON解析框架,使用上已经无需多说了。直接上源码:
在app/build.gradle中添加依赖库:

dependencies{
    implements 'com.google.code.gson:gson:2.8'
}

举下面这段JSON格式数据为例子,进行GSON解析。一般我们从后台get到的网络数据也就长这样。

[{"name":"Tom","age":20},
{"name":"James","age":30}]

定义Person类,拥有name和id两个字段,对应上面的JSON数据:

public class Person{
    private String name;
    private int age;
    public String getName(){
        return this.name;
    }
    public void setName(String name){
        this.name = name;
    }
    public int getAge(){
        return this.age;
    }
    public void setAge(int age){
        this.age = age;
    }
    
}

一般从后台get到的都是GSON数组,可以用下面的程序解析。

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        String responseData = "[{\"name\":\"Tom\",\"age\":20},{\"name\":\"James\",\"age\":30}]";
        parseJSONWithGSON(responseData);
    }

    private void parseJSONWithGSON(String jsonData){
        Gson gson = new Gson();
        List<Person> peopleList = gson.fromJson(jsonData,new TypeToken<List<Person>>(){}.getType());
        for(Person people:peopleList){
            System.out.println("name is"+people.getName()+" age is"+people.getAge() );
            Log.d("MainAcitvity","name is "+people.getName());
            Log.d("MainAcitvity","age is "+people.getAge());
        }
    }
}

Log图:


Log图.png

Gson对象的构造函数分析

Gson构造器共12个输入,如下所示:
1、final Excluder excluder,
默认:默认的排除器,具体得看Excluder类
2、final FieldNamingStrategy fieldNamingStrategy,
默认:使用IDENTITY命名规则
3、final Map<Type, InstanceCreator<?>> instanceCreators,
默认:emptyMap() 空Map
4、boolean serializeNulls,
默认:false 不支持空对象
5、boolean complexMapKeySerialization,
默认:false 不支持复杂Map的序列化
6、boolean generateNonExecutableGson,
默认:false 不生成可执行json
7、boolean htmlSafe,
默认:true 对html进行编码
8、boolean prettyPrinting,
默认:false 不支持输出格式化json
9、boolean lenient,
默认:false 使用标准json格式,不进行自定义
10、boolean serializeSpecialFloatingPointValues,
默认:false 不支持特殊浮点数序列化
11、LongSerializationPolicy longSerializationPolicy,
默认:默认的,具体得看LongSerializationPolicy类
12、List<TypeAdapterFactory> typeAdapterFactories
默认:空List

上源码分析:

  public Gson() {
    this(Excluder.DEFAULT, FieldNamingPolicy.IDENTITY,
        Collections.<Type, InstanceCreator<?>>emptyMap(), DEFAULT_SERIALIZE_NULLS,
        DEFAULT_COMPLEX_MAP_KEYS, DEFAULT_JSON_NON_EXECUTABLE, DEFAULT_ESCAPE_HTML,
        DEFAULT_PRETTY_PRINT, DEFAULT_LENIENT, DEFAULT_SPECIALIZE_FLOAT_VALUES,
        LongSerializationPolicy.DEFAULT, Collections.<TypeAdapterFactory>emptyList());
  }

  Gson(final Excluder excluder, final FieldNamingStrategy fieldNamingStrategy,
      final Map<Type, InstanceCreator<?>> instanceCreators, boolean serializeNulls,
      boolean complexMapKeySerialization, boolean generateNonExecutableGson, boolean htmlSafe,
      boolean prettyPrinting, boolean lenient, boolean serializeSpecialFloatingPointValues,
      LongSerializationPolicy longSerializationPolicy,
      List<TypeAdapterFactory> typeAdapterFactories) {
    //ConstructorConstructor 用来统一调度 instanceCreators      
    this.constructorConstructor = new ConstructorConstructor(instanceCreators);
    //排除器,在序列化对象的时候会根据使用者设置的规则排除一些数据
    this.excluder = excluder;
    //fieldNamingStrategy 负责命名规则的确定(比如大驼峰命名、小驼峰命名、下划线命名 等)
    this.fieldNamingStrategy = fieldNamingStrategy;
    //serializeNulls 是一个 boolean 类型的对象,用以表示是否支持空对象的序列化
    this.serializeNulls = serializeNulls;
    //是否要生成不可执行的 json
    this.generateNonExecutableJson = generateNonExecutableGson;
    //是否对 html 进行编码,即对部分符号进行转义(=、<、> 等)
    this.htmlSafe = htmlSafe;
    //是否在输出的时候格式化 json
    this.prettyPrinting = prettyPrinting;
     //是否设置 json 的自定义标准
    this.lenient = lenient;

    List<TypeAdapterFactory> factories = new ArrayList<TypeAdapterFactory>();

    // 不能重写的内置类型适配器
    factories.add(TypeAdapters.JSON_ELEMENT_FACTORY);
    factories.add(ObjectTypeAdapter.FACTORY);
    ......
    //设置对 long 类型的变量,是解析成字符串还是解析为 long 类型
    TypeAdapter<Number> longAdapter = longAdapter(longSerializationPolicy);
    //用于支持 double,float 类型的特殊值,比如 Infinity(无穷大) 或 -Infinity(负无穷大) 等
    factories.add(TypeAdapters.newFactory(double.class, Double.class,
            doubleAdapter(serializeSpecialFloatingPointValues)));
    factories.add(TypeAdapters.newFactory(float.class, Float.class,
            floatAdapter(serializeSpecialFloatingPointValues)));
    // the excluder must precede all adapters that handle user-defined types
    factories.add(excluder);
    ......
    // //使用者自定义的 TypeAdapterFactory
    factories.addAll(typeAdapterFactories);
    ......  
    factories.add(new CollectionTypeAdapterFactory(constructorConstructor));
    //处理 Map 类型对象的 TypeAdapterFactory,会受到 complexMapKeySerialization 的影响
    factories.add(new MapTypeAdapterFactory(constructorConstructor, complexMapKeySerialization));
    ......
    this.factories = Collections.unmodifiableList(factories);
  }

Gson对象的fromJson方法分析

fromJson方法一共又7个,我们调用的是fromJson(String json, Type typeOfT)。而fromJson(String json, Type typeOfT)调用fromJson(Reader json, Type typeOfT)调用fromJson(JsonReader reader, Type typeOfT)。

  public <T> T fromJson(String json, Type typeOfT) throws JsonSyntaxException {
    if (json == null) {
      return null;
    }
    //将字符串转成泛型T的主体方法
    //StringReader 是一个 jdk 中存在的 String 和 Reader 的关联封装类
    StringReader reader = new StringReader(json);
    T target = (T) fromJson(reader, typeOfT);
    return target;
  }

继续追踪源码中的重载方法fromJson(Reader json, Type typeOfT):

  public <T> T fromJson(Reader json, Type typeOfT) throws JsonIOException, JsonSyntaxException {
    JsonReader jsonReader = newJsonReader(json);
    T object = (T) fromJson(jsonReader, typeOfT);
    assertFullConsumption(object, jsonReader);
    return object;
  }

继续追踪源码中的重载方法fromJson(JsonReader reader, Type typeOfT):

  public <T> T fromJson(JsonReader reader, Type typeOfT) throws JsonIOException, JsonSyntaxException {
    boolean isEmpty = true;
    boolean oldLenient = reader.isLenient();
    // 打开 reader 的标准化检验
    reader.setLenient(true);
    try {
      reader.peek();
      isEmpty = false;
      //TypeToken 本质上是 Class 的增强封装类
      TypeToken<T> typeToken = (TypeToken<T>) TypeToken.get(typeOfT);
      // TypeAdapter是Gson的核心类,进行匹配Json和对象
      TypeAdapter<T> typeAdapter = getAdapter(typeToken);
      // 生成对象并返回
      T object = typeAdapter.read(reader);
      return object;
    } catch (EOFException e) {
      if (isEmpty) {
        return null;
      }
      throw new JsonSyntaxException(e);
    } catch (IllegalStateException e) {
      throw new JsonSyntaxException(e);
    } catch (IOException e) {
      throw new JsonSyntaxException(e);
    } finally {
      reader.setLenient(oldLenient);
    }
  }

参考文献

1、gson-2.8.0-javadoc.jar
2、Gson完全教程:https://www.jianshu.com/p/923a9fe78108

All is well.

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,864评论 6 494
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,175评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,401评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,170评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,276评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,364评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,401评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,179评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,604评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,902评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,070评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,751评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,380评论 3 319
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,077评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,312评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,924评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,957评论 2 351