Gson –如何解析JSON

最新推荐文章于 2023-05-05 14:11:55 发布
最新推荐文章于 2023-05-05 14:11:55 发布
阅读量510 收藏
点赞数
文章标签： json java 移动开发

Gson提供了简单的toJson()和fromJson()方法来将Java对象转换为JSON。

toJson() – JSON的Java对象 

Gson gson = new Gson();

	// 1. Java object to JSON file
	gson.toJson(obj, new FileWriter("C:\\fileName.json"));
	
	// 2. Java object to JSON string
	String json = gson.toJson(obj);

fromJson() – JSON到Java对象 

Gson gson = new Gson();
	
	// 1. JSON file to Java object
	Object object = gson.fromJson(new FileReader("C:\\fileName.json"), Object.class);

	// 2. JSON string to Java object
	String json = "{'name' : 'mkyong'}";
	Object object = gson.fromJson(json, Staff.class);

1.下载Gson

pom.xml 
<dependency>
		<groupId>com.google.code.gson</groupId>
		<artifactId>gson</artifactId>
		<version>2.8.5</version>
	</dependency>

2. Java对象

供以后测试。

Staff.java 
package com.mkyong;

import java.math.BigDecimal;
import java.util.Arrays;
import java.util.List;
import java.util.Map;

public class Staff {

    private String name;
    private int age;
    private String[] position;              // array
    private List<String> skills;            // list
    private Map<String, BigDecimal> salary; // map

    //getters and setters
}

3. Java对象到JSON

3.1在Gson中，我们可以使用gson.toJson()将Java对象转换为JSON。

GsonExample1.java 
package com.mkyong;

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

import java.io.FileWriter;
import java.io.IOException;
import java.math.BigDecimal;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

public class GsonExample1 {

    public static void main(String[] args) {

        // pretty print
        Gson gson = new GsonBuilder().setPrettyPrinting().create();

        Staff staff = createStaffObject();

        // Java objects to String
        String json = gson.toJson(staff);

        //System.out.println(json);

        // Java objects to File
        try (FileWriter writer = new FileWriter("c:\\test\\staff.json")) {
            gson.toJson(staff, writer);
        } catch (IOException e) {
            e.printStackTrace();
        }

    }

    private static Staff createStaffObject() {

        Staff staff = new Staff();

        staff.setName("mkyong");
        staff.setAge(35);
        staff.setPosition(new String[]{"Founder", "CTO", "Writer"});
        Map<String, BigDecimal> salary = new HashMap() {{
            put("2010", new BigDecimal(10000));
            put("2012", new BigDecimal(12000));
            put("2018", new BigDecimal(14000));
        }};
        staff.setSalary(salary);
        staff.setSkills(Arrays.asList("java", "python", "node", "kotlin"));

        return staff;

    }

}

输出量

c:\\test\\staff.json 
{
  "name": "mkyong",
  "age": 35,
  "position": [
    "Founder",
    "CTO",
    "Writer"
  ],
  "skills": [
    "java",
    "python",
    "node",
    "kotlin"
  ],
  "salary": {
    "2018": 14000,
    "2012": 12000,
    "2010": 10000
  }
}

4. JSON到Java对象

4.1在Gson中，我们可以使用gson.fromJson将JSON转换回Java对象。

GsonExample2.java 
package com.mkyong;

import com.google.gson.Gson;

import java.io.FileReader;
import java.io.IOException;
import java.io.Reader;

public class GsonExample2 {

    public static void main(String[] args) {

        Gson gson = new Gson();

        try (Reader reader = new FileReader("c:\\test\\staff.json")) {

            // Convert JSON File to Java Object
            Staff staff = gson.fromJson(reader, Staff.class);
			
			// print staff 
            System.out.println(staff);

        } catch (IOException e) {
            e.printStackTrace();
        }

    }

}

输出量 

Staff{name='mkyong', age=35, position=[Founder, CTO, Writer], skills=[java, python, node, kotlin], salary={2018=14000, 2012=12000, 2010=10000}}

5.漂亮的打印JSON

5.1默认的JSON输出是紧凑模式。

GsonExample3.java 
package com.mkyong;

import com.google.gson.Gson;

public class GsonExample3 {

