@SerializedName注解

Posted newcaoguo

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了@SerializedName注解相关的知识,希望对你有一定的参考价值。

  在android中解析Gson解析json数据是很方便快捷的,可以直接将json数据解析成java对象或者集合。
  Gson解析json的方法我这里就不详细说明了,网上一大把的例子,我这里主要说一下使用@SerializedName进行注解的情况。
  使用Gson解析json成对象时默认的是将json里对应字段的值解析到java对象里对应字段的属性里面。然后我们经常会遇到我们自己定义的java对象里的属性名跟json里的字段名是不一样的,这种情况怎么办呢,这时我们就可以使用@SerializedName注解来将对象里的属性跟json里字段对应值匹配起来。
  下面说说具体使用方法:
  我们有一段json数据如下:

  1. {
  2. "id":"1"
  3. "n":"zhangsan"
  4. "p":"123456"
  5. "s":"0"
  6. }

  这是一个user的数据包括id、用户名、密码、性别,如果正常些一个user类来解析的话是这样的:

  1. public class User{
  2. private String id;
  3. private String n;
  4. private String p;
  5. private String s;
  6. }

  User类要这样写才能直接使用Gson直接解析出来,但是这样的话User类的属性命名就不太友好了,那我们要怎么做呢?Gson提供注解的方法来解决这个问题@SerializedName,使用方法如下:

  1. public class User{
  2.  
  3. private String id;
  4.  
  5. @SerializedName("n")
  6. private String userName;
  7.  
  8. @SerializedName("p")
  9. private String password;
  10.  
  11. @SerializedName("s")
  12. private String sex;
  13. }

  这样再使用Gson解析的时候就会将n对应的值赋值到userName属性上,同样的如果我们要将User生成json字符串使用Gson生成的时候也会将userName的名字生成n。这样就解决了java对象里属性名跟json里字段名不匹配的情况了。

以上是关于@SerializedName注解的主要内容,如果未能解决你的问题,请参考以下文章

在android java中设置动态SerializedName注解

Gson @SerializedName注解使用说明

gson的 Expose注解和 SerializedName注解

@SerializedName注解的意义

实体类属性名字不规范用啥注解改

Gson:@Expose 与 @SerializedName