4.Json序列化和反序列化

一.序列化的必要性

在项目当中用到的Json序列化是采用的jackson。
本项目当中JSON序列化反序列化的意义:在用户登陆模块当中,用户的登陆信息是存储在session当中的,即session当中存储user对象。
在项目演进的过程当中,需要使用redis做用户登陆的分布式缓存,所以用户的登陆信息是存储在redis当中的,在redis当中设置的通用方法如下:

在登陆时放到session当中的是一个user对象,但是在设计redis的时候设计的redis的key、value都是String类型,所以需要先将用户对象序列化为JSON,在获取的时候在反序列化为对象,所以需要做一个序列户对象的工具
public static String set(String key,String value)
public static String get(String key)

即value设置的是string类型,所以要将user对象Json为String字符串,然后调用set方法存储在redis当中。在使用的时候在使用反序列化为User对象。

二.重要设置

Json的序列化主要是通过ObjectMapper对象去实现的,以下五个要在Json项目初始化的时候进行加载,下载静态代码块当中即可。以下设置默认都是true。

        /**
         * ALWAYS:设置对象的所有字段全部列入:所有的字段都进行序列化
         * NON_NULL:非null的才会序列化
         * NON_DEFAULT:字段没有默认值(设置默认值或者设置的值和默认值相同)的时候不会序列化,若设置的值和默认值不同,会参与序列化
         * NON_EMPTY:""和空数组不会出现在序列户当中
         */

        objectMapper.setSerializationInclusion(JsonSerialize.Inclusion.ALWAYS);

        //取消默认转换timestamps的格式,若为true,则Json格式化后,设置的时间字段包含timestamps
        objectMapper.configure(SerializationConfig.Feature.WRITE_DATES_AS_TIMESTAMPS, false);

        //自定义日期格式,此处使用的是自己设置所有的日期格式皆为以下的格式:yyyy-MM-dd HH:mm:ss
        objectMapper.setDateFormat(new SimpleDateFormat(DateTimeUtils.STANDARD_FORMAT));

        /**
         * 忽略空bean转json的错喔
         * false:当要json序列化的对象为赋值是空的时候,不要报错
         * true:当要json序列化的对象为赋值是空的时候,会报运行时异常
         */
        objectMapper.configure(SerializationConfig.Feature.FAIL_ON_EMPTY_BEANS, false);


        //反序列化字段
        /**
         * 忽略在Json对象当中存在,但是在java对象当中不存在对应属性的问题,防止错喔
         * 在进行JSon反序列化时,Json字段当中有一个字段,java实体类当中没有,设置为false不报错
         */
        objectMapper.configure(DeserializationConfig.Feature.FAIL_ON_UNKNOWN_PROPERTIES, false);

三.代码

在进行反序列化的过程当中,如果要反序列化为List,或者Map<,>,则反序列化的第二个参数不能简单的为Class clazz,因为如果要反序列化为List,则JackSon或在反序列化时,将user转为LinkedHashMap,这是不合适的,List.class当然也是错的。
所以可以使用JackSon提供的TypeReference, 在调用的时候只需要将返回值的类型写上即可,如返回值是List,则第二个参数那写为new TypeReference>() {}即可
或者也可以重载该方法为:public static T string2Obj(String str, Class collectionClass,Class... elements)
collectionClass返回集合,此处是List.class,elements返回集合参数,可以是多个(多个使用数组),此处是User.class.

package com.mall.util;

import com.mall.pojo.User;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.codehaus.jackson.map.DeserializationConfig;
import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.map.SerializationConfig;
import org.codehaus.jackson.map.annotate.JsonSerialize;
import org.codehaus.jackson.type.JavaType;
import org.codehaus.jackson.type.TypeReference;
import java.util.Date;


import java.text.SimpleDateFormat;

@Slf4j
public class JSONUtil {

    private static ObjectMapper objectMapper=new ObjectMapper();
    static {
        /**
         * ALWAYS:设置对象的所有字段全部列入:所有的字段都进行序列化
         * NON_NULL:非null的才会序列化
         * NON_DEFAULT:字段没有默认值(设置默认值或者设置的值和默认值相同)的时候不会序列化,若设置的值和默认值不同,会参与序列化
         * NON_EMPTY:""和空数组不会出现在序列户当中
         */

        objectMapper.setSerializationInclusion(JsonSerialize.Inclusion.ALWAYS);

        //取消默认转换timestamps的格式
        objectMapper.configure(SerializationConfig.Feature.WRITE_DATES_AS_TIMESTAMPS, false);

        //设置所有的日期格式皆为以下的格式:yyyy-MM-dd HH:mm:ss
        objectMapper.setDateFormat(new SimpleDateFormat(DateTimeUtils.STANDARD_FORMAT));

        /**
         * 忽略空bean转json的错喔
         * false:当要json序列化的对象为赋值是空的时候,不要报错
         * true:当要json序列化的对象为赋值是空的时候,会报运行时异常
         */
        objectMapper.configure(SerializationConfig.Feature.FAIL_ON_EMPTY_BEANS, false);


        //反序列化字段
        /**
         * 忽略在Json对象当中存在,但是在java对象当中不存在对应属性的问题,防止错喔
         */
        objectMapper.configure(DeserializationConfig.Feature.FAIL_ON_UNKNOWN_PROPERTIES, false);
    }

