當(dāng)前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

完全理解Gson（1）：简单入门

發(fā)布時(shí)間：2023/12/20 编程问答 34 豆豆

生活随笔收集整理的這篇文章主要介紹了完全理解Gson（1）：简单入门小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,幫大家做個(gè)參考.

GSON是Google開發(fā)的Java API，用于轉(zhuǎn)換Java對象和Json對象。本文討論并提供了使用API的簡單代碼示例。更多關(guān)于GSON的API可以訪問：http://sites.google.com/site/gson/.

本文是GSON系列文章的第一篇。本文是其他文章的基礎(chǔ)，因此不需要任何GSON或JSON經(jīng)驗(yàn)。第二篇文章提供了關(guān)于GSON反序列化（從JSON到Java）的示例，第三篇文章提供了關(guān)于GSON序列化（從Java到JSON）的示例。

下面列出的所有代碼都可以在https://java-creed-examples.googlecode.com/svn/gson/Simple%20Gson%20Example. 找到。絕大部分示例都不會(huì)包含全部的代碼，可能會(huì)忽略一些片段，這些片段都與討論的示例無關(guān)。讀者可以從上面的鏈接下載或查閱所有代碼。

讀者需要有基礎(chǔ)的Java（教程）知識和很基礎(chǔ)的Maven(首頁)知識。這里展示的代碼使用maven來下載GSON庫。把項(xiàng)目導(dǎo)入到Springsource Tool Suite（推薦的IDE），無需任何配置。

下載與安裝

在使用GSON API工作之前，你需要下載庫(jar文件)，并將其包含到類路徑中。庫，連同源代碼和Java文檔，都可以從http://code.google.com/p/google-gson/downloads/list下載。下載完畢后，添加gson-<version>.jar到類路徑。對于那些偏好使用Maven管理依賴(JAR文件)的讀者，添加如下依賴到pom.xml。

1 2 3 4 5

<dependency> ????<groupId>com.google.code.gson</groupId> ????<artifactId>gson</artifactId> ????<version>2.2.4</version> </dependency>

需要修改?<version>2.2.4</version>。本文所有代碼示例使用上面列出的版本。pom.xml文件拷貝可以在這里找到。

如果這個(gè)庫用于web應(yīng)用，請確保在WEB-INF/lib文件夾中保持一份拷貝。或者，GSON庫可以放到應(yīng)用服務(wù)器提供給web應(yīng)用。

一個(gè)簡單示例

GSON API提供一個(gè)類文件，Gson（Java文檔），它被用來處理Java和JSON對象的轉(zhuǎn)換。可以調(diào)用默認(rèn)構(gòu)造器，或如下代碼的形式，使用GsonBuilder（Java文檔）類創(chuàng)建這個(gè)類的實(shí)例。GsonBuilder類是可定制化的，并且允許開發(fā)者按需實(shí)例化Gson。

1 2 3 4 5 6 7 8 9 10 11 12

package com.javacreed.examples.gson.part1; import com.google.gson.Gson; import com.google.gson.GsonBuilder; public class SimpleExample1 { ????public static void main(String[] args) { ????????Gson gson = new GsonBuilder().create(); ????????gson.toJson("Hello", System.out); ????????gson.toJson(123, System.out); ????} }

在上面的例子中，我們創(chuàng)建了一個(gè)Gson實(shí)例，并把Java String和int轉(zhuǎn)化為JSON對象。以上代碼命令行里的輸出結(jié)果如下：

1	"Hello"123

這不是火箭科學(xué)，但它是一個(gè)開始。注意，上述的結(jié)果都將輸入到命令行。該toJason()方法有兩個(gè)參數(shù)，Java對象轉(zhuǎn)換為JSON和可追加（Java的文檔）的一個(gè)實(shí)例。我們可以很容易地改變了一個(gè)文件或網(wǎng)絡(luò)流。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

package com.javacreed.examples.gson.part1; import java.io.FileWriter; import java.io.IOException; import java.io.Writer; import com.google.gson.Gson; import com.google.gson.GsonBuilder; public class SimpleExample2 { ????public static void main(String[] args) throws IOException { ????????Writer writer = new FileWriter("Output.json"); ????????Gson gson = new GsonBuilder().create(); ????????gson.toJson("Hello", writer); ????????gson.toJson(123, writer); ????????writer.close(); ????} }

注意

