JavaBean与Json、xml互转---JSONObject

时间:2021-07-25 16:07:50

一、需要的包:json-lib-2.1-jdk15.jar和xom-1.2.5.jar

二、将Javabean转换成Json数据格式,然后将Json数据格式再转换成XML字符串。

那么问题来了,为什么不直接把Javabean转换成XML字符串呢?这是因为我之前是使用XStream把JavaBean转换成XML字符串的,XStream有个限制,就是不能把空字段输出到XML字符串中。所以改用这种方式去转换了。

//对Date类型的数据进行格式化处理
JsonConfig config = new JsonConfig();
config.registerJsonValueProcessor(Date.class,new DateJsonValueProcessor("yyyy-MM-dd HH:mm:ss"));

//转vo
TaskBoardSjToQdVo taskBoardSjToQdVo = taskBoardSjToQdService.getTaskBoardSjToQdVoByTaskBoardSjToQd(taskBoardSjToQd);

//将javabean转换为json数据格式
JSONObject json = JSONObject.fromObject(taskBoardSjToQdVo,config);
System.out.println("json----:"+json);

//将json数据格式转换为XML数据格式
XMLSerializer xMLSerializer = new XMLSerializer();
String xml = xMLSerializer.write(json, "GBK");

xml = xml.replace("<o>", "<TaskBoardSjToQd>");
xml = xml.replace("</o>", "</TaskBoardSjToQd>");
System.out.println("xml----:"+xml);
那么问题又来了,JsonConfig是用来干嘛的?请看下面:

前几天做项目的时候遇到一个问题,就是把一个javabean转换成一个JSON的字符串的时候遇到一个问题,因为javabean中含有Date日期的类型,格式化字符串的时候遇到把Date类型也作为一个对象了,而我想要的结果是key=value,取出来则是updatetime={day=24,year=2012...}这样子的,把日期给拆分掉了。

我们可以看出JSONObject net.sf.json.JSONObject.fromObject(Object object, JsonConfig jsonConfig)还接受一个JsonConfig对象,那么我们就应该从这里入手。。

我们可以写一个自己的value处理器:

/**
*
* 类说明
*
* @简述: Timestamp 处理器
* @作者:
* @版本: 1.0
* @邮箱:
* @修改时间:2012-4-27 下午12:16:24
*/
public class DateJsonValueProcessor implements JsonValueProcessor{

/**
* 字母 日期或时间元素 表示 示例 <br>
* G Era 标志符 Text AD <br>
* y 年 Year 1996; 96 <br>
* M 年中的月份 Month July; Jul; 07 <br>
* w 年中的周数 Number 27 <br>
* W 月份中的周数 Number 2 <br>
* D 年中的天数 Number 189 <br>
* d 月份中的天数 Number 10 <br>
* F 月份中的星期 Number 2 <br>
* E 星期中的天数 Text Tuesday; Tue<br>
* a Am/pm 标记 Text PM <br>
* H 一天中的小时数(0-23) Number 0 <br>
* k 一天中的小时数(1-24) Number 24<br>
* K am/pm 中的小时数(0-11) Number 0 <br>
* h am/pm 中的小时数(1-12) Number 12 <br>
* m 小时中的分钟数 Number 30 <br>
* s 分钟中的秒数 Number 55 <br>
* S 毫秒数 Number 978 <br>
* z 时区 General time zone Pacific Standard Time; PST; GMT-08:00 <br>
* Z 时区 RFC 822 time zone -0800 <br>
*/
public static final String Default_DATE_PATTERN = "yyyy-MM-dd";
private DateFormat dateFormat;

/**
*
*/
public DateJsonValueProcessor(String datePattern) {
try {
dateFormat = new SimpleDateFormat(datePattern);
} catch (Exception e) {
dateFormat = new SimpleDateFormat(Default_DATE_PATTERN);
}
}

/*
* (non-Javadoc)
* @see
* net.sf.json.processors.JsonValueProcessor#processArrayValue(java.lang
* .Object, net.sf.json.JsonConfig)
*/
@Override
public Object processArrayValue(Object value, JsonConfig jsonConfig) {
return process(value);
}

/*
* (non-Javadoc)
* @see
* net.sf.json.processors.JsonValueProcessor#processObjectValue(java.lang
* .String, java.lang.Object, net.sf.json.JsonConfig)
*/
@Override
public Object processObjectValue(String key, Object value,JsonConfig jsonConfig) {
return process(value);
}

private Object process(Object value) {
if (value == null) {
return "";
} else {
return dateFormat.format((Timestamp) value);
}
}

}
然后再:

JsonConfig config = new JsonConfig();
config.registerJsonValueProcessor(Date.class,new DateJsonValueProcessor("yyyy-MM-dd HH:mm:ss"));

JSONObject json = JSONObject.fromObject(对应的JavaBean,config);

这样就可以搞定了!


三、JsonConfig的详细使用

1、setCycleDetectionStrategy 防止自包含

/** 
* 这里测试如果含有自包含的时候需要CycleDetectionStrategy
*/
public static void testCycleObject() {
CycleObject object = new CycleObject();
object.setMemberId("yajuntest");
object.setSex("male");
JsonConfig jsonConfig = new JsonConfig();
jsonConfig.setCycleDetectionStrategy(CycleDetectionStrategy.LENIENT);

JSONObject json = JSONObject.fromObject(object, jsonConfig);
System.out.println(json);
}

public static void main(String[] args) {
JsonTest.testCycleObject();
}
其中 CycleObject.java是我自己写的一个类:

public class CycleObject {  

private String memberId;
private String sex;
private CycleObject me = this;
…… // getters && setters
}
 输出 {"sex":"male","memberId":"yajuntest","me":null}

2、setExcludes:排除需要序列化成json的属性

public static void testExcludeProperites() {  
String str = "{'string':'JSON', 'integer': 1, 'double': 2.0, 'boolean': true}";
JsonConfig jsonConfig = new JsonConfig();
jsonConfig.setExcludes(new String[] { "double", "boolean" });
JSONObject jsonObject = (JSONObject) JSONSerializer.toJSON(str, jsonConfig);
System.out.println(jsonObject.getString("string"));
System.out.println(jsonObject.getInt("integer"));
System.out.println(jsonObject.has("double"));
System.out.println(jsonObject.has("boolean"));
}

public static void main(String[] args) {
JsonTest.testExcludeProperites();
}


3、setIgnoreDefaultExcludes

@SuppressWarnings("unchecked")  
public static void testMap() {
Map map = new HashMap();
map.put("name", "json");
map.put("class", "ddd");
JsonConfig config = new JsonConfig();
config.setIgnoreDefaultExcludes(true); //默认为false,即过滤默认的key
JSONObject jsonObject = JSONObject.fromObject(map,config);
System.out.println(jsonObject);

}
上面的代码会把name 和 class都输出。
而去掉setIgnoreDefaultExcludes(true)的话,就只会输出name,不会输出class。

private static final String[] DEFAULT_EXCLUDES = new String[] { "class", "declaringClass",  
"metaClass" }; // 默认会过滤的几个key


4、registerJsonBeanProcessor 当value类型是从java的一个bean转化过来的时候,可以提供自定义处理器

public static void testMap() {  
Map map = new HashMap();
map.put("name", "json");
map.put("class", "ddd");
map.put("date", new Date());
JsonConfig config = new JsonConfig();
config.setIgnoreDefaultExcludes(false);
config.registerJsonBeanProcessor(Date.class,
new JsDateJsonBeanProcessor()); // 当输出时间格式时,采用和JS兼容的格式输出
JSONObject jsonObject = JSONObject.fromObject(map, config);
System.out.println(jsonObject);
}
注:JsDateJsonBeanProcessor 是json-lib已经提供的类,我们也可以实现自己的JsonBeanProcessor。

5、registerJsonValueProcessor
6、registerDefaultValueProcessor
为了演示,首先我自己实现了两个 Processor
一个针对Integer

public class MyDefaultIntegerValueProcessor implements DefaultValueProcessor {  

public Object getDefaultValue(Class type) {
if (type != null && Integer.class.isAssignableFrom(type)) {
return Integer.valueOf(9999);
}
return JSONNull.getInstance();
}

}
一个针对PlainObject(我自定义的类)

public class MyPlainObjectProcessor implements DefaultValueProcessor {  

public Object getDefaultValue(Class type) {
if (type != null && PlainObject.class.isAssignableFrom(type)) {
return "美女" + "瑶瑶";
}
return JSONNull.getInstance();
}
}
以上两个类用于处理当value为null的时候该如何输出。


还准备了两个普通的自定义bean
PlainObjectHolder:

public class PlainObjectHolder {  

private PlainObject object; // 自定义类型
private Integer a; // JDK自带的类型

public PlainObject getObject() {
return object;
}

public void setObject(PlainObject object) {
this.object = object;
}

public Integer getA() {
return a;
}

public void setA(Integer a) {
this.a = a;
}

}
PlainObject 也是我自己定义的类

