GSON速学必会

一. GSON 简介

GSON是一个Java语言编写的用来拍卖JSON数据格式的开源应用程序编程接口项目。它以Java对象转换为JSON表示。还可以用来将JSON字符串转换为同样的Java对象。

图片 1

gson管包含了JSON数据处理的具有常见类和接口。gson里面的子包reflectannotation,
和 streamreflect保险包含处理Java泛型类型信息的类及接口。annotation确保包含相关的切近和接口,用于对象属性之自定义名称映射。stream包包含与读写相关的类似以及接口。

GSON设计的初衷如下:

  • 来一个大概的转换机制,可以以Java对象转换为JSON。GSON
    Java项目有大气的实用方法作为api供开发人员使用。
  • 许以以前设有的不可修改的Java对象转换为JSON和自JSON转换。
  • 定制对象的代表。GSON为对象字段提供了名的自定义映射,同时将那行化为JSON字符串。
  • 提供一个一环扣一环和格式化的输出。默认情况下,为Java对象生成的JSON字符串是一体的样式。GSON提供优秀的打印设备以使其为人类可读的格式。

  • 以 GSON 中开创而的第一独 JSON


于本节倍受,将学实例化GSON及其各种方式的意思,然后是一个飞跃示例代码,展示包装档次Java对象的骨干序列化。

步骤1 – 实例化GSON

假使动GSON库,Gson类需要实例化一个com .google.GSON的目标。GSON对象非维护其他状态,这个特点有助于在多单地方用GSON对象。

GSON库提供了实例化的少数栽艺术:

  • 默认方法
  • 构造器使用安装方法

默认方法

以这种方式中,可以行使new重大字实例化GSON仿佛对象。这种办法创建了一个无设置的object实例。

构造器使用安装方式

以这种艺术吃,可以使GsonBuilder类和create道创建一个GSON类对象:

Gson gson = new GsonBuilder ().create ();

前的代码调用了GsonBuildercreate措施,它回到一个Gson目标开展初始化。

下表列举了GSON官的组成部分主意:

方法 描述
fromJson 此方法用于反序列化以获取Java对象。 API中有此方法的重载的形式。
toJson 该方法将Java对象序列化为等效的JSON表示形式。 API中有此方法的重载的形式。
toJsonTree 该方法使用它们的泛型类型序列化对象。API中有此方法的重载的形式。

2. 一个简易的事例

深受咱们看看一个粗略的事例代码,展示的中心用GSON库对Java包装类进行序列化/反序列化对象的JSON字符串:

import com.google.gson.Gson;

public class QuickStartDemo {

    public static void main(String[] args) {

        Gson gson = new Gson();

    /*Java Wrapper Type*/
        String jsonInteger = gson.toJson(new Integer(1));
        String jsonDouble = gson.toJson(new Double(12345.5432));

        System.out.println("GSON toJson Method Use ");
        System.out.println(jsonInteger);
        System.out.println(jsonDouble);

        Integer javaInteger = gson.fromJson(jsonInteger, Integer.class);
        Double javaDouble = gson.fromJson(jsonDouble, Double.class);

        System.out.println("GSON fromJson Method Use ");
        System.out.println(javaInteger);
        System.out.println(javaDouble);
    }
}

输出结果吗:

GSON toJson Method Use
1
12345.5432
GSON fromJson Method Use
1
12345.5432

前的代码演示了toJsonfromJson的星星栽方式的迅猛使。

以代码的率先有些受,使用默认方法实例化了一个Gson接近对象,并使用值112345.5432实例化了零星个Java
包装类对象,即Integer类和Double类似。这些目标传递给toJson法,该方式生成JSON等效字符串形式。

方法                           详细说明
toJSON        参数:使用Java类对象进行序列化。 返回:JSON对象的字符串表示形式
fromJSON   参数:第一个参数是JSON表示的字符串类型,第二个参数是预期的Java类类型。返回:预期的Java类对象

在代码的末尾一部分受,JSON等效字符串传递给fromJson艺术。
该方式来一定量个参数,第一单参数是一个字符串,第二只参数是一个料的Java类项目。
fromJson主意的归路始终是Java类型。

二. 需要明白之12只GSON特性

于本节被,将了解GSON库支持之重大职能跟怎样落实这些成效。

1. 对准 Java 对象的支撑

GSON中的目标为誉为JsonElement的类型:

图片 2

GSON库可以将其它用户定义的切近对象转换为JSON表示。Student类似是一个用户定义的接近,GSON可以将其他Student对象序列化为JSON。
以下是 Student.java 的代码:

package com.lee.jsondemo;

public class Student {

    private String name;

    private String subject;

    private int mark;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getSubject() {
        return subject;
    }

    public void setSubject(String subject) {
        this.subject = subject;
    }

    public int getMark() {
        return mark;
    }

    public void setMark(int mark) {
        this.mark = mark;
    }

}

Student恍如进行操作的JavaObjectFeaturesUse.java代码如下:

import com.google.gson.Gson;
importcom.packt.chapter.vo.Student;

