ZetCode

Spring Boot REST XML

最后修改于 2023 年 8 月 2 日

在本文中，我们将展示如何在Spring Boot RESTful应用程序中提供XML数据。我们为RESTful控制器创建测试方法。

Spring 是一个流行的 Java 应用程序框架，用于创建企业级应用程序。Spring Boot 是 Spring 框架演进的下一步。它有助于以最少的努力创建独立的、生产级的基于 Spring 的应用程序。它提倡使用约定优于配置的原则，而不是 XML 配置。

RESTful 应用程序

RESTful 应用程序遵循 REST 架构风格，用于设计网络应用程序。RESTful 应用程序生成 HTTP 请求，对资源执行 CRUD（创建/读取/更新/删除）操作。RESTful 应用程序通常以 JSON 或 XML 格式返回数据。

可扩展标记语言 (XML) 是一种标记语言，它定义了一组规则，用于以人类可读和机器可读的格式对文档进行编码。XML 经常用于应用程序之间的数据交换。

Spring Boot REST XML 示例

以下应用程序是一个 Spring Boot RESTful 应用程序，它使用 Spring Data JPA 从 H2 数据库以 XML 格式返回数据。

build.gradle
...
src
├── main
│   ├── java
│   │   └── com
│   │       └── zetcode
│   │           ├── Application.java
│   │           ├── model
│   │           │   ├── Cities.java
│   │           │   └── City.java
│   │           ├── controller
│   │           │   └── MyController.java
│   │           ├── repository
│   │           │   └── CityRepository.java
│   │           └── service
│   │               ├── CityService.java
│   │               └── ICityService.java
│   └── resources
│       ├── application.yml
│       └── import.sql
└── test
    └── java
        └── com
            └── zetcode
                └── test
                    └── MyControllerTest.java

这是项目结构。

build.gradle 
plugins {
    id 'org.springframework.boot' version '3.1.1'
    id 'io.spring.dependency-management' version '1.1.0'
    id 'java'
}

group = 'com.zetcode'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '17'

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-xml'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
    runtimeOnly 'com.h2database:h2'
}

test {
    useJUnitPlatform()
}

这是 Gradle 构建文件。h2 依赖项包含 H2 数据库驱动程序。jackson-dataformat-xml 添加了 Jackson XML 序列化器和反序列化器。

spring-boot-starter-web 是一个用于使用 Spring MVC 构建 Web 应用程序的启动器，包括 RESTful 应用程序。它使用 Tomcat 作为默认的嵌入式容器。

spring-boot-starter-data-jpa 是一个用于将 Spring Data JPA 与 Hibernate 一起使用的启动器。spring-boot-starter-test 是一个用于使用 JUnit、Hamcrest 和 Mockito 等库测试 Spring Boot 应用程序的启动器。

resources/application.yml 
server:
  port: 8086
  servlet:
    context-path: /rest

spring:
  main:
    banner-mode: "off"
jpa:
    database: h2
    hibernate:
    dialect: org.hibernate.dialect.H2Dialect
    ddl-auto: create-drop

logging:
  level:
    org:
    springframework: ERROR

在 application.yml 文件中，我们编写了 Spring Boot 应用程序的各种配置设置。port 设置服务器端口，context-path 设置上下文路径（应用程序名称）。进行这些设置后，我们通过 localhost:8086/rest/ 访问应用程序。使用 banner-mode 属性，我们关闭了 Spring 标语。

JPA 的 database 值指定要操作的目标数据库。我们指定了 Hibernate 方言，在本例中为 org.hibernate.dialect.H2Dialect。ddl-auto 是数据定义语言模式；create-drop 选项会自动创建和删除数据库模式。

H2 数据库在内存中运行。此外，我们将 Spring 框架的日志级别设置为 ERROR。application.yml 文件位于 src/main/resources 目录中。

com/zetcode/model/City.java 
package com.zetcode.model;

import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;
import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.persistence.Id;
import jakarta.persistence.Table;

import java.io.Serial;
import java.io.Serializable;
import java.util.Objects;

@Entity
@Table(name = "cities")
@JacksonXmlRootElement(localName = "City")
public class City implements Serializable {

    @Serial
    private static final long serialVersionUID = 21L;

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @JacksonXmlProperty(isAttribute = true)
    private Long id;

    @JacksonXmlProperty
    private String name;

    @JacksonXmlProperty
    private int population;

    public City() {
    }

    public City(Long id, String name, int population) {
        this.id = id;
        this.name = name;
        this.population = population;
    }

    public Long getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getPopulation() {
        return population;
    }

    public void setPopulation(int population) {
        this.population = population;
    }

    @Override
    public String toString() {
        return "City{" + "id=" + id + ", name=" + name
                + ", population=" + population + '}';
    }

