您的位置: 首页  >  IT文章  >  JACKSON框架用法根本

JACKSON框架用法根本

分类: IT文章 • 2023-11-19 17:03:30
JACKSON框架用法基本

JACKSON框架用法基本

之前参与的一个手机项目中和服务器进行交互的数据格式就是JSON，在手机端用JACKSON进行数据和java bean之间的转换。这次专业课的结课作业需要手机应用和服务器交互，我就想用JSON传递数据，用JACKSON来进行解析，特此总结一下。

简介

JACKSON是一个多用途的java库，来解析JSON格式的数据，用途很广。

解析JSON的三种方式

  1. Streaming API 方式。不做总结
  2. Tree Model 方式，类似于XML。不做总结
  3. Data Binding 方式，即数据绑定，将JSON数据转化为POJOs和“简单”数据绑定（返回一个内含有一个或多个 POJO的基本容器对象），总结对象

Data Binding

POJO转换

JsonGenerator和ObjectMapper是两个主要用于转换的类。
JsonGenerator的writeObject方法和ObjectMapper的writeValue方法完成对Java对象的转换，二者传递的参数及构造的方式不同:

JsonGenerator的创建依赖于ObjectMapper对象。也就是说如果你要使用JsonGenerator来转换JSON，那么你必须创建一个ObjectMapper。

但是你用ObjectMapper来转换JSON，则不需要JSONGenerator。

所以我感觉用ObjectMapper更加方便一点。

JSON转换为java对象示例：

ObjectMapper mapper = new ObjectMapper(); /* can reuse, share globally*/
User user = mapper.readValue(new File("user.json"), Bean.class);

同样的，java对象转换为JSON：

mapper.writeValue(new File("user-modified.json"), user);

ObjectMapper的readValue()和writeValue()方法重载了好多。

  • writeValue()参数一，需要提供一个输出流（java.io.OutputStream out），转换后可以通过这个流来输出转换后的内容。或是提供一个File（java.io.File resultFile）将转换后的内容写入到File中。当然，这个参数也可以接收一个JSONGenerator，然后通过JSONGenerator来输出转换后的信息。第二个参数是将要被转换的Java对象。如果用三个参数的方法，那么是一个Config。这个config可以提供一些转换时的规则，过指定的Java对象的某些属性进行过滤或转换等。
  • writeValueAsString()方法，将传入的对象转换为JSON返回String对象。
  • readValue()参数一，包括文件（java.io.File src）、URL（java.net.URL src）、String、输入流（java.io.Reader src和java.io.InputStream src）byte数组、JsonParser对象，指定JSON数据的来源。参数二可以是要被转换的Java对象、com.fasterxml.jackson.core.type.TypeReference类型对象，指明你要转换的目的类型等，不过当第一个参数是byte数组时，参数就可能发生变化了。

java.io.Reader 和 java.io.InputStream的区别

“Raw” Data Binding

可以将要转换的对象定义为 Map.class, List.class, String[].class或者更多的类型。
但是这样的话，传入的JSON数据和生成的对象时一一对应的关系。像下面这样。
将JSON转换为Map对象：

Map<String,Object> userData = mapper.readValue(new File("user.json"), Map.class);

这样一来，userData里面的数据和下面这样构造出来的对象结构是一样的：

Map<String,Object> userData = new HashMap<String,Object>();
Map<String,String> nameStruct = new HashMap<String,String>();
nameStruct.put("first", "Joe");
nameStruct.put("last", "Sixpack");
userData.put("name", nameStruct);
userData.put("gender", "MALE");
userData.put("verified", Boolean.FALSE);
userData.put("userImage", "Rm9vYmFyIQ==");

JSON转换Map对象时，不需要特别指定key和value的类型。
下面是转换对应关系
JSON Type Java Type
object LinkedHashMap< String,Object>
array ArrayList < Object >
string String
number (no fraction) Integer, Long or BigInteger (smallest applicable)
number (fraction) Double (configurable to use BigDecimal)
true|false Boolean
null null

和包含泛型的容器之间的转换

处理一般的JavaBean和JSON之间的转换只要使用ObjectMapper 对象的readValue和writeValueAsString两个方法就能实现。但是如果要转换复杂类型Collection如 List<YourBean>，那么就需要先反序列化复杂类型 为泛型的Collection Type。

如果是ArrayList<YourBean>那么使用ObjectMapper的getTypeFactory().constructParametricType(collectionClass, elementClasses);

如果是HashMap<String,YourBean>那么 ObjectMapper的getTypeFactory().constructParametricType(HashMap.class,String.class, YourBean.class);
然后调用下面一句话

mapper.readValue(jsonStr, javaType)

给一个JSON转换为List的方法

 /**
     * jsonString ---> List<Info>
     * 
     * @param jsonStr
     * @param collectionClass            List.class
     * @param elementClasses             Info.class
     * @return List<Info>
     * @throws Exception
     */
    public static <T> List<T> jsonToList(String jsonStr,
            Class<?> collectionClass, Class<?>... elementClasses)
            throws Exception {
        ObjectMapper mapper = new ObjectMapper();

        JavaType javaType = mapper.getTypeFactory().constructParametricType(
                collectionClass, elementClasses);

        return mapper.readValue(jsonStr, javaType);
    }

用的时候，这样使用

List<YourBean> list = JsonUtil.jsonToList(jsonStr, ArrayList.class,YourBean.class);

参考来源

JACKSON*
Jackson 框架，轻易转换JSON
Jackson将json字符串转换成泛型List
自己项目中的学习总结

推荐

五分钟Jackson入门

相关推荐