為什么變量聲明為Writer類型，而實(shí)際類型是FileWriter?

盡量使用泛型是一個(gè)很好的方法。在上例中，我們只使用了Appendable和Writer接口定義的方法。使用泛型使代碼更易于移植和維護(hù)，下面是個(gè)不好的例子。

注意，上面例子中，我們沒有正確處理流(Writer)。理想情況下，資源在finaly塊（教程）?中關(guān)閉或者用在try-with-resource（教程）中。我們忽略了這個(gè)是為了保持代碼簡潔。

1 2 3 4 5 6 7

public static void main(String[] args) throws IOException { ????try (Writer writer = new FileWriter("Output.json")) { ????????Gson gson = new GsonBuilder().create(); ????????gson.toJson("Hello", writer); ????????gson.toJson(123, writer); ????} }

以上代碼生成文件：包含JSON對象的Output.json。注意，這里我們使用了字符流而不是字節(jié)流。因?yàn)閠oJson()方法需要一個(gè)Appendanble實(shí)例，而字節(jié)流不能實(shí)現(xiàn)Appendable接口，所以我們使用了字符流。Appendable接口處理字符而不是字節(jié)。Java提供了InputStreanReader（Java文檔）和OutputStreamWriter（Java文檔）類進(jìn)行字節(jié)流與字符流的轉(zhuǎn)換，如下面的例子。

注意

注意，使用InputStreamREader和OutputStreamWriter類時(shí)，如果不提供編碼或者字符集，轉(zhuǎn)換將使用平臺默認(rèn)字符集。這將降低代碼的可移植性，且在其他平臺上運(yùn)行將可能產(chǎn)生錯(cuò)誤行為。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

package com.javacreed.examples.gson.part1; import java.io.FileOutputStream; import java.io.IOException; import java.io.OutputStreamWriter; import java.io.Writer; import com.google.gson.Gson; import com.google.gson.GsonBuilder; public class SimpleExample3 { ????public static void main(String[] args) throws IOException { ????????try(Writer writer = new OutputStreamWriter(new FileOutputStream("Output.json") , "UTF-8")){ ????????????Gson gson = new GsonBuilder().create(); ????????????gson.toJson("Hello", writer); ????????????gson.toJson(123, writer); ????????} ????} }

如你所見，我們只需要改變實(shí)例的一部分。代碼的剩余部分沒有任何變化。這就是使用接口代替類作為變量類型的好處之一。

使用JSON對象

比方說，我們需要使用JSON對象并加載他們?yōu)镴ava對象。假設(shè)web服務(wù)器查詢時(shí)產(chǎn)生如下JSON對象：

1 2 3 4 5

{ ??NAME:"Albert Attard", ??P_LANGUAGE:"Java", ??LOCATION:"Malta" }

此JSON對象包含3個(gè)不同值的域。比如我們需要使用JSON對象并創(chuàng)建一個(gè)Java對象來展示它。為了使這個(gè)例子更有趣，假設(shè)我們只關(guān)心name和location域。

首先創(chuàng)建一個(gè)Java類來表示name和location。類命名為Person。類的名字無關(guān)緊要，但域的名字必須一致。域名必須匹配(大小寫敏感)JSON對象中的名字。更進(jìn)一步，類必須包含一個(gè)默認(rèn)構(gòu)造函數(shù)（即使它被設(shè)置為private）。如下所示，name和location域在JSON中是大寫的。JSON中域P_LANGUAGE被忽略了，因?yàn)镴ava對象中不包括該名稱的域。請理解域名不遵守Java命名規(guī)范，暫時(shí)只是為了簡化。更多內(nèi)容將在第2部分中討論。

1 2 3 4 5 6 7 8 9 10 11 12 13 14

