Spring Boot消息转换器使用错误：XML格式REST端点异常排查

你的POST端点期望处理XML请求并返回XML响应但无法正常工作，这大概率是消息转换器配置缺失、依赖不全或者实体类注解不完整导致的。下面给你一步步排查和解决的方案：

1. 先确认必要的依赖 #

Spring Boot处理XML需要对应的转换库支持，根据你偏好的技术选择：

如果你用JAXB（适配Java 8及以前，Java 9+需额外引入） #

在pom.xml中添加这些依赖：

<dependency>
    <groupId>javax.xml.bind</groupId>
    <artifactId>jaxb-api</artifactId>
    <version>2.3.1</version>
</dependency>
<dependency>
    <groupId>com.sun.xml.bind</groupId>
    <artifactId>jaxb-impl</artifactId>
    <version>2.3.1</version>
    <scope>runtime</scope>
</dependency>
<dependency>
    <groupId>com.sun.xml.bind</groupId>
    <artifactId>jaxb-core</artifactId>
    <version>2.3.0.1</version>
</dependency>
<dependency>
    <groupId>javax.activation</groupId>
    <artifactId>activation</artifactId>
    <version>1.1.1</version>
</dependency>

如果你用Jackson XML（更推荐，兼容Java 11+） #

添加Jackson的XML扩展依赖即可：

<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-xml</artifactId>
</dependency>

2. 给实体类添加正确的注解 #

不管用哪种转换库，你的MyRequest和MyResponseType都需要加对应的注解才能被正确解析和序列化：

JAXB风格注解 #

import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class MyRequest {
    // 你的字段、getter和setter
}

@XmlRootElement
public class MyResponseType {
    // 你的字段、getter和setter
}

Jackson XML风格注解（也兼容JAXB注解） #

import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;

@JacksonXmlRootElement(localName = "myRequest")
public class MyRequest {
    // 你的字段、getter和setter
}

@JacksonXmlRootElement(localName = "myResponseType")
public class MyResponseType {
    // 你的字段、getter和setter
}

3. 明确端点的请求/响应媒体类型 #

在@RequestMapping里指定consumes和produces为application/xml，告诉Spring该用XML转换器处理这个端点：

import org.springframework.http.MediaType;
import org.springframework.http.HttpStatus;

@RequestMapping(
    value = "/rest/v1/test/listener", 
    method = RequestMethod.POST,
    consumes = MediaType.APPLICATION_XML_VALUE,
    produces = MediaType.APPLICATION_XML_VALUE
)
public ResponseEntity<MyResponseType> processBooking(@RequestBody MyRequest myRequest) throws JAXBException {
    MyResponseType response = myService.process(myRequest);
    // ... 你的业务处理逻辑
    return new ResponseEntity<>(response, HttpStatus.OK);
}

4. 手动配置消息转换器（自动配置失效时用） #

如果上面的步骤都做完还是不行，可以手动注册XML转换器，确保Spring能识别到：

Jackson XML转换器配置类 #

import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.xml.MappingJackson2XmlHttpMessageConverter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import java.util.List;

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.add(new MappingJackson2XmlHttpMessageConverter());
    }
}

JAXB转换器配置类 #

import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import java.util.List;

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.add(new Jaxb2RootElementHttpMessageConverter());
    }
}

5. 检查客户端请求头 #

确保调用接口时，请求的Content-Type头是application/xml，同时Accept头包含application/xml——这两个头会告诉Spring该用什么格式处理请求和响应。

如果还是有问题，建议查看日志里的具体异常（比如HttpMessageNotReadableException），这类异常通常会明确指出转换失败的原因，比如XML格式错误、缺少某个注解等。

内容的提问来源于stack exchange，提问作者Saif Asif