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 控件。

相关文章
|
6月前
|
NoSQL Java 数据库连接
《深入理解Spring》Spring Data——数据访问的统一抽象与极致简化
Spring Data通过Repository抽象和方法名派生查询,简化数据访问层开发,告别冗余CRUD代码。支持JPA、MongoDB、Redis等多种存储,统一编程模型,提升开发效率与架构灵活性,是Java开发者必备利器。(238字)
|
6月前
|
存储 Java 关系型数据库
Spring Boot中Spring Data JPA的常用注解
Spring Data JPA通过注解简化数据库操作,实现实体与表的映射。常用注解包括:`@Entity`、`@Table`定义表结构;`@Id`、`@GeneratedValue`配置主键策略;`@Column`、`@Transient`控制字段映射;`@OneToOne`、`@OneToMany`等处理关联关系;`@Enumerated`、`@NamedQuery`支持枚举与命名查询。合理使用可提升开发效率与代码可维护性。(238字)
606 1
存储 JSON Java
828 0
|
7月前
|
SQL Java 数据库连接
Spring Data JPA 技术深度解析与应用指南
本文档全面介绍 Spring Data JPA 的核心概念、技术原理和实际应用。作为 Spring 生态系统中数据访问层的关键组件,Spring Data JPA 极大简化了 Java 持久层开发。本文将深入探讨其架构设计、核心接口、查询派生机制、事务管理以及与 Spring 框架的集成方式,并通过实际示例展示如何高效地使用这一技术。本文档约1500字,适合有一定 Spring 和 JPA 基础的开发者阅读。
724 0
|
9月前
|
NoSQL Java Redis
Redis基本数据类型及Spring Data Redis应用
Redis 是开源高性能键值对数据库,支持 String、Hash、List、Set、Sorted Set 等数据结构,适用于缓存、消息队列、排行榜等场景。具备高性能、原子操作及丰富功能,是分布式系统核心组件。
739 2
|
11月前
|
消息中间件 缓存 NoSQL
基于Spring Data Redis与RabbitMQ实现字符串缓存和计数功能(数据同步)
总的来说,借助Spring Data Redis和RabbitMQ,我们可以轻松实现字符串缓存和计数的功能。而关键的部分不过是一些"厨房的套路",一旦你掌握了这些套路,那么你就像厨师一样可以准备出一道道饕餮美食了。通过这种方式促进数据处理效率无疑将大大提高我们的生产力。
351 32
|
NoSQL 安全 Java
深入理解 RedisConnectionFactory:Spring Data Redis 的核心组件
在 Spring Data Redis 中,`RedisConnectionFactory` 是核心组件,负责创建和管理与 Redis 的连接。它支持单机、集群及哨兵等多种模式,为上层组件(如 `RedisTemplate`)提供连接抽象。Spring 提供了 Lettuce 和 Jedis 两种主要实现,其中 Lettuce 因其线程安全和高性能特性被广泛推荐。通过手动配置或 Spring Boot 自动化配置,开发者可轻松集成 Redis,提升应用性能与扩展性。本文深入解析其作用、实现方式及常见问题解决方法,助你高效使用 Redis。
1227 4
|
SQL Java 编译器
深入理解 Spring Data JPA 的导入与使用:以 UserRepository为例
本文深入解析了 Spring Data JPA 中 `UserRepository` 的导入与使用。通过示例代码,详细说明了为何需要导入 `User` 实体类、`JpaRepository` 接口及 `@Repository` 注解。这些导入语句分别用于定义操作实体、提供数据库交互方法和标识数据访问组件。文章还探讨了未导入时的编译问题,并展示了实际应用场景,如用户保存、查询与删除操作。合理使用导入语句,可让代码更简洁高效,充分发挥 Spring Data JPA 的优势。
708 0
|
安全 Java Apache
微服务——SpringBoot使用归纳——Spring Boot中集成 Shiro——Shiro 身份和权限认证
本文介绍了 Apache Shiro 的身份认证与权限认证机制。在身份认证部分,分析了 Shiro 的认证流程,包括应用程序调用 `Subject.login(token)` 方法、SecurityManager 接管认证以及通过 Realm 进行具体的安全验证。权限认证部分阐述了权限(permission)、角色(role)和用户(user)三者的关系,其中用户可拥有多个角色,角色则对应不同的权限组合,例如普通用户仅能查看或添加信息,而管理员可执行所有操作。
625 0
|
Java 应用服务中间件 Scala
Spring Boot 实现通用 Auth 认证的 4 种方式
本文介绍了在Spring Boot中实现通用Auth的四种方式:传统AOP、拦截器(Interceptor)、参数解析器(ArgumentResolver)和过滤器(Filter)。每种方式都通过实例代码详细说明了实现步骤,并总结了它们的执行顺序。首先,Filter作为Servlet规范的一部分最先被调用;接着是Interceptor,它可以在Controller方法执行前后进行处理;然后是ArgumentResolver,在参数传递给Controller之前解析并验证参数
320 1

热门文章

最新文章

下一篇
开通oss服务