「Java 随笔系列」Jackson 常见用法

废话不多说系列，直接开整 ~

一、本文总体介绍

由于 Spring Boot 内置默认了 Jackson 序列化工具包，所以无需引入第三方 Jar 包；（例如使用 阿里巴巴的 Fastjson 需要独自引入 fastjson.jar 包） 核心功能：

• 对象 转 Json 字符串；
• JSON 字符串 转 实体对象；
• Map 转 Json 字符串；
• 对象集合 转 JSON 字符串；
• JSON 字符串 转 对象集合；

二、使用

（1）源码

import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParser.Feature;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.util.JSONPObject;
// import com.fasterxml.jackson.module.jaxb.JaxbAnnotationModule; // 需要引入其他的jackson依赖包
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.util.TimeZone;

/**
  * json工具类封装
  *
  */
public class JacksonMapper extends ObjectMapper {

    private static final long serialVersionUID = 1L;

    private static Logger logger = LoggerFactory.getLogger(JacksonMapper.class);

    private static JacksonMapper mapper;

    private JacksonMapper() {
        this(Include.NON_EMPTY);
    }

    private JacksonMapper(Include include) {
        // 设置输出时包含属性的风格  
        if (include != null) {
            this.setSerializationInclusion(include);
        }
        // 允许单引号、允许不带引号的字段名称  
        this.enableSimple();
        // 设置输入时忽略在JSON字符串中存在但Java对象实际没有的属性  
        this.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
        // 运行empty的属性
        this.disable(SerializationFeature.FAIL_ON_EMPTY_BEANS);
        // 空值处理为空串
        this.getSerializerProvider().setNullValueSerializer(new JsonSerializer<Object>() {
            @Override
            public void serialize(Object value,
                                  JsonGenerator jgen,
                                  SerializerProvider provider) throws IOException, JsonProcessingException {
                jgen.writeString("");
            }
        });

        //this.registerModule(new SimpleModule().addSerializer(new MyBigDecimalDesirializer()));

        // 进行HTML解码。  
        /*this.registerModule(new SimpleModule().addSerializer(String.class, new JsonSerializer<String>(){  
             @Override  
             public void serialize(String value, JsonGenerator jgen,  
                     SerializerProvider provider) throws IOException,  
                     JsonProcessingException {  
                 jgen.writeString(StringEscapeUtils.unescapeHtml4(value));  
             }  
         }));  */
        // 设置时区  
        this.setTimeZone(TimeZone.getDefault());//getTimeZone("GMT+8:00")  
    }

    /**
      * 使用枚举的toString函数来读写Enum,
      * 为False时使用Enum的name()函数来 读写Enum, 默认为False.
      * 注意本函数一定要在Mapper创建后, 所有的读写动作之前调用.
      */
    public JacksonMapper enableEnumUseToString() {
        this.enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING);
        this.enable(DeserializationFeature.READ_ENUMS_USING_TO_STRING);
        return this;
    }

    /**
      * 支持使用Jaxb的Annotation，使得POJO上的annotation不用与Jackson耦合。
      * 默认会先查找jaxb的annotation，如果找不到再找jackson的。
      */
    // public JacksonMapper enableJaxbAnnotation() {
    //    JaxbAnnotationModule module = new JaxbAnnotationModule();
    //    this.registerModule(module);
    //    return this;
    // }

    /**
      * 允许单引号
      * 允许不带引号的字段名称
      */
    public JacksonMapper enableSimple() {
        this.configure(Feature.ALLOW_SINGLE_QUOTES, true);
        this.configure(Feature.ALLOW_UNQUOTED_FIELD_NAMES, true);
        this.configure(SerializationFeature.WRITE_BIGDECIMAL_AS_PLAIN, true);
        return this;
    }

    /**
      * 创建只输出非Null且非Empty(如List.isEmpty)的属性到Json字符串的Mapper,建议在外部接口中使用.
      */
    public static JacksonMapper getInstance() {
        if (mapper == null) {
            mapper = new JacksonMapper(Include.ALWAYS).enableSimple();
        }
        return mapper;
    }

    /**
      * 创建只输出初始值被改变的属性到Json字符串的Mapper, 最节约的存储方式，建议在内部接口中使用。
      */
    public static JacksonMapper nonDefaultMapper() {
        if (mapper == null) {
            mapper = new JacksonMapper(Include.NON_DEFAULT);
        }
        return mapper;
    }

    /**
      * 取出Mapper做进一步的设置或使用其他序列化API.
      */
    public ObjectMapper getMapper() {
        return this;
    }

    /**
      * Object可以是POJO，也可以是Collection或数组。
      * 如果对象为Null, 返回"null".
      * 如果集合为空集合, 返回"[]".
      */
    public String toJson(Object object) {
        try {
            return this.writeValueAsString(object);
        } catch (IOException e) {
            logger.warn("write to json string error:" + object, e);
            return null;
        }
    }

    /**
      * 反序列化POJO或简单Collection如List<String>.
      * <p>
      * 如果JSON字符串为Null或"null"字符串, 返回Null.
      * 如果JSON字符串为"[]", 返回空集合.
      * <p>
      * 如需反序列化复杂Collection如List<MyBean>, 请使用fromJson(String,JavaType)
      *
      * @see #fromJson(String, JavaType)
      */
    public <T> T fromJson(String jsonString, Class<T> clazz) {
        if (jsonString == null || jsonString.isEmpty()) {
            return null;
        }
        try {
            return this.readValue(jsonString, clazz);
        } catch (IOException e) {
            logger.warn("parse json string error:" + jsonString, e);
            return null;
        }
    }

    /**
      * 反序列化复杂Collection如List<Bean>, 先使用函数createCollectionType构造类型,然后调用本函数.
      *
      * @see #createCollectionType(Class, Class...)
      */
    @SuppressWarnings("unchecked")
    public <T> T fromJson(String jsonString, JavaType javaType) {
        if (jsonString == null || jsonString.isEmpty()) {
            return null;
        }
        try {
            return (T) this.readValue(jsonString, javaType);
        } catch (IOException e) {
            logger.warn("parse json string error:" + jsonString, e);
            return null;
        }
    }

    /**
      * 构造泛型的Collection Type如:
      * ArrayList<MyBean>, 则调用constructCollectionType(ArrayList.class,MyBean.class)
      * HashMap<String,MyBean>, 则调用(HashMap.class,String.class, MyBean.class)
      */
    public JavaType createCollectionType(Class<?> collectionClass, Class<?>... elementClasses) {
        return this.getTypeFactory().constructParametricType(collectionClass, elementClasses);
    }

    /**
      * 当JSON里只含有Bean的部分属性时，更新一个已存在Bean，只覆盖该部分的属性.
      */
    @SuppressWarnings("unchecked")
    public <T> T update(String jsonString, T object) {
        try {
            return (T) this.readerForUpdating(object).readValue(jsonString);
        } catch (JsonProcessingException e) {
            logger.warn("update json string:" + jsonString + " to object:" + object + " error.", e);
        } catch (IOException e) {
            logger.warn("update json string:" + jsonString + " to object:" + object + " error.", e);
        }
        return null;
    }

    /**
      * 输出JSONP格式数据.
      */
    public String toJsonP(String functionName, Object object) {
        return toJson(new JSONPObject(functionName, object));
    }

    /**
      * 对象转换为JSON字符串
      *
      * @param object
      * @return
      */
    public static String toJsonString(Object object) {
        return JacksonMapper.getInstance().toJson(object);
    }

    /**
      * JSON字符串转换为对象
      *
      * @param jsonString
      * @param clazz
      * @return
      */
    public static Object fromJsonString(String jsonString, Class<?> clazz) {
        return JacksonMapper.getInstance().fromJson(jsonString, clazz);
    }
}