public class JavaObjectFeaturesUse {

public static void main(String[] args){

Gsongson = new Gson();

Student aStudent = new Student();
aStudent.setName("Sandeep");
aStudent.setMark(128);
aStudent.setSubject("Computer Science");

String studentJson = gson.toJson(aStudent);
System.out.println(studentJson);

Student anotherStudent = gson.fromJson(studentJson, Student.class);
System.out.println(anotherStudentinstanceof  Student);
  }
}

尽结果为:

{"name":"Sandeep","subject":"Computer Science","mark":128}
true

点的代码创建了一个name属性为sandeep的学生对象,subject属性设置也Computer Sciencmark128。然后拿一个Gson目标实例化,并将学员对象作为一个参数传递给toJson()方。它回到一个字符串,该字符串具有Java对象的JSON表示。该字符串作为控制台中的率先尽打印。学生对象的出口JSON表示是键/值对的集合。学生类的Java属性成为JSON字符串中之键。

当代码的最终一片受,fromJson()方法以JSON生成的字符串作为第一个输入参数,Student.class作为第二单参数,将JSON字符串转换回Java对象。代码的结尾一行以Student用作次行操作符的实例来证明由fromJson()道变的Java对象是否是Student色的。在控制台中,它输出true,则意味着我们以获取同JSON相同之价值。

2. 序列化与反序列化

GSON有一对类似的隐式序列化,比如Java包装类(IntegerLongDouble等等)、Java.net.urljava.net.URIjava.util.Date,等等。

为自己看个例:

import java.util.Date;
import com.google.gson.Gson;

public class InbuiltSerializerFeature {
    public static void main(String[] args) {
        Date aDateJson = new Date();
        Gson gson = new Gson();
        String jsonDate = gson.toJson(aDateJson);
        System.out.println(jsonDate);
    }
}

出口结果吧:

"Sep 15, 2017 10:38:35 PM"

前的代码是将Java的Date接近对象序列化为JSON表示。在前边的一些被,您已经了解了哪利用GSON来序列化和反序列化对象,以及它们如何也用户定义之Java类对象提供定制化的序列化器和反序列化器。让咱省她是什么样行事之。

此外,GSON还呢开发人员提供了不过定制的序列化的特性。

脚的代码是一个可定制序列化器的演示:

public class StudentTypeSerializer implements JsonSerializer<Student> {

    @Override
    public JsonElement serialize(Student student, Type type,
                                 JsonSerializationContext context) {
        JsonObject obj = new JsonObject();

        obj.addProperty("studentname", student.getName());
        obj.addProperty("subjecttaken", student.getSubject());
        obj.addProperty("marksecured", student.getMark());

        return obj;
    }
}

下面的代码是一个自定义反序列化器的例证:

class StudentTypeDeserializer implements JsonDeserializer<Student> {

    @Override
    public Student deserialize(JsonElement jsonelment, Type type,
                               JsonDeserializationContext context) throws JsonParseException {

        JsonObject jsonObject = jsonelment.getAsJsonObject();

        Student aStudent = new Student();
        aStudent.setName(jsonObject.get("studentname").getAsString());
        aStudent.setSubject(jsonObject.get("subjecttaken").getAsString());
        aStudent.setMark(jsonObject.get("marksecured").getAsInt());

        return aStudent;
    }
}

以下代码测试于定义序列化器和倒序列化器:

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

public class CustomSerializerFeature {

    public static void main(String[] args) {

        GsonBuilder gsonBuilder = new GsonBuilder();

        gsonBuilder.registerTypeAdapter(Student.class, new StudentTypeSerializer());

        Gson gson = gsonBuilder.create();

        Student aStudent = new Student();

        aStudent.setName("Sandeep");

        aStudent.setMark(150);

        aStudent.setSubject("Arithmetic");

        String studentJson = gson.toJson(aStudent);

        System.out.println("Custom Serializer : Json String Representation ");
        System.out.println(studentJson);

        gsonBuilder.registerTypeAdapter(Student.class, new StudentTypeDeserializer());
        Gson gsonde = gsonBuilder.create();
        Student deStudent = gsonde.fromJson(studentJson, Student.class);

        System.out.println("Custom DeSerializer : Java Object Creation");

        System.out.println("Student Name " + deStudent.getName());
        System.out.println("Student Mark " + deStudent.getMark());
        System.out.println("Student Subject " + deStudent.getSubject());
        System.out.println("is anotherStudent is type of Student " + (deStudent instanceof Student));
    }
}

出口结果吗:

Custom Serializer : Json String Representation 
{"studentname":"Sandeep","subjecttaken":"Arithmetic","marksecured":150}
Custom DeSerializer : Java Object Creation
Student Name Sandeep
Student Mark 150
Student Subject Arithmetic
is anotherStudent is type of Student true

3. 良的打印

GSON的序列化输出的JSON表示格式紧凑。如果有大量的Java对象集合,并且每个对象都发出多序列化的特性,那么其紧凑的JSON表示的可读性是雅差的,而且看起特别丢脸。

以缓解这个题材,GsonBuilder支撑美的打印配置,同时为序列化使用创造一个Gson对象。这个优秀的打印功能通过适当的竹签缩进和初的换行来吹嘘JSON字符串的输出。

