关于json序列化

关于json序列化(javaBean转Json的细节处理)

json序列化(javaBean转Json的细节)

Java对象在转json的时候，如果对象里面有属性值为null的话，那么在json序列化的时候要不要序列出来呢？对比以下json转换方式

三种常见的json jar序列化

fastjson

阿里巴巴提供的fastjson，当用json转换实体类时

• --无get开头的方法，将找不到序列器。
• --如果有get开头的方法，但是无此get方法后面的字段，也找不到序列器[元数据一体化的项目落到此坑]。
• --证明它与get开头的方法有关。
• --fastJson在转换java对象为json的时候，fastjson默认转换是不序列化null值对应的key的。

//当字段为基本数据类型时，例如当字段类型为int类型时：
private int start;
private int limit;
// 我如果不set值的时候，会序列化为下面这样
"limit":0,"start":0

默认为都是0了，而我的目标是如果不设置值的时候，它们不会出现。

我是简单地通过把他们的类型改为Integer了。应该有其它通过自定义序列化行为的方式来解决，暂不研究。

但是如果想把null对应的key序列化出来呢？

那就要仔细看看fastjson转换java对象为json的时候的入参了：也就是这个方法：

JSONObject.toJSONString(Object object, SerializerFeature... features)

Fastjson的SerializerFeature序列化属性：

• QuoteFieldNames：输出key时是否使用双引号,默认为true
• WriteMapNullValue：是否输出值为null的字段,默认为false
• WriteNullNumberAsZero：数值字段如果为null,输出为0,而非null
• WriteNullListAsEmpty：List字段如果为null,输出为[],而非null
• WriteNullStringAsEmpty：字符类型字段如果为null,输出为”“,而非null
• WriteNullBooleanAsFalse：Boolean字段如果为null,输出为false,而非null

结合上面，SerializerFeature... features是个数组，那么我们可以传入我们想要的参数，比如想序列化null，案例如下：

public static void main(String[] args) {
AutoPartsSearchRequest request = new AutoPartsSearchRequest();
request.setKeywords("123");
request.setSortingField("234242");
String str = JSONObject.toJSONString(request, SerializerFeature.WriteMapNullValue);
System.out.println(str);
}

Jackson

java开源的Jackson类，也与get开头的方法有关【同上】。

jackson默认是序列化null对应的key的，也就是说不管你对象属性有没有值，在转换json的时候都会被序列化出来
public static void main(String[] args) throws JsonGenerationException, JsonMappingException, IOException {
AutoPartsSearchRequest request = new AutoPartsSearchRequest();
request.setKeywords("123");
request.setSortingField("234242");
ObjectMapper mapper = new ObjectMapper();
String str = mapper.writeValueAsString(request);
System.out.println(str);
//输出结果(此处就不格式化了)：{"sortingField":"234242","partsClassifyId":null,"partsSubClassifyId":null,"sortingDirection":null:......
}

同理，想要不序列化null也是可以的，具体如下：

实体上

@JsonInclude(Include.NON_NULL)

//将该标记放在属性上，如果该属性为NULL则不参与序列化
//如果放在类上边,那对这个类的全部属性起作用
//Include.Include.ALWAYS 默认
//Include.NON_DEFAULT 属性为默认值不序列化
//Include.NON_EMPTY 属性为 空（“”） 或者为 NULL 都不序列化
//Include.NON_NULL 属性为NULL 不序列化

代码上

ObjectMapper mapper = new ObjectMapper(); 
mapper.setSerializationInclusion(Include.NON_NULL);

//通过该方法对mapper对象进行设置，所有序列化的对象都将按改规则进行系列化
//Include.Include.ALWAYS 默认
//Include.NON_DEFAULT 属性为默认值不序列化
//Include.NON_EMPTY 属性为 空（“”） 或者为 NULL 都不序列化
//Include.NON_NULL 属性为NULL 不序列化

注意：只对VO起作用，Map List不起作用，另外jackson还能过滤掉你设置的属性，具体的就各位自己去研究源码了

Gson

Google提供的Gson，该gson序列化只与属性(字段)有关，与get开头的方法无关。

gson和fastjson一样，默认是不序列化null值对应的key的，具体案例如下：

public static void main(String[] args) throws JsonGenerationException, JsonMappingException, IOException {
AutoPartsSearchRequest request = new AutoPartsSearchRequest();
request.setKeywords("123");
request.setSortingField("234242");
Gson g = new GsonBuilder().create();
String str = g.toJson(request);
System.out.println(str);
//输出结果：{"sortingField":"234242","keywords":"123"}
}

若是想序列化null值对应的key，只需要将以上创建代码改成以下代码就行：

Gson g = new GsonBuilder().serializeNulls().create();

json序列化的处理

在json的数据处理过程中，最让人无奈的就是json serializable的问题，遇到的多了，慢慢就总结了一点经验。

还是要从最基础的说起

正如上面所说的

• 在将dict, list等python对象编码成json字符串的时候就要用到json.dumps()而将json字符串解码为python 对象时用的是json.loads()
• 至于其他的基础知识查文档都可以看到，我主要说一下遇到问题怎么解决。

class JSONEncoder(json.JSONEncoder):
    """ solve the problem that ObjectId and datetime can't serializable"""
    def default(self, o):
        if isinstance(o, ObjectId):
            return str(o)
        if isinstance(o, datetime):
            return o.isoformat()
        if isinstance(o, UUID):
            return o.hex
        return json.JSONEncoder.default(self, o)

直接将遇到的不能转换的类型分装成一个类，尤其是在mongodb的数据处理中，经常能碰到objectid ,datetime,uuid的转换错误，以后要是遇到别的继续添加就是。

其中ObjectId要从bson引入。

from bson import ObjectId

datetime也要引入也有可能遇到NoneType的情况

NoneType要从types引入

from types import NoneType

UUID要从uuid引入

from uuid import UUID

接下来就是在处理的函数中调用这个类即可。

比如说我们有一个python_dict，想要将其转化为json_str

json_str= json.dumps(python_dict,cls=JSONEncoder,indent=4)

其中参数cls 是我们自己封装的类，indent参数一个数字，也可以不加，在这加的原因后面会提到。

如果我们想要让打印出来的json_str具有醒目的格式，indent则会很有用，至于具体的数字是多少，随你设定，设置为4是因为和python的缩进是一致的，看起来舒服而已。

如果想要在前端页面中显示出来json的样式。

有两种方式：

• 在前端使用js实现在将数据存入数据库之前我们就将数据转换为标准的 json 字符串，直接在页面调用即可。

• 比如在flask中，直接使用

  <pre>标签即可。</pre>

<pre>{{json_str}}</pre>

这样显示出来的就是标准的json样式了，对于内容一目了然。

补充：

其中有一个比较坑的地方。其实到这一步的时候我们该做的都已经做了，讲道理来说应该没什么问题了。但是在实践的过程中我发现页面展示出来的结果中文格式还是不正确。是'\u*\u'这样的unicode编码。回到数据库查看发现数据在存的时候就存的是unciode的编码。

最后查看json_str的格式，发现确实是unicode的编码，这样当然不会显示正确了。

所以最后一步再加上

json_str = json_str.encode('utf-8')

将json字符串以'utf-8'进行编码。

这样问题就完美的得到了解