Google GSON入门
在Java世界中,JSON已成為事實上的XML數據交換格式標準,因為它的易用性和傳輸效率高。
如果您不了解JSON,那就是Javascript對象表示法,這是一種基于文本的數據交換格式,是名稱-值的集合,其中名稱嚴格是字符串類型,值可以是int,布爾值,數組或其他json對象。
GSON是Google開發的開源Java庫。 它是用于將Java對象與json表示形式轉換的API。
為什么要使用它?
- 將任何Java對象(即新對象或任何現有/舊版對象)轉換為JSON,反之亦然。
- 對通用對象的最佳支持
- 簡單方便的轉換方法
- 無需任何注釋的字段進行轉換
- 默認情況下,所有字段(包括私有字段)都包含在轉化中
- 如果不想在轉換中包含該字段,請對該字段使用瞬變修飾符
- 它通過不將其包含在序列化輸出中,而在反序列化期間將其初始化回null,從而優雅地處理null字段。
如何將其添加到項目中?
使用以下方法之一將其添加為依賴項
使用Maven
將以下依賴項添加到項目的pom.xml中
<dependency><groupId>com.google.code.gson</groupId><artifactId>gson</artifactId><version>2.2.4</version> </dependency>使用Gradle
在項目的build.gradle中添加以下內容
repositories {mavenCentral() }dependencies {compile 'com.google.code.gson:gson:2.2.4' }用作非托管依賴項
如果不使用任何構建工具,則可以將gson jar添加到直接classpath或構建路徑中。
從GSON項目的下載頁面下載最新的jar。 下載的zip文件包含3個jar文件-二進制文件,源代碼和javadoc。 抓取二進制jar文件并將其添加到您的項目類路徑中。
如何使用它 ?
為了將對象與json相互轉換,您需要使用Gson類及其以下2種方法。
toJson() =>將提供的對象轉換為json字符串,將要轉換的對象作為參數并返回json表示字符串
fromJSon() =>將json字符串轉換為object,將第一個參數作為json字符串作為object和目標對象的類文字,并返回目標對象
您可以多次使用Gson實例/對象,因為它不會保持任何狀態。
以下是一些說明GSON API用法的示例。
示例1:對于簡單對象
考慮以下模型對象以進行轉換,但是請記住,您可以轉換任何對象
模型對象
package in.ajduke.ap012; /** * An model for gson demo? *? * @author ajduke */ public class ModelObject {String name;int val;boolean status;double f;public ModelObject(String name, int val,?boolean status, double f) {super();this.name = name;this.val = val;this.status = status;this.f = f;}@Overridepublic String toString() {return "ModelObject [name=" + name + ",val=" + val + ", status="+ status + ", f=" + f + "]";}}以下是將轉換對象轉換為json表示形式的清單,
Example1.java
final Gson gson = new Gson(); // original object instantiation ModelObject modelObject = new ModelObject("myname", 12, true, 2.3); System.out.println("toJson ---"); System.out.println("Original Java object : " + modelObject); // converting an object to json object String json = gson.toJson(modelObject); System.out.println("Converted JSON string is : " + json);System.out.println("fromJson----"); // getting object from json representation System.out.println("Original JSON string is : " + json); // converting json to object ModelObject modelObject1 = gson.fromJson(json, ModelObject.class); System.out.println("Converted Java object : " + modelObject1);請注意fromJson()的簽名,它使用第二個參數作為目標對象的類文字。
輸出如下,
示例1-輸出
toJson --- Original Java object : ModelObject [name=myname, val=12, status=true, f=2.3] Converted JSON string is : {"name":"myname","val":12,"status":true,"f":2.3} fromJson---- Original JSON string is : {"name":"myname","val":12,"status":true,"f":2.3} Converted Java object : ModelObject [name=myname, val=12, status=true, f=2.3]示例2:對于通用對象
為了將通用對象從json表示形式轉換回java對象,我們需要使用use extra對象,如下所示
類型collectionType = new TypeToken <{帶類型信息的通用對象}>(){}。getType();
您需要向TypeToken類型參數信息提供目標類類型,如上所示。 這是形成Type實例,我們需要將它作為第二個參數傳遞給fromJson()方法。
以下清單顯示了將通用類或類從集合框架轉換為json或從json轉換的示例
GenericModel.java
package in.ajduke.ap012; /** * An generified model for demo of gson conversion * @author ajduke */ public class GenericModel<T> {T value;public GenericModel(T value) {super();this.value = value;}@Overridepublic String toString() {return "Model2 [value=" + value + "]";} }Example2.java
Gson gson = new Gson();System.out.println("A generic object demo"); // a generified object GenericModel<Integer> model = new GenericModel<>(12);// converting to json representation String json = gson.toJson(model); System.out.println("json representation :" + json);// converting back to object Type collectionType = new TypeToken<GenericModel<Integer>>() { }.getType(); GenericModel<Integer> modelObj = gson.fromJson(json, collectionType); System.out.println("converted object representation: " + modelObj);System.out.println("\nA object from collection framework\n"); // for collection framework objects List<String> listOfString = new ArrayList<>(); listOfString.add("ajduke"); listOfString.add("ajduchess");// conversion to json String jsonStr = gson.toJson(listOfString); System.out.println("json representation :" + jsonStr);Type collectionType2 = new TypeToken<List<String>>() { }.getType(); List<String> listObj = gson.fromJson(jsonStr, collectionType2); System.out.println("converted object representation: " + listObj);輸出如下
例2-輸出
A generic object demo json representation :{"value":12} converted object representation: Model2 [value=12]A object from collection frameworkjson representation :["ajduke","ajduchess"] converted object representation: [ajduke, ajduchess]示例3:使用瞬態
如果您不想在json表示形式中包含某些字段,則可以對變量聲明使用transient修飾符,然后在將其轉換為json表示形式時,GSON會忽略該變量。 但是,當從json字符串轉換回對象時,它會根據變量類型初始化其默認值 。
考慮我們的ModelObject,讓我們從json表示中跳過整數val,因此,將其聲明修改為transient,如下面的清單所示
ModelObject2.java
package in.ajduke.ap012; /** * An model for demo of gson conversion * * @author ajduke */ public class ModelObject {String name;transient int val;boolean status;double f;public ModelObject(String name, int val, boolean status, double f) {super();this.name = name;this.val = val;this.status = status;this.f = f;}@Overridepublic String toString() {return "ModelObject [name=" + name + ",val=" + val + ", status="+ status + ", f=" + f + "]";} }以下是清單
Example3.java
Gson gson = new Gson(); // original object ModelObject modelObject = new ModelObject("namesake", 50, true, 4.3); System.out.print("Original Java object : "); System.out.println(modelObject);// converting to an json representation String json = gson.toJson(modelObject); System.out.print("Converted JSON string is : "); System.out.println(json);// getting back the object from json representation ModelObject modelObject3 = gson.fromJson(json, ModelObject.class); System.out.print("Converted Java object : "); System.out.println(modelObject3);因此,在進行轉換時,GSON忽略了上述內容并輸出如下
example3-輸出
Original Java object : ModelObject [name=namesake, val=50, status=true, f=4.3] Converted JSON string is : {"name":"namesake","status":true,"f":4.3} Converted Java object : ModelObject [name=namesake, val=0, status=true, f=4.3] Thats all folks, for GSON introduction !!注意:我已經為所有示例提供了小段代碼,要訪問完整列表,請訪問github上的要點
下一步是什么 ?
在接下來的幾篇文章中,我將向您展示GSON庫的一些額外好處,
所以,請繼續關注!!!
翻譯自: https://www.javacodegeeks.com/2013/08/getting-started-with-google-gson.html
總結
以上是生活随笔為你收集整理的Google GSON入门的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 支付宝建信养老飞越366怎么取出来?
- 下一篇: 多核可扩展计数器