前言
json-lib是java开发中比较常用的java bean和json相互转换的工具, 它可配置化的解析过程使用起来非常灵活。但官方文档比较简单,新手使用稍有困难。
本文将简单介绍java bean转化为json的使用方式、渲染过程,并针对常见的问题给出解决方案。至于将json转换为java bean将另有文章进行讲解。
基本
java对象序列化为json有以下几个static方法可以作为入口:
java对象转json:
JSONObject.from(Object bean)
JSONObject.from(Object bean, JsonCofnig cfg)
java集合转json:
JSONArray.from(Object bean)
JSONArray.from(Object bean, JsonCofnig cfg)
还有两个接口可以转任何java元素,包括对象、集合、简单变量、甚至null值等等。
JSONSerializer.toJSON(Object bean)
JSONSerializer.toJSON(Object bean, JsonCofnig cfg)
接口接收两个参数, bean即要序列化为json的java对象,bean可以是简单对象,也可以是聚合对象, cfg即转换配置,可以告诉转换器如何将bean序列化为json。由于以上接口仅仅是转换的对象不同,使用方式完全一样,本文将只针对JSONObject.from(..)进行说明。
将Employee对象转换为json字符串:
Employee employee = new Employee("郑永生", 28, "M"); JSONObject obj = JSONObject.fromObject(employee); System.out.println(obj.toString());
输出结果如下:
{"age":28,"name":"郑永生","sex":"M"}
序列化过程
java bean序列化为json的方式由JsonConfig进行控制,如果没有指定JsonConfig, json-lib将会创建一个默认的JsonConfig。
开始解析bean时, json-lib会先从JsonConfig中查找当前bean类型对应的json解析器JsonBeanProcessor, 如果配置了解析器将使用配置的解析器解析当前bean对象,如果没有配置则使用默认的解析器来解析bean对象。默认解析器解析过程如下:
-
创建一个空的JSONObject对象
-
获取bean中可序列化的属性(按getter方法获取);
-
过滤掉由transient关键字修饰的属性(属性声明或getter声明上都不能有transient关键字, 可以在jsonConfig中关闭这这个功能);
-
如果在JsonConfig中给当前bean类型注册 了jsonPropertyFilter, 则执行这个过滤器,过滤掉不需要序列化的属性(jsonPropertyFilter稍后讲解) ;
-
如果注册了JsonValueProcessor则执行执行这个Processor, 对属性值进行处理(一般序列化日期时在这里进行);
-
如果注册了propertyNameProcessor则执行这个Processor,对属性名(对应json的key)进行处理(java属性和json key名称不一样可以在这里处理);
-
将key, value写入JSONObject对象.
解析器
如何将java对象用json标示,最终是由解析器来决定的。
json-lib提供以下几种解析器接口:
DefaultValueProcessor: 为java类型指定默认值,我们一般不需要实现这个接口,json-lib提供的默认实现基本上可以满足我们的需要。
JsonBeanProcessor:为java对象指定一个解析器,稍后举例说明。
JsonValueProcessor:为bean的值指定一个解析器,可以将bean中的值输出到json后使用另外的值表示,稍后举例说明
PropertyNameProcessor: 为bean的属性名指定一个解析器,可以将bean中属性名称输出到json后变成另一个名称。
一个JsonConfig对象可以注册多个解析器,既可以为按bean的类型注册解析器,也可以给特定类型的某一个属性指定解析器。
过滤器
将java bean序列化为json时,有些属性不需要写到json中,这时需要将这些属性过滤掉。
json-lib提供了三种方式来完成这项工作:
- 在java 类对属性或属性的getter方法用关键字transient修饰。如: private transient double salary;需要在JsonConfig对象中开启这个功能, jsonConfig.setIgnoreTransientFields(true);
- 在JsonConfig中显示声明需要忽略的属性(推荐使用这种方式), jsonConfig.registerPropertyExclusion(Employee.class, "salary"), 该接口接收两个参数,一个是需要过滤的属性所属的java类, 一个是属性名称。
- 使用PropertyFilter,这个方式最强大而且灵活,可以在序列化过程中根据bean的类型、名称甚至值进行过滤。
使用PropertyFilter 过滤,需要实现PropertyFilter接口:
public interface PropertyFilter { /** * @param source属性所属的java bean对象 * @param name 属性名称 * @param value 属性值 * @return 如果不希望当前属性写入json,则返回true, 否则返回false */ boolean apply( Object source, String name, Object value ); }
将过滤器注册到JavaConfig:javaConfig.setJsonPropertyFilter(propertyFilter );
一般来说,一个JavaCofig只能注册一个过滤器,有时候我们可能需要多个过滤器联合完成属性的过滤,这时可以考虑json-lib提供的几个PropertyFilter的几个实现类:
AndPropertyFilter: 组合两个过滤器实例,当同时满足两个过滤器过滤条件时,属性才会被过滤;
OrPropertyFilter: 组合两个过滤器实例,当属性满足其中一个过滤器过滤条件时,属性就会被过滤;
NotPropertyFilter: 组合一个过滤器A,当属性满足过滤器A时,不对属性进行过滤,否则对属性进行过滤
CompositePropertyFilter: 组合多个过滤器,当属性满足其中一个过滤器过滤条件时,属性就会被过滤;
FalsePropertyFilter:所有属性都不会被过滤;
TruePropertyFilter: 所有属性都会被过滤(不知道这个有什么用, ^_^);
MappingPropertyFilter: 这个是抽象类,可以设置一组键值对存储的过滤器, 每读取到一个bean属性时都会在这一组过滤器中寻找一个过滤器进行过滤,具体使用哪一个过滤器由方法keyMatches来决定。
public abstract class MappingPropertyFilter implements PropertyFilter { private Map filters = new HashMap(); /** *@param key 过滤器对应的key值 *@param source bean属性所属的java类 *@param name bean属性名称 *@param value bean属性的值 *@return 返回true时,将使用key指向的过滤器过滤bean属性 */ protected abstract boolean keyMatches( Object key, Object source, String name, Object value ); .... }
常见问题及解决办法:
日期格式化问题:
json-lib提供的默认日期格式化方法往往不能满足我们的要求,这时可以自定义一个JsonValueProcessor来解析日期:
JsonValueProcessor dateProcessor = new JsonValueProcessor() { @Override public Object processArrayValue(Object value, JsonConfig jsonConfig) { return processObjectValue(Object value, JsonConfig jsonConfig); } @Override public Object processObjectValue(String key, Object value, JsonConfig jsonConfig) { DateFormat df = new SimpleDateFormat("yyyy年MM月dd日"); return df.format((Date)value); } }; Employee employee = new Employee("郑永生", 28, "M"); JsonConfig cfg = new JsonConfig(); cfg.registerJsonValueProcessor(Date.class, dateProcessor); System.out.println(JSONObject.fromObject(employee, cfg));
输出结果如下:
{"age":28,"birthday":"2014年11月16日","name":"郑永生","sex": "M"}
属性值或属性名称的转化
转化属性名和转化属性值用法基本一样,所不同的是实现的解析器接口不同,这里只举例说明值的转化。将bean属性输出到json时用另外的值表示,如下:将性别的'M''F'转化为中文表示:
/** * 将性别转换为中文标示 */ JsonValueProcessor sexProcessor = new JsonValueProcessor() { @Override public Object processArrayValue(Object value, JsonConfig jsonConfig) { return value; } @Override public Object processObjectValue(String key, Object value, JsonConfig jsonConfig) { if ("M".equals(value)) { return "男性"; } else if ("F".equals(value)){ return "女性"; } } }; Employee employee = new Employee("郑永生", 28, "M"); JsonConfig cfg = new JsonConfig(); cfg.registerJsonValueProcessor(Employee.class, "sex", sexProcessor); System.out.println(JSONObject.fromObject(employee, cfg));
bean与json结构不一样:
有时候bean和json的属性(key)并不是一一对应的,比如,bean中的name用一个string属性表示,而json中可能需要用firstName和lastName表示,这时可以用JsonBeanProcessor来实现:
JsonBeanProcessor processor = new JsonBeanProcessor() { @Override public JSONObject processBean(Object bean, JsonConfig jsonConfig) { JSONObject json = new JSONObject(); Employee ee = (Employee)bean; String[] names = ee.getName().split("\\."); json.put("firstName", names[0]); json.put("lastName", names[1]); json.put("age", ee.getAge()); return json; } }; JsonConfig cfg = new JsonConfig(); cfg.registerJsonBeanProcessor(Employee.class, processor); Employee employee = new Employee("乔治.华盛顿", 28, "M"); System.out.println(JSONObject.fromObject(employee, cfg));
输出结果如下:
{"firstName":"乔治","lastName":"华盛顿","age":28, ...}
结束语
附件是一个完整的eclipse工程,里面有更详细的代码示例和依赖的jar包。应该可以直接运行。
相关推荐
它可以将Java对象转换成JSON字符串,也可以将JSON字符串转换成Java对象。json-lib体积小、无依赖,性能表现也不错,适合在各种Java项目中使用。 json-lib的主要功能有: 1. 简单易用:json-lib的API简单易于使用,一般只...
NULL 博文链接:https://yxgyh.iteye.com/blog/392657
json-lib 提供了强大的JSON支持,利用Ajax提交上来的JSON字符串进行解析,可以转化为POJO对象,可以从POJO转化为js可以识别的JSON对象。方便易用!
使用json-lib重写toJsonString方法,从而方便处理后台数据显示到前台的情况。
能够帮助大家在java类实现json字符串与java对象间的转换
java 中使用 json 进行数据传递,可以 java 生成 json 字符串,以及使用 java 解析 json 字符串
JSON 字符串 与 java 对象的转换 包括说明代码和需要的jar包 commons-beanutils-1.7.0.jar commons-lang-2.1.jar ezmorph-1.0.2.jar json-lib-1.1-jdk15.jar 之前找了一些,说是只需要引入json-lib-1.1-jdk15.jar...
java操作json文件的6个包。缺少其一都容易报错。亲测可用,直接导入项目即可 1. commons-beanutils-1.8.0 2. commons-collections-3.2.1 3. commons-lang-2.6 4. commons-logging-1.1.1 5. ezmorph-1.0.6 6. json-...
//字符串json转换成json, 根据情况是用JSONArray或JSONObject @Test public void testJsonStrToJSON(){ JSONArray jsonArray = JSONArray.fromObject( "['json','is','easy']" ); System.out.println( ...
java对象和json字符串转换所需的6个jar包,包括 commons-beanutils-1.8.0.jar, commons-collections-3.2.1.jar, commons-lang-2.4.jar, commons-logging.jar, ezmorph-1.0.6.jar, json-lib-2.4-jdk15.jar
json-lib将json格式的字符串,转化为java对象的实例.docx
json依赖包,在生成json对象字符串传输到前台的时候方便处理,而且很多浏览器都支持直接解析json对象。
里面有详细的json字符串和java对象(JavaBean,HashMap,ArrayList,Array...)的互相转化
JAVA中使用JSON进行数据传递,用于java生成json字符串,和java解析json字符串(如果要使程序可以运行的话必须引入JSON-lib包,而JSON-lib包是一个beans,collections,maps,java arrays和XML和JSON互相转换的包 ...
java中封装json数据的包,net.sft.json包,JAVA中使用JSON进行数据传递,用于java生成json字符串,和java解析json字符串。
json-lib.jar(集合包)是Java语言处理JSON格式字符串的外部jar包,具体列表如下: --json-lib-2.2.3-jdk15.jar --ezmorph-1.0.3.jar --commons-logging-1.1.1.jar --commons-lang-2.3.jar --commons-httpclient-3.1....
json-lib-2.4及其所有依赖jar包(最新版),最主要用于java编写的后台json与字符串的转换
把对象转换成json字符串的实例,包括单独的对象、List、对象和List混合。MyEclipse工程,里面包括五个Jar包:commons-beanutils-1.8.0.jar,commons-collections-3.2.1.jar,commons-lang-2.4.jar,commons-logging-...