JAX-RS 默认支持 xml 请求和响应,需实体类符合 JAXB 规范(含无参构造函数、@XmlRootElement 等)、显式声明 @Produces("application/xml") 和/或 @Consumes("application/xml"),且 java 9+ 需手动引入 Jakarta JAXB 依赖。
处理器(如 JAXBContext)、以及在接口方法上明确声明 @Produces("application/xml") 和/或 @Consumes("application/xml")。
实体类需符合 JAXB 规范
要让 JAX-RS 能自动将 Java 对象转为 XML(或反向),实体类必须是 JAXB 友好的:
- 类需有无参构造函数
- 字段或 getter/setter 需用
@XmlRootElement标记顶层类(如@XmlRootElement(name = "user")) - 可选地使用
@XmlElement控制字段名、是否必需、默认值等 - 避免使用无法序列化的类型(如
java.util.map原生类型需包装或自定义适配器)
示例:
@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"):
-
@Produces("application/xml"):告诉 JAX-RS 返回值应序列化为 XML 并设置响应头Content-Type: application/xml -
@Consumes("application/xml"):表示该方法接受 XML 请求体,并尝试用 JAXB 反序列化为对应 Java 类 - 两者可同时存在,也可单独使用
示例方法:
@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,需手动添加依赖:
- maven(Jakarta EE 版本,推荐):
<dependency> <groupId>jakarta.xml.bind</groupId> <artifactId>jakarta.xml.bind-api</artifactId> <version>4.0.0</version> </dependency> <dependency> <groupId>org.glassfish.jaxb</groupId> <artifactId>jaxb-runtime</artifactId> <version>4.0.4</version> </dependency>
- 若用 spring Boot 3+,它默认集成 Jakarta JAXB,无需额外配置
- 传统 Java EE 容器(如 WildFly、Payara)通常自带实现,不需额外引入
调试常见失败点
XML 处理失败常因以下原因: