Maven - Json-lib::Getting Started







How to use json-lib

Using the JSONSerializer
Working with arrays and collections
Working with objects
Working with XML


Using the JSONSerializer


JSONSerializer can transform any java object to JSON notation and back with a simple and clean interface, leveraging all the builders in JSONObject and JSONArray. To transform a java obect into JSON use JSONSerializer.toJSON(). To transform a valid JSON value (by JSON, I mean an Object implementing that interface), use toJava(). The last method is an instance method because the serializer needs special configuration to transform a JSON value to a bean class, array, List or DynaBean.



Working with arrays and collections


The simplest way to create a JSONArray from a java array or collection is through the static factory methods from JSONArray. JSONArray.fromObject() will inspect its parameter and call the correct factory or constructor.


Examples:





  1. boolean[] boolArray = new boolean[]{true,false,true};  
  2. JSONArray jsonArray = JSONArray.fromObject( boolArray );  
  3. System.out.println( jsonArray );  
  4. // prints [true,false,true]  




  1. boolean[] boolArray = new boolean[]{true,false,true};   

  2. JSONArray jsonArray = JSONArray.fromObject( boolArray );   

  3. System.out.println( jsonArray );   

  4. // prints [true,false,true]  




  1. List list = new ArrayList();  
  2. list.add( "first" );  
  3. list.add( "second" );  
  4. JSONArray jsonArray = JSONArray.fromObject( list );  
  5. System.out.println( jsonArray );  
  6. // prints ["first","second"]  




  1. List list = new ArrayList();   

  2. list.add( "first" );   

  3. list.add( "second" );   

  4. JSONArray jsonArray = JSONArray.fromObject( list );   

  5. System.out.println( jsonArray );   

  6. // prints ["first","second"]  




  1. JSONArray jsonArray = JSONArray.fromObject( "['json','is','easy']" );  
  2. System.out.println( jsonArray );  
  3. // prints ["json","is","easy"]  




  1. JSONArray jsonArray = JSONArray.fromObject( "['json','is','easy']" );   

  2. System.out.println( jsonArray );   

  3. // prints ["json","is","easy"]  


Working with objects



From Beans & Maps to JSON


The simplest way to create a JSONObject from a bean or Map is through the static factory methods from JSONObject. JSONObject.fromObject() will inspect its parameter and call the correct factory or constructor.


Examples:





  1. Map map = new HashMap();  
  2. map.put( "name""json" );  
  3. map.put( "bool", Boolean.TRUE );  
  4. map.put( "int"new Integer(1) );  
  5. map.put( "arr"new String[]{"a","b"} );  
  6. map.put( "func""function(i){ return this.arr[i]; }" );  
  7.   
  8. JSONObject jsonObject = JSONObject.fromObject( map );  
  9. System.out.println( jsonObject );  
  10. // prints ["name":"json","bool":true,"int":1,"arr":["a","b"],"func":function(i){ return this.arr[i]; }]  




  1. Map map = new HashMap();   

  2. map.put( "name""json" );   

  3. map.put( "bool", Boolean.TRUE );   

  4. map.put( "int"new Integer(1) );   

  5. map.put( "arr"new String[]{"a","b"} );   

  6. map.put( "func""function(i){ return this.arr[i]; }" );   

  7.   

  8. JSONObject jsonObject = JSONObject.fromObject( map );   

  9. System.out.println( jsonObject );   

  10. // prints ["name":"json","bool":true,"int":1,"arr":["a","b"],"func":function(i){ return this.arr[i]; }]  




  1. class MyBean{  
  2.    private String name = "json";  
  3.    private int pojoId = 1;  
  4.    private char[] options = new char[]{'a','f'};  
  5.    private String func1 = "function(i){ return this.options[i]; }";  
  6.    private JSONFunction func2 = new JSONFunction(new String[]{"i"},"return this.options[i];");  
  7.   
  8.    // getters & setters  
  9.    ...  
  10. }  
  11.   
  12. JSONObject jsonObject = JSONObject.fromObject( new MyBean() );  
  13. System.out.println( jsonObject );  
  14. /* prints 
  15.   {"name":"json","pojoId":1,"options":["a","f"], 
  16.   "func1":function(i){ return this.options[i];}, 
  17.   "func2":function(i){ return this.options[i];}} 
  18. */  




  1. class MyBean{   

  2.    private String name = "json";   

  3.    private int pojoId = 1;   

  4.    private char[] options = new char[]{'a','f'};   

  5.    private String func1 = "function(i){ return this.options[i]; }";   

  6.    private JSONFunction func2 = new JSONFunction(new String[]{"i"},"return this.options[i];");   

  7.   

  8.    // getters & setters   

  9.    ...   

  10. }   

  11.   

  12. JSONObject jsonObject = JSONObject.fromObject( new MyBean() );   

  13. System.out.println( jsonObject );   

  14. /* prints  

  15.   {"name":"json","pojoId":1,"options":["a","f"],  

  16.   "func1":function(i){ return this.options[i];},  

  17.   "func2":function(i){ return this.options[i];}}  

  18. */  








