Springboot集成JAXB返回xml格式

 更新时间:2024年12月24日 15:44:33   作者:考虑考虑  
这篇文章主要为大家详细介绍了Springboot如何集成JAXB返回xml格式,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下

前言

Springboot可以返回xml数据格式

xml数据格式

本文使用的是Springboot3.4.x版本以上以及jdk17以上,由于在JDK9版本以后javax包被移动并更名为 jakarta,因此使用包如下

<!-- https://mvnrepository.com/artifact/jakarta.xml.bind/jakarta.xml.bind-api -->
<dependency>
    <groupId>jakarta.xml.bind</groupId>
    <artifactId>jakarta.xml.bind-api</artifactId>
    <version>4.0.2</version>
</dependency>

<!-- https://mvnrepository.com/artifact/org.glassfish.jaxb/jaxb-runtime -->
<dependency>
    <groupId>org.glassfish.jaxb</groupId>
    <artifactId>jaxb-runtime</artifactId>
    <version>4.0.5</version>
</dependency>

实体类配置

import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class User {

    @XmlElement
    private Long id;

    @XmlElement
    private String userName;

    @XmlElement
    private Integer age;


    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public User(Long id, String userName, Integer age) {
        this.id = id;
        this.userName = userName;
        this.age = age;
    }


    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", userName='" + userName + ''' +
                ", age=" + age +
                '}';
    }
}

接口层配置

@RestController
public class UserController {

    @GetMapping(value = "/getJson", produces = MediaType.APPLICATION_JSON_VALUE)
    public User getJson() {
        User user = new User(2L, "asdas1", 15);
        return user;
    }


    @GetMapping(value = "/getXml", produces = MediaType.APPLICATION_XML_VALUE)
    public User getXml() {
        User user = new User(1L, "hello", 12);
        return user;
    }
}

xml返回

一开始,调用

http://ip:端口/getXml

抛出异常,异常如下

后面调试源码异常信息,发现需要一个无参构造器,因此在实体类加上无参构造函数

import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class User {

    @XmlElement
    private Long id;

    @XmlElement
    private String userName;

    @XmlElement
    private Integer age;


    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public User() {
        
    }

    public User(Long id, String userName, Integer age) {
        this.id = id;
        this.userName = userName;
        this.age = age;
    }


    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", userName='" + userName + ''' +
                ", age=" + age +
                '}';
    }
}

然后调用接口发觉还是异常

然后发觉异常信息为

发觉该包会从成员变量以及get方法中获取变量,因此重复了,就异常了,

解决方法如下

更改get方法名称

import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class User {

    @XmlElement
    private Long id;

    @XmlElement
    private String userName;

    @XmlElement
    private Integer age;


    public Long getId1() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getUserName1() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public Integer getAge1() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public User() {

    }

    public User(Long id, String userName, Integer age) {
        this.id = id;
        this.userName = userName;
        this.age = age;
    }


    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", userName='" + userName + ''' +
                ", age=" + age +
                '}';
    }
}

访问之后返回

使用@XmlAccessorType

@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class User {

    @XmlElement
    private Long id;

    @XmlElement
    private String userName;

    @XmlElement
    private Integer age;


    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public User() {

    }

    public User(Long id, String userName, Integer age) {
        this.id = id;
        this.userName = userName;
        this.age = age;
    }


    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", userName='" + userName + ''' +
                ", age=" + age +
                '}';
    }
}

在类上加上 @XmlAccessorType(XmlAccessType.FIELD) 注解,加上此注解后,xml的访问类型为成员变量,而不是getter/setter方法

备注: 返回xml时,需要加上这个

 produces = MediaType.APPLICATION_XML_VALUE

以上就是Springboot集成JAXB返回xml格式的详细内容,更多关于Springboot集成JAXB返回xml的资料请关注脚本之家其它相关文章!

相关文章

  • 深入探究MyBatis插件机制灵活扩展及自定义增强框架能力

    深入探究MyBatis插件机制灵活扩展及自定义增强框架能力

    这篇文章主要介绍了深入探究MyBatis插件机制灵活扩展及自定义增强框架能力
    2024-01-01
  • Java enum 对枚举元素的赋值和取值方式

    Java enum 对枚举元素的赋值和取值方式

    这篇文章主要介绍了Java enum 对枚举元素的赋值和取值方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-05-05
  • java 实现截取字符串并按字节分别输出实例代码

    java 实现截取字符串并按字节分别输出实例代码

    这篇文章主要介绍了java 实现截取字符串并按字节分别输出实例代码的相关资料,需要的朋友可以参考下
    2017-03-03
  • Mybatis如何解决sql中like通配符模糊匹配问题

    Mybatis如何解决sql中like通配符模糊匹配问题

    这篇文章主要介绍了Mybatis如何解决sql中like通配符模糊匹配问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-01-01
  • Java Mybatis框架多表操作与注解开发详解分析

    Java Mybatis框架多表操作与注解开发详解分析

    MyBatis 是一款优秀的持久层框架,它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO为数据库中的记录
    2021-10-10
  • SpringBoot+Caffeine+Redis实现多级缓存的方法

    SpringBoot+Caffeine+Redis实现多级缓存的方法

    多级缓存是指在系统中部署多层功能互补的缓存组件,让请求按照预设顺序依次访问各层缓存,仅当所有缓存层均未命中时,才访问底层数据库的架构模式,这篇文章主要介绍了SpringBoot+Caffeine+Redis实现多级缓存的方法,需要的朋友可以参考下
    2026-02-02
  • Java服务刚启动时接口超时排查全过程

    Java服务刚启动时接口超时排查全过程

    这篇文章主要为大家介绍了Java服务刚启动时,一小波接口超时排查全过程,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-07-07
  • Maven打包之解决没有依赖jar包问题及分析

    Maven打包之解决没有依赖jar包问题及分析

    用户使用Maven打包FTPServer程序时,因未配置依赖打包导致jar体积过小且运行报错,解决方法是添加maven-assembly插件生成包含依赖的jar包,确保程序正常运行
    2025-09-09
  • Java大文件分片上传超详细教程(minio版)

    Java大文件分片上传超详细教程(minio版)

    Minio是一个开源的分布式对象存储系统,它允许用户在存储服务上存储和检索数据,下面这篇文章主要给大家介绍了关于Java大文件分片上传(minio版)的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2024-08-08
  • JDBC数据库连接步骤解析

    JDBC数据库连接步骤解析

    这篇文章主要介绍了JDBC数据库连接步骤解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-02-02

最新评论