Gson转Map详解

一、介绍

Gson是Google公司开发的Java语言的JSON解析工具，它可以将Java对象转换成对应的Json串，也可以将Json串转换成Java对象。其中，Gson转换为Map可以让我们更加方便地进行数据处理。

二、使用步骤

使用Gson将Json串转换为Map类型的对象，需要四个步骤：

1. 创建Gson对象

在使用Gson进行Json与Java对象之间的转换时，必须创建一个Gson对象，该对象提供了操作Json数据的方法。

Gson gson = new Gson();

2. 解析Json数据

首先，需要定义Json字符串。

String jsonString = "{\"key1\":\"value1\",\"key2\":\"value2\"}";

接下来，直接将jsonString转换成Map对象。

Type type = new TypeToken<Map<String, String>>() {}.getType();
Map<String, String> map = gson.fromJson(jsonString, type);

3. 获取Map中的值

现在，我们已经将Json字符串转换为Map对象，接下来可以使用get()方法获取Map中的值。

String value1 = map.get("key1"); // "value1"
String value2 = map.get("key2"); // "value2"

4. 解析复杂Json串

在解析复杂的Json串时，可以使用TypeToken将Json串类型化为对应的Java类型，然后通过Gson将Json数据解析成Java对象。

class User {
    private long id;
    private String name;
    private List<String> friends;

    public long getId() {
        return id;
    }

    public void setId(long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

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

    public List<String> getFriends() {
        return friends;
    }

    public void setFriends(List<String> friends) {
        this.friends = friends;
    }
}

String jsonStr = "{\"id\":1,\"name\":\"Tom\",\"friends\":[\"Alice\",\"Bob\"]}";
User user = gson.fromJson(jsonStr, User.class);

三、常见问题

1. Json串中含有不合法的字符怎么办？

当Json串中含有不合法的字符时，如单引号或反斜杠，Gson并不能正确地解析。这时，可以使用Apache Commons库的StringEscapeUtils类对Json串进行转义处理。

String jsonString = "{\"key1\":\"value1\",\"key2\":\"This string contains 'single quotes' and \\backslashes\\\\.\"}";
jsonString = StringEscapeUtils.escapeJava(jsonString);
Type type = new TypeToken<Map<String, String>>() {}.getType();
Map<String, String> map = gson.fromJson(jsonString, type);

2. 如何将Map对象转化为Json串？

Gson可以将Java对象转换为对应的Json串，可以将Map对象转换为Json串。

Map<String, String> map = new HashMap<>();
map.put("key1", "value1");
map.put("key2", "value2");
String jsonString = gson.toJson(map);

3. 如何忽略不需要的属性？

在反序列化Json数据时，有时需要忽略部分属性。可以通过使用@Expose注解来实现属性的忽略。

class User {
    @Expose
    private int id;
    
    @Expose
    private String name;
    
    private String password;
}

GsonBuilder builder = new GsonBuilder();
builder.excludeFieldsWithoutExposeAnnotation();
Gson gson = builder.create();
User user = gson.fromJson("{\"id\":1,\"name\":\"Tom\",\"password\":\"123456\"}", User.class);

4. 如何处理日期格式的数据？

Gson默认情况下无法将Json数据中的日期格式化为Java对象中的Date类型。为了解决这个问题，可以自定义TypeAdapter实现Json与Java对象之间的转换。

class DateAdapter extends TypeAdapter<Date> {
    private DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

    @Override
    public void write(JsonWriter out, Date value) throws IOException {
        if (value == null) {
            out.nullValue();
        } else {
            out.value(dateFormat.format(value));
        }
    }

    @Override
    public Date read(JsonReader in) throws IOException {
        Date parse = null;
        try {
            parse = dateFormat.parse(in.nextString());
        } catch (ParseException e) {
            e.printStackTrace();
        }

        return parse;
    }
}

GsonBuilder builder = new GsonBuilder();
builder.registerTypeAdapter(Date.class, new DateAdapter());
Gson gson = builder.create();

String json = "{\"time\":\"2019-11-11 11:11:11\"}";
Map<String, Object> map = gson.fromJson(json, new TypeToken<Map<String, Object>>() {}.getType());
Date date = new Date((long) map.get("time"));

四、代码示例

下面是将Json串转为Map和将Map转为Json中的代码示例。

1. Json串转换为Map

Gson gson = new Gson();
String jsonString = "{\"key1\":\"value1\",\"key2\":\"value2\"}";
Type type = new TypeToken<Map<String, String>>() {}.getType();
Map<String, String> map = gson.fromJson(jsonString, type);
System.out.println(map.get("key1")); // "value1"
System.out.println(map.get("key2")); // "value2"

2. Map转换为Json串

Gson gson = new Gson();
Map<String, String> map = new HashMap<>();
map.put("key1", "value1");
map.put("key2", "value2");
String jsonString = gson.toJson(map);
System.out.println(jsonString); // {"key1":"value1","key2":"value2"}

五、总结

通过本文我们学习了如何使用Gson将Json串解析成Map类型的对象，并通过实例代码演示了这一过程。