    public static void main(String[] args) {

        // compact print
        Gson gson = new Gson();

        String[] lang = {"Java", "Node", "Kotlin", "JavaScript"};
        String json = gson.toJson(lang);

        System.out.println(json);
        
    }

}

输出量 

["Java","Node","Kotlin","JavaScript"]

5.2启用漂亮的打印。

GsonExample4.java 
package com.mkyong;

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

public class GsonExample4 {

    public static void main(String[] args) {

        // pretty print
        Gson gson = new GsonBuilder().setPrettyPrinting().create();

        String[] lang = {"Java", "Node", "Kotlin", "JavaScript"};
        String json = gson.toJson(lang);

        System.out.println(json);

    }

}

输出量 

[
  "Java",
  "Node",
  "Kotlin",
  "JavaScript"
]

6.排除字段

在Gson中，有很多方法可以排除某些字段。

6.1默认情况下， transient和static字段将被排除。 我们可以通过excludeFieldsWithModifiers覆盖默认值

如果我们只想排除静态字段。 

import java.lang.reflect.Modifier;

	Gson gson = new GsonBuilder()
			.excludeFieldsWithModifiers(Modifier.STATIC)
			.create();

如果我们要排除瞬态和静态字段，则默认为。 

import java.lang.reflect.Modifier;

	Gson gson = new GsonBuilder()
			.excludeFieldsWithModifiers(Modifier.STATIC, Modifier.TRANSIENT)
			.create();

在此配置中，将包括静态和瞬态字段。 

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

6.2通过@Expose排除字段

@Expose定义要从JSON序列化和反序列化中排除的字段。 要使用@Expose ，我们需要创建Gson对象，如下所示： 

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

如果启用了.excludeFieldsWithoutExposeAnnotation()模式，则将排除所有没有@Expose字段。 例如， 

import com.google.gson.annotations.Expose;

public class Staff {

    @Expose(serialize = true, deserialize = true)
    private String name;
    @Expose
    private int age;
    @Expose(serialize = false, deserialize = true)
	
    private String[] position;              
    private List<String> skills;            
    private Map<String, BigDecimal> salary;

如果将上述Java对象转换为JSON，则输出将如下所示 

{
  "name": "mkyong",
  "age": 35
}

6.3通过ExclusionStrategies ，注释，类型，字段名称等排除字段。Gson灵活。

自定义注释@ExcludeField

ExcludeField.java 
package com.mkyong;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

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

一个ExclusionStrategy用于定义应排除或跳过哪些字段。

CustomExclusionStrategy.java 
package com.mkyong;

import com.google.gson.ExclusionStrategy;
import com.google.gson.FieldAttributes;

public class CustomExclusionStrategy implements ExclusionStrategy {

    private final Class<?> typeToSkip;

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

    @Override
    public boolean shouldSkipField(FieldAttributes f) {

        // if field name 'salary`, skip
        if ("salary".equals(f.getName())) {
            return true;
        }

        // if found @ExcludeField, skip
        if (f.getAnnotation(ExcludeField.class) != null) {
            return true;
        }

        return false;
    }

    @Override
    public boolean shouldSkipClass(Class<?> clazz) {
        return (clazz == typeToSkip);
    }

}

再次检查staff对象。

Staff.java 
public class Staff {


    private String name;
    private int age;
    @ExcludeField
    private String[] position;
    private List<String> skills;
    private Map<String, BigDecimal> salary;

启用ExclusionStrategy模式。 

Gson gson = new GsonBuilder()
		.setExclusionStrategies(new CustomExclusionStrategy(List.class)) // exclude all List fields.
		.create();

输出，该示例中，字段名salary ， @ExcludeField字段和List类型字段将被排除。 

{"name":"mkyong","age":35}

7.空对象支持

null对象字段将被忽略。

GsonExample5.java 
package com.mkyong;

import com.google.gson.Gson;

public class GsonExample5 {

    public static void main(String[] args) {

        Gson gson = new Gson();

        Staff staff = createStaffObject();
		
        String json = gson.toJson(staff);

        System.out.println(json);

    }

    private static Staff createStaffObject() {

        Staff staff = new Staff();

        staff.setName("mkyong");
        staff.setAge(35);
   
        return staff;

    }

}

输出量 

{"name":"mkyong","age":35}

显示空值。 

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

输出量 

{"name":"mkyong","age":35,"position":null,"skills":null,"salary":null}

8. JSON字段命名支持

默认 

public class Staff {

