贝利信息

JAX-RS (RESTful)如何处理XML请求和响应 @Produces("application/xml")

日期:2025-12-17 00:00 / 作者:煙雲
JAX-RS 默认支持 XML 请求和响应,需实体类符合 JAXB 规范(含无参构造函数、@XmlRootElement 等)、显式声明 @Produces("application/xml") 和/或 @Consumes("application/xml"),且 Java 9+ 需手动引入 Jakarta JAXB 依赖。

JAX-RS 默认支持 XML 请求和响应,但需满足几个关键条件:实体类必须可被 JAXB 序列化、正确配置消息体处理器(如 JAXBContext)、以及在接口方法上明确声明 @Produces("application/xml") 和/或 @Consumes("application/xml")

实体类需符合 JAXB 规范

要让 JAX-RS 能自动将 Java 对象转为 XML(或反向),实体类必须是 JAXB 友好的:

示例:

@XmlRootElement(name = "user")
public class User {
    private String name;
    private int age;

    public User() {} // 必须有

    @XmlElement
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }

    @XmlElement
    public int getAge() { return age; }
    public void setAge(int age) { this.age = age; }
}

@Produces 和 @Consumes 必须显式声明

仅加 @Produces("application/xml") 不足以处理入参 XML;若要接收 XML 请求体,还需 @Consumes("application/xml")

示例方法:

@POST
@Consumes("application/xml")
@Produces("application/xml")
public Response createUser(User user) {
    // user 已由 JAXB 从请求体解析完成
    user.setId(123);
    return Response.ok(user).build(); // 自动转为 XML 响应
}

确保运行时有 JAXB 实现(Java 9+ 特别注意)

Java 8 及以前内置 JAXB;但从 Java 9 开始模块化后,JAXB 被移出默认 classpath,Java 11+ 更是完全移除。若用较新 JDK,需手动添加依赖:


    jakarta.xml.bind
    jakarta.xml.bind-api
    4.0.0


    org.glassfish.jaxb
    jaxb-runtime
    4.0.4

调试常见失败点

XML 处理失败常因以下原因: