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提供突出的打字与印刷设备以使其以人类可读的格式。

1. 在 GSON 中开创你的率先个 JSON

在本节中,将学习实例化GSON及其各类办法的意义,然后是二个便捷示例代码,展现包装档次Java对象的着力系列化。

步骤1 – 实例化GSON

要利用GSON库,Gson类必要实例化1个com .google.GSON的靶子。GSON对象不维护别的动静,这一个特点有助于在三个地点重用GSON对象。

GSON库提供了实例化的三种方法:

  • 暗中认可方法
  • 构造器使用安装格局

私下认可方法

在那种艺术中,能够接纳new重在字实例化GSON类对象。这种措施创立了1个从未设置的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情势。
该格局有多少个参数,第叁个参数是三个字符串,第1个参数是三个预期的Java类项目。
fromJson艺术的回来类型始终是Java类型。

二. 要求明白的13个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作为第3行操作符的实例来表达由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还为开发职员提供了可定制的体系化的性子。

下面包车型地铁代码是2个可定制种类化器的示范:

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;
    }
}

上边包车型大巴代码是3个自定义反体系化器的例证:

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支撑美好的打字与印刷配置,同时为种类化使用创制2个Gson对象。这么些美丽的打印功效通过适当的价签缩进和新的换行来吹嘘JSON字符串的输出。

以下是有关格式化程序的一部分主要内容:

  • JsonPrintFormatterJsonCompactFormatter是GSON中的三种格式化类型的表示。
  • JsonCompactFormatter是GSON的暗中同意格式化程序。
  • JsonPrintFormatter用于优质的打字与印刷,它不会揭露在API中。所以开发者不可能修改。
  • JsonPrintFormatter支撑1个默许行长度为7九个字符,七个字符缩进,以及左侧保持四个字符。
  • 能够经过调用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中的1个实例之中类能够因而使用外部类对象来实例化。下边的代码演示了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表示。

让大家来看2个数组的例证:

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表示。

让大家看3个空对象的例子:

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提供了一种体制来满意那一个差别版本数据的呼吁。

让我们看1个版本帮助的例子:

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提供1个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()方法,该方法再次回到值2四千的参数化的Salary构造方法。

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

当GSON找到空的Salary字符串时,它将追寻类型Salary的暗许构造方法。由于不存在暗中同意的Salary构造方法,所以它寻找类型适配器的GsonBuilder设置,并找到SalaryInstanceCreator。并调用createInstance()方法。

就此,当对3个空的Salary类对象开始展览反系列化时,GSON将取得2伍仟当做暗中同意值。

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还提供了3个FieldNamingStrategy类,以使开发职员能够创制自身的脾性命名策略。以下步骤示例怎样成立自定义属性命名策略:

  • 创设一个 Java 类并完成FieldNamingStrategy接口
  • 重写translateName方法
  • 该格局提供了自定义属性命名策略的真的完毕。GSON在拍卖自定义属性名称策略时,使用该措施中的逻辑作为属性名:
方法 详细说明
translateName 参数:java.lang.reflect.Field;返回:已更改的属性名字符串

让我们看2个用户定义属性命名的言传身教:

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
  • 归来类型:再次回到2个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"}

我们得以从后面包车型大巴代码中取得多少个启示:

  • 输出的率先行有2个Employee类JSON字符串,它有两特性情:namedepartment。这几个输出是出于Gson对象,使用私下认可的艺术创立的。由此,在体系化时,它大约了statictransient修饰的性格。
  • 出口的第2行有一个Employee类JSON字符串,它有八个属性:namegenderdesignationdepartment。那几个输出是由于Gson对象使用构造器的措施和excludeFieldWithModifiers()艺术。当没有参数字传送递时,它会类别化Employee对象中留存的保有字属性类型。
  • 出口的第叁行有三个Employee类JSON字符串,该字符串包涵多少个属性:namegenderdepartment。输出是出于Gson对象使用构造器的艺术和excludeFieldsWithModifiers()方法。Modifier.STATIC作为2个参数字传送递给那一个艺术,它不连串化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接口,没有别的性质或形式。简单来说,1个空的Java接口是2个符号接口。该接口的名称将用作自定义排除评释。
  2. 2个Java类来完成com.google.gson.ExclusionStrategyExclusionStrategy接口提供了二种方式。通过落到实处这几个接口,Java类提供了定制排除评释的功用。当GSON在类别化或反连串化并找到二个自定义注脚时,它会翻动完成了ExclusionStrategy接口的Java类,以找出什么样处理它。

ExclusionStrategy接口提供了二种方法:

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

让大家来看3个用户定义的质量排除表明的演示:

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类实例化3个自定义排除策略。
  • 使用setExclusionStrategies方法,GsonBuilder安插那些新的排除策略。
  • 现在,由GsonBuilder创建的Gson目的将免去带有@MyExclude注明的字段。

12. 应用GSON

在JSON格式和它对应的语言库GSON的表达之后,Java
web应用程序的支出(客户端与劳务器端实行通讯并以JSON格式对数码开始展览响应)获得了大批量的风靡,那使得Web
2.0应用程序分外成功。

以下StudentJsonDataServlet.java来得了1个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中创设2个表格。

该情势应用for循环来迭代种种学生JSON对象来营造表格的行。上边截图展现了学员JSON响应数据营造的学生详细音讯的HTML表格:

图片 5

三. 你应该精晓的声援文书档案

一旦您要求有关GSON资料文书档案的扶植,那里有一对网址是不行有效的:

1. 官网网址

2. 作品和学科

3. 社区

4. 博客

相关文章