使用Gson解析Json

1.Json介绍

      JSON的全称是"JavaScript Object Notation",即JavaScript对象表示法，它是一种基于文本，独立于语言的轻量级数据交换格式。XML也是一种数据交换格式。两者的区别：因为XML虽然可以作为跨平台的数据交换格式，但是在JS中处理XML非常不方便，同时XML标记比数据多，增加了交换产生的流量，而JSON没有附加的任何标记，在JS中可作为对象处理，所以我们倾向于选择JSON来交换数据。

2.Json的两种结构

    JSON有两种表示结构，对象和数组。

    对象结构：以{}为闭合，中间部分由","来分割的"key/value"对构成，关键字和值之间以"："分隔。其中关键字是字符串，而值可以使字符串，数值，true,false,null,对象或数组。语法结构如下：
　　{key1:value1,key2:value2,key3:value3,key4:value4......}
　　举例：{"UserID":11, "Name":"Truly", "Email":"zhuleipro@hotmail.com"};
　 数组结构：以[]闭合，中间由","来分割的值列表组成，语法结构如下：
　　[
　　{
　　key1:value1,
　　key2:value2
　　},
　　{
　　key3:value3,
　　key4:value4
　　}]

3.区分JSON字符串和JSON对象

     JSON字符串：使用""(双引号)或''(单引号)包括的符合JSON格式的字符串。例如：
var str = "{StudentID:'101',Name:‘mike',Age:15}";
     JSON对象：指符合JSON格式的js对象，例如：

