Springboot3+将ID转为JSON字符串的详细配置方案

更新时间：2025年06月11日 16:12:03 作者：堕落年代

这篇文章主要介绍了纯后端实现 Long/BigInteger ID 转为 JSON 字符串的详细配置方案,s 基于 Spring Boot 3+ 和 SpringDoc (OpenAPI) 最新实践,需要的可以了解下

1. 添加依赖

确保你的 pom.xml（或 Gradle）中包含：

<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-databind</artifactId>
</dependency>
<dependency>
  <groupId>com.fasterxml.jackson.datatype</groupId>
  <artifactId>jackson-datatype-jsr310</artifactId>
</dependency>
<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
  <version>2.x</version>
</dependency>

2. 全局 Jackson 配置

创建一个全局 ObjectMapper，让所有 Long 类型自动序列化为字符串：

@Configuration
public class JacksonConfig {

    @Bean
    @Primary
    public ObjectMapper objectMapper() {
        ObjectMapper mapper = new ObjectMapper();

        // Java 8 日期时间支持
        mapper.registerModule(new JavaTimeModule());
        mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);

        // 去掉 null 字段
        mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

        // 将 Long / long 转为 String
        SimpleModule idModule = new SimpleModule();
        idModule.addSerializer(Long.class, ToStringSerializer.instance);
        idModule.addSerializer(Long.TYPE, ToStringSerializer.instance);
        idModule.addSerializer(BigInteger.class, ToStringSerializer.instance);
        mapper.registerModule(idModule);

        return mapper;
    }
}

上述配置无需在 POJO 上添加注解，确保所有后端输出中的 Long/BigInteger 都以字符串形式传输。这是社区常用解决方案，也是 StackOverflow 推荐做法。

3. 精准控制（可选）

如有需求，仅针对某些字段转换，新增注解支持：

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD})
@JacksonAnnotationsInside
@JsonSerialize(using = ToStringSerializer.class)
public @interface StringId {}

使用方式：

public class User {
    @StringId
    private Long id;
    private String name;
}

并在全局配置中扫描该注解，使用 BeanSerializerModifier 判断并替换：

@Bean
public Jackson2ObjectMapperBuilderCustomizer customIdSerializer() {
    return builder -> builder.modules(new SimpleModule() {
        @Override
        public void setupModule(SetupContext context) {
            context.addBeanSerializerModifier(new BeanSerializerModifier() {
                @Override
                public List<BeanPropertyWriter> changeProperties(
                        SerializationConfig config,
                        BeanDescription beanDesc,
                        List<BeanPropertyWriter> props) {
                    return props.stream().map(writer -> {
                        if (writer.getAnnotation(StringId.class) != null) {
                            return writer.withSerializer(ToStringSerializer.instance);
                        }
                        return writer;
                    }).toList();
                }
            });
        }
    });
}

4. OpenAPI (SpringDoc) 类型同步

为了 Swagger 文档中显示 ID 为 “string” 而不是 “integer”，增加 OpenAPI 自定义：

@Bean
public OpenApiCustomiser idAsStringSchemaCustomizer() {
    return openApi -> {
        openApi.getComponents().getSchemas().forEach((name, schema) -> {
            if (schema.getProperties() != null) {
                schema.getProperties().forEach((propName, propSchema) -> {
                    if (propName.toLowerCase().endsWith("id") 
                        && "integer".equals(propSchema.getType())) {
                        propSchema.setType("string");
                        propSchema.setFormat("int64");
                    }
                });
            }
        });
    };
}

使用步骤总结

引入依赖 - Jackson、JSR‑310、SpringDoc。

配置全局 ObjectMapper - Long/String 自动转换。

（可选）添加 @StringId 注解 - 精细控制。

同步 OpenAPI Schema 类型 - Swagger 查看准确。

测试验证：序列化、反序列化均正常。

测试示例

@SpringBootTest
public class IdConversionTest {
    @Autowired ObjectMapper mapper;

    @Test
    void testLongToString() throws Exception {
        TestEntity e = new TestEntity();
        e.setId(1234567890123456789L);
        String json = mapper.writeValueAsString(e);
        assertTrue(json.contains("\"id\":\"1234567890123456789\""));
    }

    @Test
    void testStringToLong() throws Exception {
        String json = "{\"id\":\"1234567890123456789\"}";
        TestEntity e = mapper.readValue(json, TestEntity.class);
        assertEquals(1234567890123456789L, e.getId());
    }

    static class TestEntity { Long id; /* getter-setter */ }
}

这样可以无感在后端处理，前端收到字符串，避免 JS 精度问题，同时 Swagger 文档也保持一致。

如果需要我帮你快速落地这套配置在你项目中，可以提供你 Spring Boot 和 SpringDoc 版本，我来进一步定制配置。

到此这篇关于Springboot3+将ID转为JSON字符串的详细配置方案的文章就介绍到这了,更多相关Springboot ID转JSON字符串内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

java中synchronized Lock(本地同步)锁的8种情况
本文主要介绍了java中synchronized Lock(本地同步)锁的8种情况，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-09-09
Java获取当前时间的时间戳方法总结
Java中获取时间戳的方式有很多种,下面这篇文章主要给大家介绍了关于Java获取当前时间的时间戳的相关资料,文中通过代码介绍的非常详细,对大家学习或者使用java具有一定的参考借鉴价值,需要的朋友可以参考下
2024-06-06
Java基于redis实现分布式锁
系统的不断扩大，分布式锁是最基本的保障。今天我们介绍通过redis实现分布式锁，感兴趣的朋友可以参考下
2021-05-05
解决get请求入参@NotNull验证不生效问题
这篇文章主要介绍了解决get请求入参@NotNull验证不生效问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-09-09
Maven属性与版本管理详细步骤分解
这篇文章主要介绍了Maven中关于属性与版本控制管理的步骤操作，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-08-08
spring mvc实现文件上传并携带其他参数的示例
本篇文章主要介绍了spring mvc实现文件上传并携带其他参数的示例，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-02-02
简单学习Java+MongoDB
本文给大家介绍的是如何简单的使用java+MongoDB实现数据调用的问题，非常的实用，有需要的小伙伴可以参考下
2016-03-03
java 创建线程的几种方式
本文主要介绍了java中创建线程的几种方式。具有很好的参考价值，下面跟着小编一起来看下吧
2017-02-02
java中如何区分==和equals
这篇文章主要介绍了java中如何区分==和equals，文中讲解的非常细致，代码帮助大家更好的理解和学习，感兴趣的朋友可以了解下
2020-07-07
Spring Boot CORS 配置方法允许跨域请求的最佳实践方案
跨域请求在现代Web开发中非常重要,特别是在涉及多个前端和后端服务时,本文详细介绍了跨域请求的背景、重要性以及如何解决跨域问题,通过SpringBoot框架的CORS配置,可以有效地处理跨域请求,确保数据传输的安全性和用户体验,感兴趣的朋友跟随小编一起看看吧
2024-11-11