Spring认证中国教育管理中心-Spring Data REST框架教程二

最新推荐文章于 2022-03-25 23:44:57 发布

原创最新推荐文章于 2022-03-25 23:44:57 发布 · 246 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java

Spring Professional认证专栏收录该内容

102 篇文章

订阅专栏

本文档详细介绍了Spring Data REST框架中馆藏资源、物品资源、协会资源、搜索资源和查询方法资源对HTTP方法的支持，包括GET、POST、PUT、PATCH和DELETE。内容涵盖了方法的使用、自定义状态代码、媒体类型以及相关资源。此外，还讨论了分页和排序功能。

原标题：Spring认证中国教育管理中心-Spring Data REST框架教程二（Spring中国教育管理中心）

4.2.馆藏资源

Spring Data REST 公开了一个以导出存储库正在处理的域类的非大写复数版本命名的集合资源。资源的名称和路径都可以通过@RepositoryRestResource在存储库界面上使用来自定义。

4.2.1.支持的 HTTP 方法

集合资源同时支持GET和POST. 所有其他 HTTP 方法都会导致405 Method Not Allowed.

GET

通过其findAll(…)方法返回存储库服务器的所有实体。如果存储库是分页存储库，我们会在必要时包含分页链接和其他页面元数据。

用于调用的方法

如果存在，则使用以下方法（降序）：

findAll(Pageable)
findAll(Sort)
findAll()

有关方法默认公开的更多信息，请参阅存储库方法公开。

参数

如果存储库具有分页功能，则资源采用以下参数：

page: 要访问的页码（0 索引，默认为 0）。
size：请求的页面大小（默认为 20）。
sort: 格式为($propertyname,)+[asc|desc]?的排序指令的集合。

自定义状态代码

该GET方法只有一个自定义状态代码：

405 Method Not Allowed：如果findAll(…)方法未导出（通过@RestResource(exported = false)）或不存在于存储库中。

支持的媒体类型

该GET方法支持以下媒体类型：

application/hal+json
application/json

HEAD

该HEAD方法返回集合资源是否可用。它没有状态代码、媒体类型或相关资源。

用于调用的方法

如果存在，则使用以下方法（降序）：

findAll(Pageable)
findAll(Sort)
findAll()

有关方法默认公开的更多信息，请参阅存储库方法公开。

POST

该POST方法从给定的请求正文创建一个新实体。默认情况下，响应是否包含正文由Accept随请求发送的标头控制。如果发送了一个，则会创建一个响应正文。如果不是，则响应正文为空，并且可以通过以下Location响应标头中包含的链接获取所创建资源的表示。可以通过相应的配置来覆盖此行为
RepositoryRestConfiguration.setReturnBodyOnCreate(…)。

用于调用的方法

如果存在，则使用以下方法（降序）：

save(…)

有关方法默认公开的更多信息，请参阅存储库方法公开。

自定义状态代码

该POST方法只有一个自定义状态代码：

405 Method Not Allowed：如果save(…)方法未导出（通过@RestResource(exported = false)）或根本不存在于存储库中。

支持的媒体类型

该POST方法支持以下媒体类型：

应用程序/hal+json
应用程序/json

4.3.物品资源

Spring Data REST 将单个集合项的资源公开为集合资源的子资源。

4.3.1.支持的 HTTP 方法

项目资源通常支持GET、PUT、PATCH和DELETE，除非显式配置阻止（请参阅“关联资源”了解详细信息）。

得到

该GET方法返回单个实体。

用于调用的方法

如果存在，则使用以下方法（降序）：

findById(…)

有关方法默认公开的更多信息，请参阅存储库方法公开。

自定义状态代码

该GET方法只有一个自定义状态代码：

405 Method Not Allowed：如果findOne(…)方法未导出（通过@RestResource(exported = false)）或不存在于存储库中。

支持的媒体类型

该GET方法支持以下媒体类型：

应用程序/hal+json
应用程序/json

HEAD

该HEAD方法返回项目资源是否可用。它没有状态代码、媒体类型或相关资源。

用于调用的方法

