@JsonUnwrapped 以扁平的数据结构序列化/反序列化属性

@JsonUnwrapped 表明属性应该以扁平化的形式进行序列化，即，目标属性将不会序列化为 JSON 对象，但其属性将序列化为包含它的对象的属性。并能以相同的方式反序列化。让我们通过一个例子来理解它。

Example

Java Objects

public class Department {
    private String deptName;
    private String location;
    ...
}    

public class Employee {
    private String name;
    @JsonUnwrapped
    private Department dept;
    ...
}    

Main class

public class ExampleMain {
    public static void main(String[] args) throws IOException {
        Department dept = new Department();
        dept.setDeptName("Admin");
        dept.setLocation("NY");
        Employee employee = new Employee();
        employee.setName("Amy");
        employee.setDept(dept);

        System.out.println("-- before serialization --");
        System.out.println(employee);

        System.out.println("-- after serialization --");
        ObjectMapper om = new ObjectMapper();
        String jsonString = om.writeValueAsString(employee);
        System.out.println(jsonString);

        System.out.println("-- after deserialization --");
        Employee employee2 = om.readValue(jsonString, Employee.class);
        System.out.println(employee2);
    }
}

dept 属性并没有被序列化为 JSON 对象，而是将 dept 的属性作为 Employee 的属性序列化了。

-- before serialization --
Employee{name='Amy', dept=Department{deptName='Admin', location='NY'}}
-- after serialization --
{"name":"Amy","deptName":"Admin","location":"NY"}
-- after deserialization --
Employee{name='Amy', dept=Department{deptName='Admin', location='NY'}}

不使用 @JsonUnwrapped

dept 以 JSON 对象的形式被序列化了

-- before serialization --
Employee{name='Amy', dept=Department{deptName='Admin', location='NY'}}
-- after serialization --
{"name":"Amy","dept":{"deptName":"Admin","location":"NY"}}
-- after deserialization --
Employee{name='Amy', dept=Department{deptName='Admin', location='NY'}}

使用 prefix、suffix 避免名称冲突

使用 @JsonUnwrapped 可能出现名称冲突的情况，可以用 @JsonUnwrapped#prefix、@JsonUnwrapped#suffix 解决。Department、Employee 都有 name 属性，会产生冲突

public class Department {
    private String name;
    private String location;
    ...
}    

public class Employee {
    private String name;
    @JsonUnwrapped(prefix = "dept-")
    private Department dept;
    ...
}    

-- before serialization --
Employee{name='Amy', dept=Department{name='Admin', location='NY'}}
-- after serialization --
{"name":"Amy","dept-name":"Admin","dept-location":"NY"}
-- after deserialization --
Employee{name='Amy', dept=Department{name='Admin', location='NY'}}

若不使用 @JsonUnwrapped#prefix，Department.name 被反序列化为 null：

-- before serialization --Employee{name='Amy', dept=Department{name='Admin', location='NY'}}-- after serialization --{"name":"Amy","name":"Admin","location":"NY"}-- after deserialization --Employee{name='Admin', dept=Department{name='null', location='NY'}}

原文链接

1. Jackson JSON - Using @JsonUnwrapped to serialize/deserialize properties as flattening data structure

2. Jackson JSON - Using prefix and suffix attributes of @JsonUnwrapped to avoid name collisions