以下是有关格式化程序的一对关键内容:

  • JsonPrintFormatterJsonCompactFormatter是GSON中之片种植格式化类型的意味。
  • JsonCompactFormatter举凡GSON的默认格式化程序。
  • JsonPrintFormatter用于优质的打印,它不会见暴露于API中。所以开发者不可知改改。
  • JsonPrintFormatter支持一个默认行长度为80个字符,两个字符缩进,以及右侧保持四单字符。
  • 得经过调用GsonBuildersetPrettyPrinting()措施来以JsonPrintFormatter

具体看一个例子:

import java.util.ArrayList;
import java.util.List;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.packt.chapter.vo.Student;

 public class PrettyPrintFeature {


  public static void main(String[] args) {

    Gson gson = new GsonBuilder().setPrettyPrinting().create();
    List<Student> listOfStudent = new ArrayList<Student>();

    Student student1 = new Student();
    student1.setName("Sandeep Kumar Patel");
    student1.setSubject("Arithmetic");
    student1.setMark(234);

    Student student2 = new Student();
    student2.setName("Sangeeta Patel");
    student2.setSubject("Geography");
    student2.setMark(214);

    listOfStudent.add(student1);
    listOfStudent.add(student2);

    String prettyJsonString = gson.toJson(listOfStudent);
    System.out.println(prettyJsonString);
  }

}

出口结果也:

[
  {
    "name": "Sandeep Kumar Patel",
    "subject": "Arithmetic",
    "mark": 234
  },
  {
    "name": "Sangeeta Patel",
    "subject": "Geography",
    "mark": 214
  }
]

上面的代码用生列表序列化为JSON表示。它应用GsonBuilder接近获得一个Gson对象。使用setPrettyPrinting()方配置不错的打印。可以见到以前的代码的出口都正确地缩进,并且阅读起来挺欢。

4. 内部类

Java内部类可发三三两两种植类型:

  • 静态内部类
  • 实例之中类

脚用见到GSON如何处理这些类别的里边类类对象的。

(1) 静态内部类

GSON可以隐式地序列化/反序列化静态内部类。不待格外的安排。

深受咱们看一个静态内部类的事例:

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

class Student {

    private String studentName;

    private int mark;

    public String getStudentName() {
        return studentName;
    }

    public void setStudentName(String studentName) {
        this.studentName = studentName;
    }

    public int getMark() {
        return mark;
    }

    public void setMark(int mark) {
        this.mark = mark;
    }

    public static class Course {

        private String courseName;

        private String duration;

        public String getCourseName() {
            return courseName;
        }

        public void setCourseName(String courseName) {
            this.courseName = courseName;
        }

        public String getDuration() {
            return duration;
        }

        public void setDuration(String duration) {
            this.duration = duration;
        }
    }
}

public class StaticNestedClassFeature {

    public static void main(String[] args) {

        Gson gson = new GsonBuilder().setPrettyPrinting().create();

        Student.Course aCourse = new Student.Course();
        aCourse.setCourseName("M.TECH.");
        aCourse.setDuration("120 hr");

        String jsonCourse = gson.toJson(aCourse);
        System.out.println(jsonCourse);

        Student.Course anotherCourse = gson.fromJson(jsonCourse, Student.Course.class);

        System.out.println("Course : " + anotherCourse.getCourseName() + "Duration : " + anotherCourse.getDuration());
    }
}

出口结果为:

{
  "courseName": "M.TECH.",
  "duration": "120 hr"
}
Course : M.TECH.Duration : 120 hr

以面的代码中,Course类是Student类内的静态内部类。courseNameduration凡片只特性,以及个别的getter和setter方法在。通过外部类的.操作符调用,可以在Java中实例化一个静态的里边类。Student.Course aCourse = new Student.Course()从而来初始化内部Course类的。M.TECH.120 hr虽说是因此来实例化它的有限单价。从出口中可见见,GSON能够序列化生成Course靶的JSON表示的静态内部类。输出的末尾一执行显示GSON成功地用那反序列化。

(2) 实例之中类

Java中的一个实例之中类可经运用外部类对象来实例化。下面的代码演示了GSON如何序列化和倒序列化一个实例之中类的Java类对象:

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

class Student {

    private String studentName;
    private int mark;

    public String getStudentName() {
        return studentName;
    }

    public void setStudentName(String studentName) {
        this.studentName = studentName;
    }

    public int getMark() {
        return mark;
    }

    public void setMark(int mark) {
        this.mark = mark;
    }

    public class Course {

        private String courseName;

        private String duration;

        public String getCourseName() {
            return courseName;
        }

        public void setCourseName(String courseName) {
            this.courseName = courseName;
        }

        public String getDuration() {
            return duration;
        }

        public void setDuration(String duration) {
            this.duration = duration;
        }
    }
}

public class InstanceNestedClassFeature {