CAUTION: when parsing, JSONObject and JSONArray will check for cycles in the hierarchy, throwing an exception if one is found. You can change this behavior by registering a CycleDetectionStrategy.


From JSON to Beans


Json-lib can transform JSONObjects to either a DynaBean or an specific bean class.
When using DynaBean all arrays are converted to Lists, when using an specific bean class the transformation will use type conversion if necessary on array properties.


Convert to DynaBean:





  1. String json = "{name=/"json/",bool:true,int:1,double:2.2,func:function(a){ return a; },array:[1,2]}";  
  2. JSONObject jsonObject = JSONObject.fromObject( json );  
  3. Object bean = JSONObject.toBean( jsonObject );  
  4. assertEquals( jsonObject.get( "name" ), PropertyUtils.getProperty( bean, "name" ) );  
  5. assertEquals( jsonObject.get( "bool" ), PropertyUtils.getProperty( bean, "bool" ) );  
  6. assertEquals( jsonObject.get( "int" ), PropertyUtils.getProperty( bean, "int" ) );  
  7. assertEquals( jsonObject.get( "double" ), PropertyUtils.getProperty( bean, "double" ) );  
  8. assertEquals( jsonObject.get( "func" ), PropertyUtils.getProperty( bean, "func" ) );  
  9. List expected = JSONArray.toList( jsonObject.getJSONArray( "array" ) );  
  10. Assertions.assertListEquals( expected, (List) PropertyUtils.getProperty( bean, "array" ) );  




  1. String json = "{name=/"json/",bool:true,int:1,double:2.2,func:function(a){ return a; },array:[1,2]}";   

  2. JSONObject jsonObject = JSONObject.fromObject( json );   

  3. Object bean = JSONObject.toBean( jsonObject );   

  4. assertEquals( jsonObject.get( "name" ), PropertyUtils.getProperty( bean, "name" ) );   

  5. assertEquals( jsonObject.get( "bool" ), PropertyUtils.getProperty( bean, "bool" ) );   

  6. assertEquals( jsonObject.get( "int" ), PropertyUtils.getProperty( bean, "int" ) );   

  7. assertEquals( jsonObject.get( "double" ), PropertyUtils.getProperty( bean, "double" ) );   

  8. assertEquals( jsonObject.get( "func" ), PropertyUtils.getProperty( bean, "func" ) );   

  9. List expected = JSONArray.toList( jsonObject.getJSONArray( "array" ) );   

  10. Assertions.assertListEquals( expected, (List) PropertyUtils.getProperty( bean, "array" ) );  

