使用Jackson序列化不可修改对象时为Address添加自增ID属性

问题背景 #

你手头有两个无法修改的实体类：

TestEntity { 
    // 其他字段省略
    @JsonProperty("addresses") 
    List<Address> addresses; 
    // 其他字段省略
} 

Address { 
    // 注意：没有ID字段
    String street;
    String number;
    // 其他字段省略
} 

现在需要把TestEntity序列化为XML，要求每个<Address>节点都带上自增的id属性，期望的输出大概是这样：

... 
<Addresses> 
    <Address id="1"> 
        <street>...</street> 
        <!-- 其他Address字段 -->
    </Address> 
    <Address id="2"> 
        <street>...</street> 
        <!-- 其他Address字段 -->
    </Address> 
    <!-- 更多Address节点 -->
</Addresses> 

你目前考虑用自定义Mixin类，想知道有没有更优的实现方案，而且不能创建包装实体，必须直接通过objectMapper.writeAsString(testEntity)来执行序列化。

方案1：自定义List序列化器（更直接的最优方案） #

既然核心需求是给列表里的每个Address节点加自增id，最直接的方式就是给List<Address>类型写一个自定义序列化器，在遍历列表的时候为每个元素注入自增的id属性。

具体步骤如下：

1. 编写自定义的List<Address>序列化器：

public class AddressListXmlSerializer extends StdSerializer<List<Address>> {

    protected AddressListXmlSerializer() {
        super((Class<List<Address>>) (Class<?>) List.class);
    }

    @Override
    public void serialize(List<Address> addresses, JsonGenerator gen, SerializerProvider provider) throws IOException {
        // 转换成XML生成器，方便操作XML节点和属性
        if (gen instanceof ToXmlGenerator xmlGen) {
            // 先写外层的<Addresses>容器节点
            xmlGen.writeStartObject("Addresses");
            
            int idCounter = 1;
            for (Address addr : addresses) {
                // 开始写<Address>节点，同时添加id属性
                xmlGen.writeStartObject("Address");
                xmlGen.writeAttribute("id", String.valueOf(idCounter++));
                
                // 让默认序列化器处理Address的其他字段，不用重复写逻辑
                provider.defaultSerializeValue(addr, gen);
                
                xmlGen.writeEndObject();
            }
            
            xmlGen.writeEndObject();
        } else {
            // 如果不是XML序列化场景，走默认逻辑兼容其他格式
            provider.defaultSerializeValue(addresses, gen);
        }
    }
}

2. 把这个序列化器注册到你的XML ObjectMapper里：

XmlMapper xmlMapper = new XmlMapper();

SimpleModule customModule = new SimpleModule();
customModule.addSerializer(new AddressListXmlSerializer());
xmlMapper.registerModule(customModule);

// 执行序列化
String xmlResult = xmlMapper.writeAsString(testEntity);

这个方案的好处是逻辑直接，针对性强，不需要绕Mixin的弯子，维护起来也更清晰，毕竟我们就是要处理列表的序列化逻辑。

方案2：使用Mixin类（你原本考虑的方案） #

如果你更习惯用Mixin的方式来扩展原类的序列化行为，也可以通过Mixin把自定义序列化器绑定到TestEntity的addresses字段上，本质和方案1是一样的，只是关联方式不同：

1. 编写TestEntity的Mixin类：

public abstract class TestEntityMixin {
    @JsonProperty("addresses")
    @JsonSerialize(using = AddressListXmlSerializer.class)
    List<Address> addresses;
}

2. 同时注册Mixin和自定义序列化器到XmlMapper：

XmlMapper xmlMapper = new XmlMapper();
// 绑定Mixin到TestEntity
xmlMapper.addMixIn(TestEntity.class, TestEntityMixin.class);

// 注册自定义序列化器
SimpleModule customModule = new SimpleModule();
customModule.addSerializer(new AddressListXmlSerializer());
xmlMapper.registerModule(customModule);

String xmlResult = xmlMapper.writeAsString(testEntity);

这个方案适合你需要给多个不同实体类的List<Address>字段统一加这个逻辑的场景，但如果只是针对TestEntity这一个类，方案1会更简洁。

几个注意点 #

• 确保你引入了Jackson的XML扩展依赖（jackson-dataformat-xml），不然没法处理XML的节点和属性操作。
• 自定义序列化器里加了ToXmlGenerator的判断，这样可以保证在非XML序列化场景下不会出错，兼容性更好。
• 自增id默认从1开始，如果你需要从0或者其他数值开始，调整idCounter的初始值就行。

内容的提问来源于stack exchange，提问作者Dan