如果存在，则使用以下方法（降序）：

findById(…)

有关方法默认公开的更多信息，请参阅存储库方法公开。

PUT

该PUT方法用提供的请求正文替换目标资源的状态。默认情况下，响应是否包含正文由Accept随请求发送的标头控制。如果请求标头存在，200 OK则返回响应正文和状态代码。如果不存在标头，则响应正文为空，并且成功的请求将返回状态204 No Content。可以通过相应的配置来覆盖此行为
RepositoryRestConfiguration.setReturnBodyOnUpdate(…)。

用于调用的方法

如果存在，则使用以下方法（降序）：

save(…)

有关方法默认公开的更多信息，请参阅存储库方法公开。

自定义状态代码

该PUT方法只有一个自定义状态代码：

405 Method Not Allowed：如果save(…)方法未导出（通过@RestResource(exported = false)）或根本不存在于存储库中。

支持的媒体类型

该PUT方法支持以下媒体类型：

应用程序/hal+json
应用程序/json

PATCH

该PATCH方法与方法类似，PUT但部分更新资源状态。

用于调用的方法

如果存在，则使用以下方法（降序）：

save(…)

有关方法默认公开的更多信息，请参阅存储库方法公开。

自定义状态代码

该PATCH方法只有一个自定义状态代码：

405 Method Not Allowed：如果save(…)方法未导出（通过@RestResource(exported = false)）或不存在于存储库中。

支持的媒体类型

该PATCH方法支持以下媒体类型：

应用程序/hal+json
应用程序/json
应用程序/补丁+json
应用程序/合并补丁+json

DELETE

该DELETE方法删除暴露的资源。

用于调用的方法

如果存在，则使用以下方法（降序）：

delete(T)
delete(ID)
delete(Iterable)

有关方法默认公开的更多信息，请参阅存储库方法公开。

自定义状态代码

该DELETE方法只有一个自定义状态代码：

405 Method Not Allowed：如果delete(…)方法未导出（通过@RestResource(exported = false)）或不存在于存储库中。

4.4.协会资源

Spring Data REST 为每个项目资源具有的每个关联公开每个项目资源的子资源。资源的名称和路径默认为关联属性的名称，可以在关联属性上使用自定义@RestResource。

4.4.1.支持的 HTTP 方法

关联资源支持以下媒体类型：

得到
放
邮政
删除

GET

该GET方法返回关联资源的状态。

支持的媒体类型

该GET方法支持以下媒体类型：

应用程序/hal+json
应用程序/json

PUT

该PUT方法将给定 URI 指向的资源绑定到关联资源（请参阅支持的媒体类型）。

自定义状态代码

该PUT方法只有一个自定义状态代码：

400 Bad Request：当为一对一关联提供多个 URI 时。

支持的媒体类型

该PUT方法仅支持一种媒体类型：

text/uri-list：指向要绑定到关联的资源的 URI。

POST

该POST方法仅支持集合关联。它向集合中添加了一个新元素。

支持的媒体类型

该POST方法仅支持一种媒体类型：

text/uri-list：指向要添加到关联的资源的 URI。

DELETE

该DELETE方法解除关联。

自定义状态代码

该POST方法只有一个自定义状态代码：

405 Method Not Allowed：当关联是非可选的。

4.5.搜索资源

搜索资源返回存储库公开的所有查询方法的链接。可以使用@RestResource方法声明来修改查询方法资源的路径和名称。

4.5.1.支持的 HTTP 方法

由于搜索资源是只读资源，所以只支持该GET方法。

GET

该GET方法返回指向各个查询方法资源的链接列表。

支持的媒体类型

该GET方法支持以下媒体类型：

应用程序/hal+json
应用程序/json

HEAD

该HEAD方法返回搜索资源是否可用。404 返回码表示没有可用的查询方法资源。

4.6.查询方法资源

查询方法资源通过存储库界面上的单个查询方法运行公开的查询。

4.6.1.支持的 HTTP 方法

由于查询方法资源是只读资源，所以GET只支持。

GET

该GET方法返回查询的结果。

参数

