Spring boot 2.04 Jackson 无法将 LocalDateTime 序列化为 String答案

【问题标题】：Spring boot 2.04 Jackson cannot serialize LocalDateTime to StringSpring boot 2.04 Jackson 无法将 LocalDateTime 序列化为 String
【发布时间】：2019-02-16 00:43:57
【问题描述】：

我将 Spring 启动应用程序和 LocalDateTime 属性序列化为 JSON 数组，而不是 String。

我在网上搜索时发现，我只需要在 application.properties

中进行设置

spring.jackson.serialization.write-dates-as-timestamps=false

我也尝试将 jackson-datatype-jsr310 放入依赖项，但也没有运气

我也尝试添加注释：

@DateTimeFormat(iso = ISO.DATE_TIME)

也没有用。

我看到很多人都在做类似的事情，但他们的解决方案似乎与 Spring Boot 1.x 有关，而我使用的是 2.04

我也使用 Lombok，但不确定它是否会影响序列化格式。

如何追踪并修复日期序列化格式为 ISO 日期字符串？

这里的响应示例（开始是 LocalDateTime，我想将它作为 ISO 字符串）：

{
  "id": 3,
  "enabled": true,
  "outletId": 5,
  "reason": "hello",
  "start": [
    2019,
    9,
    10,
    10,
    42,
    11
  ],
  "status": "AVAILABLE"
}

这里是 REST 控制器方法响应对象：

@Data
@Entity
@Table(indexes = { @Index(columnList = ("outletId"),name="outlet_id_index"), 
        @Index(columnList = ("start"),name="start_index"),
        @Index(columnList = ("outletId, start"),name="outlet_id_start_index")})
public class OutletChron extends BaseEntity {
    private Long outletId;
    private String reason;

    @DateTimeFormat(iso = ISO.DATE_TIME)
    private LocalDateTime start;
    @Enumerated(EnumType.STRING)
    @Column(length = 30)
    private OutletStatus status;
}

这是我的 POM：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.banquets</groupId>
    <artifactId>Banquet</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>Banquet</name>
    <description></description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.4.RELEASE</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Finchley.SR1</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>com.fasterxml.jackson.datatype</groupId>
            <artifactId>jackson-datatype-jsr310</artifactId>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>

        <!-- <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web-services</artifactId> 
            </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId> 
            </dependency> -->

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>


</project>

更新

我建立一个新项目只是为了测试，我发现 String 格式是 LocalDateTime 映射的默认格式。配置 swagger 后，我就能够追踪到格式更改。所以没有这个招摇的配置我有字符串格式：

@Configuration
@EnableSwagger2
public class SwaggerConfig extends WebMvcConfigurationSupport {

    @Autowired
    ServletContext servletContext;

    @Bean
    public Docket productApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.demo"))
                .build();
    }

    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");

        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

更新这个 Swagger 配置似乎有效（日期格式是字符串，我可以通过 http://localhost:8000/api/swagger-ui.html 访问 Swagger UI

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket apiDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

【问题讨论】：

extends WebMvcConfigurationSupport 实际上是web配置。有了这个，你注册了一个该类型的 bean，因此 Spring Boot 不会自动配置与 web 相关的 bean。这是由@EnableWebMvc 导入的类（实际上它导入了该类的子类）。因此扩展该类与添加@EnableWebMvc 相同。

标签： java spring spring-boot jackson swagger

【解决方案1】：

Spring boot 2.x 不需要导入 JSR310 规范，因为它现在是 Spring 框架的一部分，因此无需导入它们，字符串格式化将自动起作用。

如果你需要覆盖spring boot的一些默认配置，那么你需要实现WebMvcConfigurer而不是扩展WebMvcConfigurationSupport。

在您的情况下，如果您想将静态文件放在不在默认资源文件夹中的其他位置，那么您可能需要覆盖 addResourceHandlers 并注册路径。

如果默认路径中的资源则不需要，只需删除扩展 WebMvcConfigurationSupport 将适用于默认字符串格式。

更新答案：

如果您使用WebMvcConfigurationSupport，这意味着它不应该自动配置 Spring MVC，意味着默认设置将不起作用，您必须通过覆盖其支持方法来定义所有内容。所以代替WebMvcConfigurationSupport 实现WebMvcConfigurer。

这是更新的配置。

@Configuration
@EnableSwagger2
public class SwaggerConfig implements WebMvcConfigurer {

    @Bean
    public Docket productApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.demo"))
                .build();
    }

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");

        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

【讨论】：

是的，我就是这样做的。 Lombok 看起来不错，但是 Swagger 配置破坏了一些东西。请查看更新。
@Pavlo 检查我更新的答案，这将解决您的问题。
我能够通过完全删除“扩展 WebMvcConfigurationSupport”来使其工作。我不知道它是为了什么。那么为什么我还需要“implements WebMvcConfigurer”呢？
如果您需要添加资源处理程序，那么您需要实现它，不确定但似乎您想访问 swagger UI。我更正了您在描述中更新的配置。
是的，我在localhost:8000/api/swagger-ui.html 上获得了带有 UI 的 Swagger，没有“扩展 WebMvcConfigurationSupport”，也没有“实现 WebMvcConfigurer”。可能是 Spring Boot 关心它，我不确定。我将使用我当前的招摇配置更新初始化问题

【解决方案2】：

对我来说，以下工作：

@JsonFormat(pattern = "dd.MM.yyyy HH:mm")
private LocalDateTime startTime;

这将以字符串格式打印日期，例如喜欢 11.09.2018 15:44

【讨论】：

这可能是可行的解决方案。虽然我不喜欢它，因为我必须自己编写模式。如果我找不到更好的东西，将不得不使用它。

【解决方案3】：

手动创建对象映射器

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

    JavaTimeModule timeModule = new JavaTimeModule();
    mapper.registerModule(timeModule);

    mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
    mapper.configure(SerializationFeature.WRITE_DATE_TIMESTAMPS_AS_NANOSECONDS, false);

    return mapper;
}

【讨论】：

没有任何变化。 :( 我将此 bean 添加到根应用程序类。我在启动应用程序时看到它被调用，但日期响应格式保持不变 - 它是一个数组
移除@DateTimeFormat注解
我试过没有它，但它也不起作用。我能够追踪我的 Swagger 配置似乎是导致它的原因。请检查问题更新。