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

煙雲
发布: 2025-12-17 08:05:02
原创
664人浏览过
JAX-RS 默认支持 XML 请求和响应,需实体类符合 JAXB 规范(含无参构造函数、@XmlRootElement 等)、显式声明 @Produces("application/xml") 和/或 @Consumes("application/xml"),且 Java 9+ 需手动引入 Jakarta JAXB 依赖。

jax-rs (restful)如何处理xml请求和响应 @produces(\

JAX-RS 默认支持 XML 请求和响应,但需满足几个关键条件:实体类必须可被 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")

Getsound
Getsound

基于当前天气条件生成个性化音景音乐

Getsound 212
查看详情 Getsound
  • @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 处理失败常因以下原因:

  • HTTP 状态码 400 或 415:检查请求头 Content-Type: application/xml 是否准确发送
  • 返回空响应或 500:确认实体类有 @XmlRootElement,且所有嵌套对象也满足 JAXB 要求
  • 字段为空或忽略:检查 getter/setter 是否 public,或是否误用了 @XmlTransient
  • 中文乱码:确保客户端和服务端都指定 UTF-8(JAX-RS 默认使用 UTF-8,但 Tomcat 等容器可能需额外配置 URIEncoding="UTF-8"

以上就是JAX-RS (RESTful)如何处理XML请求和响应 @Produces("application/xml")的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号