json字符串与java对象互转

转载，原文地址：http://www.cnblogs.com/wangf-keep/p/6480019.html

〇、背景介绍

在开发过程中，经常需要和别的系统交换数据，数据交换的格式有XML、JSON等，JSON作为一个轻量级的数据格式比xml效率要高，XML需要很多的标签，这无疑占据了网络流量，JSON在这方面则做的很好，下面先看下JSON的格式，

JSON可以有两种格式，一种是对象格式的，另一种是数组对象，

{"name":"JSON","address":"北京市西城区","age":25}   //JSON的对象格式的字符串
[{"name":"JSON","address":"北京市西城区","age":25}] //数据对象格式

从上面的两种格式可以看出对象格式和数组对象格式唯一的不同则是在对象格式的基础上加上了[]，再来看具体的结构，可以看出都是以键值对的形式出现的，中间以英文状态下的逗号（,）分隔。

在前端和后端进行数据传输的时候这种格式也是很受欢迎的，后端返回json格式的字符串，前台使用js中的JSON.parse()方法把JSON字符串解析为json对象，然后进行遍历，供前端使用。

下面进入正题，介绍在JAVA中JSON和java对象之间的互转。

要想实现JSON和java对象之间的互转，需要借助第三方jar包，这里使用json-lib这个jar包，下载地址为：https://sourceforge.net/projects/json-lib/，json-lib需要commons-beanutils-1.8.0.jar、commons-collections-3.2.1.jar、commons-lang-2.5.jar、commons-logging-1.1.1.jar、ezmorph-1.0.6.jar五个包的支持，可以自行从网上下载，这里不再贴出下载地址。

json-lib提供了几个类可以完成此功能，例，JSONObject、JSONArray。从类的名字上可以看出JSONObject转化的应该是对象格式的，而JSONArray转化的则应该是数组对象（即，带[]形式）的。

一、java普通对象和json字符串的互转

1、java对象 -> 字符串

java普通对象指的是java中的一个java bean，即一个实体类，如，

package com.cn.study.day3;
public class Student {
    //姓名
    private String name;
    //年龄
    private String age;
    //住址
    private String address;
    
    //此处省略setter、getter、toString方法
}

上面是我的一个普通的java实体类，看json-lib如何把它转化为字符串形式，

public static void convertObject() {
    Student stu=new Student();
    stu.setName("JSON");
    stu.setAge("23");
    stu.setAddress("北京市西城区");
    
    //1、使用JSONObject
    JSONObject json = JSONObject.fromObject(stu);
    
    //2、使用JSONArray
    JSONArray array=JSONArray.fromObject(stu);
    String strJson=json.toString();
    String strArray=array.toString();
    
    System.out.println("strJson:"+strJson);
    System.out.println("strArray:"+strArray);
}

我定义了一个Student的实体类，然后分别使用了JSONObject和JSONArray两种方式转化为JSON字符串，下面看打印的结果，

strJson:{"address":"北京市西城区","age":"23","name":"JSON"}
strArray:[{"address":"北京市西城区","age":"23","name":"JSON"}]

从结果中可以看出两种方法都可以把java对象转化为JSON字符串，只是转化后的结构不同。

2、JSON字符串 -> java对象

上面说明了如何把java对象转化为JSON字符串，下面看如何把JSON字符串格式转化为java对象，

首先需要定义两种不同格式的字符串，需要使用对双引号进行转义，

public static void jsonStrToJava(){
    //定义两种不同格式的字符串
    String objectStr="{"name":"JSON","age":"24","address":"北京市西城区"}";
    String arrayStr="[{"name":"JSON","age":"24","address":"北京市西城区"}]";
    
    //1、使用JSONObject
    JSONObject jsonObject=JSONObject.fromObject(objectStr);
    Student stu=(Student)JSONObject.toBean(jsonObject, Student.class);
    
    //2、使用JSONArray
    JSONArray jsonArray=JSONArray.fromObject(arrayStr);
    //获得jsonArray的第一个元素
    Object o=jsonArray.get(0);
    JSONObject jsonObject2=JSONObject.fromObject(o);
    Student stu2=(Student)JSONObject.toBean(jsonObject2, Student.class);
    System.out.println("stu:"+stu);
    System.out.println("stu2:"+stu2);
}

打印结果为：

stu:Student [name=JSON, age=24, address=北京市西城区]
stu2:Student [name=JSON, age=24, address=北京市西城区]

