【问题】如题所示,在我们使用hibernate框架而又需要将对象转化为json的时候,如果配置了双向的关联关系,就会出现这个死循环问题
异常信息:
【原因】为什么会这样呢?原因在于你要转化的对象里配置了对另外一个对象的关联,而那个对象里又配置了对你这个对象的关联。比如我的两个类叫做Shop(商店)和Staff(员工),一个商店可以有多个员工,所以我给这两个对象配置了双向的一对多和多对一的关联关系。这时候问题就出现了,JSON lib在把shop对象转化为json字符串的时候,发现shop里有个Set<Staff>,它就会去级联的把Set<Staff>转化为json字符串,在它遍历Set的时候,发现Staff里又有一个Shop对象,这时候它又会去尝试把shop转化为json字符串,然后就发现shop里又有Set<Staff>,如此周而复始,就形成了死循环。
1 Method public java.lang.String org.apache.commons.lang.exception.NestableRuntimeException.getMessage(int) threw an exception when invoked on net.sf.json.JSONException: There is a cycle in the hierarchy! 2 The problematic instruction: 3 ---------- 4 ==> ${msgs[0][0]} [on line 76, column 25 in org/apache/struts2/dispatcher/error.ftl] 5 ---------- 6 7 Java backtrace for programmers: 8 ---------- 9 freemarker.template.TemplateModelException: Method public java.lang.String org.apache.commons.lang.exception.NestableRuntimeException.getMessage(int) threw an exception when invoked on net.sf.json.JSONException: There is a cycle in the hierarchy! 10 at freemarker.ext.beans.SimpleMethodModel.exec(SimpleMethodModel.java:130) 11 at freemarker.ext.beans.SimpleMethodModel.get(SimpleMethodModel.java:138) 12 at freemarker.core.DynamicKeyName.dealWithNumericalKey(DynamicKeyName.java:111) 13 at freemarker.core.DynamicKeyName._getAsTemplateModel(DynamicKeyName.java:90) 14 at freemarker.core.Expression.getAsTemplateModel(Expression.java:89) 15 at freemarker.core.Expression.getStringValue(Expression.java:93) 16 at freemarker.core.DollarVariable.accept(DollarVariable.java:76) 17 at freemarker.core.Environment.visit(Environment.java:209) 18 at freemarker.core.MixedContent.accept(MixedContent.java:92) 19 at freemarker.core.Environment.visit(Environment.java:209) 20 at freemarker.core.IfBlock.accept(IfBlock.java:82) 21 at freemarker.core.Environment.visit(Environment.java:209) 22 at freemarker.core.IfBlock.accept(IfBlock.java:82) 23 at freemarker.core.Environment.visit(Environment.java:209) 24 at freemarker.core.MixedContent.accept(MixedContent.java:92) 25 at freemarker.core.Environment.visit(Environment.java:209) 26 at freemarker.core.Environment.process(Environment.java:189) 27 at freemarker.template.Template.process(Template.java:237) 28 at org.apache.struts2.dispatcher.Dispatcher.sendError(Dispatcher.java:748) 29 at org.apache.struts2.dispatcher.Dispatcher.serviceAction(Dispatcher.java:505) 30 at org.apache.struts2.dispatcher.ng.ExecuteOperations.executeAction(ExecuteOperations.java:77) 31 at org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter.doFilter(StrutsPrepareAndExecuteFilter.java:91) 32 at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:235) 33 at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:206) 34 at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:233) 35 at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:191) 36 at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:127) 37 at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:103) 38 at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:109) 39 at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:293) 40 at org.apache.coyote.http11.Http11Processor.process(Http11Processor.java:861) 41 at org.apache.coyote.http11.Http11Protocol$Http11ConnectionHandler.process(Http11Protocol.java:606) 42 at org.apache.tomcat.util.net.JIoEndpoint$Worker.run(JIoEndpoint.java:489) 43 at java.lang.Thread.run(Thread.java:619) 44 Caused by: java.lang.NullPointerException 45 at freemarker.ext.beans.SimpleMemberModel.unwrapArguments(SimpleMemberModel.java:85) 46 at freemarker.ext.beans.SimpleMethodModel.exec(SimpleMethodModel.java:106) 47 ... 33 more
【解决】问题清楚了,如何解决呢?我百度了一下,也找到了数十条的资料,但大都只是都说明了要用jsonConfig.setJsonPropertyFilter(new PropertyFilter(){}),而对于其中的参数和if语句该如何写,并没有一个说的很明白的。为此我查看了json-lib的源码,并进行了尝试,总结如下:
1,思路是在JSONObject把Shop对象转化为json字符串的时候,在中间加一道过滤,如果当前要转化的属性是Set并且属性名是staffs,那么就进行过滤
2,代码如下:
Map<String, Object> map=new HashMap<String, Object>(); map.put("shops", list); map.put("total", total); JsonConfig jsonConfig = new JsonConfig(); jsonConfig.setJsonPropertyFilter(new PropertyFilter() { public boolean apply(Object obj, String name, Object value) { if(value instanceof Set<?>&&name.equals("staffs")){ return true; }else{ return false; } } }); return JSONObject.fromObject(map,jsonConfig);
如上,PropertyFilter是json-lib提供的进行属性过滤的一个接口,具体的实现是由apply方法做的,那么我们就需要重写apply方法。
此方法有三个参数,第一个是Object类型的,是你要转化的对象的类型(Shop);
第二个参数是String类型,是你要过滤的属性的名称;
第三个参数是Object类型的,是你要过滤的属性的值(值可能是String或其它类型的,所以用Object)。
返回值是boolean类型的,返回true,会进行过滤;返回false,不会进行过滤。
if语句的写法就要根据实际的需要了,比如说我这里要解决死循环,就要实现把Shop里的Set<Staff> staffs属性过滤掉,那我的if语句就应该如上面那样写。总而言之就是JSON-lib在转化的时候,会对每个属性都调用这个apply方法,这样我们就要根据实际的业务需要,如果当前属性符合你的if条件,那你就要返回true,进行过滤。是使用||还是&&也要根据实际而定。
这样配置后,再测试,就发现获取Shop的时候死循环问题已经不再出现了。
3,同理,Staff端也应该进行类似的配置
Map<String,Object> map=new HashMap<String, Object>(); map.put("staffs", list); map.put("total", total); JsonConfig jsonConfig = new JsonConfig(); jsonConfig.setExcludes(new String[]{"handler","hibernateLazyInitializer"}); jsonConfig.setJsonPropertyFilter(new PropertyFilter() { public boolean apply(Object obj, String name, Object value) { if(name.equals("shop")){ return true; }else{ return false; } } }); return JSONObject.fromObject(map,jsonConfig);
经过测试,也是没有问题的。
这里大家也可以看见jsonConfig.setExcludes(new String[]{"handler","hibernateLazyInitializer"});,这一行是为了防止hibernate延迟加载造成的异常而设置的。
4,到这里大功告成了吗?不,我在测试的时候发现了一个更严重的问题,如果按照上面做这样配置,那我获取shop的时候,生成的json字符串里staffs的Set不见了;获取Staff的时候,它的属性shop在json字符串里也不见了!稍加分析就可以知道这是上面配置造成的。按上面的配置,Shop里的Set<Staff>被过滤掉了,“过滤掉”的含义不是不级联的转化Staff里的Shop了,而是直接连Set<Staff>都不转化了。这可坏了,我配置双向关联关系就是为了关联显示,你把我的属性过滤掉了,那我还配置双向关联干嘛?我还这么大费周章的来解决死循环干嘛?
那么这个问题该如何解决呢?其实仔细一想,也不难,大家看我把Shop的配置改成下面这样
Map<String, Object> map=new HashMap<String, Object>(); map.put("shops", list); map.put("total", total); JsonConfig jsonConfig = new JsonConfig(); jsonConfig.setJsonPropertyFilter(new PropertyFilter() { public boolean apply(Object obj, String name, Object value) { if(value instanceof Shop&&name.equals("shop")){ return true; }else{ return false; } } }); return JSONObject.fromObject(map,jsonConfig);
这样就可以获取到了,为什么呢?因为这样配置的话,在将Shop里的Set<Staff> staffs转化的时候,我们不过滤;而在将staffs里的每个Staff里的shop转化的时候,我们进行过滤,这样就既解决了死循环问题,又避免了Shop里的staffs被过滤掉的问题。
同理,Staff要这样配置
Map<String,Object> map=new HashMap<String, Object>(); map.put("staffs", list); map.put("total", total); JsonConfig jsonConfig = new JsonConfig(); jsonConfig.setExcludes(new String[]{"handler","hibernateLazyInitializer"}); jsonConfig.setJsonPropertyFilter(new PropertyFilter() { public boolean apply(Object obj, String name, Object value) { if(name.equals("staffs")){ return true; }else{ return false; } } }); return JSONObject.fromObject(map,jsonConfig);
可是我测试的时候却发现得到的字符串里只有total,staffs没有了?大家可能已经明白了,不仅Shop里的staffs被过滤掉了,map里的staffs也被过滤掉了。解决也很简单,把map.put("staffs",list);改成map.put("list",list);就行了,就是换个名字。
【扩展】到这里,应该能解决大家的问题了。另外还有一种方法也要提一下,
1 JsonConfig jsonConfig = new JsonConfig(); 2 jsonConfig.setIgnoreDefaultExcludes(false); //设置默认忽略 3 jsonConfig.setCycleDetectionStrategy(CycleDetectionStrategy.LENIENT);//设置循环策略为忽略 解决json最头疼的问题 死循环 4 jsonConfig.setExcludes(new String[] {"staffs"});//此处是亮点,只要将所需忽略字段加到数组中即可
这种配置也是比较好理解的,但也要注意属性过滤问题,Shop过滤shop,Staff过滤staffs。
本文转载自http://blog.csdn.net/superick/article/details/19421145
原文:http://www.cnblogs.com/clairesing/p/4374501.html