信息发布→ 登录 注册 退出

Spring Boot如何处理xml请求与响应 配置ContentNegotiationManager解析xml

发布时间:2025-11-13

点击量:
Spring Boot通过添加jackson-dataformat-xml依赖并配置ContentNegotiationManager,可实现根据请求头或参数自动返回XML或JSON。1. 添加Jackson XML依赖以支持XmlMapper;2. 配置WebMvcConfigurer启用内容协商,支持Accept头或format参数决定格式;3. 实体类可使用JAXB注解优化XML序列化;4. @RestController无需修改即可同时处理XML与JSON的请求和响应,实现无缝切换。

Spring Boot 默认使用 Jackson 处理 JSON,但要支持 XML 请求与响应,需要引入相关依赖并配置 ContentNegotiationManager,让 Spring 能根据请求头或扩展名自动选择返回 XML 或 JSON 格式。

1. 添加 Jackson XML 依赖

Spring Boot 使用 JacksonXmlModule 来处理 XML 序列化和反序列化。需在 pom.xml 中添加:


  com.fasterxml.jackson.dataformat
  jackson-dataformat-xml

该依赖提供 XmlMapper,Spring 会自动检测并用于 XML 数据绑定。

2. 启用 Web MVC 并配置 ContentNegotiationManager

如果使用自定义内容协商策略(如通过请求路径或参数决定返回格式),需配置 WebMvcConfigurer

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {

  @Override
  public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
    configurer.favorParameter(true)
        .parameterName("format")
        .defaultContentType(MediaType.APPLICATION_JSON)
        .mediaType("json", MediaType.APPLICATION_JSON)
        .mediaType("xml", MediaType.APPLICATION_XML);
  }

  @Bean
  public ContentNegotiationManager contentNegotiationManager() {
    List strategies = new ArrayList();
    strategies.add(new HeaderContentNegotiationStrategy()); // 默认按 Accept 头判断
    strategies.add(new ParameterContentNegotiationStrategy(
        MediaType.APPLICATION_JSON,
        MediaType.APPLICATION_XML));

    return new ContentNegotiationManager(strategies);
  }
}

这样可以通过以下方式触发 XML 响应:

  • 请求头:Accept: application/xml
  • 请求参数:?format=xml

3. 实体类添加 JAXB 注解(可选)

为确保 XML 序列化正确,实体类建议添加 javax.xml.bind.annotation 注解:

@XmlRootElement(name = "user")
public class User {
  private Long id;
  private String name;

  @XmlElement
  public Long getId() { return id; }

  @XmlElement
  public String getName() { return name; }

  // setter...
}

如果不加注解,Jackson XML 仍能工作,但控制粒度较弱。

4. 控制器示例

普通 @RestController 即可同时支持 JSON 和 XML:

@RestController
public class UserController {

  @GetMapping("/user/{id}")
  public User getUser(@PathVariable Long id) {
    return new User(id, "张三");
  }

  @PostMapping("/user")
  public User createUser(@RequestBody User user) {
    user.setId(1L);
    return user;
  }
}

发送 Content-Type: application/xml 的 POST 请求,Spring 会自动解析 XML 为对象;响应时根据协商结果输出 XML 或 JSON。

基本上就这些。只要依赖正确、配置好协商策略,Spring Boot 可无缝切换 XML 与 JSON 支持。不复杂但容易忽略注解和依赖。

标签:# class  # 仍能  # 绑定  # 但要  # 不加  # 可选  # 自定义  # 扩展名  # 可以通过  # 实体类  # 序列化  # 对象  # private  # public  # java  # void  # xml  # format  # String  # spring boot  # spring  # mvc  # lsp  # app  # go  # json  # js  
在线客服
服务热线

服务热线

4008888355

微信咨询
二维码
返回顶部
×二维码

截屏,微信识别二维码

打开微信

微信号已复制,请打开微信添加咨询详情!