Spring Boot REST XML 教程 · ZetCode 中文系列教程

# Spring Boot REST XML 教程 > 原文： [http://zetcode.com/springboot/restxml/](http://zetcode.com/springboot/restxml/) Spring Boot REST XML 教程展示了如何在 Spring Boot RESTFul 應用中提供 XML 數據。我們為 RESTful 控制器創建測試方法。 Spring 是用于創建企業應用的流行 Java 應用框架。 Spring Boot 是 Spring 框架發展的下一步。它有助于以最小的努力創建獨立的，基于生產級的 Spring 應用。它提倡在 XML 配置上使用約定而不是配置原則。 ## RESTFul 應用 RESTFul 應用遵循 REST 架構樣式，該樣式用于設計網絡應用。 RESTful 應用生成對資源執行 CRUD（創建/讀取/更新/刪除）操作的 HTTP 請求。 RESTFul 應用通常以 JSON 或 XML 格式返回數據。可擴展標記語言（XML）是一種標記語言，它定義了一組規則，用于以人類可讀和機器可讀的格式對文檔進行編碼。 XML 通常用于應用之間的數據交換。 ## Spring Boot REST XML 示例以下應用是一個 Spring Boot RESTful 應用，它使用 Spring Data JPA 從 H2 數據庫返回 XML 格式的數據。 ```java $ tree . ├── pom.xml └── src ├── main │ ├── java │ │ └── com │ │ └── zetcode │ │ ├── Application.java │ │ ├── bean │ │ │ ├── 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 └── RestControllerTest.java ``` 這是項目結構。 `pom.xml` ```java <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.zetcode</groupId> <artifactId>springbootrestxml</artifactId> <version>1.0-SNAPSHOT</version> <packaging>jar</packaging> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>11</maven.compiler.source> <maven.compiler.target>11</maven.compiler.target> </properties> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.0.RELEASE</version> </parent> <dependencies> <dependency> <groupId>com.h2database</groupId> <artifactId>h2</artifactId> <scope>runtime</scope> </dependency> <dependency> <groupId>com.fasterxml.jackson.dataformat</groupId> <artifactId>jackson-dataformat-xml</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>javax.xml.bind</groupId> <artifactId>jaxb-api</artifactId> <version>2.3.1</version> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project> ``` 這是 Maven 構建文件。 `h2`依賴項包括 H2 數據庫驅動程序。 `jackson-dataformat-xml`添加了 Jackson XML 序列化器和反序列化器。 Spring Boot 啟動器是一組方便的依賴項描述符，可以極大地簡化 Maven 配置。 `spring-boot-starter-parent`具有 Spring Boot 應用的一些常用配置。 `spring-boot-starter-web`是使用 Spring MVC（包括 RESTFul 應用）構建 Web 應用的入門工具。它使用 Tomcat 作為默認的嵌入式容器。 `spring-boot-starter-data-jpa`是將 Spring Data JPA 與 Hibernate 結合使用的入門工具。 `spring-boot-starter-test`是使用包含 JUnit，Hamcrest 和 Mockito 的庫測試 Spring Boot 應用的入門程序。由于從 Java 11 中的 Java SE 中刪除了 JAXB API，因此我們需要添加`jaxb-api`依賴項。在`spring-boot-maven-plugin`提供了 Maven 的 Spring Boot 支持，使我們能夠打包可執行的 JAR 或 WAR 檔案。它的`spring-boot:run`目標運行 Spring Boot 應用。 `application.yml` ```java 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`目錄。 `City.java` ```java package com.zetcode.bean; import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty; import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement; import java.io.Serializable; import java.util.Objects; import javax.persistence.Entity; import javax.persistence.GeneratedValue; import javax.persistence.GenerationType; import javax.persistence.Id; import javax.persistence.Table; @Entity @Table(name = "CITIES") @JacksonXmlRootElement(localName = "City") public class City implements Serializable { 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 會創建這個實體表模式。 ```java @Entity @Table(name = "CITIES") @JacksonXmlRootElement(localName = "City") public class City implements Serializable { ``` `@Entity`注解指定該類是一個實體，并映射到數據庫表。 `@Table`注解指定要用于映射的數據庫表的名稱。使用`@JacksonXmlRootElement(localName = "City")`注解，我們為 XML 輸出根元素設置了名稱。 ```java @Id @GeneratedValue(strategy = GenerationType.IDENTITY) @JacksonXmlProperty(isAttribute = true) private Long id; ``` `@Id`注解指定實體的主鍵，`@GeneratedValue`提供生成主鍵值的策略。使用`@JacksonXmlProperty(isAttribute = true)`，我們將`id`設置為 XML 輸出中`City`元素的屬性。 ```java @JacksonXmlProperty private String name; @JacksonXmlProperty private int population; ``` 使用`@JacksonXmlProperty`，我們將`name`和`population`屬性設置為 XML 輸出中 City 元素的屬性。 `Cities.java` ```java package com.zetcode.bean; 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.Serializable; import java.util.ArrayList; import java.util.List; @JacksonXmlRootElement public class Cities implements Serializable { 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 輸出。 ```java @JacksonXmlProperty(localName = "City") @JacksonXmlElementWrapper(useWrapping = false) private List<City> cities = new ArrayList<>(); ``` 使用`@JacksonXmlProperty`和`@JacksonXmlElementWrapper`注解，我們確保`Cities`元素中嵌套了`ArrayList`城市對象的`City`元素。 `import.sql` ```java 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 表。 `CityRepository.java` ```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()`。這樣，我們節省了大量樣板代碼。 `ICityService.java` ```java package com.zetcode.service; import com.zetcode.bean.City; import com.zetcode.bean.Cities; import java.util.Optional; public interface ICityService { Cities findAll(); Optional<City> findById(Long id); } ``` `ICityService`提供了獲取所有城市并通過其 ID 獲得一個城市的契約方法。 `CityService.java` ```java package com.zetcode.service; import com.zetcode.bean.Cities; import com.zetcode.bean.City; import com.zetcode.repository.CityRepository; import java.util.List; import java.util.Optional; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; @Service public class CityService implements ICityService { @Autowired private CityRepository repository; @Override public Cities findAll() { var cities = (List<City>) repository.findAll(); var mycities = new Cities(); mycities.setCities(cities); return mycities; } @Override public Optional<City> findById(Long id) { var city = repository.findById(id); return city; } } ``` `CityService`包含`findAll()`和`findById()`方法的實現。我們使用存儲庫來處理數據。 ```java @Autowired private CityRepository repository; ``` 注入`CityRepository`。 ```java @Override public Cities findAll() { var cities = (List<City>) repository.findAll(); var mycities = new Cities(); mycities.setCities(cities); return mycities; } ``` 注意，`findAll()`方法返回`Cities` bean。 `MyController.java` ```java package com.zetcode.controller; import com.zetcode.bean.City; import com.zetcode.bean.Cities; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.RequestMapping; import com.zetcode.service.ICityService; import org.springframework.http.MediaType; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RestController; @RestController public class MyController { @Autowired private ICityService cityService; @RequestMapping(value="/cities", produces=MediaType.APPLICATION_XML_VALUE) public Cities findCities() { return cityService.findAll(); } @RequestMapping(value="/cities/{cityId}", produces=MediaType.APPLICATION_XML_VALUE) public City findCity(@PathVariable Long cityId) { var city = cityService.findById(cityId).get(); return city; } } ``` 這是 Spring Boot RESTful 應用的控制器類。 `@RestController`注解創建一個 RESTful 控制器。傳統的 MVC 控制器使用`ModelAndView`，而 RESTful 控制器僅返回對象，并且對象數據通常以 JSON 或 XML 格式直接寫入 HTTP 響應（通常）。 ```java @Autowired private ICityService cityService; ``` 我們在`countryService`字段中插入`ICityService`。 ```java @RequestMapping(value="/cities", produces=MediaType.APPLICATION_XML_VALUE) public Cities findCities() { return cityService.findAll(); } ``` 我們將帶有`/cities`路徑的請求映射到控制器的`findCities()`方法。默認請求是 GET 請求。通過使用`MediaType.APPLICATION_XML_VALUE`，Spring 使用了一個生成 XML 數據的消息轉換器。 ```java @RequestMapping(value="/cities/{cityId}", produces=MediaType.APPLICATION_XML_VALUE) public City findCity(@PathVariable Long cityId) { var city = cityService.findById(cityId).get(); return city; } ``` 在第二種方法中，我們返回一個特定的城市。 URL 路徑包含要檢索的城市的 ID；我們使用`@PathVariable`注解將 URL 模板變量綁定到`cityId`參數。 `RestControllerTest.java` ```java package com.zetcode.test; import java.util.List; import com.zetcode.bean.City; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; 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.http.*; import org.springframework.test.context.junit4.SpringRunner; import static org.assertj.core.api.Assertions.assertThat; import org.junit.Before; import org.springframework.beans.factory.annotation.Value; import org.springframework.core.ParameterizedTypeReference; @RunWith(SpringRunner.class) @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) public class RestControllerTest { @Autowired private TestRestTemplate restTemplate; @Value("http://localhost:${local.server.port}/${server.servlet.context-path}/cities") private String appPath; private City c1, c2, c3; @Before 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); assertThat(cities.getBody()).hasSize(8); assertThat(cities.getBody()).contains(this.c1, this.c2, this.c3); } @Test public void oneCity() { var city = this.restTemplate.getForObject(appPath + "/1/", City.class); assertThat(city).extracting("name", "population").containsExactly("Bratislava", 432000); } } ``` `RestControllerTest`包含兩種測試控制器方法的方法。 `Application.java` ```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`啟用自動配置和組件掃描。 ```java $ mvn spring-boot:run ``` 使用`mvn spring-boot:run`命令，運行應用。該應用部署在嵌入式 Tomcat 服務器上。 ```java $ 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`命令，我們可以獲得所有城市。 ```java $ 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 數據庫檢索數據。您可能也對相關教程感興趣： * [Spring Boot CSV 教程](/articles/springbootcsv/) * [Spring Boot Jersey 教程](/springboot/jersey/) * [Spring Boot RestTemplate 教程](/springboot/resttemplate/) * [Spring Boot H2 REST 教程](/articles/springbootresth2/) * [Spring Boot Thymeleaf 教程](/articles/springbootthymeleaf/) * [Spring Boot Mustache 教程](/articles/springbootmustache/) * [Spring Boot Swing 集成教程](/articles/springbootswing/) * [Spring Web 應用介紹](/articles/springwebfirst/) * [Spring Boot RESTFul 應用](/articles/springbootrestsimple/)