使用json-lib进行Java和JSON之间的转换

Posted 2021-01-24 WFiresun

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了使用json-lib进行Java和JSON之间的转换相关的知识，希望对你有一定的参考价值。

使用json-lib进行Java和JSON之间的转换

1. json-lib是一个java类库，提供将Java对象，包括beans, maps, collections, java arrays and XML等转换成JSON，或者反向转换的功能。

2. json-lib 主页： http://json-lib.sourceforge.net/

3.执行环境

需要以下类库支持

jakarta commons-lang 2.5
jakarta commons-beanutils 1.8.0
jakarta commons-collections 3.2.1
jakarta commons-logging 1.1.1
ezmorph 1.0.6

4.功能示例

这里通过JUnit-Case例子给出代码示例

package com.mai.json;

import static org.junit.Assert.assertEquals;

import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import net.sf.ezmorph.Morpher;
import net.sf.ezmorph.MorpherRegistry;
import net.sf.ezmorph.bean.BeanMorpher;
import net.sf.json.JSONArray;
import net.sf.json.JSONObject;
import net.sf.json.util.JSONUtils;

import org.apache.commons.beanutils.PropertyUtils;
import org.junit.Test;

public class JsonLibTest {

    /*
     *  普通类型、List、Collection等都是用JSONArray解析
     *
     *  Map、自定义类型是用JSONObject解析
     *  可以将Map理解成一个对象，里面的key/value对可以理解成对象的属性/属性值
     *  即{key1:value1,key2,value2......}
     *
     * 1.JSONObject是一个name:values集合，通过它的get(key)方法取得的是key后对应的value部分(字符串)
     *         通过它的getJSONObject(key)可以取到一个JSONObject，--> 转换成map,
     *         通过它的getJSONArray(key) 可以取到一个JSONArray ，
     *
     *
     */

    //一般数组转换成JSON
    @Test
    public void testArrayToJSON(){
        boolean[] boolArray = new boolean[]{true,false,true};
        JSONArray jsonArray = JSONArray.fromObject( boolArray );
        System.out.println( jsonArray );
        // prints [true,false,true]
    }


    //Collection对象转换成JSON
    @Test
    public void testListToJSON(){
        List list = new ArrayList();
        list.add( "first" );
        list.add( "second" );
        JSONArray jsonArray = JSONArray.fromObject( list );
        System.out.println( jsonArray );
        // prints ["first","second"]
    }


    //字符串json转换成json，根据情况是用JSONArray或JSONObject
    @Test
    public void testJsonStrToJSON(){
        JSONArray jsonArray = JSONArray.fromObject( "[\'json\',\'is\',\'easy\']" );
        System.out.println( jsonArray );
        // prints ["json","is","easy"]
    }


    //Map转换成json，是用jsonObject
    @Test
    public void testMapToJSON(){
        Map map = new HashMap();
        map.put( "name", "json" );
        map.put( "bool", Boolean.TRUE );
        map.put( "int", new Integer(1) );
        map.put( "arr", new String[]{"a","b"} );
        map.put( "func", "function(i){ return this.arr[i]; }" );

        JSONObject jsonObject = JSONObject.fromObject( map );
        System.out.println( jsonObject );
    }

    //复合类型bean转成成json
    @Test
    public void testBeadToJSON(){
        MyBean bean = new MyBean();
        bean.setId("001");
        bean.setName("银行卡");
        bean.setDate(new Date());

        List cardNum = new ArrayList();
        cardNum.add("农行");
        cardNum.add("工行");
        cardNum.add("建行");
        cardNum.add(new Person("test"));

        bean.setCardNum(cardNum);

        JSONObject jsonObject = JSONObject.fromObject(bean);
        System.out.println(jsonObject);

    }

    //普通类型的json转换成对象
    @Test
    public void testJSONToObject() throws Exception{
        String json = "{name=\\"json\\",bool:true,int:1,double:2.2,func:function(a){ return a; },array:[1,2]}";
        JSONObject jsonObject = JSONObject.fromObject( json );
        System.out.println(jsonObject);
        Object bean = JSONObject.toBean( jsonObject );
        assertEquals( jsonObject.get( "name" ), PropertyUtils.getProperty( bean, "name" ) );
        assertEquals( jsonObject.get( "bool" ), PropertyUtils.getProperty( bean, "bool" ) );
        assertEquals( jsonObject.get( "int" ), PropertyUtils.getProperty( bean, "int" ) );
        assertEquals( jsonObject.get( "double" ), PropertyUtils.getProperty( bean, "double" ) );
        assertEquals( jsonObject.get( "func" ), PropertyUtils.getProperty( bean, "func" ) );
        System.out.println(PropertyUtils.getProperty(bean, "name"));
        System.out.println(PropertyUtils.getProperty(bean, "bool"));
        System.out.println(PropertyUtils.getProperty(bean, "int"));
        System.out.println(PropertyUtils.getProperty(bean, "double"));
        System.out.println(PropertyUtils.getProperty(bean, "func"));
        System.out.println(PropertyUtils.getProperty(bean, "array"));

        List arrayList = (List)JSONArray.toCollection(jsonObject.getJSONArray("array"));
        for(Object object : arrayList){
            System.out.println(object);
        }

    }


