如何为Jackson全局注册自定义Boolean转Number序列化器并默认生效

问题分析 #

你当前的自定义序列化器存在两个核心问题：

1. 使用gen.writeString()输出的是字符串类型的"1"/"0"，但你期望的是JSON数字类型
2. 手动创建的ObjectMapper未被Spring MVC正确接管，导致全局配置不生效

以下是修正后的完整解决方案：

1. 修正自定义序列化器 #

调整序列化逻辑，输出数字而非字符串，同时处理Boolean为null的场景：

public class MyBooleanSerializer extends JsonSerializer<Boolean> {
    @Override
    public void serialize(Boolean value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        // 若为null默认转0，可根据业务需求调整规则
        gen.writeNumber(value != null && value ? 1 : 0);
    }
}

如果需要处理基本类型boolean，补充对应的序列化器：

public class MyPrimitiveBooleanSerializer extends JsonSerializer<Boolean> {
    @Override
    public void serialize(boolean value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        gen.writeNumber(value ? 1 : 0);
    }
}

2. 全局注册序列化器（Spring Boot环境） #

推荐两种配置方式，任选其一即可：

方式一：通过Jackson2ObjectMapperBuilder构建ObjectMapper #

利用Spring Boot提供的构建器，确保生成的ObjectMapper被Spring MVC接管使用：

@Configuration
public class JacksonConfig {

    @Bean
    @Primary
    public ObjectMapper objectMapper(Jackson2ObjectMapperBuilder builder) {
        ObjectMapper objectMapper = builder.build();
        SimpleModule booleanModule = new SimpleModule();
        // 注册包装类Boolean的序列化器
        booleanModule.addSerializer(Boolean.class, new MyBooleanSerializer());
        // 注册基本类型boolean的序列化器（按需添加）
        booleanModule.addSerializer(boolean.class, new MyPrimitiveBooleanSerializer());
        
        objectMapper.registerModule(booleanModule);
        // 保留你的非空序列化配置
        objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
        return objectMapper;
    }
}

方式二：直接注册自定义Module #

Spring Boot会自动扫描并注册Module类型的Bean，无需手动构建ObjectMapper：

@Configuration
public class JacksonConfig {

    @Bean
    public Module booleanSerializerModule() {
        SimpleModule module = new SimpleModule();
        module.addSerializer(Boolean.class, new MyBooleanSerializer());
        module.addSerializer(boolean.class, new MyPrimitiveBooleanSerializer());
        return module;
    }
}

3. 验证效果 #

重启应用后调用/hello接口，将得到符合预期的JSON响应：

{
  "success": 1,
  "message": "Hi there"
}

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