package com.javacreed.examples.gson.part2; public class Person { ????private String NAME; ????private String LOCATION; ????// Getters and setters are not required for this example. ????// GSON sets the fields directly using reflection. ????@Override ????public String toString() { ????????return NAME + " - " + LOCATION; ????} }

準(zhǔn)備好Java對象后，我們可以讀取JSON對象并加載為Java對象，如下代碼所示。為了模擬真實(shí)情況，我們使用了字節(jié)流作為輸入。還要注意，JSON內(nèi)容保存在resource文件夾的文件里(這不是常規(guī)做法)。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

package com.javacreed.examples.gson.part2; import java.io.IOException; import java.io.InputStreamReader; import java.io.Reader; import com.google.gson.Gson; import com.google.gson.GsonBuilder; public class JsonToJava { ????public static void main(String[] args) throws IOException { ????????try(Reader reader = new InputStreamReader(JsonToJava.class.getResourceAsStream("/Server1.json"), "UTF-8")){ ????????????Gson gson = new GsonBuilder().create(); ????????????Person p = gson.fromJson(reader, Person.class); ????????????System.out.println(p); ????????} ????} }

輸出如下：

1	Albert Attard - Malta

Gson解析JSON對象并創(chuàng)建了一個(gè)Person類的實(shí)例，并打印到命令行中。

嵌套JSON對象

讓我們對上面的例子更進(jìn)一步，以下所示JSON代碼段包含了一個(gè)嵌套對象。

1 2 3 4 5 6 7 8 9

{ ??NAME:"Albert Attard", ??P_LANGUAGE:"Java", ??LOCATION:"Malta", ??EXAM: { ????SUBJECT:"Programming", ????GRADE:4.5 ??} }

EXAM域由兩個(gè)域組成，分別是SUBJECT和GRADE。我們需要修改Person類的定義來包含EXAM域，并創(chuàng)建一個(gè)新的Java類來表示EXAM，該類包含SUBJECT和GRADE域。

我們首先創(chuàng)建新的類來表示嵌套對象。就像之前討論那樣，類名無關(guān)緊要，但是域名必須與JSON中的域名匹配。

1 2 3 4 5 6 7 8 9 10 11 12 13 14

package com.javacreed.examples.gson.part3; public class Exam { ????private String SUBJECT; ????private double GRADE; ????// Getters and setters are not required for this example. ????// GSON sets the fields directly using reflection. ????@Override ????public String toString() { ????????return SUBJECT + " - " + GRADE; ????} }

現(xiàn)在我們可以修改Person類，引入一個(gè)與JSON中EXAM同名的域，類型為Exam。注意，下面的Person類與前一個(gè)<span style=”color: #ff0000;”>位于</span>不同的包。

1 2 3 4 5 6 7 8 9 10 11 12 13

package com.javacreed.examples.gson.part3; public class Person { ????private String NAME; ????private String LOCATION; ????private Exam EXAM; ????@Override ????public String toString() { ????????return NAME + " - " + LOCATION + " (" + EXAM + ")"; ????} }

注意，所需的變化是最小的，因?yàn)镚son動(dòng)態(tài)發(fā)現(xiàn)(使用反射)類和它的域。本文不包含反射，對于更多關(guān)于反射的信息，請參考：Reflection in Action.

最后，讓我們嘗試新的變化。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

package com.javacreed.examples.gson.part3; import java.io.IOException; import java.io.InputStreamReader; import java.io.Reader; import com.google.gson.Gson; import com.google.gson.GsonBuilder; public class JsonToJava { ????public static void main(String[] args) throws IOException { ????????try(Reader reader = new InputStreamReader(JsonToJava.class.getResourceAsStream("/Server2.json"), "UTF-8")){ ????????????Gson gson = new GsonBuilder().create(); ????????????Person p = gson.fromJson(reader, Person.class); ????????????System.out.println(p); ????????} ????} }

JsonToJava類沒有做任何改變，因?yàn)镚son使用了模型(Person和Exam類)將Json映射成Java。

結(jié)論

即使JSON可能是一個(gè)新概念，但它十分簡單與直接。此外，相比于需要增加標(biāo)簽進(jìn)行消息/數(shù)據(jù)轉(zhuǎn)換而不斷膨脹的笨重的XML，它因?yàn)楹唵胃恿餍小Ｐ枰赋鯦SON是JavaScript的一個(gè)子集，JavaScript將它作為一個(gè)完美的方案來進(jìn)行數(shù)據(jù)交換，例如網(wǎng)頁。GSON API使它更便于使用，即使在這里沒有討論的部分，它也提供了強(qiáng)大的靈活性。

欲了解更多GSON的例子，請移步第2部分，我們會(huì)探索更復(fù)雜的例子，并討論如何使用GSON解串器來完全控制反序列化過程。

總結(jié)

以上是生活随笔為你收集整理的完全理解Gson（1）：简单入门的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。

上一篇：第二十九节 MT-iBeacon基站关
下一篇：如何去除微信小程序 wxParse 解析