var jsonObj = {StudentID:'101',Name:‘mike',Age:15};

     下面我们就Java使用Gson解析json数据举例说明，首先我们要导入Gson.jar包。网上可以下载，我这里用的是Gson-2.3.jar。

 4.实例

实现：

使用Gson的API实现Json和javaBean的相互转换

使用Gson的API实现Map和Json字符串相互转换
List<Object>或List<JavaBean>与Json字符串相互转换

目录结构：

这里，我们主要对json字符串和各种对象之间转换进行了举例，实现方法在JsonUtil.java中，同时，针对config.properties配置文件中没有的字段信息，我们会进行更新。

代码清单【1】People.java

package com.lxf.json;
/**
 * javaBean
 * @author Administrator
 * 
 * 20170107
 */
public class People
{
    //编号
    private String id;
    //姓名
    private String name;
    //邮箱地址
    private String email;
    //是否是vip  true:是  false:不是
    private boolean vip;
    
    public People()
    {
        
    }
    public People(String id, String name, String email, boolean vip) {
        super();
        this.id = id;
        this.name = name;
        this.email = email;
        this.vip = vip;
    }
    
    public String getId()
    {
        return id;
    }
    public void setId(String id)
    {
        this.id = id;
    }
    public String getName() 
    {
        return name;
    }
    public void setName(String name) 
    {
        this.name = name;
    }
    public String getEmail() 
    {
        return email;
    }
    public void setEmail(String email) 
    {
        this.email = email;
    }
    public boolean isVip() 
    {
        return vip;
    }
    public void setVip(boolean vip)
    {
        this.vip = vip;
    }
    
    @Override
    public String toString() {
        StringBuilder builder = new StringBuilder();
        builder.append("People [id=");
        builder.append(id);
        builder.append(", name=");
        builder.append(name);
        builder.append(", email=");
        builder.append(email);
        builder.append(", vip=");
        builder.append(vip);
        builder.append("]");
        return builder.toString();
    }    

}

代码清单【2】JsonUtil.java

package com.lxf.json;

import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.OutputStream;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;

import com.google.gson.Gson;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonPrimitive;
import com.google.gson.internal.LinkedHashTreeMap;
import com.google.gson.internal.LinkedTreeMap;
import com.google.gson.reflect.TypeToken;

/**
 * Json工具类
 * @author Administrator
 *
 */
public class JsonUtil 
{
    private static String propertiesPath = "src/config.properties";
    
    private static Properties prop = new Properties(); 
    
    static 
    {
        try 
        {
            prop.load(new FileInputStream(propertiesPath));
        }
        catch (Exception e) 
        {
            e.printStackTrace();
        }
    }
    
    /**
     * 0.0读取配置文件的相应键的值
     * @param str  主键
     * @return
     */
    public static String readConfig(String str)
    {
    
        if(prop.containsKey(str))
        {
            return prop.getProperty(str);
        }
        else
        {
            throw new RuntimeException("the properties file don't contains "+ str + " key");
        }
        
    }
    
    /**
     * 0.1 更新（或插入）一对properties信息(主键及其键值)  
     * 如果该主键已经存在，更新该主键的值；  
     * 如果该主键不存在，则插件一对键值。 
     * @param str  键名
     * @param value  键值
     */
    public static void updateConfig(String str,String value) 
    {
        try
        {
            OutputStream fos = new FileOutputStream(propertiesPath);
            //如果该主键已经存在，更新该主键的值；  
            prop.setProperty(str, value);
            if(prop.containsKey(str))
            {
                prop.store(fos, "Update ：" + str + "=" + value);
            }
            else
            {
                prop.store(fos, "Insert : " + str + "=" + value);
            }
        } 
        catch (Exception e) 
        {
            System.out.println();
        }
        
    }
    /*
     * 1.1 json字符串--->JavaBean
     */
    public static void jsonToJavaBean()
    {
        
        String jsonStr = readConfig("huawei");
        Gson gson = new Gson();
        People people = gson.fromJson(jsonStr, People.class);
        System.out.println(people.toString());
    }
    
    /*
     * 1.2 JavaBean--->json字符串
     */
    public static void javaBeanToJson() 
    {
        //创建javaBean
        People p = new People();
        p.setId("99");
        p.setName("apple");
        p.setEmail("110@163.com");
        p.setVip(false);
        //把javaBean转换为json字符串
        Gson gson = new Gson();
        String json = gson.toJson(p);
        System.out.println(json);
        
        //查看配置文件中是否有该配置项，如果没有，添加到配置文件中，如果有，更新value值
        String configKey = p.getName();
        updateConfig(configKey,json);
    }
    
    /*
     * 1.3 json字符串---->Json对象 
     */
    public static void jsonToJsonObj()
    {
        String jsonStr = readConfig("huawei");
        Gson gson = new Gson();
        //json字符串转换为JsonObject
        JsonObject jsonObject = (JsonObject) gson.fromJson(jsonStr, JsonElement.class);
        System.out.println(jsonObject);
        System.out.println(jsonObject.toString().equals(jsonStr));
        //得到JsonObject的某个字段的值
        JsonPrimitive namePrimitive = (JsonPrimitive) jsonObject.get("name");
        //JsonPrimitive namePrimitive =  jsonObject.getAsJsonPrimitive("name");
        System.out.println(namePrimitive);
        String name = namePrimitive.getAsString();
        System.out.println(name);
    }
    /**
     * 总结:
     *     --在json字符串转成JavaBean时，fromJson传入的第二个参数是Entity.class;
     *     --在json字符串转成JsonObject时，fromJson传入的第二个参数是JsonElement.class,不能传入JsonObject.class,
     *  否则返回的JsonObject是空的对象。
     *  --如果想得到某个JsonObject对象的某个属性值，可以使用.get(String str).getAsString().
     * 
     */


    /**
     * 2.1Map--->json转换
     */
    public static void mapToJson()
    {
        Gson gson = new Gson();
        Map<String, Object> map = new HashMap<String, Object>();
        map.put("id", 1);
        map.put("name", "xiaomi");
        map.put("vip", true);
        String json = gson.toJson(map);
        System.out.println(json);
        
        //查看配置文件中是否有该配置项，如果没有，添加到配置文件中，如果有，更新value值
        String configKey = (String) map.get("name");
        updateConfig(configKey,json);
    }
    
    /**
     * 2.2 json---->Map转换
     */
    
    public static void jsonToMap()
    {
        Gson gson = new Gson();
        String json = prop.getProperty("xiaomi");
        Map<String, Object> map = gson.fromJson(json, Map.class);
        //这里原来map中id键对应的值类型是int，但是转成json字符串再转回来后，int类型变为Double类型了，这值得重视。
        //如果需要int型，还需要利用double.intValue()方法转为int型。
        System.out.println(map);
        System.out.println(map.get("name"));
        System.out.println(map.get("name").getClass());
        System.out.println(map.get("name").getClass().getName());
    }
    
    
    /*
     * 3.List与Json相互转换
     */
    /**
     * 3.1 List<Object>与json字符串互换
     */
    public static void listObjectToJson()
    {
        List<Object> list = new ArrayList<Object>();
        for(int i = 0; i < 2; i++ )
        {
            list.add(i);
            list.add("element" + i);
        }
        System.out.println(list);
        Gson gson = new Gson();
        String json = gson.toJson(list);
        System.out.println(json);
        
        list = gson.fromJson(json, List.class);
        System.out.println(list);
        for(int i = 0 ; i < list.size(); i++)
        {
            Object o = list.get(i);
            System.out.println(o);
            System.out.println(o.getClass().getName());
        }
    }
    
    /**
     * List<Bean> 转化为json字符串
     * 
     * 1.不管是转换List<Object>,还是List<JavaBean>,当把字符串反序列化为list时，gson.fromJson(String json, Class<T> classOfT)
     * 的第2个参数必须传入List.class.
     * 2.转换List<JavaBean>，有2中方法：
     * (1).gson.fromJson(String json, Class<T> classOfT)的第二个参数传入List.class.此时返回的额list中的元素不是JavaBean，而是Map
     * 如果想得到一个个javaBean，还需要从map总去除键值对，然后利用构造器封装成javaBean.
     * (2).gson.fromJson(String json, Class<T> classOfT)的第二个参数传入Type对象（Type type = new TypeToken<List<People>>(){}.getType();），
     * 此时返回的list对象的元素就是一个个的javaBean对象。
     */
    public static void listBeanTojson()
    {
        List<People> personList = new ArrayList<People>();
        People p1 = new People("1001", "三星", "1001@163.com", false);
        People p2 = new People("1002", "诺基亚", "1002@163.com", false);
        People p3 = new People("1003", "中兴", "1003@163.com", true);
        personList.add(p1);
        personList.add(p2);
        personList.add(p3);
        
        //利用List.class与json字符串转换
        Gson gson = new Gson();
        String json = gson.toJson(personList) ;
        System.out.println(json);
        
        //写入到配置文件中
        String configKey = "info";
        updateConfig(configKey,json);
    }
    
    /**
     * 使用List.class将json转换为List<JavaBean>
     */
    public static void jsonToListJavaBean()
    {
        System.out.println("*********");
        Gson gson = new Gson();
        String json = prop.getProperty("info");
        List<LinkedTreeMap<String, Object>> list = gson.fromJson(json,List.class);
        System.out.println(list);
        for(LinkedTreeMap<String, Object> map : list)
        {
            System.out.println(map.getClass().getName());
            System.out.println(map.toString());
            Set<Map.Entry<String, Object>> set = map.entrySet();
            for(Iterator<Map.Entry<String, Object>> it = set.iterator();it.hasNext();)
            {
                Map.Entry<String, Object> entry = it.next();
                System.out.println(entry.getKey() + "--->" + entry.getValue());
            }
        }
        
    }
    
    /**
     * 使用Type将json字符串转化为List<JavaBean>
     */
    public static void jsonToListJavaByType()
    {    
        Gson gson = new Gson();
        String json = prop.getProperty("info");
        List<People> personList = new ArrayList<People>();
        People p1 = new People("1001", "三星", "1001@163.com", false);
        People p2 = new People("1002", "诺基亚", "1002@163.com", false);
        People p3 = new People("1003", "中兴", "1003@163.com", true);
        personList.add(p1);
        personList.add(p2);
        personList.add(p3);
        
        //利用TypeToken,List<JavaBean>与Json互换
        Type type = new TypeToken<List<People>>(){}.getType();
        System.out.println("type :" + type);
        String json2 = gson.toJson(personList, type);
                
        System.out.println(json2.equals(json));
        List<People> userList = gson.fromJson(json2, type);
        
        System.out.println(userList);
        for(int i = 0; i < userList.size(); i++)
        {
            System.out.println(userList.get(i).getEmail());
        }
    }
    

}

代码清单【3】JsonMain.java

package com.lxf.json;

import org.junit.Test;

import com.google.gson.Gson;

public class JsonMain 
{
    /**
     * 1.1 json字符串--->JavaBean测试
     */
    @Test
    public void testJsonToJavaBean()
    {
        JsonUtil.jsonToJavaBean(); 
    }
    
    /**
     * 1.2 JavaBean--->json字符串测试
     */
    @Test
    public void testJavaBeanToJson() 
    {
        JsonUtil.javaBeanToJson();
        
    }
    /**
     * 1.3 json字符串---->JsonObject
     */
    @Test
    public void testJsonToJsonObject()
    {
        JsonUtil.jsonToJsonObj();
    }
    
    /**
     * 2.1Map--->Json测试
     */
    @Test
    public void testMapToJson()
    {
        JsonUtil.mapToJson();
    }
    
    /**
     *  json---->Map转换
     */
    @Test
    public void testJsonToMap()
    {
        JsonUtil.jsonToMap();
    }
    
    /**
     * list<Object> <----> json测试
     */
    @Test
    public void testListObjectToJson()
    {
        JsonUtil.listObjectToJson();
    }
    
    /**
     * List<Bean> 转化为json字符串 测试
     */
    @Test
    public void testlistBeanTojson()
    {
        JsonUtil.listBeanTojson();
    }

    /**
     * 使用List.class将json转换为List<JavaBean> 测试
     */
    @Test
    public void testJsonToListJavaBean()
    {
        JsonUtil.jsonToListJavaBean();
    }
    /**
     * 使用Type将json字符串转化为List<JavaBean>
     */
    @Test
    public void testJsonToListJavaByType()
    {
        JsonUtil.jsonToListJavaByType();
    }
}

运行结果：

config.properties文件：

#Update uFF1Ainfo=[{"id":"1001","name":"u4E09u661F","email":"1001@163.com","vip":false},{"id":"1002","name":"u8BFAu57FAu4E9A","email":"1002@163.com","vip":false},{"id":"1003","name":"u4E2Du5174","email":"1003@163.com","vip":true}]
#Mon Jan 09 23:54:36 CST 2017
apple={"id":"99","name":"apple","email":"110@163.com","vip":false}
huawei={"id":101,"name":"huawei","email":"2582376681@qq.com","vip":true}
info=[{"id":"1001","name":"u4E09u661F","email":"1001@163.com","vip":false},{"id":"1002","name":"u8BFAu57FAu4E9A","email":"1002@163.com","vip":false},{"id":"1003","name":"u4E2Du5174","email":"1003@163.com","vip":true}]
xiaomi={"id":1,"vip":true,"name":"xiaomi"}

 5.拓展补充