    @Override
    public int hashCode() {
        int hash = 5;
        hash = 37 * hash + Objects.hashCode(this.id);
        hash = 37 * hash + Objects.hashCode(this.name);
        hash = 37 * hash + this.population;
        return hash;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final City other = (City) obj;
        if (this.population != other.population) {
            return false;
        }
        if (!Objects.equals(this.name, other.name)) {
            return false;
        }

        return Objects.equals(this.id, other.id);
    }
}

这是 City 实体。每个实体必须至少定义两个注解：@Entity 和 @Id。之前，我们已将 ddl-auto 选项设置为 create-drop，这意味着 Hibernate 将从此实体创建表模式。

@Entity
@Table(name = "cities")
@JacksonXmlRootElement(localName = "City")
public class City implements Serializable {

@Entity 注解指定该类是一个实体，并映射到数据库表。@Table 注解指定用于映射的数据库表的名称。使用 @JacksonXmlRootElement(localName = "City") 注解，我们设置 XML 输出根元素的名称。

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@JacksonXmlProperty(isAttribute = true)
private Long id;

@Id 注解指定实体的**主键**，@GeneratedValue 提供了生成主键值的策略。使用 @JacksonXmlProperty(isAttribute = true)，我们将 id 设置为 XML 输出中 City 元素的属性。

@JacksonXmlProperty
private String name;

@JacksonXmlProperty
private int population;

使用 @JacksonXmlProperty，我们将 name 和 population 属性设置为 XML 输出中 City 元素的属性。

com/zetcode/model/Cities.java 
package com.zetcode.model;

import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;

import java.io.Serial;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

@JacksonXmlRootElement
public class Cities implements Serializable {

    @Serial
    private static final long serialVersionUID = 22L;

    @JacksonXmlProperty(localName = "City")
    @JacksonXmlElementWrapper(useWrapping = false)
    private List<City> cities = new ArrayList<>();

    public List<City> getCities() {
        return cities;
    }

    public void setCities(List<City> cities) {
        this.cities = cities;
    }
}

Cities bean 是一个帮助 bean，用于获得更好的 XML 输出。

@JacksonXmlProperty(localName = "City")
@JacksonXmlElementWrapper(useWrapping = false)
private List<City> cities = new ArrayList<>();

使用 @JacksonXmlProperty 和 @JacksonXmlElementWrapper 注解，我们确保在 Cities 元素中嵌套 City 元素，用于一个城市对象 ArrayList。

resources/import.sql 
INSERT INTO cities(name, population) VALUES('Bratislava', 432000);
INSERT INTO cities(name, population) VALUES('Budapest', 1759000);
INSERT INTO cities(name, population) VALUES('Prague', 1280000);
INSERT INTO cities(name, population) VALUES('Warsaw', 1748000);
INSERT INTO cities(name, population) VALUES('Los Angeles', 3971000);
INSERT INTO cities(name, population) VALUES('New York', 8550000);
INSERT INTO cities(name, population) VALUES('Edinburgh', 464000);
INSERT INTO cities(name, population) VALUES('Berlin', 3671000);

模式由 Hibernate 自动创建；稍后，执行 import.sql 文件以用数据填充 H2 表。

com/zetcode/repository/CityRepository.java 
package com.zetcode.repository;

import com.zetcode.bean.City;
import org.springframework.data.repository.CrudRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface CityRepository extends CrudRepository<City, Long> {

}

通过扩展 Spring 的 CrudRepository，我们将为我们的数据存储库实现一些方法，包括 findAll 和 findById。通过这种方式，我们节省了大量样板代码。

com/zetcode/service/ICityService.java 
package com.zetcode.service;

import com.zetcode.model.Cities;
import com.zetcode.model.City;

public interface ICityService {

    Cities findAll();
    City findById(Long id);
}

ICityService 提供了获取所有城市和通过其 Id 获取一个城市的契约方法。

com/zetcode/service/CityService.java 
package com.zetcode.service;

import com.zetcode.model.Cities;
import com.zetcode.model.City;
import com.zetcode.repository.CityRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class CityService implements ICityService {

    private final CityRepository repository;

    @Autowired
    public CityService(CityRepository repository) {
        this.repository = repository;
    }

    @Override
    public Cities findAll() {

        var cities = (List<City>) repository.findAll();
        var mycities = new Cities();
        mycities.setCities(cities);

        return mycities;
    }

    @Override
    public City findById(Long id) {

        return repository.findById(id).orElse(new City());
    }
}

CityService 包含 findAll 和 findById 方法的实现。我们使用存储库来处理数据。

private final CityRepository repository;

@Autowired
public CityService(CityRepository repository) {
    this.repository = repository;
}

CityRepository 被注入。

@Override
public Cities findAll() {

    var cities = (List<City>) repository.findAll();
    var mycities = new Cities();
    mycities.setCities(cities);

    return mycities;
}

请注意，findAll 方法返回 Cities bean。

@Override
public City findById(Long id) {

    return repository.findById(id).orElse(new City());
}

findById 服务方法调用存储库的 findById 方法以通过其 Id 获取城市；如果未找到城市，则返回一个空的城市。

com/zetcode/controller/MyController.java 
package com.zetcode.controller;

import com.zetcode.model.Cities;
import com.zetcode.model.City;
import com.zetcode.service.ICityService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    private final ICityService cityService;