    public static void main(String[] args) {

        Gson gson = new GsonBuilder().setPrettyPrinting().create();
        Student outstudent = new Student();
        Student.Course instanceCourse = outstudent.new Course();

        instanceCourse.setCourseName("M.TECH.");
        instanceCourse.setDuration("12 hr");

        String jsonCourse = gson.toJson(instanceCourse);
        System.out.println(jsonCourse);

        Student.Course anotherCourse = gson.fromJson(jsonCourse, Student.Course.class);
        System.out.println("Course : " + anotherCourse.getCourseName() + "Duration : " + anotherCourse.getDuration());
    }
}

出口结果吧:

{
  "courseName": "M.TECH.",
  "duration": "12 hr"
}
Course : M.TECH.Duration : 12 hr

当前边的代码中,Course大凡一个实例之中类,有少单字段和她的getter和setter方法。Course对象的nstanceccourse凡是采取外部类对象outstudent实例化的。这个里面类对象为停放到序列化和倒序列化中,从而以控制台上有结果。在反序列化过程中,fromJson()计运用Student作为第二只参数。当然,它帮助GSON成功地拿其反序列化到中类对象中。

5. 数组

GSON支持以Java数组转换为JSON表示。

吃咱来拘禁一个数组的例证:

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

public class ArrayFeature {

    public static void main(String[] args) {

        Gson gson = new GsonBuilder().create();

        int[] numberArray = { 121, 23, 34, 44, 52 };

        String[] fruitsArray = { "apple", "oranges", "grapes" };

        String jsonNumber = gson.toJson(numberArray);
        String jsonString = gson.toJson(fruitsArray);

        System.out.println(jsonNumber);
        System.out.println(jsonString);

        int[] numCollectionArray = gson.fromJson(jsonNumber, int[].class);
        String[] fruitBasketArray = gson.fromJson(jsonString, String[].class);

        System.out.println("Number Array Length " + numCollectionArray.length);
        System.out.println("Fruit Array Length " + fruitBasketArray.length);

    }

}

输出结果也:

[121,23,34,44,52]
["apple","oranges","grapes"]
Number Array Length 5
Fruit Array Length 3

6. 泛型

GSON使用com.google.gson.reflect.TypeToken来支持泛型类型的Java类对象,用于序列化和倒序列化。使用TypeToken好像的目的是采用Java泛型类型的项目擦除的性状。

列擦除发生在编译期,在此处,Java泛型类型为全除去,以生字节码。因此,在以JSON字符串反序列化为泛型Java类时,它可能会见无是地反序列化。

下的代码演示了泛型类型序列化/反序列化以及TypeToken仿佛是故来缓解这个题材:

import java.lang.reflect.Type;
import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;

class StudentGeneric<T, E> {

    T mark;

    E name;

    public T getMark() {
        return mark;
    }

    public void setMark(T mark) {
        this.mark = mark;
    }

    public E getName() {
        return name;
    }

    public void setName(E name) {
        this.name = name;
    }
}

public class GenericTypeFeature {

    @SuppressWarnings("unchecked")
    public static void main(String[] args) {

        Gson gson = new Gson();
        StudentGeneric<Integer, String> studGenericObj1 = new StudentGeneric<Integer, String>();
        studGenericObj1.setMark(25);
        studGenericObj1.setName("Sandeep");

        String json = gson.toJson(studGenericObj1);
        System.out.println("Serialized Output :");
        System.out.println(json);

        StudentGeneric<Integer, String> studGenericObj2 = gson.fromJson(json, StudentGeneric.class);
        System.out.println("DeSerialized Output :");
        System.out.println("Mark : " + studGenericObj2.getMark());

        Type studentGenericType = new TypeToken<StudentGeneric<Integer, String>>() {}.getType();

        StudentGeneric<Integer, String> studGenericObj3 = gson.fromJson(json, studentGenericType);
        System.out.println("TypeToken Use DeSerialized Output :");
        System.out.println("Mark : " + studGenericObj3.getMark());
    }

}

输出结果也:

Serialized Output :
{"mark":25,"name":"Sandeep"}
DeSerialized Output :
Mark : 25.0
TypeToken Use DeSerialized Output :
Mark : 25

在上头的代码中,StudentGeneric恍如接受两只泛型参数,并出各自的getter和setter方法。StudentGeneric接近对象下IntegerString作为markname的色来创造的。在序列化时,mark让初始化为25,但反而序列化输出显示也25.0,这是一个勿得法的值,因为路擦除属性在编译时从接近吃删除了泛型类型的参数。使用TypeToken类似来缓解此问题。getType()主意返回具有泛型参数的原始类类型,它拉GSON正确地反序列化对象,并以正确价值输出为25。

7. 对准 null 对象的支持

GSON也会针对null对象开展序列化/反序列化的JSON表示。

受咱们看一个缺损对象的例证:

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

public class NullSupportFeature {

    public static void main(String[] args) {
        Gson gson = new GsonBuilder().serializeNulls().setPrettyPrinting().create();

        Student aStudent = new Student();
        aStudent.setName("Sandeep Kumar Patel");
        aStudent.setSubject(null);
        aStudent.setMark(234);

        String studentJson = gson.toJson(aStudent);

        System.out.println(studentJson);

        Student javaStudentObject = gson.fromJson(studentJson, Student.class);

        System.out.println("Student Subject: " + javaStudentObject.getSubject());
        System.out.println("Student Name: " + javaStudentObject.getName());
    }
}