public class PlainObject {  

private String memberId;
private String sex;

public String getMemberId() {
return memberId;
}

public void setMemberId(String memberId) {
this.memberId = memberId;
}

public String getSex() {
return sex;
}

public void setSex(String sex) {
this.sex = sex;
}

}
A,如果JSONObject.fromObject(null) 这个参数直接传null进去,json-lib会怎么处理:

public static JSONObject fromObject( Object object, JsonConfig jsonConfig ) {  
if( object == null || JSONUtils.isNull( object ) ){
return new JSONObject( true );
看代码是直接返回了一个空的JSONObject,没有用到任何默认值输出。

B,其次,我们看如果java对象直接是一个JDK中已经有的类(什么指 Enum,Annotation,JSONObject,DynaBean,JSONTokener,JSONString,Map,String,Number,Array),但是值为null ,json-lib如何处理
JSONObject.java

}else if( object instanceof Enum ){  
throw new JSONException( "'object' is an Enum. Use JSONArray instead" ); // 不支持枚举
}else if( object instanceof Annotation || (object != null && object.getClass()
.isAnnotation()) ){
throw new JSONException( "'object' is an Annotation." ); // 不支持 注解
}else if( object instanceof JSONObject ){
return _fromJSONObject( (JSONObject) object, jsonConfig );
}else if( object instanceof DynaBean ){
return _fromDynaBean( (DynaBean) object, jsonConfig );
}else if( object instanceof JSONTokener ){
return _fromJSONTokener( (JSONTokener) object, jsonConfig );
}else if( object instanceof JSONString ){
return _fromJSONString( (JSONString) object, jsonConfig );
}else if( object instanceof Map ){
return _fromMap( (Map) object, jsonConfig );
}else if( object instanceof String ){
return _fromString( (String) object, jsonConfig );
}else if( JSONUtils.isNumber( object ) || JSONUtils.isBoolean( object )
|| JSONUtils.isString( object ) ){
return new JSONObject(); // 不支持纯数字
}else if( JSONUtils.isArray( object ) ){
throw new JSONException( "'object' is an array. Use JSONArray instead" ); //不支持数组,需要用JSONArray替代
}else{
根据以上代码,主要发现_fromMap是不支持使用DefaultValueProcessor 的。
原因看代码:
JSONObject.java
if( value != null ){ //大的前提条件,value不为空  
JsonValueProcessor jsonValueProcessor = jsonConfig.findJsonValueProcessor(
value.getClass(), key );
if( jsonValueProcessor != null ){
value = jsonValueProcessor.processObjectValue( key, value, jsonConfig );
if( !JsonVerifier.isValidJsonValue( value ) ){
throw new JSONException( "Value is not a valid JSON value. " + value );
}
}
setValue( jsonObject, key, value, value.getClass(), jsonConfig );
private static void setValue( JSONObject jsonObject, String key, Object value, Class type,           JsonConfig jsonConfig ) {        boolean accumulated = false;        if( value == null ){ // 当 value为空的时候使用DefaultValueProcessor           value = jsonConfig.findDefaultValueProcessor( type )                 .getDefaultValue( type );           if( !JsonVerifier.isValidJsonValue( value ) ){              throw new JSONException( "Value is not a valid JSON value. " + value );           }        }  ……  
根据我的注释, 上面的代码显然是存在矛盾。
_fromDynaBean是支持DefaultValueProcessor的和下面的C是一样的。


C,我们看如果 java 对象是自定义类型的,并且里面的属性包含空值(没赋值,默认是null)也就是上面B还没贴出来的最后一个else

else {return _fromBean( object, jsonConfig );}  
我写了个测试类:

public static void testDefaultValueProcessor() {  
PlainObjectHolder holder = new PlainObjectHolder();
JsonConfig config = new JsonConfig();
config.registerDefaultValueProcessor(PlainObject.class,
new MyPlainObjectProcessor());
config.registerDefaultValueProcessor(Integer.class,
new MyDefaultIntegerValueProcessor());
JSONObject json = JSONObject.fromObject(holder, config);
System.out.println(json);
}
这种情况的输出值是 {"a":9999,"object":"美女瑶瑶"}
即两个Processor都起作用了。

7、Json To Java ,ignoreDefaultExcludes
public static void json2java() {  
String jsonString = "{'name':'hello','class':'ddd'}";
JsonConfig config = new JsonConfig();
config.setIgnoreDefaultExcludes(true); // 与JAVA To Json的时候一样,不设置class属性无法输出
JSONObject json = (JSONObject) JSONSerializer.toJSON(jsonString,config);
System.out.println(json);
}