jackson ObjectMapper介绍

1.使用ObjectMapper进行读写

public class Car {
    
    

    private String color;
    private String type;

    // standard getters setters
}

1.1Java对象转JSON

使用ObjectMapper类的writeValue方法将Java对象序列化为JSON的第一个示例:

ObjectMapper objectMapper = new ObjectMapper();
Car car = new Car("yellow", "renault");
objectMapper.writeValue(new File("target/car.json"), car);

输出:

{
    
    "color":"yellow","type":"renault"}

ObjectMapper类的writeValueAsString和writeValueAsBytes方法从Java对象生成JSON,并将生成的JSON作为字符串或字节数组返回。

String carAsString = objectMapper.writeValueAsString(car);

1.2JSON转Java对象

以下是使用ObjectMapper类将JSON字符串转换为Java对象的简单示例:

String json = "{ \"color\" : \"Black\", \"type\" : \"BMW\" }";
Car car = objectMapper.readValue(json, Car.class);	

readValue()函数还接受其他形式的输入,例如包含JSON字符串的文件:

Car car = objectMapper.readValue(new File("src/test/resources/json_car.json"), Car.class);
Car car = objectMapper.readValue(new URL("file:src/test/resources/json_car.json"), Car.class);

1.3JSON到Jackson JsonNode

或者,可以将JSON解析为JsonNode对象,并用于从特定节点检索数据:

String json = "{ \"color\" : \"Black\", \"type\" : \"FIAT\" }";
JsonNode jsonNode = objectMapper.readTree(json);
String color = jsonNode.get("color").asText();
// Output: color -> Black

1.4从JSON数组字符串创建Java列表

可以使用TypeReference将数组形式的JSON解析为Java对象列表:

String jsonCarArray = 
  "[{ \"color\" : \"Black\", \"type\" : \"BMW\" }, { \"color\" : \"Red\", \"type\" : \"FIAT\" }]";
List<Car> listCar = objectMapper.readValue(jsonCarArray, new TypeReference<List<Car>>(){
    
    });

1.5从JSON字符串创建Java Map

可以将JSON解析为Java Map:

String json = "{ \"color\" : \"Black\", \"type\" : \"BMW\" }";
Map<String, Object> map 
  = objectMapper.readValue(json, new TypeReference<Map<String,Object>>(){
    
    });

2.高级特征

Jackson库的最大优势之一是高度可定制的序列化和反序列化过程。

高级功能,其中输入或输出JSON响应可能不同于生成或使用响应的对象。

2.1配置序列化或反序列化功能

在将JSON对象转换为Java类时,如果JSON字符串包含一些新字段,则默认过程将导致异常:

String jsonString 
  = "{ \"color\" : \"Black\", \"type\" : \"Fiat\", \"year\" : \"1970\" }";

上面示例中的默认解析过程中,对Class Car的Java对象的JSON字符串将导致UnrecognizedPropertyException异常

通过configure方法,可以扩展默认过程以忽略新字段:

objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
Car car = objectMapper.readValue(jsonString, Car.class);

JsonNode jsonNodeRoot = objectMapper.readTree(jsonString);
JsonNode jsonNodeYear = jsonNodeRoot.get("year");
String year = jsonNodeYear.asText();

另一个选项基于FAIL_ON_NULL_FOR_PRIMITIVES,它定义是否允许原始值的空值:

objectMapper.configure(DeserializationFeature.FAIL_ON_NULL_FOR_PRIMITIVES, false);

同样,FAIL_ON_NUMBERS_FOR_ENUM控制是否允许将枚举值序列化/反序列化为数字:

objectMapper.configure(DeserializationFeature.FAIL_ON_NUMBERS_FOR_ENUMS, false);

2.2创建自定义序列化器或反序列化器

ObjectMapper类的另一个基本功能是能够注册自定义序列化器和反序列化器。

在输入或输出JSON响应的结构与必须对其进行序列化或反序列化的Java类不同的情况下,自定义序列化器和反序列化器非常有用。

以下是自定义JSON序列化程序的示例:

public class CustomCarSerializer extends StdSerializer<Car> {
    
    
    
    public CustomCarSerializer() {
    
    
        this(null);
    }

    public CustomCarSerializer(Class<Car> t) {
    
    
        super(t);
    }

    @Override
    public void serialize(
      Car car, JsonGenerator jsonGenerator, SerializerProvider serializer) {
    
    
        jsonGenerator.writeStartObject();
        jsonGenerator.writeStringField("car_brand", car.getType());
        jsonGenerator.writeEndObject();
    }
}

此自定义序列化器可以这样调用:

ObjectMapper mapper = new ObjectMapper();
SimpleModule module = 
  new SimpleModule("CustomCarSerializer", new Version(1, 0, 0, null, null, null));
module.addSerializer(Car.class, new CustomCarSerializer());
mapper.registerModule(module);
Car car = new Car("yellow", "renault");
String carJson = mapper.writeValueAsString(car);

这是Car在客户端的外观(作为JSON输出):

var carJson = {
    
    "car_brand":"renault"}

这是一个自定义JSON反序列化器的示例:

public class CustomCarDeserializer extends StdDeserializer<Car> {
    
    
    
    public CustomCarDeserializer() {
    
    
        this(null);
    }

    public CustomCarDeserializer(Class<?> vc) {
    
    
        super(vc);
    }

    @Override
    public Car deserialize(JsonParser parser, DeserializationContext deserializer) {
    
    
        Car car = new Car();
        ObjectCodec codec = parser.getCodec();
        JsonNode node = codec.readTree(parser);
        
        // try catch block
        JsonNode colorNode = node.get("color");
        String color = colorNode.asText();
        car.setColor(color);
        return car;
    }
}

可以通过以下方式调用此自定义反序列化器:

String json = "{ \"color\" : \"Black\", \"type\" : \"BMW\" }";
ObjectMapper mapper = new ObjectMapper();
SimpleModule module =
  new SimpleModule("CustomCarDeserializer", new Version(1, 0, 0, null, null, null));
module.addDeserializer(Car.class, new CustomCarDeserializer());
mapper.registerModule(module);
Car car = mapper.readValue(json, Car.class);

2.3处理日期格式

java.util.Date的默认序列化产生一个数字,即纪元时间戳(自1970年1月1日以来的毫秒数,UTC)。 但这不是人类可读的,并且需要进一步转换以人类可读的格式显示。

使用datePurchased属性将到目前为止使用的Car实例包装在Request类中:

public class Request 
{
    
    
    private Car car;
    private Date datePurchased;

    // standard getters setters
}

要控制日期的字符串格式并将其设置为yyyy-MM-dd HH:mm a z,请考虑以下代码段:

ObjectMapper objectMapper = new ObjectMapper();
DateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm a z");
objectMapper.setDateFormat(df);
String carAsString = objectMapper.writeValueAsString(request);
// output: {"car":{"color":"yellow","type":"renault"},"datePurchased":"2016-07-03 11:43 AM CEST"}

2.4处理集合

DeserializationFeature类提供的另一个小而有用的功能是能够从JSON Array响应生成所需类型的集合的功能。

例如,我们可以将结果生成为数组:

String jsonCarArray = 
  "[{ \"color\" : \"Black\", \"type\" : \"BMW\" }, { \"color\" : \"Red\", \"type\" : \"FIAT\" }]";
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.configure(DeserializationFeature.USE_JAVA_ARRAY_FOR_JSON_ARRAY, true);
Car[] cars = objectMapper.readValue(jsonCarArray, Car[].class);
// print cars

或作为列表:

String jsonCarArray = 
  "[{ \"color\" : \"Black\", \"type\" : \"BMW\" }, { \"color\" : \"Red\", \"type\" : \"FIAT\" }]";
ObjectMapper objectMapper = new ObjectMapper();
List<Car> listCar = objectMapper.readValue(jsonCarArray, new TypeReference<List<Car>>(){
    
    });
// print cars

在这里插入图片描述

猜你喜欢

转载自blog.csdn.net/niugang0920/article/details/115251394