JackJson中怎么自定义JsonSerializer

# Jackson中怎么自定义JsonSerializer

## 1. 引言

Jackson是Java生态中最流行的JSON处理库之一，它提供了高效的数据绑定和序列化/反序列化功能。虽然Jackson能够自动处理大多数Java对象到JSON的转换，但在某些特殊场景下（如自定义日期格式、复杂对象结构等），我们需要通过自定义`JsonSerializer`来实现特定的序列化逻辑。

本文将详细介绍如何在Jackson中自定义`JsonSerializer`，包括基础实现、高级用法和实际案例。

---

## 2. 基础实现步骤

### 2.1 创建自定义序列化器

继承`com.fasterxml.jackson.databind.JsonSerializer<T>`类并实现`serialize`方法：

```java
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import java.io.IOException;

public class CustomDateSerializer extends JsonSerializer<Date> {
    @Override
    public void serialize(Date value, JsonGenerator gen, SerializerProvider provider) 
        throws IOException {
        // 自定义序列化逻辑
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        String formattedDate = sdf.format(value);
        gen.writeString(formattedDate);
    }
}

2.2 注册序列化器

有两种注册方式：

方式一：通过注解注册

public class Event {
    @JsonSerialize(using = CustomDateSerializer.class)
    private Date eventDate;
    // getters/setters...
}

方式二：通过Module全局注册

SimpleModule module = new SimpleModule();
module.addSerializer(Date.class, new CustomDateSerializer());
objectMapper.registerModule(module);

3. 高级用法

3.1 处理泛型类型

对于泛型类型，需要指定Type信息：

public class GenericSerializer<T> extends JsonSerializer<T> {
    @Override
    public void serialize(T value, JsonGenerator gen, SerializerProvider provider) 
        throws IOException {
        // 根据实际类型处理
        if (value instanceof List) {
            gen.writeStartArray();
            for (Object item : (List<?>) value) {
                gen.writeObject(item);
            }
            gen.writeEndArray();
        }
    }
}

3.2 结合JsonNode构建复杂结构

可以直接操作JsonGenerator构建复杂JSON：

gen.writeStartObject();
gen.writeStringField("name", "value");
gen.writeFieldName("nested");
gen.writeStartArray();
gen.writeNumber(1);
gen.writeEndArray();
gen.writeEndObject();

3.3 条件序列化

通过SerializerProvider获取上下文信息：

if (provider.getAttribute("skipNulls") != null) {
    if (value == null) return;
}

4. 实战案例

案例1：金额格式化

public class MoneySerializer extends JsonSerializer<BigDecimal> {
    @Override
    public void serialize(BigDecimal value, JsonGenerator gen, SerializerProvider provider) 
        throws IOException {
        gen.writeString(value.setScale(2, RoundingMode.HALF_UP) + "元");
    }
}

案例2：枚举自定义输出

public enum Status { ACTIVE, INACTIVE }

public class StatusSerializer extends JsonSerializer<Status> {
    @Override
    public void serialize(Status value, JsonGenerator gen, SerializerProvider provider) 
        throws IOException {
        gen.writeString(value == Status.ACTIVE ? "可用" : "不可用");
    }
}

5. 常见问题解决

5.1 循环引用问题

通过@JsonIdentityInfo或手动控制序列化深度：

gen.writeStartObject();
if (provider.getAttribute("depth") == null) {
    provider.setAttribute("depth", 1);
    gen.writeObjectField("child", entity.getChild());
}
gen.writeEndObject();

5.2 性能优化

对于高频使用的序列化器： 1. 重用DateFormat等线程安全对象 2. 避免在serialize()中创建临时对象 3. 考虑使用BeanSerializerModifier进行批量处理

6. 总结

自定义JsonSerializer的主要流程： 1. 继承JsonSerializer实现具体逻辑 2. 通过注解或Module注册 3. 处理特殊场景（泛型、循环引用等）

通过灵活使用自定义序列化器，可以解决项目中90%的特殊序列化需求。对于更复杂的场景，可以结合BeanSerializerModifier或实现ContextualSerializer实现动态适配。

提示：Jackson 2.12+版本提供了更简洁的ValueSerializer接口，适合简单场景。 “`

（全文约1100字）