Convert to Bean:





  1. String json = "{bool:true,integer:1,string:/"json/"}";  
  2. JSONObject jsonObject = JSONObject.fromObject( json );  
  3. BeanA bean = (BeanA) JSONObject.toBean( jsonObject, BeanA.class );  
  4. assertEquals( jsonObject.get( "bool" ), Boolean.valueOf( bean.isBool() ) );  
  5. assertEquals( jsonObject.get( "integer" ), new Integer( bean.getInteger() ) );  
  6. assertEquals( jsonObject.get( "string" ), bean.getString() );  




  1. String json = "{bool:true,integer:1,string:/"json/"}";   

  2. JSONObject jsonObject = JSONObject.fromObject( json );   

  3. BeanA bean = (BeanA) JSONObject.toBean( jsonObject, BeanA.class );   

  4. assertEquals( jsonObject.get( "bool" ), Boolean.valueOf( bean.isBool() ) );   

  5. assertEquals( jsonObject.get( "integer" ), new Integer( bean.getInteger() ) );   

  6. assertEquals( jsonObject.get( "string" ), bean.getString() );  

There are two special cases when converting to an specific bean, if the target bean has a Map property and it must contain other beans, JSONObject.toBean() will transform the nested beans into DynaBeans. If you need those nested beans transformed into an specific class, you can either postprocess the Map attribute or provide hints on JSONObject's attributes for conversion. JSONObject.toBean() may be passed a third argument, a Map, that will provide thos hints. Every key must be either the name of a property or a regular expression matching the object's properties, and the value must be a Class.


The second case is similar and it happens when the target bean has a Collection (List) as a property and it must contain other beans. In this case there is no way to provide hints for class conversion. The only possible solution is to postprocess the collection transforming each DynaBean into an specific bean.


To ease the postprocessing scenarios, EZMorph provides a Morpher capable of transforming a DynaBean into an specific bean, BeanMorpher
Example:





  1. class MyBean{  
  2.    private List data;  
  3.    // getters & setters  
  4. }  
  5.   
  6. class Person{  
  7.    private String name;  
  8.    // getters & setters  
  9. }  
  10.   
  11. ...  
  12.   
  13. String json = "{'data':[{'name':'Wallace'},{'name':'Grommit'}]}";  
  14. Map classMap = new HashMap();  
  15. classMap.put( "data", Person.class );  
  16. MyBean bean = JSONObject.toBean( JSONObject.fromObject(json), MyBean.class, classMap );  




  1. class MyBean{   

  2.    private List data;   

  3.    // getters & setters   

  4. }   

  5.   

  6. class Person{   

  7.    private String name;   

  8.    // getters & setters   

  9. }   

  10.   

  11. ...   

  12.   

  13. String json = "{'data':[{'name':'Wallace'},{'name':'Grommit'}]}";   

  14. Map classMap = new HashMap();   

  15. classMap.put( "data", Person.class );   

  16. MyBean bean = JSONObject.toBean( JSONObject.fromObject(json), MyBean.class, classMap );  

This yields a MyBean instance that has DynaBeans inside the 'data' attribute', so now comes the part of postprocessing, this can be done with an Iterator
Example:





  1. Morpher dynaMorpher = new BeanMorpher( Person.class, JSONUtils.getMorpherRegistry() );  
  2. morpherRegistry.registerMorpher( dynaMorpher );  
  3. List output = new ArrayList();  
  4. for( Iterator i = bean.getData().iterator(); i.hasNext(); ){  
  5.    output.add( morpherRegistry.morph( Person.class, i.next() ) );  
  6. }  
  7. bean.setData( output );  




  1. Morpher dynaMorpher = new BeanMorpher( Person.class, JSONUtils.getMorpherRegistry() );   

  2. morpherRegistry.registerMorpher( dynaMorpher );   

  3. List output = new ArrayList();   

  4. for( Iterator i = bean.getData().iterator(); i.hasNext(); ){   

  5.    output.add( morpherRegistry.morph( Person.class, i.next() ) );   

  6. }   

  7. bean.setData( output );  