输出结果为:

{
  "name": "Sandeep Kumar Patel",
  "subject": null,
  "mark": 234
}
Student Subject:null
Student Name:Sandeep Kumar Patel

8. 版支持

GSON提供了版本化的序列化/反序列化的Java对象的JSON表示。这促进迭代开发以及发布值对象。GSON
API提供了扳平种植体制来满足这些不同版本数据的乞求。

深受咱们看一个本支持之事例:

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.annotations.Since;

@Since(1.0)
class Student {

    private String name;

    private String subject;

    private int mark;

    @Since(1.1)
    private String gender;

    public String getGender() {
        return gender;
    }

    public void setGender(String gender) {
        this.gender = gender;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getSubject() {
        return subject;
    }

    public void setSubject(String subject) {
        this.subject = subject;
    }

    public int getMark() {
        return mark;
    }

    public void setMark(int mark) {
        this.mark = mark;
    }
}

public class VersionSupportFeature {

    public static void main(String[] args) {

        Student aStudent = new Student();
        aStudent.setName("Sandeep Kumar Patel");
        aStudent.setSubject("Algebra");
        aStudent.setMark(534);
        aStudent.setGender("Male");

        System.out.println("Student json for Version 1.0 ");
        Gson gson = new GsonBuilder().setVersion(1.0).setPrettyPrinting().create();
        String jsonOutput = gson.toJson(aStudent);
        System.out.println(jsonOutput);

        System.out.println("Student json for Version 1.1 ");
        gson = new GsonBuilder().setVersion(1.1).setPrettyPrinting().create();
        jsonOutput = gson.toJson(aStudent);
        System.out.println(jsonOutput);
    }
}

出口结果也:

Student json for Version 1.0 
{
  "name": "Sandeep Kumar Patel",
  "subject": "Algebra",
  "mark": 534
}
Student json for Version 1.1 
{
  "name": "Sandeep Kumar Patel",
  "subject": "Algebra",
  "mark": 534,
  "gender": "Male"
}

9. 针对任参数构造方法的支撑

尽管Java对象开展序列化/反序列化或JSON字符串,GSON创建一个默认实例的接近的构造方法。有一个默认的Java类的甭管参数构造方法是特别好的。如果一个类似没有默认构造函数,GSON提供一个class.google.gson.InstanceCreator接口实现来拍卖它。

方法 详细说明
createInstance 参数:java.lang.reflect.Type类的实例;返回值:T类型的默认对象实例,引用对象实例的类类型。

叫咱看一个无参构造方法的例证:

import java.lang.reflect.Type;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.InstanceCreator;

class Employee {

    private String name;
    private Salary salary;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Salary getSalary() {
        return salary;
    }

    public void setSalary(Salary salary) {
        this.salary = salary;
    }

    @Override
    public String toString() {
        return "Employee [name=" + name + ", salary=" + salary + " ]";
    }
}

class Salary {

    private int salaryAmount;

    Salary(int salary) {
        this.salaryAmount = salary;
    }

    @Override
    public String toString() {
        return "Salary [salaryAmount=" + salaryAmount + "]";
    }
}

class SalaryInstanceCreator implements InstanceCreator<Salary> {
    @Override
    public Salary createInstance(Type type) {
        return new Salary(25000);
    }
}

public class InstanceCreatorUse {

    public static void main(String[] args) {

        String jsonString = "{\"name\" :\"Sandeep\" , \"salary\": {}}";

        Gson gson = new GsonBuilder().serializeNulls().registerTypeAdapter(Salary.class, new SalaryInstanceCreator())
                .setPrettyPrinting().create();

        System.out.println(gson.fromJson(jsonString, Employee.class));
    }
}

点的代码演示了一个JSON字符串类型的Employee类,该字符串被反序列化为Employee花色的对象。

  • 输入:一个 JSON
    对象:jsonString = "{\"name\" :\"Sandeep\" , \"salary\": {}}";
  • 输出:一个 Java
    对象:重写了toString()方法:Employee [name=Sandeep, salary=Salary [salaryAmount=25000]]

使用com .google. gson.InstanceCreator来贯彻一个SalaryInstanceCreator类似,并再度写createInstance()方法,该方法返回值25000的参数化的Salary构造方法。

这个SalaryInstanceCreator使用registerTypeAdapter()术注册为GSON。

当GSON找到空的Salary字符串时,它以寻找类型Salary的默认构造方法。由于匪设有默认的Salary构造方法,所以其寻找类型适配器的GsonBuilder设置,并找到SalaryInstanceCreator。并调用createInstance()方法。

故,当对一个拖欠的Salary恍如对象开展反序列化时,GSON将获取25000作默认值。

10. 性质命名的支撑

拖欠特性也开发人员在排化Java对象时提供由定义名称提供了灵活性。JSON代表变得更有意义和可读性。

GSON提供了一个拥有内置属性命名支持的FieldNamingPolicy类:

import com.google.gson.FieldNamingPolicy;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.annotations.SerializedName;

class College {

    @SerializedName("instituteName")
    private String name;

