Gson使用總結
1、基礎使用
1. 經常使用方法
Gson.toJson(Object);
Gson.fromJson(Reader,Class);
Gson.fromJson(String,Class);
Gson.fromJson(Reader,Type);
Gson.fromJson(String,Type);
複製代碼
2.基本數據類型解析
Gson能夠結合泛型使用，但用到泛型時，需指定
type,如new TypeToken<List<String>>(){}.getType();TypeToken的構造方法是protected的，全部這麼寫new TypeToken<List<String>>(){}php
Gson gson = new Gson();html
反序列化：git
int i = gson.fromJson("1",Integer.class);
boolean b = gson.fromJson("\"true\"",Boolean.class);
double d = gson.fromJson("1.1",Double.class);
double d1 = gson.fromJson("\"1.2\"",Double.class);
String str = gson.fromJson("TomCruise",String.class);
List<String>stringList = gson.fromJson("[\"aa\",\"bb\"]",new TypeToken<List<String>>(){}.getType());
複製代碼
序列化：github
String jsonInt = gson.toJson(2);
String jsonBoolean = gson.toJson(false); // false
String jsonString = gson.toJson("String"); //"String"
List<String>list = new ArrayList<>();
list.add("a");
list.add("b");
String jsonList = gson.toJson(list);
複製代碼
3.POJO類解析
POJO類：Userjson
@JsonAdapter(UserTypeAdapter.class)
public final class User {
@Expose @Since(4)
private String name;
@Expose @Until(4)
private int age;
@Expose private Date date;
@Expose
private List<User>children;
private User parent;
// @SerializedName(value = "email_address",alternate = {"emailAddress","email"})
private String emailAddress;
public User(String name, int age){
this.name = name;
this.age = age;
}
...
...
}
複製代碼
Gson自動化:
Gson gson = new Gson();
String json = "{\"name\":\"John\",\"age\":22,\"email_address\":\"xxx@163.com\"}";
User userF = gson.fromJson(json,User.class);//反序列化
User userT = new User("Tom",10);
userT.setAddress("xxx");
String jsonUser = gson.toJson(userT);//序列化
複製代碼
注：字符串中應注意使用轉義字符，如
\"name\"api
字段重命名：@SerializedName
Java中通常採用駝峯命名，如
emailAddress，但後臺有時命名方式不一樣，如php形式的email_address，此時@SerializedName註解就能起大做用。bash
@SerializedName能夠更改字段名，還能提供備用名屬性：alternate，使用以下：ide
@SerializedName(value = "email_address",alternate = {"emailAddress","email"})
複製代碼
當上面的三個屬性(email_address、email、emailAddress)中出現任意一個時都能進行解析。ui
注：當多種狀況同時出時，以最後一個出現的值爲準。this
4.泛型使用
Gson能夠結合泛型使用，但用到泛型時，需指定
type,如new TypeToken<List<String>>(){}.getType();TypeToken的構造方法是protected的，全部這麼寫new TypeToken<List<String>>(){}； 不管使用List<User>仍是List<String>，最終都是List.class（泛型擦除）
引入泛型能夠很大程度上方便接口的設計，如後臺的返回數據格式常見兩種:
{"code":"0","message":"success","data":{}}和 {"code":"0","message":"success","data":[]
data的類型一種是對象，一種是數據，若無泛型的支持，則需定義兩個httpResponse類，引入泛型，則只需定義一個泛型類，不用去寫無謂的代碼，能更專一於邏輯功能。
public final class HttpResult<T> {
private int code;
private boolean success;
private T data;
...
...
}
複製代碼
使用時：
Gson gson = new Gson();
Type objType = new TypeToken<HttpResult<User>>(){}.getType();
Type listType = new TypeToken<HttpResult<List<User>>>(){}.getType();
HttpResult<User> objUser = gson.fromJson("{\"code\":200,\"data\":{\"age\":70,\"name\":\"Cap\"},\"success\":true}",objType);
HttpResult<List<User>> listUser = gson.fromJson("{\"code\":200,\"data\":[{\"age\":70,\"name\":\"Cap\"}],\"success\":true}",listType);
gson.toJson(objUser);
gson.toJson(listUser);
複製代碼
五、Null、日期格式化等Gson配置
Gson gson = new GsonBuilder()
//格式化輸出
.setPrettyPrinting()
//序列化null
.serializeNulls()
// 設置日期時間格式，另有2個重載方法
// 在序列化和反序化時均生效
.setDateFormat("yyyy-MM-dd")
// 禁此序列化內部類
.disableInnerClassSerialization()
//生成不可執行的Json（多了 )]}' 這4個字符）
.generateNonExecutableJson()
//禁止轉義html標籤
.disableHtmlEscaping()
.create();
User user = new User("John",30);
user.setDate(new Date()); //日期格式化
Log.i("format",gson.toJson(user));
複製代碼
2、手動流式序列化和流式反序列化
利用
JsonReader和JsonWriter手動讀取
JsonReader讀取：
try {
JsonReader jsonReader = new JsonReader(new StringReader("[{\"name\":\"Cap\",\"age\":70, \"address\":\"xxx@163.com\"}" +
",{\"name\":\"Thor\",\"age\":1000, \"address\":\"xxx@q.com\"}]"));
jsonReader.beginArray();
while (jsonReader.hasNext()){
jsonReader.beginObject();
Log.d("JsonReaderArray",jsonReader.nextName()+":"+jsonReader.nextString());
Log.d("JsonReaderArray",jsonReader.nextName()+":"+jsonReader.nextInt());
Log.d("JsonReaderArray",jsonReader.nextName()+":"+jsonReader.nextString());
jsonReader.endObject();
}
jsonReader.endArray();
}catch (Exception e){
e.printStackTrace();
}
複製代碼
JsonWriter讀取：
try {
StringWriter writer = new StringWriter();
JsonWriter jsonWriter = new JsonWriter(writer); jsonWriter.beginArray();
jsonWriter.beginObject();
jsonWriter.name("name")
.value("Stark")
.name("age")
.value(50)
.name("email")
.value("xxx@qq.com");
jsonWriter.endObject();
jsonWriter.beginObject();
jsonWriter.name("name")
.value("BlackWidow")
.name("age")
.value(40)
.name("email")
.value("xxx@qq.com");
jsonWriter.endObject();
jsonWriter.endArray();
jsonWriter.flush();
Log.i("JsonWriter","writer:"+writer.toString());
}catch (Exception e){
e.printStackTrace();
}
複製代碼
注： beginObject和endObject配套使用，beginArray和endArray配套使用
3、過濾忽略字段
須要使用
new GsonBuilder()配置生成Gson對象。對於Gson gson = new Gson()直接生成的Gson對象不起做用。
1.@Expose註解
有兩個屬性值deserialize默認爲true,serialize默認爲true。定義在字段上，代表是否在序列化或反序列化過程當中暴露出來。
注： 是不導出的不加
@Expose
@Expose(deserialize = true,serialize = true) //序列化和反序列化都都生效，等價於上一條
@Expose(deserialize = true,serialize = false) //反序列化時生效
@Expose(deserialize = false,serialize = true) //序列化時生效
@Expose(deserialize = false,serialize = false) // 和不寫註解同樣
複製代碼
User配置如上文 POJO類：User 所示；
Gson gson = new GsonBuilder()
.excludeFieldsWithoutExposeAnnotation()//Expose生效
// .serializeNulls()
// .setPrettyPrinting()
.create();
User user = new User("Tom",50);
User child = new User("Kid",6);
User parent = new User("parent",80);
List<User> children = new ArrayList<>();
children.add(child);
user.setChildren(children);
user.setParent(parent);
Log.d("expose","User:"+gson.toJson(user));
Log.i("expose","User:"+gson.fromJson("{\"age\":50,\"children\":[{\"age\":6,\"name\":\"Kid\"}],\"name\":\"Tom\",\"parent\":{\"age\":80,\"name\":\"parent\"}}"
,User.class));
複製代碼
2.版本號（@Since和@Until）
使用方法：當前版本(GsonBuilder中設置的版本) 大於等於Since的值時該字段導出，小於Until的值時該該字段導出。
User配置如上文 POJO類：User 所示；
Gson gson = new GsonBuilder()
.setVersion(4) //設置版本號
.create();
User user = new User("Tom",50);
User child = new User("Kid",6);
User parent = new User("parent",80);
List<User> children = new ArrayList<>();
children.add(child);
user.setChildren(children);
user.setParent(parent);
Log.d("version","User:"+gson.toJson(user));
Log.i("version","User:"+gson.fromJson("{\"age\":50,\"children\":[{\"age\":6,\"name\":\"Kid\"}],\"name\":\"Tom\",\"parent\":{\"age\":80,\"name\":\"parent\"}}"
,User.class));
複製代碼
3.權限修飾符
即public static final private protected這些修飾符
使用方法：
class ModifierSample {
final String finalField = "final";
static String staticField = "static";
public String publicField = "public";
protected String protectedField = "protected";
String defaultField = "default";
private String privateField = "private";
}
複製代碼
ModifierSample modifierSample = new ModifierSample();
Gson gson = new GsonBuilder()
.excludeFieldsWithModifiers(Modifier.FINAL, Modifier.STATIC, Modifier.PRIVATE)
.create();
System.out.println(gson.toJson(modifierSample));
// 結果：{"publicField":"public","protectedField":"protected","defaultField":"default"}
複製代碼
4.自定義過濾策略(最靈活方便)
基於GsonBuilder的addSerializationExclusionStrategy和addDeserializationExclusionStrategy，使用以下：
Gson gson = new GsonBuilder()
.addSerializationExclusionStrategy(new ExclusionStrategy() {
//基於字段排除
@Override
public boolean shouldSkipField(FieldAttributes f) {
// Expose expose = f.getAnnotation(Expose.class);
// return expose!=null && !expose.serialize();
return false;
}
//基於類排除
@Override
public boolean shouldSkipClass(Class<?> clazz) {
return clazz == int.class||clazz== Integer.class;
}
}).create();
複製代碼
4、POJO與JSON字段名的映射規則
GsonBuilder提供了FieldNamingStrategy接口和setFieldNamingPolicy和setFieldNamingStrategy兩個方法，以及GSON的@SerializedName註解。
1.@SerializedName註解
注： @SerializedName註解擁有最高優先級，在加有@SerializedName註解的字段上FieldNamingStrategy不生效！
@SerializedName能夠更改字段名，還能提供備用名屬性：alternate，使用以下：
@SerializedName(value = "email_address",alternate = {"emailAddress","email"})
複製代碼
2.FieldNamingPolicy
結合GsonBuilder.setFieldNamingPolicy使用，對於：
User user = new User("Cap", 70);
user.emailAddress = "xxx@163.com";
複製代碼
Gson gson = new GsonBuilder()
.setFieldNamingPolicy(FieldNamingPolicy.UPPER_CAMEL_CASE_WITH_SPACES)
.create();
複製代碼
對應的字段效果是：
| FieldNamingPolicy | 結果（僅輸出emailAddress字段） |
|---|---|
| IDENTITY | {"emailAddress":"xxx@163.com"} |
| LOWER_CASE_WITH_DASHES | {"email-address":"xxx@163.com"} |
| LOWER_CASE_WITH_UNDERSCORES | {"email_address":"xxx@163.com"} |
| UPPER_CAMEL_CASE | {"EmailAddress":"xxx@163.com"} |
| UPPER_CAMEL_CASE_WITH_SPACES | {"Email Address":"xxx@163.com"} |
3.自定義實現
GsonBuilder.setFieldNamingStrategy 方法須要與Gson提供的FieldNamingStrategy接口配合使用，用於實現將POJO的字段與JSON的字段相對應。
注：
FieldNamingPolicy也實現了FieldNamingStrategy接口，即FieldNamingPolicy也可使用setFieldNamingStrategy方法。
使用：
Gson gson = new GsonBuilder()
.setFieldNamingStrategy(new FieldNamingStrategy() {
@Override
public String translateName(Field f) {
//實現本身的規則
return null;
}
})
.create();
複製代碼
5、接管序列化和反序列化過程
使用TypeAdapter接口，或JsonSerializer 、JsonDeserializer
注：TypeAdapter 以及 JsonSerializer 和 JsonDeserializer 都須要與 GsonBuilder.registerTypeAdapter 或GsonBuilder.registerTypeHierarchyAdapter配合使用;
注：註冊了 TypeAdapter以後，@SerializedName 、FieldNamingStrategy、Since、Until、Expose都失去了效果，直接由TypeAdapter以後接管。
registerTypeAdapter與registerTypeHierarchyAdapter的區別：
| registerTypeAdapter | registerTypeHierarchyAdapter | |
|---|---|---|
| 支持泛型 | 是 | 否 |
| 支持繼承 | 否 | 是 |
1.TypeAdapter
使用：
Gson gson =new GsonBuilder().registerTypeAdapter(User.class, new TypeAdapter<User>() {
@Override
public void write(JsonWriter out, User value) throws IOException {
out.beginObject();
out.name("mName")
.value(value.getName());
out.endObject();
out.flush();
}
@Override
public User read(JsonReader in) throws IOException {
User user = new User("a",4);
in.beginObject();
if (in.nextName().equals("mName"))
user.setName(in.nextString());
in.endObject();
return user;
}
}).create();
User user = new User("我",10);
Log.i("adapter","user:"+gson.toJson(user));
Log.i("adapter","user:"+gson.fromJson("{\"mName\":\"我\"}",User.class));
複製代碼
2.JsonSerializer和JsonDeserializer
TypeAdapter接管了序列化和反序列化過程，而JsonSerializer和JsonDeserializer則只分別單獨接管序列化和反序列化過程。
使用：
Gson gson =new GsonBuilder()
.registerTypeAdapter(User.class, new JsonSerializer<User>() {
@Override
public JsonElement serialize(User src, Type typeOfSrc, JsonSerializationContext context) {
JsonObject jsonElement = new JsonObject();
jsonElement.addProperty("name","serialize");
return jsonElement;
}
})
.registerTypeAdapter(User.class, new JsonDeserializer<User>() {
@Override
public User deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException {
User user = new User("",10);
user.setName(json.getAsJsonObject().get("mName").getAsString());
return user;
}
}).create();
複製代碼
3.TypeAdapterFactory
用於建立TypeAdapter的工廠類，經過對比Type，肯定有沒有對應的TypeAdapter，沒有就返回null，與GsonBuilder.registerTypeAdapterFactory配合使用。
Gson gson = new GsonBuilder()
.registerTypeAdapterFactory(new TypeAdapterFactory() {
@Override
public <T> TypeAdapter<T> create(Gson gson, TypeToken<T> type) {
return null;
}
})
.create();
複製代碼
4.@JsonAdapter註解
做用在POJO類上的，接收一個參數，且必須是TypeAdpater，JsonSerializer或JsonDeserializer這三個其中之一。
前面的JsonSerializer和JsonDeserializer都要配合GsonBuilder.registerTypeAdapter使用，但每次使用都要註冊也太麻煩了，JsonAdapter就是爲了解決這個痛點的。
使用：
@JsonAdapter(UserTypeAdapter.class)
public final class User {
.....
}
複製代碼
public class UserTypeAdapter implements JsonSerializer<User> {
@Override
public JsonElement serialize(User src, Type typeOfSrc, JsonSerializationContext context) {
JsonObject jsonElement = new JsonObject();
jsonElement.addProperty("name","serialize");
return jsonElement;
}
}
複製代碼
User user = new User("我",10);
Log.i("adapter","user:"+new Gson().toJson(user));//直接使用簡單的new GSON()便可，無需配置註冊
複製代碼
參考連接
- 1. Gson使用總結
- 2. ：關於gson使用的一點總結
- 3. Google Gson使用小結
- 4. Json&Gson學習總結(一)---Json和Gson區別與聯繫及其使用
- 5. 使用GSON
- 6. Gson的使用
- 7. GSON的使用
- 8. Gson使用
- 9. android gson使用
- 10. jersey使用Gson
- 更多相關文章...
- • TortoiseSVN 使用教程 - SVN 教程
- • Docker 容器使用 - Docker教程
- • Composer 安裝與使用
- • 算法總結-雙指針
-
每一个你不满意的现在，都有一个你没有努力的曾经。
- 1. Gson使用總結
- 2. ：關於gson使用的一點總結
- 3. Google Gson使用小結
- 4. Json&Gson學習總結(一)---Json和Gson區別與聯繫及其使用
- 5. 使用GSON
- 6. Gson的使用
- 7. GSON的使用
- 8. Gson使用
- 9. android gson使用
- 10. jersey使用Gson