Spring Boot 内容协商机制详解：从配置到调试
1. 内容协商基础概念
内容协商（Content Negotiation）是指服务器根据客户端的不同接受能力，返回相应媒体类型数据的能力。例如，若客户端HTTP请求携带Accept: application/xml，则服务器返回XML格式数据；若携带Accept: application/json，则返回JSON格式数据。核心处理类是AbstractJackson2HttpMessageConverter.java。
2. 环境准备
2.1 项目依赖配置
首先创建Maven项目并导入必要依赖：
<?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.rainbowsea</groupId>
<artifactId>springboot_jsonxml</artifactId>
<version>1.0-SNAPSHOT</version>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.5.3</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</dependencies>
</project>
2.2 实体Bean定义
定义Car和Monster两个实体类，使用Lombok简化代码：
// Car.java
package com.rainbowsea.bean;
import lombok.Data;
@Data
public class Car {
private String name;
private Double price;
}
// Monster.java
package com.rainbowsea.bean;
import lombok.*;
import org.springframework.stereotype.Component;
import java.util.*;
@Component
@Setter
@Getter
@ToString
@AllArgsConstructor
@NoArgsConstructor
public class Monster {
private Integer id;
private String name;
private Boolean isMarried;
private Integer age;
private Date birth;
private Car car;
private String[] skill;
private List<String> hobby;
private Map<String,Object> wife;
private Set<Double> salaries;
private Map<String, List<Car>> cars;
}
2.3 控制器编写
创建一个控制器，映射并返回Monster对象：
package com.rainbowsea.controller;
import com.rainbowsea.bean.Car;
import com.rainbowsea.bean.Monster;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import java.util.Date;
@Controller
public class ResponseController {
@GetMapping("/get/monster")
@ResponseBody
public Monster getMonster() {
Monster monster = new Monster();
monster.setId(100);
monster.setName("奔波霸");
monster.setAge(200);
monster.setIsMarried(false);
monster.setBirth(new Date());
Car car = new Car();
car.setName("奔驰");
car.setPrice(222.2);
monster.setCar(car);
return monster;
}
}
2.4 启动类
package com.rainbowsea;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
启动后访问http://localhost:8080/get/monster，初始返回JSON格式数据。
3. 内容协商工作原理
3.1 Accept头决定输出格式
返回的数据格式由HTTP请求头中的Accept字段决定。例如一个典型浏览器的Accept头：
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8
其中application/xml;q=0.9表示XML格式优先级为0.9，而*/*;q=0.8表示其他格式（含JSON）优先级为0.8。由于项目仅包含JSON库（由spring-boot-starter-web自动引入），因此即使Accept头中XML优先级更高，服务器无法输出XML，最终输出JSON。
为了验证这一点，可以在AbstractJackson2HttpMessageConverter.writeInternal()方法中设置断点进行调试，观察generator变量值为JSON。
3.2 引入XML依赖后的行为变化
在pom.xml中添加XML处理依赖：
<dependency>
<groupId>com.fasterxml.jackson.dataformat</groupId>
<artifactId>jackson-dataformat-xml</artifactId>
</dependency>
重启应用再次访问，输出变为XML格式。这是因为XML优先级（0.9）高于JSON（*/*对应的0.8）。调试时，generator变量将显示为XML。
4. 内容协商配置与扩展
4.1 启用基于请求参数的内容协商
浏览器无法直接修改Accept头，因此Spring Boot支持基于请求参数的内容协商。在application.yaml中开启：
spring:
mvc:
contentnegotiation:
favor-parameter: true # 启用请求参数内容协商
配置后，URL中可通过?format=json指定返回JSON，通过?format=xml指定返回XML。注意：参数名format是ParameterContentNegotiationStrategy类的默认参数名，不可随意更改。
4.2 自定义协商参数名
如需更换参数名（例如改为rainbowsea），可添加配置：
spring:
mvc:
contentnegotiation:
favor-parameter: true
parameter-name: rainbowsea # 自定义参数名，替代默认的format
此时URL应使用?rainbowsea=json或?rainbowsea=xml，默认的format参数失效。
5. 调试说明
若要深入了解内容协商的处理流程，建议在AbstractJackson2HttpMessageConverter.writeInternal()处设置断点。通过观察generator变量类型，可以确认最终输出的数据格式是JSON还是XML。此外，ParameterContentNegotiationStrategy类负责解析请求参数，其parameterName属性即为我们配置的参数名。