    //将json解析成复合类型对象, 包含List
    @Test
    public void testJSONToBeanHavaList(){
        String json = "{list:[{name:\'test1\'},{name:\'test2\'}],map:[{test1:{name:\'test1\'}},{test2:{name:\'test2\'}}]}";
//        String json = "{list:[{name:\'test1\'},{name:\'test2\'}]}";
        Map classMap = new HashMap();
        classMap.put("list", Person.class);
        MyBeanWithPerson diyBean = (MyBeanWithPerson)JSONObject.toBean(JSONObject.fromObject(json),MyBeanWithPerson.class , classMap);
        System.out.println(diyBean);

        List list = diyBean.getList();
        for(Object o : list){
            if(o instanceof Person){
                Person p = (Person)o;
                System.out.println(p.getName());
            }
        }
    }


    //将json解析成复合类型对象, 包含Map
    @Test
    public void testJSONToBeanHavaMap(){
        //把Map看成一个对象
        String json = "{list:[{name:\'test1\'},{name:\'test2\'}],map:{test1:{name:\'test1\'},test2:{name:\'test2\'}}}";
        Map classMap = new HashMap();
        classMap.put("list", Person.class);
        classMap.put("map", Map.class);
        //使用暗示，直接将json解析为指定自定义对象，其中List完全解析,Map没有完全解析
        MyBeanWithPerson diyBean = (MyBeanWithPerson)JSONObject.toBean(JSONObject.fromObject(json),MyBeanWithPerson.class , classMap);
        System.out.println(diyBean);

        System.out.println("do the list release");
        List<Person> list = diyBean.getList();
        for(Person o : list){
            Person p = (Person)o;
            System.out.println(p.getName());
        }

        System.out.println("do the map release");

        //先往注册器中注册变换器，需要用到ezmorph包中的类
        MorpherRegistry morpherRegistry = JSONUtils.getMorpherRegistry();
        Morpher dynaMorpher = new BeanMorpher( Person.class,  morpherRegistry);
        morpherRegistry.registerMorpher( dynaMorpher );


        Map map = diyBean.getMap();
        /*这里的map没进行类型暗示，故按默认的，里面存的为net.sf.ezmorph.bean.MorphDynaBean类型的对象*/
        System.out.println(map);
        List<Person> output = new ArrayList();
        for( Iterator i = map.values().iterator(); i.hasNext(); ){
            //使用注册器对指定DynaBean进行对象变换
           output.add( (Person)morpherRegistry.morph( Person.class, i.next() ) );
        }

        for(Person p : output){
            System.out.println(p.getName());
        }

    }

JSON 与对象、集合之间的转换

JSON字符串和java对象的互转【json-lib】

在开发过程中，经常需要和别的系统交换数据，数据交换的格式有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字符串的互转

java对象--》》字符串

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

package com.cn.study.day3;

public class Student {
    //姓名
    private String name;
    //年龄
    private String age;
    //住址
    private String address;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getAge() {
        return age;
    }
    public void setAge(String age) {
        this.age = age;
    }
    public String getAddress() {
        return address;
    }
    public void setAddress(String address) {
        this.address = address;
    }
    @Override
    public String toString() {
        return "Student [name=" + name + ", age=" + age + ", address="
                + address + "]";
    }
    

}

上面是我的一个普通的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字符串，只是转化后的结构不同。

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字符串的互转

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"}]

这样结果是正常的。
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字符串的互转

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"}}]

上面打印了两种形式。

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

    

}

使用JSONObject生成和解析json

1. json数据类型

类型	描述
Number	数字型
String	字符串型
Boolean	布尔型
Array	数组
Object	对象
null	空值

（1）json中不区分整数、小数等类型，而统一使用Number来存储数字。

（2）Array表示数组，以中括号"[]"括起来，元素之间以逗号分隔，元素可以为任意类型。

（3）Object表示对象，类似于C语言中的结构体，以花括号"{}"括起来，其元素要求为键值对，key必须为String类型的，而value则可为任意类型。key和value之间以":"表示映射关系，元素之间也是以逗号分隔。

2. 构建json

在eclipse中使用JSONObject需要引用org.json包，推荐通过maven引用，如果不会使用maven，搭建maven项目可参考这篇文章《使用Eclipse构建Maven项目 (step-by-step)》，引用json则参考这篇文章《maven引入json各种版本》。

温馨提示：我在构建maven项目的时候屡屡创建失败，在网上查了很久还是搞不定，后来科学上网就搞定了，如果你也创建失败，可以尝试一下。

如果是在android Studio中，则可以直接使用。

2.1 直接构建

JSONObject obj = new JSONObject();
obj.put(key, value);

直接构建即直接实例化一个JSONObject对象，而后调用其put()方法，将数据写入。put()方法的第一个参数为key值，必须为String类型，第二个参数为value，可以为boolean、double、int、long、Object、Map以及Collection等。当然，double以及int等类型只是在Java中，写入到json中时，统一都会以Number类型存储。

范例：

