Spring mvc实现Restful返回xml格式数据实例详解

下面是关于“Spring MVC实现Restful返回XML格式数据实例详解”的完整攻略，包含两个示例说明。

Spring MVC实现Restful返回XML格式数据实例详解

在Java Web开发中，Spring MVC是一个非常流行的框架。在本文中，我们将介绍如何使用Spring MVC实现Restful返回XML格式数据。

步骤1：添加依赖

首先，我们需要在pom.xml文件中添加Spring MVC和Jackson的依赖。以下是一个简单的依赖示例：

<dependencies>
  <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>5.3.9</version>
  </dependency>
  <dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-core</artifactId>
    <version>2.12.4</version>
  </dependency>
  <dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.12.4</version>
  </dependency>
  <dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-xml</artifactId>
    <version>2.12.4</version>
  </dependency>
</dependencies>

步骤2：配置Spring MVC

接下来，我们需要在Spring MVC配置文件中配置Jackson。在src/main/resources目录下创建一个名为spring-servlet.xml的文件，并添加以下内容：

<beans xmlns="http://www.springframework.org/schema/"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
         http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
         http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
         http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">

  <context:component-scan base-package="com.example"/>

  <mvc:annotation-driven>
    <mvc:message-converters>
      <bean class="org.springframework.http.converter.xml.MappingJackson2XmlHttpMessageConverter">
        <property name="supportedMediaTypes" value="application/xml"/>
      </bean>
    </mvc:message-converters>
  </mvc:annotation-driven>

</beans>

在上面的配置文件中，我们使用了<context:component-scan>元素来扫描com.example包中的组件。我们还使用了<mvc:annotation-driven>元素来启用注解驱动的Spring MVC，并使用<mvc:message-converters>元素来配置Jackson的XML消息转换器。

示例1：返回XML格式数据

以下是一个示例，演示如何使用Spring MVC返回XML格式数据：

@RestController
@RequestMapping("/users")
public class UserController {

  @GetMapping("/{id}")
  public User getUser(@PathVariable Long id) {
    User user = new User();
    user.setId(id);
    user.setName("John Doe");
    user.setEmail("[e-mail]");
    return user;
  }

  @PostMapping
  public void createUser(@RequestBody User user) {
    // save user to database
  }

  @PutMapping("/{id}")
  public void updateUser(@PathVariable Long id, @RequestBody User user) {
    // update user in database
  }

  @DeleteMapping("/{id}")
  public void deleteUser(@PathVariable Long id) {
    // delete user from database
  }
}

在上面的示例中，我们使用了Spring MVC的@RestController注解来标记控制器，并使用@RequestMapping注解来指定请求路径。我们还使用了@GetMapping、@PostMapping、@PutMapping和@DeleteMapping注解来处理GET、POST、PUT和DELETE请求。我们还使用了@PathVariable注解来获取路径参数，并使用@RequestBody注解来获取请求体中的数据。最后，我们返回了一个User对象，它将被自动转换为XML格式数据。

示例2：自定义XML格式

以下是一个示例，演示如何自定义XML格式：

@RestController
@RequestMapping("/users")
public class UserController {

  @GetMapping(value = "/{id}", produces = "application/vnd.example+xml")
  public User getUser(@PathVariable Long id) {
    User user = new User();
    user.setId(id);
    user.setName("John Doe");
    user.setEmail("[e-mail]");
    return user;
  }

  @PostMapping(consumes = "application/vnd.example+xml")
  public void createUser(@RequestBody User user) {
    // save user to database
  }

  @PutMapping(value = "/{id}", consumes = "application/vnd.example+xml")
  public void updateUser(@PathVariable Long id, @RequestBody User user) {
    // update user in database
  }

  @DeleteMapping("/{id}")
  public void deleteUser(@PathVariable Long id) {
    // delete user from database
  }
}

在上面的示例中，我们使用了produces属性和consumes属性来指定自定义的XML格式。我们还使用了@RequestMapping注解的produces属性和consumes属性来指定自定义的XML格式。最后，我们返回了一个User对象，它将被自动转换为自定义的XML格式数据。