    @Autowired
    public MyController(ICityService cityService) {
        this.cityService = cityService;
    }

    @GetMapping(value = "/cities", produces = MediaType.APPLICATION_XML_VALUE)
    public Cities findCities() {

        return cityService.findAll();
    }

    @GetMapping(value = "/cities/{cityId}", produces = MediaType.APPLICATION_XML_VALUE)
    public City findCity(@PathVariable Long cityId) {

        return cityService.findById(cityId);
    }
}

这是 Spring Boot RESTful 应用程序的控制器类。@RestController 注解创建一个 RESTful 控制器。虽然传统的 MVC 控制器使用 ModelAndView，但 RESTful 控制器仅返回对象，并且对象数据直接写入 HTTP 响应（通常）为 JSON 或 XML 格式。

private final ICityService cityService;

@Autowired
public MyController(ICityService cityService) {
    this.cityService = cityService;
}

我们将 ICityService 注入到 cityService 字段中。

@GetMapping(value="/cities", produces=MediaType.APPLICATION_XML_VALUE)
public Cities findCities() {

    return cityService.findAll();
}

我们将具有 /cities 路径的请求映射到控制器的 findCities 方法。默认请求是 GET 请求。通过使用 MediaType.APPLICATION_XML_VALUE，Spring 使用产生 XML 数据的消息转换器。

@GetMapping(value="/cities/{cityId}", produces=MediaType.APPLICATION_XML_VALUE)
public City findCity(@PathVariable Long cityId) {

    return cityService.findById(cityId);
}

在第二种方法中，我们返回一个特定的城市。URL 路径包含要检索的城市的 Id；我们使用 @PathVariable 注解将 URL 模板变量绑定到 cityId 参数。

com/zetcode/test/MyControllerTest.java 
package com.zetcode.test;

import com.zetcode.model.City;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.core.ParameterizedTypeReference;
import org.springframework.http.HttpMethod;

import java.util.List;

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
public class MyControllerTest {

    @Autowired
    private TestRestTemplate restTemplate;

    @Value("https://:${local.server.port}/${server.servlet.context-path}/cities")
    private String appPath;

    private City c1, c2, c3;

    @BeforeEach
    public void setUp() {

        this.c1 = new City(1L, "Bratislava", 432000);
        this.c2 = new City(2L, "Budapest", 1759000);
        this.c3 = new City(3L, "Prague", 1280000);
    }

    @Test
    public void allCitiesTest() {

        var paramType = new ParameterizedTypeReference<List<City>>() { };
        var cities = restTemplate.exchange(appPath, HttpMethod.GET, null, paramType);

        Assertions.assertThat(cities.getBody()).hasSize(8);
        Assertions.assertThat(cities.getBody()).contains(this.c1, this.c2, this.c3);
    }

    @Test
    public void oneCity() {

        var city = this.restTemplate.getForObject(appPath + "/1", City.class);
        Assertions.assertThat(city).extracting("name", "population").containsExactly("Bratislava",
                432000);
    }
}

MytControllerTest 包含两个用于测试控制器方法的测试方法。

com/zetcode/Application.java 
package com.zetcode;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

Application 设置了 Spring Boot 应用程序。@SpringBootApplication 启用了自动配置和组件扫描。

$ ./gradlew bootRun

使用 ./gradlew bootRun 命令，我们运行应用程序。该应用程序部署在嵌入式 Tomcat 服务器上。

$ curl localhost:8086/rest/cities
<Cities>
<City id="1"><name>Bratislava</name><population>432000</population></City>
<City id="2"><name>Budapest</name><population>1759000</population></City>
<City id="3"><name>Prague</name><population>1280000</population></City>
<City id="4"><name>Warsaw</name><population>1748000</population></City>
<City id="5"><name>Los Angeles</name><population>3971000</population></City>
<City id="6"><name>New York</name><population>8550000</population></City>
<City id="7"><name>Edinburgh</name><population>464000</population></City>
<City id="8"><name>Berlin</name><population>3671000</population></City>
</Cities>

使用 curl 命令，我们可以获取所有城市。

$ curl localhost:8086/rest/cities/1
<City id="1"><name>Bratislava</name><population>432000</population></City>

在这里，我们获取一个由其 Id 标识的城市。

在本文中，我们从 Spring Boot RESTful 应用程序以 XML 格式将数据返回给客户端。我们使用 Spring Data JPA 从 H2 数据库检索数据。

作者

我的名字是 Jan Bodnar，我是一位热情的程序员，拥有丰富的编程经验。自 2007 年以来，我一直在撰写编程文章。到目前为止，我已经撰写了 1,400 多篇文章和 8 本电子书。我拥有超过十年的编程教学经验。

列出 所有 Spring Boot 教程。