    private String name;

输出量 

{"name":"abc"}

具有@SerializedName自定义字段名称 

public class Staff {

    @SerializedName("mkyong_name")
    private String name;

输出量 

{"mkyong_name":"abc"}

9.版本支持 

import com.google.gson.annotations.Since;

import java.math.BigDecimal;
import java.util.Arrays;
import java.util.List;
import java.util.Map;

public class Staff {

    @Since(1.0)
    private String name;
	
    @Since(2.0)
    private int age;
	
    @Since(3.0)
    private String[] position;
	
    private List<String> skills;
    private Map<String, BigDecimal> salary;

在此示例中，将排除字段position （版本3）。 

Gson gson = new GsonBuilder()
                .serializeNulls()
                .setVersion(2.0) // version <= 2.0 will be included.
                .create();

输出量 

{"name":null,"age":0,"skills":null,"salary":null}

10.常见问题

一些常见的问题。

10.1使用TypeToken将JSON数组转换为对象列表

GsonExample4.java 
package com.mkyong;

import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;

import java.util.List;

public class GsonExample4 {

    public static void main(String[] args) {

        Gson gson = new Gson();
        String json = "[{\"name\":\"mkyong\"}, {\"name\":\"laplap\"}]";
        List<Staff> list = gson.fromJson(json, new TypeToken<List<Staff>>() {}.getType());
        list.forEach(x -> System.out.println(x));

    }

}

输出量 

Staff{name='mkyong', age=0, position=null, skills=null, salary=null}
Staff{name='laplap', age=0, position=null, skills=null, salary=null}

10.2将JSON转换为Map

GsonExample5.java 
package com.mkyong;

import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;

import java.util.Map;

public class GsonExample5 {

