Spring Boot ResponseEntity

Spring Boot ResponseEntity 教程展示了如何在 Spring 应用中使用ResponseEntity。

Spring 是流行的 Java 应用框架，而 Spring Boot 是 Spring 的演进，可以帮助轻松地创建独立的，生产级的基于 Spring 的应用。

ResponseEntity

ResponseEntity代表 HTTP 响应，包括标头，正文和状态。 尽管@ResponseBody将返回值放入响应的正文中，但是ResponseEntity也允许我们添加标头和状态代码。

Spring Boot ResponseEntity示例

在以下应用中，我们演示ResponseEntity的用法。 该应用有两种方法：一种方法使用ResponseEntity创建 HTTP 响应，另一种方法@ResponseBody。

pom.xmlsrc├───main│   ├───java│   │   └───com│   │       └───zetcode│   │           │   Application.java│   │           ├───controller│   │           │       MyController.java│   │           └───model│   │                   Country.java│   └───resources│       └───static│               index.html└───test    └───java

这是 Spring 应用的项目结构。

pom.xml

<?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>responseentityex</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>org.springframework.boot</groupId>            <artifactId>spring-boot-starter-web</artifactId>        </dependency>    </dependencies>    <build>        <plugins>            <plugin>                <groupId>org.springframework.boot</groupId>                <artifactId>spring-boot-maven-plugin</artifactId>            </plugin>        </plugins>    </build></project>

这是 Maven pom.xml文件。 spring-boot-starter-parent是父 POM，它为使用 Maven 构建的应用提供依赖关系和插件管理。 spring-boot-starter-web是使用 Spring MVC 创建 Spring Boot Web 应用的依赖项。 spring-boot-maven-plugin将 Spring 应用打包到可执行的 JAR 或 WAR 归档文件中。

com/zetcode/model/Country.java

package com.zetcode.model;public class Country {    private String name;    private int population;    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;    }}

这是Country bean。 它具有两个属性：name和population。

com/zetcode/controller/MyController.java

package com.zetcode.controller;import com.zetcode.bean.Country;import org.springframework.http.HttpHeaders;import org.springframework.http.ResponseEntity;import org.springframework.stereotype.Controller;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.ResponseBody;@Controllerpublic class MyController {    @RequestMapping(value = "/getCountry")    public ResponseEntity<Country> getCountry() {        var c = new Country();        c.setName("France");        c.setPopulation(66984000);        var headers = new HttpHeaders();        headers.add("Responded", "MyController");        return ResponseEntity.accepted().headers(headers).body(c);    }    @RequestMapping(value = "/getCountry2")    @ResponseBody    public Country getCountry2() {        var c = new Country();        c.setName("France");        c.setPopulation(66984000);        return c;    }    }

控制器包含两种方法。 第一个使用ResponseEntity，第二个使用@ResponseBody。

@RequestMapping(value = "/getCountry")public ResponseEntity<Country> getCountry() {

getCountry()方法映射到getCountry URL 模式； 它返回类型为Country的ResponseEntity。

var c = new Country();c.setName("France");c.setPopulation(66984000);

我们创建一个Country bean； 此 bean 在响应中返回。

var headers = new HttpHeaders();headers.add("Responded", "MyController");

我们创建HttpHeaders的实例并添加新的标头值。

return ResponseEntity.accepted().headers(headers).body(c);

返回ResponseEntity。 我们给ResponseEntity一个自定义状态代码，标头和正文。

@RequestMapping(value = "/getCountry2")@ResponseBodypublic Country getCountry2() {    var c = new Country();    c.setName("France");    c.setPopulation(66984000);    return c;}  

使用@ResponseBody，仅返回正文。 标题和状态代码由 Spring 提供。

resources/static/index.html

<!DOCTYPE html><html>    <head>        <title>Home page</title>        <meta charset="UTF-8">        <meta name="viewport" content="width=device-width, initial-scale=1.0">    </head>    <body>        <p>            <a href="getCountry">Get country 1</a>        </p>        <p>            <a href="getCountry2">Get country 2</a>        </p>            </body></html>

这是主页。 它包含两个链接。

com/zetcode/Application.java

package com.zetcode;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplicationpublic class Application  {    public static void main(String[] args) {        SpringApplication.run(Application.class, args);    }}

Application是设置 Spring Boot 应用的入口。

$ curl localhost:8080/getCountry -IHTTP/1.1 202Responded: MyControllerContent-Type: application/json;charset=UTF-8Transfer-Encoding: chunkedDate: Thu, 17 Jan 2019 21:40:49 GMT

调用第一个方法时，我们可以看到选择的 202 状态代码和自定义标头值。

在本教程中，我们展示了如何在 Spring 应用中使用ResponseEntity。