import org.json.JSONObject;

public class JSONObjectSample {

    public static void main(String[] args) {
        createJson();
    }

    private static void createJson() {
        JSONObject obj = new JSONObject();
        obj.put("name", "John");
        obj.put("sex", "male");
        obj.put("age", 22);
        obj.put("is_student", true);
        obj.put("hobbies", new String[] {"hiking", "swimming"});
        //调用toString()方法可直接将其内容打印出来
        System.out.println(obj.toString());
    }

}

输出结果为：

{"hobbies":["hiking","swimming"],"sex":"male","name":"John","is_student":true,"age":22}

这里可以看到，为了压缩大小以便于更高效地传输，json把所有空格、换行符等空白符全部去掉了。如果想要直观点看其内容，可以用一些在线的json解析器看，例如：http://www.jsoneditoronline.org/

2.2 使用HashMap构建

使用HashMap构建json，实际上即先创建好一个HashMap对象并且将数据打包进去，而后在创建JSONObject时将其作为一个参数传进去。

范例：

public class JSONObjectSample {

    public static void main(String[] args) {
        createJsonByMap();
    }

    private static void createJsonByMap() {
        Map<String, Object> data = new HashMap<String, Object>();
        data.put("name", "John");
        data.put("sex", "male");
        data.put("age", 22);
        data.put("is_student", true);
        data.put("hobbies", new String[] {"hiking", "swimming"});
        
        JSONObject obj = new JSONObject(data);
        System.out.println(obj.toString());
    }

}

2.3 使用JavaBean构建

相较于前两种方法，实际开发中应用JavaBean构建json的情况更为常见，因为这样代码的重用率更高。

范例：

JavaBean：

public class PersonInfo {

    private String name;
    private String sex;
    private int age;
    private boolean isStudent;
    private String[] hobbies;
    
    public void setName(String name) {
        this.name = name;
    }
    public void setSex(String sex) {
        this.sex = sex;
    }
    public void setAge(int age) {
        this.age = age;
    }
    public void setStudent(boolean isStudent) {
        this.isStudent = isStudent;
    }
    public void setHobbies(String[] hobbies) {
        this.hobbies = hobbies;
    }
        //getter不能少
    public String getName() {
        return name;
    }
    public String getSex() {
        return sex;
    }
    public int getAge() {
        return age;
    }
    public boolean isStudent() {
        return isStudent;
    }
    public String[] getHobbies() {
        return hobbies;
    }
}

main：

import org.json.JSONObject;

public class JSONObjectSample {

    public static void main(String[] args) {
        createJsonByJavaBean();
    }

    private static void createJsonByJavaBean() {
        PersonInfo info = new PersonInfo();
        info.setName("John");
        info.setSex("male");
        info.setAge(22);
        info.setStudent(true);
        info.setHobbies(new String[] {"hiking", "swimming"});
        
        JSONObject obj = new JSONObject(info);
        System.out.println(obj);
    }

}

需要注意一点，JavaBean一定要有getter方法，否则会无法访问存储的数据。

3. 解析json

解析json主要是基本类型如Number、boolean等，与数组Array。

基本类型的解析直接调用JSONObject对象的getXxx(key)方法，如果获取字符串则getString(key)，布尔值则getBoolean(key)，以此类推。

数组的解析稍微麻烦一点，需要通过JSONObject对象的getJSONArray(key)方法获取到一个JSONArray对象，再调用JSONArray对象的get(i)方法获取数组元素，i为索引值。

范例：

首先在工程目录"src/main/java"下创建一个json文件，用于解析。

demo.json：

{
  "hobbies": [
    "hiking",
    "swimming"
  ],
  "sex": "male",
  "name": "John",
  "is_student": true,
  "age": 22
}

在pom.xml中加入对commons-io的依赖，以便于使用FileUtils进行文件访问：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.studying</groupId>
  <artifactId>myjson</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>myjson</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.json</groupId>
      <artifactId>json</artifactId>
      <version>20160810</version>
    </dependency>
    <!--加入对commons-io的依赖-->
    <dependency>
      <groupId>commons-io</groupId>
      <artifactId>commons-io</artifactId>
      <version>2.4</version>
    </dependency>
  </dependencies>
</project>

主类：

import java.io.File;
import java.io.IOException;

import org.apache.commons.io.FileUtils;
import org.json.JSONArray;
import org.json.JSONObject;

public class JSONObjectSample {

    public static void main(String[] args) throws IOException {
        File file = new File("src/main/java/demo.json");
        String content = FileUtils.readFileToString(file);
        //对基本类型的解析
        JSONObject obj = new JSONObject(content);
        System.out.println("name：" + obj.getString("name"));
        System.out.println("sex：" + obj.getString("sex"));
        System.out.println("age" + obj.getInt("age"));
        System.out.println("is_student" + obj.getBoolean("is_student"));
        //对数组的解析
        JSONArray hobbies = obj.getJSONArray("hobbies");
        System.out.println("hobbies：");
        for (int i = 0; i < hobbies.length(); i++) {
            String s = (String) hobbies.get(i);
            System.out.println(s);
        }
    }
}