如何在Spring Boot REST服务的XML响应中添加命名空间

你的配置未生效的核心原因是Spring Boot默认使用Jackson XML作为XML序列化实现，不原生支持JAXB的@XmlSchema等注解，可根据需求选择以下两种解决方案：

方案1：使用JAXB作为XML序列化实现（更推荐，对JAXB注解兼容性更好） #

• 第一步：引入JAXB相关依赖（Spring Boot 2.x及以上版本默认未内置JAXB，需手动引入）

<!-- JAXB API -->
<dependency>
    <groupId>javax.xml.bind</groupId>
    <artifactId>jaxb-api</artifactId>
    <version>2.3.1</version>
</dependency>
<!-- JAXB运行时实现 -->
<dependency>
    <groupId>org.glassfish.jaxb</groupId>
    <artifactId>jaxb-runtime</artifactId>
    <version>2.3.6</version>
    <scope>runtime</scope>
</dependency>

• 第二步：替换默认的XML消息转换器

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        // 移除默认的Jackson XML消息转换器
        converters.removeIf(converter -> converter instanceof MappingJackson2XmlHttpMessageConverter);
        // 注册JAXB消息转换器
        converters.add(new Jaxb2RootElementHttpMessageConverter());
    }
}

• 第三步：保留你原有的package-info.java配置，放在DTO类所在的包路径下即可

@XmlSchema(
    namespace = "http://www.aa.com/bb",
    elementFormDefault = XmlNsForm.QUALIFIED,
    xmlns = {
        @XmlNs(prefix = "ns1", namespaceURI = "http://www.aa.com/bb")
    }
)
package com.yourproject.dto;

import javax.xml.bind.annotation.XmlNs;
import javax.xml.bind.annotation.XmlNsForm;
import javax.xml.bind.annotation.XmlSchema;

• 第四步：在DTO类上添加@XmlRootElement注解

@Data
@XmlRootElement(name = "自定义根节点名", namespace = "http://www.aa.com/bb")
public class YourResponseDTO {
    // 配置了elementFormDefault = QUALIFIED后，字段会自动继承包级别的命名空间，无需单独配置
    private String field1;
    private Integer field2;
}

方案2：保留Jackson XML序列化实现，使用Jackson专属注解配置 #

如果不想替换原有消息转换器，可直接使用Jackson XML的命名空间注解配置：

• 单DTO单独配置示例：

@Data
@JacksonXmlRootElement(localName = "自定义根节点名", namespace = "http://www.aa.com/bb")
public class YourResponseDTO {
    @JacksonXmlProperty(localName = "field1", namespace = "http://www.aa.com/bb")
    private String field1;
    @JacksonXmlProperty(localName = "field2", namespace = "http://www.aa.com/bb")
    private Integer field2;
}

• 全局统一命名空间配置示例：

@Configuration
public class JacksonXmlConfig {
    @Bean
    public MappingJackson2XmlHttpMessageConverter xmlHttpMessageConverter() {
        XmlMapper xmlMapper = XmlMapper.builder()
            // 可自定义序列化逻辑，统一为所有字段添加指定命名空间
            .build();
        return new MappingJackson2XmlHttpMessageConverter(xmlMapper);
    }
}

内容的提问来源于stack exchange，提问作者Wally Liu