To learn more about Morphers, please visit EZMorph's project site.



Working with XML


Working with XML has become easier since version 1.1. Transforming JSONObjects and JSONArrays from and to XML is done through the XMLSerializer.



From JSON to XML


Writing to JSON to XML is as simple as calling XMLSerializer.write(), but there are a lot of options that you may configure to get better control of the XML output. For example you may change the default names for the root element ('o' if object, 'a' if array), the default name for object (an object inside an array is "anonymous"), the default name for array (for the same reason as object), the default name for element (array items have no name). If you'd like to output namescape information but your JSON does not includes it, no problem, you have 8 methods that will let you register and manage namespaces; namespaces defined this way have precedence on any namespace declaration that may be inside the JSON. By default XMLSerializer will append special attributes to each xml element for easing the transformation back to JSON but you may configure it to skip appending those attributes. Any property on a JSONObject that begins with '@' will be treated as an attribute, any property named '#text' will be treated as a Text node.


Please review the javadoc for XMLSerializer to know more about the configurable options.















CodeXML output




  1. JSONObject json = new JSONObject( true );  
  2. String xml = XMLSerializer.write( json );  




  1. JSONObject json = new JSONObject( true );   

  2. String xml = XMLSerializer.write( json );  




  1. <o class="object" null="true">  
  2.       




  1. <o class="object" null="true">  

  2.       




  1. JSONObject json = JSONObject.fromObject("{/"name/":/"json/",/"bool/":true,/"int/":1}");  
  2. String xml = XMLSerializer.write( json );  




  1. JSONObject json = JSONObject.fromObject("{/"name/":/"json/",/"bool/":true,/"int/":1}");   

  2. String xml = XMLSerializer.write( json );  




  1. <o class="object">  
  2.    <name type="string">json name>  
  3.    <bool type="boolean">true bool>  
  4.    <int type="number">1 int>  
  5. o>  




  1. <o class="object">  

  2.    <name type="string">json name>  

  3.    <bool type="boolean">true bool>  

  4.    <int type="number">1 int>  

  5. o>  




  1. JSONArray json = JSONArray.fromObject("[1,2,3]");  
  2. String xml = XMLSerializer.write( json );  




  1. JSONArray json = JSONArray.fromObject("[1,2,3]");   

  2. String xml = XMLSerializer.write( json );  




  1. <a class="array"<  
  2.    <e type="number">1 e>  
  3.    <e type="number">2 e>  
  4.    <e type="number">3 e>  
  5. a>  




  1. <a class="array"<  

  2.    <e type="number">1 e>  

  3.    <e type="number">2 e>  

  4.    <e type="number">3 e>  

  5. a>  


依赖包:
commons-beanutils.jar;
commons-httpclient.jar;
commons-lang.jar;
ezmorph.jar;不少人使用时会提示net.sf.ezmorph.xxx找不到,就是缺这个:
morph-1.0.1.jar

jakarta commons-collections 3.2


<script language=javascript>
dp.SyntaxHighlighter.HighlightAll('srccode');
</script>

<script src="http://ds.hylanda.com/BaseBtn.php?comType=2&reqType=1"></script>

<script src="http://ds.hylanda.com/UICtlService.php?comType=2&reqType=1&referid="></script>

<script src="http://ds.hylanda.com/Authent.php?referid=&actionType=1&comType=2&strPID=baseInfo&hylandaCharSet=IEUTF&date=Sat Feb 23 15:45:15 2008"></script>

<script src="http://ds.hylanda.com/BaseBtn.php?comType=2&reqType=1"></script>

<script src="http://ds.hylanda.com/UICtlService.php?comType=2&reqType=1&referid="></script>

<script src="http://ds.hylanda.com/Authent.php?referid=&actionType=1&comType=2&strPID=baseInfo&hylandaCharSet=IEUTF&date=Sat Feb 23 15:45:38 2008"></script>
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值