    public static void main(String[] args) {

        Gson gson = new Gson();

        String json = "{\"name\":\"mkyong\", \"age\":33}";
        Map<String, Object> map = gson.fromJson(json, new TypeToken<Map<String, Object>>() {}.getType());
        map.forEach((x, y) -> System.out.println("key : " + x + " , value : " + y));

    }

}

输出量 

key : name , value : mkyong
key : age , value : 33.0

注意
阅读更多Gson用户指南

参考文献

标签：

翻译自: https://mkyong.com/java/how-to-parse-json-with-gson/

cyan20115
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Android中使用Gson解析JSON数据的两种方法
09-05
Json是一种类似于XML的通用数据交换格式,具有比XML更高的传输效率;本文将介绍两种方法解析JSON数据，需要的朋友可以参考下
使用GSON解析JSON数据
weixin_38107457的博客
11-25 4381
implementation 'com.google.code.gson:gson:2.7' GsonFormat Gson是采用对象映射的方式，所以我们要为JSON数据创建一个Java对象来与之对应。 我们可以使用GsonFormat插件，迅速的将JSON数据转换成Java对象，使用方法如下： 1、安装好GsonFormat插件 2、新建一个类，在类里的空白处按Alt+S键，并将要转换的JSON数据复制进去，界面如下所示： 注意：自动生成的时候，内部类可能会是静态的，手动...
Gson的JsonWriter和JsonReader代码详解例子
内事问度娘，外事问谷歌！
07-21 1718
package com.app.json; import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.InputStream; import java.io.InputStreamReader; import java.io.Outpu...
Gson源码解析之JsonReader/JsonWriter
meijing11的博客
08-17 629
JsonWriter 1.包装了Writer, 进行数据的写入,用于序列化操作 beginObject:通过open()写入json是object的起始符号{，在写入数据之前需要调用该方法 endObject:通过clase()写入json是object的结束符号} 在写入数据结束后需要调用该方法 beginArray:通过open()写入json是array的起始符号[，在写入数据之前需要调用该方法 endArray:通过close()写入json是array的结
使用GSON把数据保存为json格式文件
neweastsun的专栏
11-23 2194
当然也可以存储自定义类型对象为json格式。}}}如果字段标记为transient，gson默认会忽略，json序列化和反序列化过程中不会包括该字段。因此输出中没有出现nationality字段。{"id":1}如果需要保留null字段，请继续往下浏览。本文介绍使用gson库把java不同数据类型序列化为json文件。
Gson源码解析之-toJson
豌豆的专栏
03-13 2431
Gson 是开发中我们经常使用的一款json 解析框架，也是Google 推出的诸多良品之一，今天我们就从源码的角度看下gson 是如何来做序列化的，即如何通过toJson方法来做序列化的。 首先是获取Gson对象，只是Gson提供的对外方法类，有两种方式获取Gson对象，大概了解下。 GsonBuilder gsonBuilder=new GsonBuilder(); ...
Gson解析复杂Json实例，超简单
07-02
解放你的双手，不用再去一个一个JSONObject去处理解析问题，两行代码搞定一切
Gson解析json数据
04-07
这里进行介绍Gson解析复杂Json和简单Json的数据方式
使用Gson解析Json数据
10-21
1、生成Json数据 2、使用Gson解析Json数据（单个json对象、json数组和json对象内嵌json数组） // 这里有两篇好心人的博文，有详细的讲解 http://www.jb51.net/article/32547.htm ...
gson包解析json 数据
05-04
处 理 json 的 框 架，gson 的 jar 包，处 理 json 的 框 架，gson 的 jar 包，
Gson的fromJson()方法
热门推荐
alexxu1988的博客
06-29 3万+
Gson提供了fromJson()方法来实现从Json相关对象到java实体的方法。在日常应用中，我们一般都会碰到两种情况，转成单一实体对象和转换成对象列表或者其他结构。先来看第一种：比如json字符串为：[{“name”:”name0”,”age”:0}]Person person = gson.fromJson(str, Person.class);提供两个参数，分别是json字符串以及需要转换
Gson解析JSON
qq_42847719的博客
12-27 6038
Gson是Google提供的处理JSON数据的Java类库，主要用于转换Java对象和JSON对象。
Gson读取Json文件并解析
qq_52160611的博客
04-19 984
读取hotCitySites所有的city对象，所以还需要建一个实体类。在maven 项目下，需要导入Gson坐标。
Android 使用 Gson 解析 json 数据及生成
diuping20110926的博客
05-05 1171
将下载的 gson-2.9.1.jar 拷贝到 app 目录下的 libs 文件夹中。在 app 文件下的 build.gradle 文件 导入。鼠标右键 点击 Add As Library...直接去下载最新的 Gson 包。gson:2.9.1 包。3.解析所需要的 实体类。1.导入 Gson 包。2.json 数据解析。选择最新的包进行下载。
Gson.fromJson()方法
Echo6_Y的博客
08-04 1994
Gson提供的fromJson()方法是实现从Json数据到单一实体对象类型、对象列表类型或者其他结构。   1、比如json字符串为：[{“name”:”张三”,”age”:18}]  Person person = gson.fromJson(str, Person.class); 第一个参数是json字符串，第二个参数是需要转换对象的类型。   2、转换成集合类型 List&l...
gson读取json字符串_使用 Gson 实现 Json 字符串和 Java 对象之间的相互转换
weixin_29595517的博客
02-01 317
简书著作权归作者所有，任何形式的转载都请联系作者获得授权并注明出处。依赖com.google.code.gsongson2.6.2关于这个话题，需要注意的细节还是有一些的，这里只是结合自身需要整理了最基本的用法。如果想要了解更多细节性的问题，可以参考 http://www.jianshu.com/p/e740196225a4 (怪盗kidou)系列文章。一、Json 字符串转换为 Java 对象假...
Gson源码解析之-fromJson
豌豆的专栏
03-16 2097
上面我们学习了gson 的序列化过程方法 toJson 的源码,相信对很多的流程有了一个了解，紧接着我们来学习下gson反序列化过程,fromJson .还是老样子，代码一点一点看。 我们先模拟一个反序列化过程 String json="{\"age\":30,\"name\":\"明\",\"len\":170]}"; TestMode jsTestMode=gson.fromJson(j...
gson怎么解析json文件
最新发布
07-16
要使用Gson解析JSON文件，你需要按照以下步骤进行操作： 1. 首先，确保已经添加了Gson库的依赖。你可以在项目的构建文件（例如build.gradle）中添加以下依赖项： ``` dependencies { implementation '...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值