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

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

原标题: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
相关资源
该GET方法支持用于发现相关资源的单个链接:

search:如果后备存储库公开查询方法,则公开搜索资源。
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
相关资源
对于域类型的每个关联,我们公开以关联属性命名的链接。您可以通过@RestResource在属性上使用来自定义此行为。相关资源为关联资源类型。

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
相关资源
对于存储库中声明的每个查询方法,我们公开一个查询方法资源。如果资源支持分页,则指向它的 URI 是包含分页参数的 URI 模板。

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方法返回查询方法资源是否可用。

  1. 分页和排序

本节记录了 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框架教程二
此功能可让您将屏幕上的可选按钮映射到这些超媒体控件,让您无需对 URI 进行硬编码即可实现 UI 体验的导航功能。事实上,用户可以从页面大小列表中进行选择,动态更改所提供的内容,而无需next在顶部或底部重写和`prev 控件。

相关文章
|
24天前
|
数据采集 监控 前端开发
二级公立医院绩效考核系统源码,B/S架构,前后端分别基于Spring Boot和Avue框架
医院绩效管理系统通过与HIS系统的无缝对接,实现数据网络化采集、评价结果透明化管理及奖金分配自动化生成。系统涵盖科室和个人绩效考核、医疗质量考核、数据采集、绩效工资核算、收支核算、工作量统计、单项奖惩等功能,提升绩效评估的全面性、准确性和公正性。技术栈采用B/S架构,前后端分别基于Spring Boot和Avue框架。
|
1月前
|
Java API 数据库
Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐
本文通过在线图书管理系统案例,详细介绍如何使用Spring Boot构建RESTful API。从项目基础环境搭建、实体类与数据访问层定义,到业务逻辑实现和控制器编写,逐步展示了Spring Boot的简洁配置和强大功能。最后,通过Postman测试API,并介绍了如何添加安全性和异常处理,确保API的稳定性和安全性。
38 0
|
28天前
|
前端开发 Java 数据库连接
Spring 框架:Java 开发者的春天
Spring 框架是一个功能强大的开源框架,主要用于简化 Java 企业级应用的开发,由被称为“Spring 之父”的 Rod Johnson 于 2002 年提出并创立,并由Pivotal团队维护。
43 1
Spring 框架:Java 开发者的春天
|
21天前
|
JavaScript 安全 Java
如何使用 Spring Boot 和 Ant Design Pro Vue 构建一个前后端分离的应用框架,实现动态路由和菜单功能
本文介绍了如何使用 Spring Boot 和 Ant Design Pro Vue 构建一个前后端分离的应用框架,实现动态路由和菜单功能。首先,确保开发环境已安装必要的工具,然后创建并配置 Spring Boot 项目,包括添加依赖和配置 Spring Security。接着,创建后端 API 和前端项目,配置动态路由和菜单。最后,运行项目并分享实践心得,帮助开发者提高开发效率和应用的可维护性。
38 2
|
20天前
|
消息中间件 NoSQL Java
springboot整合常用中间件框架案例
该项目是Spring Boot集成整合案例,涵盖多种中间件的使用示例,每个案例项目使用最小依赖,便于直接应用到自己的项目中。包括MyBatis、Redis、MongoDB、MQ、ES等的整合示例。
79 1
|
28天前
|
Java 数据库连接 开发者
Spring 框架:Java 开发者的春天
【10月更文挑战第27天】Spring 框架由 Rod Johnson 在 2002 年创建,旨在解决 Java 企业级开发中的复杂性问题。它通过控制反转(IOC)和面向切面的编程(AOP)等核心机制,提供了轻量级的容器和丰富的功能,支持 Web 开发、数据访问等领域,显著提高了开发效率和应用的可维护性。Spring 拥有强大的社区支持和丰富的生态系统,是 Java 开发不可或缺的工具。
|
1月前
|
人工智能 开发框架 Java
总计 30 万奖金,Spring AI Alibaba 应用框架挑战赛开赛
Spring AI Alibaba 应用框架挑战赛邀请广大开发者参与开源项目的共建,助力项目快速发展,掌握 AI 应用开发模式。大赛分为《支持 Spring AI Alibaba 应用可视化调试与追踪本地工具》和《基于 Flow 的 AI 编排机制设计与实现》两个赛道,总计 30 万奖金。
|
6月前
|
XML Java 数据库连接
Spring Boot的数据访问之Spring Data JPA以及Hibernate的实战(超详细 附源码)
Spring Boot的数据访问之Spring Data JPA以及Hibernate的实战(超详细 附源码)
114 0
|
2月前
|
Java 数据库连接 API
【Java笔记+踩坑】Spring Data JPA
从常用注解、实体类和各层编写方法入手,详细介绍JPA框架在增删改查等方面的基本用法,以及填充用户名日期、分页查询等高级用法。
【Java笔记+踩坑】Spring Data JPA
|
3月前
|
Java Spring 数据库
怎样动动手指就能实现数据操作?Spring Data JPA背后的魔法揭秘
【8月更文挑战第31天】在Java开发中,数据库交互至关重要。传统的JDBC操作繁琐且难维护,而Spring Data JPA作为集成JPA的数据访问层解决方案,提供了CRUD等通用操作接口,显著减少代码量。通过继承`JpaRepository`,开发者能轻松实现数据的增删改查,甚至复杂查询和分页也不再困难。本文将通过示例详细介绍如何利用Spring Data JPA简化数据访问层的开发,提升代码质量和可维护性。
43 0