    private String[] coursesOffer;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String[] getCoursesOffer() {
        return coursesOffer;
    }

    public void setCoursesOffer(String[] coursesOffer) {
        this.coursesOffer = coursesOffer;
    }
}

public class FieldNamingFeature {

    public static void main(String[] args) {

        Gson gson = new GsonBuilder().setFieldNamingPolicy(FieldNamingPolicy.UPPER_CAMEL_CASE).setPrettyPrinting()
                .create();

        College aCollege = new College();
        aCollege.setName("VIT University, Vellore");
        String[] courses = { "BTECH, MTECH, BSC, MSC" };
        aCollege.setCoursesOffer(courses);

        String jsonCollege = gson.toJson(aCollege);
        System.out.println(jsonCollege);
        College anotherCollege = gson.fromJson(jsonCollege, College.class);
        System.out.println("College Name : " + anotherCollege.getName());
    }
}

输出结果为:

{
  "instituteName": "VIT University, Vellore",
  "CoursesOffer": [
    "BTECH, MTECH, BSC, MSC"
  ]
}
College Name : VIT University, Vellore

(1) 用户从定义属性命名

除了核心的性命名意义之外,GSON还提供了一个FieldNamingStrategy恍如,以要开发人员能够创立自己的特性命名策略。以下步骤示例如何创建于定义属性命名策略:

  • 始建一个 Java 类并促成FieldNamingStrategy接口
  • 重写translateName方法
  • 该措施供了自定义属性命名策略的确实贯彻。GSON在处理打定义属性名称策略时,使用该办法被之逻辑作为属性名:
方法 详细说明
translateName 参数:java.lang.reflect.Field;返回:已更改的属性名字符串

给我们看一个用户定义属性命名的演示:

import java.lang.reflect.Field;
import com.google.gson.FieldNamingStrategy;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

class College {

    private String name;

    private String[] coursesOffer;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String[] getCoursesOffer() {
        return coursesOffer;
    }

    public void setCoursesOffer(String[] coursesOffer) {
        this.coursesOffer = coursesOffer;
    }
}

class CustomFieldStrategy implements FieldNamingStrategy {

    @Override
    public String translateName(Field aField) {

        String nameOfField = aField.getName();

        return nameOfField.toUpperCase();
    }
}

public class CustomFieldNamingFeature {

    public static void main(String[] args) {

        Gson gson = new GsonBuilder().setFieldNamingStrategy(new CustomFieldStrategy()).setPrettyPrinting().create();

        College aCollege = new College();
        aCollege.setName("VIT University, Vellore");
        String[] courses = { "BTECH, MTECH, BSC, MSC" };
        aCollege.setCoursesOffer(courses);

        String jsonCollege = gson.toJson(aCollege);
        System.out.println(jsonCollege);
    }
}

输出结果吗:

{
  "NAME": "VIT University, Vellore",
  "COURSESOFFER": [
    "BTECH, MTECH, BSC, MSC"
  ]
}

11. 性质排除策略

GSON
API为支撑序列化期间的性排除。开发人员可以在列化Java对象时解除某些性能。GSON提供了少数种不同的措施来兑现属性之清除:

  • 配置GsonBuilder
  • 动注解

图片 3

面前的图纸显示了GSON中有数种植不同的性质排除策略措施的摘要。每一样栽方法还发出详实的说明。

(1)配置GsonBuilder

GsonBuilder提供excludeFieldsWithModifiers()艺术来解属性序列化。该方法供了消除有有指定修饰符的类属性的力量。该法的原型特征如下:

public GsonBuilder excludeFieldsWithModifiers(int... modifiers)
  • 输入参数:...记,表示入参是java.lang.reflect.Modifier项目可易参数,例如Modifier.STATICModifier.PUBLIC
    Modifier.PRIVATE
  • 回去路:返回一个GsonBuilder花色的援对象。

为咱来拘禁一个布局GsonBuilder的示例:

import java.lang.reflect.Modifier;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

class Employee {

    private String name;
    private transient String gender;
    private static String designation;
    protected String department;

    public Employee() {
        this("Abcd Employee", "MALE", "Tech Lead", "IT Services");
    }

    @SuppressWarnings("static-access")
    public Employee(String name, String gender, String designation,
                    String department) {
        this.name = name;
        this.gender = gender;
        this.designation = designation;
        this.department = department;
    }
}

public class FieldExclusionFeature {

    public static void main(String[] args) {

        Gson gson = new Gson();

        String json = gson.toJson(new Employee("Sandeep", "Male", "Tech Lead", "IT Services"));
        System.out.println(json);

        Gson gson2 = new GsonBuilder().excludeFieldsWithModifiers().create();
        json = gson2.toJson(new Employee("Sandeep", "MALE", "Tech Lead", "IT Services"));
        System.out.println(json);

        Gson gson3 = new GsonBuilder().excludeFieldsWithModifiers(Modifier.STATIC).create();
        json = gson3.toJson(new Employee("Sandeep", "MALE", "Tech Lead", "IT Services"));
        System.out.println(json);
    }

}

输出结果吗:

{"name":"Sandeep","department":"IT Services"}
{"name":"Sandeep","gender":"MALE","designation":"Tech Lead","department":"IT Services"}
{"name":"Sandeep","gender":"MALE","department":"IT Services"}

咱得以起之前的代码中取得三个启迪:

  • 输出的首先尽有一个Employee类JSON字符串,它发零星独特性:namedepartment。这个输出是由Gson对象,使用默认的法创建的。因此,在序列化时,它概括了statictransient修饰的习性。
  • 出口的第二履有一个Employee类JSON字符串,它发四只属性:namegenderdesignationdepartment。这个输出是出于Gson对象下构造器的方式以及excludeFieldWithModifiers()主意。当没参数传递时,它会序列化Employee目标中有的具有字属性类型。
  • 出口的老三执行有一个Employee类JSON字符串,该字符串包含三只属性:namegenderdepartment。输出是由于Gson对象下构造器的方同excludeFieldsWithModifiers()方法。Modifier.STATIC用作一个参数传递给此办法,它不序列化Employee对象的任何静态属性。

(2)使用注解

GSON提供@Expose注实现以序列化期间排除指定属性。属性标有@Expose注解的用行化为JSON表示。GSON的excludeFieldsWithoutExposeAnnotation()术必须以配置GsonBuilder使用@Expose诠释时受调用。

叫咱来拘禁一个利用@Expose注的例证:

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.annotations.Expose;

class Vegetable {

    private String name;
    @Expose
    private int price;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getPrice() {
        return price;
    }

    public void setPrice(int price) {
        this.price = price;
    }
}

public class FieldExclusionAnnotationUse {

    public static void main(String[] args) {

        Gson gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation()
                .create();
        Vegetable aVegetable = new Vegetable();
        aVegetable.setName("Potato");
        aVegetable.setPrice(26);
        String jsonVegetable = gson.toJson(aVegetable);

        System.out.println("JSON Representation of Vegetable : ");
        System.out.println(jsonVegetable);
    }
}

输出结果为:

JSON Representation of Vegetable : 
{"price":26}

咱俩可自眼前的代码中汲取以下几点启示:

  • 前面同一段代码的输出有一个带属性price的JSON字符串。这个输出是由于Gson对象下构造器的道同excludeFieldsWithoutExposeAnnotation()方法。
  • 排化Java对象时,它仅序列化带有@Expose的属性。

(3)用户从定义属性排除注解

GSON为开发人员提供了灵活性,可以创造一个自定义注解,用于破除属性和类似。下面的步调示例了什么创造于定义注解:

  1. 声称一个标记Java接口。一个标记接口是大概的Java接口,没有其它性质或艺术。简而言之,一个缺损的Java接口是一个号接口。该接口的名将为此作起定义排除注解。
  2. 一个Java近乎来贯彻com.google.gson.ExclusionStrategyExclusionStrategy接口提供了简单栽方法。通过实现这个接口,Java类提供了定制排除注解的意义。当GSON在序列化或反序列化并找到一个自定义注解时,它见面翻实现了ExclusionStrategy接口的Java类,以找有怎样处理它。

ExclusionStrategy接口提供了零星种植方式:

方法名 详细说明
shouldSkipField 参数:FieldAttributes 引用类型;返回Boolean值:true:属性将被序列化/反序列化输出的一部分;false:属性将不会被序列化/反序列化输出的一部分。
shouldSkipClass 参数:Class类的引用类型。返回Boolean值:true:类将序列化/反序列化输出的一部分;false:类将不会被序列化/反序列化输出的一部分。

叫咱来拘禁一个用户定义之性排除注解的言传身教:

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import com.google.gson.ExclusionStrategy;
import com.google.gson.FieldAttributes;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.FIELD })
@interface MyExclude {
}

class CustomExclusionStrategy implements ExclusionStrategy {

    private final Class<?> typeToExclude;

    CustomExclusionStrategy(Class<?> typeToExclude) {
        this.typeToExclude = typeToExclude;
    }

    public boolean shouldSkipClass(Class<?> classname) {
        return (classname == typeToExclude);
    }

    public boolean shouldSkipField(FieldAttributes f) {
        return f.getAnnotation(MyExclude.class) != null;
    }

}

class Vegetable {

    private String name;
    @MyExclude
    private int price;

    public Vegetable() {
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getPrice() {
        return price;
    }

    public void setPrice(int price) {
        this.price = price;
    }
}

public class UserDefinedFieldExclusion {

    public static void main(String[] args) {

        Gson gson = new GsonBuilder().setExclusionStrategies(new CustomExclusionStrategy(MyExclude.class)).create();

        Vegetable aVegetable = new Vegetable();
        aVegetable.setName("Potato");
        aVegetable.setPrice(26);
        String jsonVegetable = gson.toJson(aVegetable);

        System.out.println(jsonVegetable);
    }
}

出口结果也:

{"name":"Potato"}

上面的代码执行以下步骤:

  • 使用java.lang.annotation创立用户从定义注解@MyExclude
  • 采用含MyExclude.class参数的CustomExclusionStrategy类实例化一个自定义排除策略。
  • 使用setExclusionStrategies方法,GsonBuilder布是新的解除策略。
  • 现在,由GsonBuilder创建的Gson对象将辟带有@MyExclude注解的字段。

