關於Gson和XML的解析方式
JSON (官網) 是一種文字形式的資料交換格式,它比XML更輕量、比二進位制容易閱讀和編寫,調式也更加方便。其重要性不言而喻。解析和生成的方式很多,Java中最常用的類庫有:JSON-Java、Gson、Jackson、FastJson等。
該系列其它文章
注:此係列基於Gson 2.4。
對Gson使用很自信的大大可以點選關閉啦。
本篇文章的主要內容:
- Gson的基本用法
- 屬性重新命名
@SerializedName
註解的使用 - Gson中使用泛型
一、Gson的基本用法
Gson提供了fromJson()
和toJson()
兩個直接用於解析和生成的方法,前者實現反序列化,後者實現了序列化。同時每個方法都提供了過載方法,我常用的總共有5個。
基本資料型別的解析
Gson gson = new Gson();
int i = gson.fromJson("100", int.class); //100
double d = gson.fromJson("\"99.99\"", double.class); //99.99
boolean b = gson.fromJson("true", boolean.class); // true
String str = gson.fromJson("String", String.class); // String
注:不知道你是否注意到了第2、3行有什麼不一樣沒
基本資料型別的生成
Gson gson = new Gson();
String jsonNumber = gson.toJson(100); // 100
String jsonBoolean = gson.toJson(false); // false
String jsonString = gson.toJson("String"); //"String"
POJO類的生成與解析
public class User {
//省略其它
public String name;
public int age;
public String emailAddress;
}
生成JSON:
Gson gson = new Gson();
User user = new User("怪盜kidou",24);
String jsonObject = gson.toJson(user); // {"name":"怪盜kidou","age":24}
解析JSON:
Gson gson = new Gson();
String jsonString = "{\"name\":\"怪盜kidou\",\"age\":24}";
User user = gson.fromJson(jsonString, User.class);
二、屬性重新命名 @SerializedName 註解的使用
從上面POJO的生成與解析可以看出json的欄位和值是的名稱和型別是一一對應的,但也有一定容錯機制(如第一個例子第3行將字串的99.99轉成double型,你可別告訴我都是字串啊),但有時候也會出現一些不和諧的情況,如:
期望的json格式
{"name":"怪盜kidou","age":24,"emailAddress":"[email protected]"}
實際
{"name":"怪盜kidou","age":24,"email_address":"[email protected]"}
這對於使用PHP作為後臺開發語言時很常見的情況,php和js在命名時一般採用下劃線風格,而Java中一般採用的駝峰法,讓後臺的哥們改吧 前端和後臺都不爽,但要自己使用下劃線風格時我會感到不適應,怎麼辦?難到沒有兩全齊美的方法麼?
我們知道Gson在序列化和反序列化時需要使用反射,說到反射就不得不想到註解,一般各類庫都將註解放到annotations
包下,開啟原始碼在com.google.gson
包下果然有一個annotations
,裡面有一個SerializedName
的註解類,這應該就是我們要找的。
那麼對於json中email_address
這個屬性對應POJO的屬性則變成:
@SerializedName("email_address")
public String emailAddress;
這樣的話,很好的保留了前端、後臺、Android/java各自的命名習慣。
你以為這樣就完了麼?
如果接中設計不嚴謹或者其它地方可以重用該類,其它欄位都一樣,就emailAddress
欄位不一樣,比如有下面三種情況那怎麼?重新寫一個?
{"name":"怪盜kidou","age":24,"emailAddress":"[email protected]"}
{"name":"怪盜kidou","age":24,"email_address":"[email protected]"}
{"name":"怪盜kidou","age":24,"email":"[email protected]"}
為POJO欄位提供備選屬性名SerializedName
註解提供了兩個屬性,上面用到了其中一個,別外還有一個屬性alternate
,接收一個String陣列。
注:alternate
需要2.4版本
@SerializedName(value = "emailAddress", alternate = {"email", "email_address"})
public String emailAddress;
當上面的三個屬性(email_address、email、emailAddress)都中出現任意一個時均可以得到正確的結果。
注:當多種情況同時出時,以最後一個出現的值為準。
Gson gson = new Gson();
String json = "{\"name\":\"怪盜kidou\",\"age\":24,\"emailAddress\":\"[email protected]\",\"email\":\"[email protected]\",\"email_address\":\"[email protected]\"}";
User user = gson.fromJson(json, User.class);
System.out.println(user.emailAddress); // [email protected]
三、Gson中使用泛型
上面瞭解的JSON中的Number、boolean、Object和String,現在說一下Array。
例:JSON字串陣列
["Android","Java","PHP"]
當我們要通過Gson解析這個json時,一般有兩種方式:使用陣列,使用List。而List對於增刪都是比較方便的,所以實際使用是還是List比較多。
陣列比較簡單
Gson gson = new Gson();
String jsonArray = "[\"Android\",\"Java\",\"PHP\"]";
String[] strings = gson.fromJson(jsonArray, String[].class);
但對於List將上面的程式碼中的 String[].class
直接改為 List<String>.class
是行不通的。對於Java來說List<String>
和List<User>
這倆個的位元組碼檔案只一個那就是List.class
,這是Java泛型使用時要注意的問題 泛型擦除。
為了解決的上面的問題,Gson為我們提供了TypeToken
來實現對泛型的支援,所以當我們希望使用將以上的資料解析為List<String>
時需要這樣寫。
Gson gson = new Gson();
String jsonArray = "[\"Android\",\"Java\",\"PHP\"]";
String[] strings = gson.fromJson(jsonArray, String[].class);
List<String> stringList = gson.fromJson(jsonArray, new TypeToken<List<String>>() {}.getType());
注:TypeToken
的構造方法是protected
修飾的,所以上面才會寫成new
TypeToken<List<String>>() {}.getType()
而不是 new TypeToken<List<String>>().getType()
泛型解析對介面POJO的設計影響
泛型的引入可以減少無關的程式碼,如我現在所在公司介面返回的資料分為兩類:
{"code":"0","message":"success","data":{}}
{"code":"0","message":"success","data":[]}
我們真正需要的data
所包含的資料,而code
只使用一次,message
則幾乎不用。如果Gson不支援泛型或不知道Gson支援泛型的同學一定會這麼定義POJO。
public class UserResponse {
public int code;
public String message;
public User data;
}
當其它介面的時候又重新定義一個XXResponse
將data
的型別改成XX,很明顯code
,和message
被重複定義了多次,通過泛型的話我們可以將code
和message
欄位抽取到一個Result
的類中,這樣我們只需要編寫data
欄位所對應的POJO即可,更專注於我們的業務邏輯。如:
public class Result<T> {
public int code;
public String message;
public T data;
}
那麼對於data
欄位是User
時則可以寫為 Result<User>
,當是個列表的時候為 Result<List<User>>
,其它同理。
PS:嫌每次 new TypeToken<Result<XXX>
和 new
TypeToken<Result<List<XXX>>
太麻煩, 想進一步封裝? 檢視我的另一篇部落格:
結語
本文主要通過程式碼向各位讀者講解了Gson的基本用法,以後還會更新更多更高階的用法,如果你還不熟悉 註解和泛型 那麼你要多多努力啦。
如果你有其它的想了解的內容(不限於Gson)請給我留言評論,水平有限,歡迎拍磚。
4月6日補充
有說看不懂Result那段怎麼個簡化法,下面給個兩個完整的例子,User和List<User> 。
沒有引入泛型之前時寫法:
public class UserResult {
public int code;
public String message;
public User data;
}
//=========
public class UserListResult {
public int code;
public String message;
public List<User> data;
}
//=========
String json = "{..........}";
Gson gson = new Gson();
UserResult userResult = gson.fromJson(json,UserResult.class);
User user = userResult.data;
UserListResult userListResult = gson.fromJson(json,UserListResult.class);
List<User> users = userListResult.data;
上面有兩個類UserResult
和UserListResult
,有兩個欄位重複,一兩個介面就算了,如果有上百個怎麼辦?不得累死?所以引入泛型。
//不再重複定義Result類
Type userType = new TypeToken<Result<User>>(){}.getType();
Result<User> userResult = gson.fromJson(json,userType);
User user = userResult.data;
Type userListType = new TypeToken<Result<List<User>>>(){}.getType();
Result<List<User>> userListResult = gson.fromJson(json,userListType);
List<User> users = userListResult.data;
看出區別了麼?引入了泛型之後雖然要多寫一句話用於獲取泛型資訊,但是返回值型別很直觀,也少定義了很多無關類
相關推薦
關於Gson和XML的解析方式
JSON (官網) 是一種文字形式的資料交換格式,它比XML更輕量、比二進位制容易閱讀和編寫,調式也更加方便。其重要性不言而喻。解析和生成的方式很多,Java中最常用的類庫有:JSON-Java、Gson、Jackson、FastJson等。 該系列其它文章 注
帶URL的XML解析方式
add body xsd manager clas pos pen turn table XmlDocument xml = new XmlDocument(); xml.LoadXml(responseString); XmlNode root = xml.Documen
Python-Json字符串和XML解析
all 創建 目標 有效 語言 系列化 res 組成 tag Python-json字符串和xml解析 JSON:JavaScript Object Notation(JavaScript 對象表示法) JSON是存儲和交換文本信息的語法,類似XML JSON比
Android網絡請求與數據解析,使用Gson和GsonFormat解析復雜Json數據
byte 自動 content json對象 .sh cimage 超文本 getjson puts 版權聲明:未經博主允許不得轉載 一:簡介 【達叔有道】軟件技術人員,時代作者,從 Android 到全棧之路,我相信你也可以!閱讀他的文章,會上癮!You and m
XML解析方式之實體類解析
/// <summary> /// XML字串解析實體類方法 /// </summary> public class StringXML { public StringXML() { } public Stri
properties和 xml配置方式,如何選擇
完成 add log4j xml配置 試驗 key val log 文件結構 在學習集成log4j的時候,接觸到了properties配置 個人感覺不是很好用,但與xml配置都可以完成指定的功能 properties配置文件,風格是一個屬性對應於一個值(key = valu
Gson和fastJson 解析巢狀泛型的json資料
Test /* * { "code": 1, "datas": [{ "address": "深圳",
Spring基於註解和XML混合方式的使用
首先要明白,基於註解和XML兩種方式的實現功能是一樣的,只是兩種不同的配置方式。 一、IoC配置 1、配置xml 在使用註解與xml結合的方式配置IoC之前,首先要引入context標籤: xmlns:context="http://www.springframework.org/schema/con
xml和xml解析
lan win 字符 依賴 modify 增刪改 fir email 容易 1.簡介XML XML 可擴展標記語言,傳輸數據 HTML超文本標記語言,顯示數據 XML 文檔聲明 只能放在第一行,註釋不能放在聲明之前 <?xml version="1.0"
分別講解gson和fastjson解析json格式
1、Gson講解 gson是谷歌開發支援的,谷歌GSON這個Java類庫可以把Java物件轉換成JSON,也可以把JSON字串轉換成一個相等的Java物件。 * 伺服器端將資料轉換成json字串 在很多的時候,需要客戶端上傳json格式給伺服器,如果你自己去拼湊js
四種XML解析方式詳解
一、介紹及優缺點分析 1. DOM(Document Object Model) DOM是用與平臺和語言無關的方式表示XML文件的官方W3C標準。DOM是以層次結構組織的節點或資訊片斷的集合。這個層次結構允許開發人員在樹中尋找特定資訊。分析該結構通常需要載入整個文件和構造層次結構,然後才能
Android xml解析方式
常用的xml解析方式有三種:SAX解析、pull解析和DOM解析。Android推薦的解析方式是pull解析pull解析小巧靈便,解析速度快,是Android推薦的解析方式try { //得到xml解析器 XmlPullParser pullParser = Xml.
Spring AOP之---基於ProxyFactory的類編碼方式和XML配置方式實現AOP
前一篇文章Spring AOP之—基於JDK動態代理和CGLib動態代理的AOP實現 介紹了AOP的底層實現,基於JDK動態代理和CGLib動態代理。手工編碼的方式很繁瑣,本文介紹通過ProxyFactory和配置的方式實現AOP,方便快捷。 一、Sp
xml兩種解析方式(封裝了獲得文件和回寫)
開始時間:2018年10月6日13:16:37 結束時間:2018年10月6日14:26:25 累計時間:1 xml解析: 這一篇挺好 https://blog.csdn.net/CristianoJason/article/details/51777853
XML的解析方式-DMO和SAX
支援DOM和SAX兩種解析技術的JAR包 SUN公司:JAXP DOM4J公司:DOM4J DOM解析方式 把XML文件載入到記憶體中,形成樹狀結構 特點:文件過大,容易產生記憶體溢位的問題,但是可以進行增刪改查的操作 SAX解析方式 邊讀邊解析,基於事件驅動 特點:
xml中倆種解析方式
print source 想要 tree urn 由於 oot con 一個 兩種解析方式 1、from xml.etree import ElementTree as ET 利用ElementTree模塊下的xml方法可以把一個字符串類型的東西轉換成Element類,
XML 解析---dom解析和sax解析
靜態 open 轉換器 tno 抽象 imp 高速 default 內容 眼下XML解析的方法主要用兩種: 1、dom解析:(Document Object Model。即文檔對象模型)是W3C組織推薦的解析XML的一種方式。 使用dom解析XML文檔,該解析器會先
xml的兩種解析方式
name 字符 system main ner exce pub void ref xml解析是日常項目中用到比較多的技能。不管是配置參數或者數據都能夠保存在xml文件裏。同一時候也能夠將xml作為數據傳輸的一種格式。本文將介紹兩種基本解析方式:xml字符串解析和xml
XML的四種解析方式
ron 合並 parent 問題 private entity cti fin system 基礎方法: DOM、SAX DOM:與平臺無關的官方解析方式 SAX:基於事件驅動的解析方式 擴展方法:JDOM、DOM4J(在基礎的方法上擴展的,只有Java能夠使用
Android中三種常用解析XML的方式(DOM、SAX、PULL)簡介及區別
字符串 lan win name屬性 Coding 空間 toc log fin XML在各種開發中都廣泛應用,Android也不例外。作為承載數據的一個重要角色,如何讀寫XML成為Android開發中一項重要的技能。今天就由我向大家介紹一下在Android平臺下幾種常見的