从上面的代码中可以看出，使用JSONObject可以轻松的把JSON格式的字符串转化为java对象，但是使用JSONArray就没那么容易了，因为它有“[]”符号，所以我们这里在获得了JSONArray的对象之后，取其第一个元素即我们需要的一个student的变形，然后使用JSONObject轻松获得。

二、list和json字符串的互转

1、list -> json字符串

public static void listToJSON(){
    Student stu=new Student();
    stu.setName("JSON");
    stu.setAge("23");
    stu.setAddress("北京市海淀区");
    List<Student> lists=new ArrayList<Student>();
    lists.add(stu);
    
    //1、使用JSONObject
    //JSONObject listObject=JSONObject.fromObject(lists);
    
    //2、使用JSONArray
    JSONArray listArray=JSONArray.fromObject(lists);
    
    //System.out.println("listObject:"+listObject.toString());
    System.out.println("listArray:"+listArray.toString());
}

我把使用JSONObject的方式给注掉了，我们先看注释之前的结果，

Exception in thread "main" net.sf.json.JSONException: 'object' is an array. Use JSONArray instead
告诉我说有一个异常，通过查看源码发现，在使用fromObject方法的时候会先进行参数类型的判断，这里就告诉我们，传入的参数是一个array类型，因为使用的ArrayList，再来看，注释之后的结果，

listArray:[{"address":"北京市海淀区","age":"23","name":"JSON"}]
这样结果是正常的。

2、json字符串 -> list

从上面的例子可以看出list的对象只能转化为数组对象的格式，那么我们看下面的字符串到list的转化，

public static void jsonToList(){
    String arrayStr="[{"name":"JSON","age":"24","address":"北京市西城区"}]";
    
    //转化为list
    List<Student> list2=(List<Student>)JSONArray.toList(JSONArray.fromObject(arrayStr), Student.class);
    for (Student stu : list2) {
        System.out.println(stu);
    }
    
    //转化为数组
    Student[] ss =(Student[])JSONArray.toArray(JSONArray.fromObject(arrayStr),Student.class);
    for (Student student : ss) {
        System.out.println(student);
    }
}

打印结果，

Student [name=JSON, age=24, address=北京市西城区]
Student [name=JSON, age=24, address=北京市西城区]

由于字符串的格式为带有“[]”的格式，所以这里选择JSONArray这个对象，它有toArray、toList方法可供使用，前者转化为java中的数组，或者转化为java中的list，由于这里有实体类进行对应，所以在使用时指定了泛型的类型（Student.class），这样就可以得到转化后的对象。

三、map和json字符串的互转

1、map -> json字符串

public static void mapToJSON(){
    Student stu=new Student();
    stu.setName("JSON");
    stu.setAge("23");
    stu.setAddress("中国上海");
    Map<String,Student> map=new HashMap<String,Student>();
    map.put("first", stu);
    
    //1、JSONObject
    JSONObject mapObject=JSONObject.fromObject(map);
    System.out.println("mapObject"+mapObject.toString());
    
    //2、JSONArray
    JSONArray mapArray=JSONArray.fromObject(map);
    System.out.println("mapArray:"+mapArray.toString());
}

打印结果，

mapObject{"first":{"address":"中国上海","age":"23","name":"JSON"}}
mapArray:[{"first":{"address":"中国上海","age":"23","name":"JSON"}}]

上面打印了两种形式。

2、json字符串 -> map

JSON字符串不能直接转化为map对象，要想取得map中的键对应的值需要别的方式，

public static void jsonToMap(){
    String strObject="{"first":{"address":"中国上海","age":"23","name":"JSON"}}";
    
    //JSONObject
    JSONObject jsonObject=JSONObject.fromObject(strObject);
    Map map=new HashMap();
    map.put("first", Student.class);
    
    //使用了toBean方法，需要三个参数 
    MyBean my=(MyBean)JSONObject.toBean(jsonObject, MyBean.class, map);
    System.out.println(my.getFirst());
}

打印结果，

Student [name=JSON, age=23, address=中国上海]

下面是MyBean的代码，

package com.cn.study.day4;
import java.util.Map;
import com.cn.study.day3.Student;

public class MyBean {
    private Student first;
    public Student getFirst() {
        return first;
    }
    public void setFirst(Student first) {
        this.first = first;
    }
}

使用toBean()方法是传入了三个参数，第一个是JSONObject对象，第二个是MyBean.class，第三个是一个Map对象。通过MyBean可以知道此类中要有一个first的属性，且其类型为Student，要和map中的键和值类型对应，即，first对应键 first类型对应值的类型。