FastJson的坑--"$ref"重复引用和循环引用

在开发的过程中使用FastJson进行json数据处理可能会碰到重复引用和循环引用的问题，下面提供了几个解决思路。

首先看一个小demo，证明证明fastJson转map 和对象，结果是一样的，之后的演示为了方便，使用map集合代替对象。

 @Test
    public void mapToJson(){
        Map map = new HashMap();

        map.put("name","张三");
        map.put("password","1234");

        String map1Str = JSON.toJSONString(map);
        System.out.println(map1Str);

        User user = new User();
        user.setName("李四");
        user.setPasswird("123456");
        String userStr = JSON.toJSONString(user);
        System.out.println(userStr);

    }

场景一：重复引用

数据库将查到的对象存入一个list集合中，然后进行json转换，但将一个对象查到了两次，都存入了list中，这时转换的时候就会出现引用的问题 。

 @Test
    public void testList(){
        List list = new ArrayList();
		// 模拟数据库查到用户张三
        Map map1 = new HashMap();
        map1.put("name","张三");
        map1.put("password","1234");
		// 模拟数据库查到用户李四
        Map map2 = new HashMap();
        map2.put("name","李四");
        map2.put("password","5678");

        list.add(map1);  // 第一次存入
        list.add(map2);
        list.add(map1); // 同一个对象第二次存入list中

        String string = JSON.toJSONString(list);
        System.out.println(string);

    }

运行结果如下：引用了集合中0号索引的数据。

这个引用java代码可以解析，但目前传到前端后，前端框架暂时无法进行解析。

解决方法：在进行数据转换时，加上SerializerFeature.DisableCircularReferenceDetect。

修改上方代码

 String string = JSON.toJSONString(list,SerializerFeature.DisableCircularReferenceDetect);

再次运行结果：

场景二：循环引用

在多对多的关系中，容易出现循环引用的情况，如一个用户对象包含多个角色信息，一个角色对象同时包含多个用户信息

一个用户对象张三拥有管理员和普通员工两个角色
管理员角色拥有张三用户
在转换对象信息的时候，会出现用户的roleList集合中role对象包含userList集合，userList集合中user对象又包含roleList信息。。。。会形成循环引用

	@Test
public void testRef(){

       Map role1 = new HashMap();  // 管理员角色
       role1.put("name","管理员");
       Map role2 = new HashMap();  // 员工角色
       role2.put("name","员工");

       List roleList = new ArrayList();
       roleList.add(role1);
       roleList.add(role2);
       Map user = new HashMap();    // 用户对象
       user.put("username","张三");
       user.put("password","1234");
       user.put("roleList",roleList);
       List userList = new ArrayList();
       userList.add(user);
      role1.put("userList",userList);
 
    String s = JSON.toJSONString(user);
    System.out.println(s);


} 

运行结果如下：

解决思路一

fastJson中对象转json字符串是按照对象的属性进行转化的，所以可以在实体类中不想转换的属性上添加注解@JSONField(serialize = false)，在转换时忽略此属性。但此方法弊端较大。

解决思路二：

在上边的代码中添加以下语句：将灵活控制需要显示的属性

 SimplePropertyPreFilter filter = new SimplePropertyPreFilter("username","password","roleList","name");
    String s = JSON.toJSONString(user,filter);
    System.out.println(s);

运行结果如下：

解决了循环引用问题。