Spring Cloud中Feign调用Spring Boot微服务LocalDateTime类型字段异常解析处理技巧
2023-11-21 13:49:00
Feign 调用 Spring Boot 微服务时处理 LocalDateTime 字段异常
在微服务架构中，利用 Feign 框架进行服务调用时，我们经常会遇到一个棘手的问题：当服务接口实体类中存在 LocalDateTime 字段时，调用方在解析返回值时可能会出现异常。这篇文章将深入分析问题根源，并提供一个详细的解决方法。
问题分析
当服务 A 调用服务 B 时，如果 B 服务的接口实体类中包含 LocalDateTime 字段，A 服务在解析 B 服务返回的 JSON 数据时，会将该字段解析成字符串，导致数据格式不正确。例如：
// 服务 B 接口实体类
public class Book {
private Long id;
private String title;
private LocalDateTime publishDate;
}
// 服务 B 返回的 JSON 数据
{
"id": 1,
"title": "Java 编程思想",
"publishDate": "2023-03-08T09:35:23.123"
}
在服务 A 中，如果直接使用 POJO 来接收 B 服务返回的数据，那么 publishDate 字段将被解析成 String 类型，而不是 LocalDateTime 类型，从而抛出异常。
解决方法
要解决这个问题，我们需要在 B 服务接口实体类的 LocalDateTime 字段上添加 Jackson 的 @JsonFormat 注解。这个注解可以指定字段的 JSON 序列化和反序列化格式。
// 服务 B 接口实体类
public class Book {
private Long id;
private String title;
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private LocalDateTime publishDate;
}
同时，在服务 A 中，在 Feign 客户端接口中，在对应的实体类字段上也需要添加 @JsonFormat 注解。
// 服务 A Feign 客户端接口
@FeignClient(name = "service-b")
public interface BookClient {
@GetMapping("/books/{id}")
Book getBookById(@PathVariable Long id);
}
此外，还需要在服务 A 的 application.yml 配置文件中添加 Jackson 相关的配置：
spring:
jackson:
date-format: yyyy-MM-dd HH:mm:ss
time-zone: Asia/Shanghai
通过以上步骤，就能解决 Feign 调用 Spring Boot 微服务时，LocalDateTime 字段异常解析的问题。
代码示例
服务 B 接口实体类：
import com.fasterxml.jackson.annotation.JsonFormat;
public class Book {
private Long id;
private String title;
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private LocalDateTime publishDate;
}
服务 A Feign 客户端接口：
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
@FeignClient(name = "service-b")
public interface BookClient {
@GetMapping("/books/{id}")
Book getBookById(@PathVariable Long id);
}
服务 A application.yml 配置：
spring:
jackson:
date-format: yyyy-MM-dd HH:mm:ss
time-zone: Asia/Shanghai
注意事项
- 确保服务 A 和服务 B 使用相同的 Jackson 版本。
- 在服务 A 中，需要在 Feign 客户端接口中添加
@JsonFormat注解，否则无法正确解析服务 B 返回的 JSON 数据。 - 在服务 A 的
application.yml配置文件中，需要添加 Jackson 相关的配置，否则无法正确格式化 LocalDateTime 字段。
常见问题解答
Q1：为什么在服务 B 接口实体类的 LocalDateTime 字段上添加 @JsonFormat 注解就能解决问题？
A1：@JsonFormat 注解可以指定字段的 JSON 序列化和反序列化格式，在服务 B 的接口实体类中添加这个注解，可以告诉 Jackson 如何将 LocalDateTime 字段序列化成 JSON 字符串和反序列化成 LocalDateTime 对象。
Q2：为什么在服务 A 中也需要在 Feign 客户端接口中添加 @JsonFormat 注解？
A2：在服务 A 中添加 @JsonFormat 注解，可以让 Feign 在解析服务 B 返回的 JSON 数据时，将 LocalDateTime 字段正确解析成 LocalDateTime 对象。
Q3：为什么还需要在服务 A 的 application.yml 配置文件中添加 Jackson 相关的配置？
A3：Jackson 相关的配置可以指定 Jackson 的全局配置，包括日期格式、时区等，这些配置对于正确解析和格式化 LocalDateTime 字段至关重要。
Q4：如果服务 A 和服务 B 使用不同的 Jackson 版本会怎样？
A4：如果服务 A 和服务 B 使用不同的 Jackson 版本，可能会导致 LocalDateTime 字段的解析和格式化出现问题，甚至抛出异常。
Q5：除了 @JsonFormat 注解外，还有其他解决方法吗？
A5：除了 @JsonFormat 注解外，还可以在服务 B 的接口实体类中使用 @JsonSerialize 和 @JsonDeserialize 注解来指定 LocalDateTime 字段的序列化和反序列化方式。