如果查询方法具有分页功能（在指向资源的 URI 模板中指示），则资源采用以下参数：

page: 要访问的页码（0 索引，默认为 0）。
size：请求的页面大小（默认为 20）。
sort: 格式为($propertyname,)+[asc|desc]?的排序指令的集合。

支持的媒体类型

该GET方法支持以下媒体类型：

application/hal+json
application/json

HEAD

该HEAD方法返回查询方法资源是否可用。

5. 分页和排序

本节记录了 Spring Data REST 对 Spring Data Repository 分页和排序抽象的使用。要熟悉这些功能，请参阅您使用的存储库实现（例如 Spring Data JPA）的 Spring Data 文档。

5.1.分页

Spring Data REST 不是从大型结果集中返回所有内容，而是识别一些影响页面大小和起始页码的 URL 参数。

如果您扩展
PagingAndSortingRepository<T, ID>并访问所有实体的列表，您将获得前 20 个实体的链接。要将页面大小设置为任何其他数字，请添加一个size参数，如下所示：

http://localhost:8080/people/?size=5

前面的示例将页面大小设置为 5。

要在您自己的查询方法中使用分页，您需要更改方法签名以接受附加Pageable参数并返回 aPage而不是 a List。比如下面的查询方法导出到
/people/search/nameStartsWith并支持分页：

@RestResource(path = "nameStartsWith", rel = "nameStartsWith")
public Page findByNameStartsWith(@Param("name") String name, Pageable p);

Spring Data REST 导出器识别返回Page并在响应正文中为您提供结果，就像处理非分页响应一样，但会向资源添加额外的链接以表示数据的上一页和下一页。

5.1.1.上一个和下一个链接

每个分页响应使用 IANA 定义的链接关系prev和next. 但是，如果您当前位于结果的第一页，则不会prev呈现任何链接。对于结果的最后一页，不next呈现链接。

考虑以下示例，我们将页面大小设置为 5：

{
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/persons{&sort,page,size}", 
      "templated" : true
    },
    "next" : {
      "href" : "http://localhost:8080/persons?page=1&size=5{&sort}", 
      "templated" : true
    }
  },
  "_embedded" : {
  	… data …
  },
  "page" : { 
    "size" : 5,
    "totalElements" : 50,
    "totalPages" : 10,
    "number" : 0
  }
}

在顶部，我们看到_links：

该self链接为整个系列提供了一些选项。

该next链接指向下一页，假设页面大小相同。

底部是有关页面设置的额外数据，包括页面大小、总元素、总页数以及您当前查看的页码。

Spring认证中国教育管理中心-Spring Data REST框架教程二

使用curl命令行等工具时，如果&语句中有“&”( )，则需要将整个URI用引号括起来。

请注意，self和nextURI 实际上是 URI 模板。它们不仅接受size, 还接受page和sort作为可选标志。

如前所述，HAL 文档的底部包含有关该页面的详细信息集合。这些额外信息使您可以轻松配置滑块或指示器等 UI 工具，以反映用户在查看数据时的整体位置。例如，前面示例中的文档显示我们正在查看第一页（页码从 0 开始）。

以下示例显示了当我们点击next链接时会发生什么：

$ curl "http://localhost:8080/persons?page=1&size=5"

{
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/persons{&sort,projection,page,size}",
      "templated" : true
    },
    "next" : {
      "href" : "http://localhost:8080/persons?page=2&size=5{&sort,projection}", 
      "templated" : true
    },
    "prev" : {
      "href" : "http://localhost:8080/persons?page=0&size=5{&sort,projection}", 
      "templated" : true
    }
  },
  "_embedded" : {
	... data ...
  },
  "page" : {
    "size" : 5,
    "totalElements" : 50,
    "totalPages" : 10,
    "number" : 1 
  }
}

这看起来非常相似，除了以下差异：

该next链接现在指向另一个页面，表明它与self链接的相对视角。

prev现在出现一个链接，为我们提供上一页的路径。

当前编号现在是 1（表示第二页）。

Spring认证中国教育管理中心-Spring Data REST框架教程二