（2）使用示例

准备测试实体类 TestBean.java

 public class TestBean {
     private String name;
     private Integer age;
     private String address;
     // ....get、set方法
 }

① 普通对象转 JSON 字符串

private static void testObj2Json() {
    TestBean tb = new TestBean();
    tb.setAddress("天安门广场");
    tb.setName("老八");
    tb.setAge(12);
    String s = JacksonMapper.getInstance().toJson(tb);
    System.out.println(s);
    // 使用static方法
    System.out.println(JacksonMapper.toJsonString(tb));
}

// 控制台打印
// {"name":"老八","age":12,"address":"天安门广场"}
// {"name":"老八","age":12,"address":"天安门广场"}

② 普通 json 字符串转对象

// s = {"name":"老八","age":12,"address":"天安门广场"}
private static void testJson2Obj() {
    String s = "{\"name\":\"老八\",\"age\":12,\"address\":\"天安门广场\"}";
    TestBean testBean = JacksonMapper.getInstance().fromJson(s, TestBean.class);
    // 控制台打印 TestBean{name='老八', age=12, address='天安门广场'}
    System.out.println(testBean);
}

③ 对象集合转 JSON 字符串

private static void testObjList2Json() {
    List<TestBean> list = new ArrayList<>();
    TestBean tb = new TestBean(), tb1 = new TestBean();
    tb.setAddress("天安门广场");
    tb.setName("老八");
    tb.setAge(12);
    tb1 = tb;
    list.add(tb);
    list.add(tb1);
    String s = JacksonMapper.getInstance().toJson(list);
    // [{"name":"老八","age":12,"address":"天安门广场"},{"name":"老八","age":12,"address":"天安门广场"}]
    System.out.println(s);
}

④ JSON 字符串转对象集合

 // 方式一
 List<TestBean> testBeanList = JacksonMapper.getInstance().fromJson(s, List.class);
 System.out.println(testBeanList);
 
 // 方式二
 JavaType javaType = JacksonMapper.getInstance().createCollectionType(List.class, TestBean.class);
 testBeanList = JacksonMapper.getInstance().fromJson(s, javaType);
 System.out.println(testBeanList);
 
 // 方式三
 testBeanList = JacksonMapper.getInstance().convertValue(testBeanList, new TypeReference<List<TestBean>>() {});
 System.out.println(testBeanList);
 
 // 控制台打印
 [{name=老八, age=12, address=天安门广场}, {name=老八12, age=122, address=天安门广场12}]
 [TestBean{name='老八', age=12, address='天安门广场'}, TestBean{name='老八12', age=122, address='天安门广场12'}]
 [TestBean{name='老八', age=12, address='天安门广场'}, TestBean{name='老八12', age=122, address='天安门广场12'}]

⑤ map 转 JSON 字符串

private static void testMap2Json() {
    TestBean tb = new TestBean();
    tb.setAddress("天安门广场");
    tb.setName("老八");
    tb.setAge(12);
    Map<String, Object> map = new HashMap<>(2);
    map.put("code", 200);
    map.put("data", tb);

    String ms = JacksonMapper.getInstance().toJson(map);
    // {"code":200,"data":{"name":"老八","age":12,"address":"天安门广场"}}
    System.out.println(ms);
}

🙏至此，感谢阅读🙏