  • 应用GSON


以JSON格式和它对应的语言库GSON的表明之后,Java
web应用程序的支出(客户端和劳动器端进行通信并因JSON格式对数据开展响应)获得了汪洋底盛行,这让Web
2.0应用程序非常成功。

以下StudentJsonDataServlet.java著了一个Java
servlet如何回到Student型的JSON数据,并在浏览器被表现为HTML表格:

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import com.google.gson.Gson;
import com.packt.myapp.data.Student;

@WebServlet("/StudentJsonDataServlet")
public class StudentJsonDataServlet extends HttpServlet {

    private static final long serialVersionUID = 1L;

    public StudentJsonDataServlet() {
    }

    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {

        Gson gson = new Gson();

        List<Student> listOfStudent = getStudentData();

        String jsonString = gson.toJson(listOfStudent);

        response.setContentType("application/json");

        response.getWriter().write(jsonString);
    }

    /**
     * Returns List of Static Student data
     */
    private List<Student> getStudentData() {

        Student s1 = new Student();
        s1.setName("Sandeep");
        s1.setSubject("Computer");
        s1.setMark(85);

        Student s2 = new Student();
        s2.setName("John");
        s2.setSubject("Science");
        s2.setMark(85);

        Student s3 = new Student();
        s3.setName("Ram");
        s3.setSubject("Computer");
        s3.setMark(85);

        List<Student> listOfStudent = new ArrayList<Student>();
        listOfStudent.add(s1);
        listOfStudent.add(s2);
        listOfStudent.add(s3);

        return listOfStudent;
    }
}

StudentJsonDataServlet拿学员的详细信息作为JSON字符串返回。并为浏览器表明,数据应是一个json类型的头文件,需要装也application/json

以下studentstableview.html大凡当浏览器被渲染servlet响应的公文:

<html>
  <head>
  <title>Students JSON Table View</title>
  <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
  </head>
  <body>
    <div id="student-data-container"></div>
    <script>
    $(document).ready(function(){

      var getStudentTableHtml, html, 

      htmlStudent, container =$('#student-data-container'),

      ajaxRequest = $.ajax({
        url: "StudentJsonDataServlet",

        dataType: "JSON",

        success: function(data){

          htmlStudent = getStudentTableHtml(data);

          container.html(htmlStudent)
        }
    }),

    getStudentTableHtml = function(data){

      html = [];

      html.push("<TABLE border='2px' cellspacing='2px'>");
      html.push("<TR>");
      html.push("<TH>NAME</TH>");
      html.push("<TH>SUBJECT</TH>");
      html.push("<TH>MARK</TH>");
      html.push("</TR>");

      $.each(data,function(index, aStudent){
        html.push("<TR>");
        html.push("<TD>");
        html.push(aStudent.name);
        html.push("</TD>");
        html.push("<TD>");
        html.push(aStudent.subject);
        html.push("</TD>");
        html.push("<TD>");
        html.push(aStudent.mark);
        html.push("</TD>");
        html.push("</TR>");
      });
      html.push("</TABLE>")

      return html.join("");
    }
  })
    </script>
  </body>
</html>

上面的代码展示了在DOM就绪事件上调用jQuery Ajax事件。servlet使用GSON
API将Student靶的列表转换为相应的JSON表示,并拿那看做响应内容发送到客户端。以下截图中的Firebug控制台显示了JSON对象吃之Ajax请求和响应:

图片 4

以博响应时,jQuery调用success法来拍卖。作为返回,成功处理程序调用getStudentTableHtml()术以HTML中构建一个报表。

拖欠措施应用for循环来迭代每个学生JSON对象来构建表格的实施。下面截图显示了学生JSON响应数据构建的学员详细信息的HTML表格:

图片 5

三. 你当了解的赞助文档

假设你需要有关GSON资料文档的辅助,这里发生部分网址是可怜管用的:

1. 官网网址

  • 主页: http://code.google.com/p/google-gson/
  • 手册和文档:http://google-gson.googlecode.com/svn/trunk/gson/docs/javadocs/index.html
  • 维基百科:http://en.wikipedia.org/wiki/GSON
  • 源码:http://code.google.com/p/google-gson/source/checkout
  • 筹文档:https://sites.google.com/site/gson/gson-design-document
  • 反馈:http://code.google.com/p/google-gson/feeds

  • 章与课程


  • 谷歌提供的用户指南:https://sites.google.com/site/gson/gson-user-guide
  • Mkyong的博客:http://www.mkyong.com/java/how-do-convert-java-object-to-from-json-format-gson-api/

  • 社区


  • 官方论坛:https://groups.google.com/forum/?fromgroups#!forum/google-gson
  • 未官方论坛:http://stackoverflow.com/questions/tagged/gson

  • 博客


  • Java code
    geek博客:http://examples.javacodegeeks.com/core-java/gson/convert-java-object-to-from-json-using-gson-example/
  • GSON应用程序:http://www.tutorialsavvy.com/search/label/gson

相关文章