vlambda博客
学习文章列表

REST（具象状态转移）是一种架构 style 用于创建网络服务。 REST 不是标准的，但它定义了由 Roy Fielding 定义的set 约束。六个约束如下：

统一接口是一个重要的约束，它定义了每个 REST 架构都应该具有以下元素：

我们将在以下主题中开发的 RESTful Web 服务遵循 REST 架构原则。

在 Spring Boot 中，所有 HTTP 请求都由控制器类处理。为了能够创建 RESTful Web 服务，首先，我们必须创建一个控制器类。我们将为控制器创建自己的 Java 包：

      package com.packt.cardatabase.web;

      import org.springframework.web.bind.annotation.RestController;

      @RestController
      public class CarController { 
      }

      package com.packt.cardatabase.web;

      import org.springframework.web.bind.annotation.RestController;

      @RestController
      public class CarController {
        @RequestMapping("/cars")
        public Iterable<Car> getCars() {

        } 
      }

getCars() 方法返回所有汽车对象，然后由 Jackson 库编组为 JSON 对象。

      package com.packt.cardatabase.web;

      import org.springframework.beans.factory.annotation.Autowired;
      import org.springframework.web.bind.annotation.RequestMapping;
      import org.springframework.web.bind.annotation.RestController;

      import com.packt.cardatabase.domain.Car;
      import com.packt.cardatabase.domain.CarRepository;

      @RestController
      public class CarController {
        @Autowired
        private CarRepository repository;

        @RequestMapping("/cars")
        public Iterable<Car> getCars() {
          return repository.findAll();
        }
      }

      // Owner.java

      @OneToMany(cascade = CascadeType.ALL, mappedBy="owner")
      @JsonIgnore
      private List<Car> cars;

我们已经完成了我们的第一个 RESTful Web 服务，它返回所有的汽车。 Spring Boot 提供了一种更强大的方式来创建 RESTful Web 服务，这将在下一个主题中进行研究。

Spring Data REST 是 Spring Data 项目的一部分。它提供了一种简单 和快速的方式来使用Spring 实现RESTful Web 服务。首先，使用 Spring Data REST，您必须将以下依赖项添加到 pom.xml 文件中：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-rest</artifactId>
</dependency>

默认情况下，Spring Data REST 从应用程序中查找所有公共存储库，并为您的实体自动创建 RESTful Web 服务。

您可以在 application.properties 文件中定义服务端点：

spring.data.rest.basePath=/api

现在您可以从 localhost:8080/api 端点访问 RESTful Web 服务。通过调用服务的根端点，它返回可用的资源。 Spring Data REST 在 HAL（超文本应用程序语言 ）格式。 HAL 格式 提供 一组用于在 JSON 中表达超链接的约定，它使您的 RESTful Web 服务更易于前端开发人员使用：

我们可以看到有汽车和车主实体服务的链接。 Spring Data Rest 服务路径名派生自实体名称。然后该名称将是复数形式且不大写。例如，实体 Car 服务路径名将命名为 cars。配置文件链接由 Spring Data Rest 生成，它包含特定于应用程序的元数据。

现在，我们开始更仔细地检查不同的服务。有多种工具可用于测试和使用 RESTful Web 服务。在本书中，我们使用 Postman，但您可以使用您熟悉的工具，例如 cURL。 Postman 可以作为桌面应用程序 或浏览器插件获取。通过使用 Windows Ubuntu Bash，cURL 也可用于 Windows 10。

如果你使用 cars端点http://localhost:8080/api/cars发出请求class="literal">GET 方法，您将获得所有 汽车的列表，如下图所示：

在 JSON 响应中，您可以看到有一个 cars 数组，每辆汽车都包含汽车特定的数据。所有的汽车还有 "_links" 属性，它是一个链接的集合，通过这些你可以访问汽车本身或获取汽车的所有者。要访问一辆特定的汽车，路径将是 http://localhost:8080/api/cars/{id}。

对 http://localhost:8080/api/cars/3/owner 的请求返回汽车的所有者。响应现在包含车主数据、车主链接以及用户拥有的其他 汽车的链接：

Spring Data Rest 服务提供所有 CRUD 操作。下表显示了可用于不同 CRUD 操作的 HTTP 方法：

接下来，我们将了解如何使用我们的 RESTful Web 服务从 database 中删除汽车。在删除操作中，您必须使用 DELETE 方法和要删除的汽车的链接（http://localhost: 8080/api/cars/{id}）。以下截图显示了如何使用 cURL 删除 ID 为4 的一辆汽车。 在删除请求之后，您可以看到现在剩下两辆汽车在数据库：

当我们要向数据库中添加一辆新车时，我们必须使用 POST方法，链接为http://localhost :8080/api/cars.标头必须包含  Content-Type 字段，其值为 Content-Type:application/json，新的汽车对象将嵌入到请求正文中：

响应将发回一个新创建的汽车对象。现在，如果您再次向 http://localhost:8080/api/cars 路径发出 GET 请求，可以看到数据库中存在新车：

要更新实体，我们必须使用 PATCH 方法和我们要更新的汽车的链接  (http://localhost:8080/api/cars/{id})。 标头必须包含 内容-Type 字段的值为Content-Type:application/json 以及带有编辑数据的汽车对象将在请求中给出身体。如果您使用 PATCH，您必须只发送更新的字段。如果您使用 PUT，则必须包含所有要请求的字段。让我们编辑我们在上一个示例中创建的汽车。我们将更改颜色为白色并填写我们留空的寄存器号。

我们还将使用所有者字段将所有者链接到汽车。所有者字段的内容是所有者的链接 (http://localhost:8080/api/owners/{id})。以下屏幕截图显示了 PATCH 请求内容：

使用 GET 请求获取所有汽车后，您可以看到汽车已更新：

在上一章中，我们创建了对存储库的查询。这些查询也可以包含在我们的服务中。要包含查询，您必须将 @RepositoryRestResource 注释添加到存储库类。查询参数使用 @Param 注释进行注释。以下源代码显示了我们的 CarRepository 带有这些注释：

package com.packt.cardatabase.domain;

import java.util.List;

import org.springframework.data.repository.CrudRepository;
import org.springframework.data.repository.query.Param;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;

@RepositoryRestResource
public interface CarRepository extends CrudRepository <Car, Long> {
  // Fetch cars by brand
  List<Car> findByBrand(@Param("brand") String brand);

  // Fetch cars by color
  List<Car> findByColor(@Param("color") String color);
}

现在，当您向 http://localhost:8080/api/cars 路径发出 GET请求时，您可以看到有一个名为 /search 的新端点。调用 http://localhost:8080/api/cars/search 路径返回以下响应：

从响应中，您可以看到这两个查询现在在我们的服务中可用。以下 URL 演示了如何按品牌获取汽车：

http://localhost:8080/api/cars/search/findByBrand?brand=Ford