<think>我们正在讨论在
Spring Boot中
配置和使用Gson
消息转换器。根据引用[1]和引用[2]中的信息，我们可以通过
配置一个GsonHttpMessageConverter来替换默认的Jackson转换器。以下是具体步骤：
1. **添加Gson依赖**：在pom.xml中添加Gson库的依赖。
2. **创建
配置类**：通过@Configuration注解定义
一个配置类，并在其中创建GsonHttpMessageConverter的Bean。
3. **自定义Gson实例**（可选）：如果需要定制Gson的行为（比如日期格式），可以创建
一个Gson实例并进行
配置。
引用[1]中提供了
一个配置类的示例，但请注意，在
Spring Boot中，我们通常不需要手动注册GsonHttpMessageConverter，因为
Spring Boot的自动
配置会检测到Gson的存在并自动
配置一个转换器。但是，如果我们想要自定义Gson的行为，则需要自己创建Gson实例并
配置到转换器中。
另外，引用[3]中提到了使用FastJson的
配置，但我们现在关注的是Gson，因此可以参考其
配置方式，但使用Gson相关的类。
下面我将详细说明两种方法：一种是让
Spring Boot自动
配置Gson转换器（通过
配置属性），另一种是手动
配置Gson转换器（通过Java
配置类）。
### 方法1：使用
Spring Boot的自动
配置（推荐）
Spring Boot的`
spring-
boot-starter-web`默认包含Jackson，但如果我们排除Jackson并添加Gson依赖，
Spring Boot会自动
配置Gson。
步骤：
1. 排除Jackson依赖，并添加Gson依赖：
```xml
<dependency>
<groupId>org.
springframework.
boot</groupId>
<artifactId>
spring-
boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
</dependency>
```
2. 在`application.properties`或`application.yml`中
配置Gson属性（可选）：
```properties
spring.gson.date-format=yyyy-MM-dd HH:mm:ss
spring.gson.pretty-printing=true
# 其他
配置，如是否序列化null值等
```
Spring Boot会自动根据这些属性
配置Gson，并创建GsonHttpMessageConverter。
### 方法2：手动
配置Gson
消息转换器
如果我们想要更精细地控制Gson的
配置，可以手动创建GsonHttpMessageConverter的Bean。此时，我们不需要排除Jackson（因为手动
配置的转换器会优先），但通常我们还是会排除Jackson以避免冲突或节省资源。
步骤：
1. 排除Jackson并添加Gson依赖（同上）。
2. 创建
一个配置类，定义`GsonHttpMessageConverter`的Bean：
```java
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import org.
springframework.context.annotation.Bean;
import org.
springframework.context.annotation.Configuration;
import org.
springframework.http.converter.json.GsonHttpMessageConverter;
@Configuration
public class GsonConfig {
@Bean
public GsonHttpMessageConverter gsonHttpMessageConverter() {
GsonHttpMessageConverter converter = new GsonHttpMessageConverter();
converter.setGson(gson());
return converter;
}
@Bean
public Gson gson() {
return new GsonBuilder()
.setDateFormat("yyyy-MM-dd HH:mm:ss")
.serializeNulls() // 序列化null值
.create();
}
}
```
注意：在
Spring Boot中，如果我们手动注册了
一个`HttpMessageConverter`，那么默认的转换器（包括Jackson）将不会被自动
配置。所以，如果我们同时想要使用Gson和Jackson，则需要同时
配置两者，并且注意顺序（通过实现`WebMvcConfigurer`接口并重写`configureMessageConverters`方法，然后添加多个转换器）。
### 测试
配置完成后，我们可以编写
一个简单的Controller进行测试：
```java
@RestController
public class TestController {
@GetMapping("/test")
public User test() {
User user = new User();
user.setName("John");
user.setAge(30);
user.setBirthday(new Date());
return user;
}
}
```
访问`/test`，应该会返回JSON格式的数据，并且日期格式为我们
设置的格式。
### 总结
- 如果只需要使用Gson替换Jackson，推荐使用方法1（自动
配置），简单方便。
- 如果需要深度定制Gson，则使用方法2（手动
配置）。
### 注意事项
- 如果项目中同时存在Jackson和Gson的转换器，
Spring MVC会按照转换器注册的顺序选择第
一个能够处理请求的转换器。为了避免不确定性，通常我们只保留
一个JSON转换器。
- 如果使用手动
配置，并且想要完全控制
消息转换器，可以实现`WebMvcConfigurer`接口，然后重写`configureMessageConverters`方法，并添加自己的转换器。这样会覆盖默认的转换器列表。
§§相关问题§§
1.
Spring Boot中如何同时使用Gson和Jackson作为JSON
消息转换器？
2. 如何自定义Gson的序列化和反序列化规则？
3. 在
Spring Boot中如何
配置多个HttpMessageConverter？</think>###
Spring Boot 配置和使用 Gson
消息转换器详解
#### 一、核心
配置步骤
1. **添加 Gson 依赖**
在 `pom.xml` 中排除 Jackson 并添加 Gson 依赖：
```xml
<dependency>
<groupId>org.
springframework.
boot</groupId>
<artifactId>
spring-
boot-starter-web</artifactId>
<exclusions>
<!-- 排除 Jackson -->
<exclusion>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.10.1</version> <!-- 使用最新稳定版 -->
</dependency>
```
2. **创建 Gson
配置类**
```java
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import org.
springframework.context.annotation.Bean;
import org.
springframework.context.annotation.Configuration;
import org.
springframework.http.converter.json.GsonHttpMessageConverter;
@Configuration
public class GsonConfig {
// 自定义 Gson 实例
@Bean
public Gson gson() {
return new GsonBuilder()
.setDateFormat("yyyy-MM-dd HH:mm:ss") // 日期格式
.serializeNulls() // 序列化 null 值
.disableHtmlEscaping() // 禁用 HTML 转义
.create();
}
// 注册
消息转换器
@Bean
public GsonHttpMessageConverter gsonHttpMessageConverter(Gson gson) {
GsonHttpMessageConverter converter = new GsonHttpMessageConverter();
converter.setGson(gson); // 注入自定义 Gson
配置
return converter;
}
}
```
#### 二、高级
配置选项
1. **自定义序列化规则**
```java
@Bean
public Gson gson() {
return new GsonBuilder()
.registerTypeAdapter(LocalDateTime.class, new JsonSerializer<LocalDateTime>() {
@Override
public JsonElement serialize(LocalDateTime src, Type type, JsonSerializationContext context) {
return new JsonPrimitive(src.format(DateTimeFormatter.ISO_LOCAL_DATE_TIME));
}
})
.create();
}
```
2. **
配置转换器优先级**
```java
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Autowired
private GsonHttpMessageConverter gsonConverter;
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
// 确保 Gson 转换器优先于其他转换器
converters.add(0, gsonConverter);
}
}
```
#### 三、验证
配置效果
创建测试 Controller：
```java
@RestController
public class TestController {
@GetMapping("/user")
public User getUser() {
return new User("张三", 28, LocalDateTime.now());
}
@Data
@AllArgsConstructor
static class User {
private String name;
private Integer age;
private LocalDateTime createTime;
}
}
```
访问 `/user` 将返回 Gson 格式化的 JSON：
```json
{
"name": "张三",
"age": 28,
"createTime": "2023-08-15T14:30:45"
}
```
#### 四、
配置注意事项
1. **与 Jackson 共存问题**
- 若需同时保留 Jackson，需显式指定转换器顺序
- 在 `WebMvcConfigurer` 中手动排序：
```java
converters.add(new MappingJackson2HttpMessageConverter()); // Jackson
converters.add(gsonConverter); // Gson
```
2. **特殊格式处理**
| 数据类型 | Gson 默认行为 | 推荐
配置方法 |
|---------------|--------------------|--------------------------|
| 日期时间 | ISO-8601 格式 | `setDateFormat()` |
| null 字段 | 自动忽略 | `serializeNulls()` |
| HTML 特殊字符 | 自动转义 | `disableHtmlEscaping()` |
| 浮点数 | 可能丢失精度 | `setPrettyPrinting()` |
3. **性能优化建议**
- 使用 `GsonBuilder.create()` 重用 Gson 实例
- 启用缓存：`new GsonBuilder().enableComplexMapKeySerialization()`
- 对于大型对象启用流式处理
> **最佳实践**：生产环境建议通过 `@ConditionalOnMissingBean` 保证
配置唯一性[^2]：
> ```java
> @Bean
> @ConditionalOnMissingBean
> public GsonHttpMessageConverter gsonConverter() {...}
> ```
本文介绍了如何在SpringBoot中配置自定义消息转换器MappingJackson2HttpMessageConverter，并添加登录拦截器，简化了JSON数据的处理。
扫一扫
1537
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
