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

本文主要是介绍Springboot3+将ID转为JSON字符串的详细配置方案，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

《Springboot3+将ID转为JSON字符串的详细配置方案》：本文主要介绍纯后端实现Long/BigIntegerID转为JSON字符串的详细配置方案,s基于SpringBoot3+和Spr...

1. 添加依赖

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

<dependencyChina编程>
  <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, ToStringSerializerjs.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
 China编程   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,
         http://www.chinasem.cn               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字符串内容请搜索编程China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持China编程(www.chinasem.cn)！

这篇关于Springboot3+将ID转为JSON字符串的详细配置方案的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！