您的位置 首页 java

「Java工具类」Jackson工具类,json字符串转各种对象或者集合

介绍语

本头条号主要是 java 常用关键技术点,通用工具类的分享;以及springboot+springcloud+ Mybatis plus+druid+mysql+ redis +swagger+ maven + docker 等集成框架的技术分享;datax、 kafka 、flink等大数据处理框架的技术分享。文章会不断更新,欢迎码友关注点赞收藏转发!

望各位码友点击关注,冲1000粉。后面会录制一些视频教程,图文和视频结合,比如:图书介绍网站系统、抢购系统、大数据中台系统等。技术才是程序猿的最爱,码友们冲啊

如果码友觉得代码太长,可以从头到尾快速扫射一遍,了解大概即可。觉得有用后再转发收藏,以备不时之需。

正文:

可以毫不夸张的说每一个项目中都有json字符串转对象或者对象转 json 字符串,或者对象数组。我发现很多同事在用 阿里 fastjson 或者用 谷歌 的gson工具类,也有用jackson工具类。甚至一个项目同时用这三个工具类的都有,我也并没有对这样的事感到奇怪和禁止,毕竟每个程序猿的习惯不一样,不能强求他们使用不熟悉的工具类。

我自己是选择了jackson工具类,然后自己进一步封装了。这个工具类也是 spring 推荐的,拓展性很强。下面上几个使用的例子:

例子1

普通对象转json字符串

  TestBean tb = new TestBean();
 tb.setAddress(" 天安门广场 ");
 tb.setName("老八");
 tb.setAge(12);
 String s = JacksonMapper. getInstance ().to JSON (tb);
 System.out.println(s);
 // 使用 static 方法
 System.out.println(JacksonMapper.toJsonString(tb));
 
 // 控制台打印
 {"name":"老八","age":12,"address":"天安门广场"}
 {"name":"老八","age":12,"address":"天安门广场"}  

例子2

普通json字符串转对象

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

例子3

对象集合转 Json 字符串

  List<TestBean> list = new ArrayList<>();
 list.add(tb);
 list.add(tb1);
 s = JacksonMapper.getInstance().toJson(list);
 System.out.println(s);
 
 // 控制台打印
 [{"name":"老八","age":12,"address":"天安门广场"},{"name":"老八12","age":122,"address":"天安门广场12"}]  

例子4

json字符串转对象集合

  // 方式一
 List<TestBean> testBeanList = JacksonMapper.getInstance().fromJson(s, List.class);
 System.out.println(testBeanList);
 
 // 方式二
 JavaType javaType = JacksonMapper.getInstance().create collection Type(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'}]
   

例子5

map转json字符串

  Map<String, Object> map = new HashMap<>();
 map.put("code", 200);
 map.put("data", tb);
 
 String ms = JacksonMapper.getInstance().toJson(map);
 System.out.println(ms);
 
 // 控制台打印
 {"code":200,"data":{"name":"老八","age":12,"address":"天安门广场"}}  

例子中用到的TestBean实体类

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

工具类源码:

  import com.fasterxml.jackson. annotation .Json include .Include;
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.core.JsonParser.Feature;
 import com.fasterxml.jackson.core. JSONP rocessing Exception ;
 import com.fasterxml.jackson.databind.*;
 import com.fasterxml.jackson.databind.util.JSONPObject;
 import com.fasterxml.jackson.module.jaxb.Jaxb Annotation Module;
 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.set Serialization Inclusion(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, My Bean .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);
     }
 }  

鄙人编码十年多,在项目中也积累了一些工具类,很多工具类在每个项目都有在用,很实用。大部分是鄙人封装的,有些工具类是同事封装的,有些工具类已经不记得是ctrl+c的还是自己封装的了,现在有空就会总结项目中大部分的工具类,分享给各位码友。如果文章中涉及的代码有侵权行为请通知鄙人处理。

计划是先把工具类整理出来,正所谓工欲善其事,必先利其器。项目中不管是普通单体项目还是多模块maven项目或是分布式微服务,一部分功能模块都是可以重用的,工具类模块就是其中之一。

文章来源:智云一二三科技

文章标题:「Java工具类」Jackson工具类,json字符串转各种对象或者集合

文章地址:https://www.zhihuclub.com/171144.shtml

关于作者: 智云科技

热门文章

网站地图