    /**
     * 将对象转换为string
     * @param obj,首先判断对象是否为null,然后判断obj是否为String或子类,,是则直接返回,因为是T类型,所以要强转以下,不是则序列户为String
     * @param :表示将此方法申明为泛型方法,或申明方法只有一个类型T
     * @return
     */
    public static  String obj2String(T obj){
        if(obj==null){
            return null;
        }
        try {
            return obj instanceof String ? (String)obj:objectMapper.writeValueAsString(obj);
        } catch (Exception e) {
            log.warn("parse object to string error",e);
            return null;
        }
    }
    //将对象转换为string,可以返回格式化好的JSON对象
    public static  String obj2StringPretty(T obj){
        if(obj==null){
            return null;
        }
        try {
            return obj instanceof String ? (String)obj:objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(obj);
        } catch (Exception e) {
            log.warn("parse object to string error",e);
            return null;
        }
    }

    //反序列化:将一个字符串转换为对象
    public static  T string2Obj(String str,Class clazz){

        if(StringUtils.isEmpty(str) || clazz==null){
            return null;
        }
        try {
            return clazz.equals(String.class) ? (T)str : objectMapper.readValue(str,clazz);
        } catch (Exception e) {
            log.warn("parse object to string error",e);
            return null;
        }
    }


    /**
     * 对于复杂对象都可以使用后面两个方法
     * 第一个方法:在调用的时候只需要将返回值的类型写上即可,如返回值是List,则第二个刹那火速写为new TypeReference>() {}
     * 第二个方法:collectionClass返回集合,elements返回集合参数,可以是多个(多个使用数组)
     */




    /**
     * 反序列化为集合List,但是传参数的时候不能是List.class,所以只能传User.class或者List.class,但是如果传入的List.class,
     * 那么就会转为LinkedHashMap,最后决定使用jackSon的TypeReference是一个接口,可以转换为User
     */
    public static  T string2Obj(String str, TypeReference typeReference){
        if(StringUtils.isEmpty(str) || typeReference == null){
            return null;
        }
        try {
            return (T)(typeReference.getType().equals(String.class) ? str : objectMapper.readValue(str,typeReference));
        } catch (Exception e) {
            log.warn("parse object to string error",e);
            return null;
        }
    }

    /**
     * @param str
     * @param collectionClass  ?表示是collectionClass,集合的类型
     * @param elements         ?表示是         ...表示可以传递多个参数,多个参数的时候传递数组即可,集合当中参数的类型
     * @param 
     * @return
     */
    public static  T string2Obj(String str, Class collectionClass,Class... elements){

        JavaType javaType=objectMapper.getTypeFactory().constructParametricType(collectionClass,elements);

        try {
            return objectMapper.readValue(str,javaType);
        } catch (Exception e) {
            log.warn("parse object to string error",e);
            return null;
        }
    }







    public static void main(String[] args) {
        User u1=new User();
        u1.setId(1);
        u1.setEmail("[email protected]");
        u1.setCreateTime(new Date());
        String user1Json=JSONUtil.obj2StringPretty(u1);
        log.info("user1Json:{}",user1Json);
        /*User u2=new User();
        u2.setId(2);
        u2.setEmail("[email protected]");*/

       /* List userList= Lists.newArrayList();
        userList.add(u1);
        userList.add(u2);
        */
        /*String user1Json=JSONUtil.obj2String(userList);
        String user1JsonPretty=JSONUtil.obj2StringPretty(userList);
        log.info("user1Json:{}",user1Json);
        log.info("user1JsonPretty:{}",user1JsonPretty);*/

        //List userList11=JSONUtil.string2Obj(user1Json,List.class);
        //jackson在反序列化的时候,如果传入的List.class,那么就会转为LikedHashMap
        //TypeReference是一个接口,
       /*List userList1=JSONUtil.string2Obj(user1Json, new TypeReference>() {
       });

        List userList2=JSONUtil.string2Obj(user1Json,List.class,User.class);
        */
        System.out.println("end");
    }



}

你可能感兴趣的:(4.Json序列化和反序列化)