使用 Spring Data Repositories

原标题：Spring认证|使用 Spring Data Repositories（下）来源：（Spring中国教育管理中心）

对可分页的超媒体支持

Spring HATEOAS 附带了一个表示模型类 ( PagedResources)，它允许Page使用必要的Page元数据和链接来丰富实例的内容，让客户端轻松导航页面。aPage到 a的转换PagedResources是由 Spring HATEOASResourceAssembler接口的实现完成的，称为PagedResourcesAssembler. 以下示例显示了如何使用 aPagedResourcesAssembler作为控制器方法参数：

示例 51.使用 PagedResourcesAssembler 作为控制器方法参数

@Controller

class PersonController {

@Autowired PersonRepository repository;

@RequestMapping(value = "/persons", method = RequestMethod.GET)

HttpEntity persons(Pageable pageable,

  PagedResourcesAssembler assembler) {

  Page persons = repository.findAll(pageable);

  return new ResponseEntity(assembler.toResources(persons), HttpStatus.OK);

}

}

启用配置，如前面的示例所示，可以PagedResourcesAssembler将 用作控制器方法参数。调用toResources(…)它有以下效果：

的内容Page成为PagedResources实例的内容。

该PagedResources对象PageMetadata附加了一个实例，并填充了来自Page和底层 的信息PageRequest。

将PagedResources可能会prev和next连接链路，根据页面的状态。链接指向方法映射到的 URI。添加到该方法的分页参数与 的设置相匹配，PageableHandlerMethodArgumentResolver以确保稍后可以解析链接。

假设我们Person在数据库中有 30 个实例。您现在可以触发请求 ( ) 并看到类似于以下内容的输出：GET http://localhost:8080/persons

{ "links" : [ { "rel" : "next",

              "href" : "http://localhost:8080/persons?page=1&size=20" }

],

"content" : [

   … // 20 Person instances rendered here

],

"pageMetadata" : {

  "size" : 20,

  "totalElements" : 30,

  "totalPages" : 2,

  "number" : 0

}

}

组装器生成了正确的 URI 并选择了默认配置，以将参数解析Pageable为即将到来的请求。这意味着，如果您更改该配置，链接将自动遵守更改。默认情况下，汇编器指向调用它的控制器方法，但您可以通过传递一个自定义Link来自定义它，该自定义用作构建分页链接的基础，这会重载该PagedResourcesAssembler.toResource(…)方法。

Spring Data Jackson 模块

核心模块和一些特定于商店的模块附带一组 Jackson 模块，用于 Spring Data 域使用的类型，例如org.springframework.data.geo.Distance和org.springframework.data.geo.Point。

一旦启用Web 支持并可用，com.fasterxml.jackson.databind.ObjectMapper就会导入这些模块。

在初始化期间SpringDataJacksonModules，像 一样SpringDataJacksonConfiguration，被基础设施接收，以便声明的com.fasterxml.jackson.databind.Modules 可供 Jackson 使用ObjectMapper。

以下域类型的数据绑定混合由公共基础结构注册。

org.springframework.data.geo.Distanceorg.springframework.data.geo.Pointorg.springframework.data.geo.Boxorg.springframework.data.geo.Circleorg.springframework.data.geo.Polygon

单个模块可能会提供额外的SpringDataJacksonModules.

有关更多详细信息，请参阅商店特定部分。

网页数据绑定支持

您可以使用 Spring Data 投影（在Projections 中描述）通过使用JSONPath表达式（需要Jayway JsonPath或XPath表达式（需要XmlBeam）来绑定传入的请求有效负载，如以下示例所示：

示例 52.使用 JSONPath 或 XPath 表达式的 HTTP 负载绑定

@ProjectedPayload

public interface UserPayload {

@XBRead("//firstname")

@JsonPath("$..firstname")

String getFirstname();

@XBRead("/lastname")

@JsonPath({ "$.lastname", "$.user.lastname" })

String getLastname();

}

可以使用在前面的例子中为一个Spring MVC处理程序方法参数或通过使用所示类型ParameterizedTypeReference上的方法之一RestTemplate。前面的方法声明将尝试查找firstname给定文档中的任何位置。该lastnameXML查询是对输入文档的顶层进行。其 JSON 变体lastname首先尝试顶级，但如果前者不返回值，也会尝试lastname嵌套在user子文档中。这样，无需客户端调用公开的方法（通常是基于类的有效负载绑定的缺点）即可轻松减轻源文档结构的更改。

如Projections 中所述，支持嵌套投影。如果该方法返回复杂的非接口类型，ObjectMapper则使用Jackson来映射最终值。

对于 Spring MVC，必要的转换器一旦@EnableSpringDataWebSupport处于活动状态就会自动注册，并且所需的依赖项在类路径上可用。对于使用RestTemplate，注册ProjectingJackson2HttpMessageConverter（JSON）或XmlBeamHttpMessageConverter手动。

有关更多信息，请参阅规范Spring 数据示例存储库中的Web 投影示例。

Querydsl 网络支持

对于那些具有QueryDSL集成的商店，您可以从Request查询字符串中包含的属性派生查询。

考虑以下查询字符串：

?firstname=Dave&lastname=Matthews

给定User前面示例中的对象，您可以使用 将查询字符串解析为以下值QuerydslPredicateArgumentResolver，如下所示：

QUser.user.firstname.eq("Dave").and(QUser.user.lastname.eq("Matthews"))

@EnableSpringDataWebSupport当在类路径上找到 Querydsl 时 ，会自动启用该功能以及。

将 a 添加@QuerydslPredicate到方法签名提供了一个随时可用的Predicate，您可以使用QuerydslPredicateExecutor.

类型信息通常从方法的返回类型解析。由于该信息不一定与域类型匹配，因此使用 的root属性可能是一个好主意QuerydslPredicate。

以下示例显示了如何@QuerydslPredicate在方法签名中使用：

@Controller

@Controller

class UserController {

@Autowired UserRepository repository;

@RequestMapping(value = "/", method = RequestMethod.GET)

String index(Model model, @QuerydslPredicate(root = User.class) Predicate predicate, 

        Pageable pageable, @RequestParam MultiValueMap parameters) {

  model.addAttribute("users", repository.findAll(predicate, pageable));

  return "index";

}

}

将查询字符串参数解析为匹配Predicatefor User。

默认绑定如下：

Object在简单的属性上eq。

Object在像属性一样的集合上contains。

Collection在简单的属性上in。

您可以通过Java 8的bindings属性@QuerydslPredicate或通过使用 Java 8default methods并将QuerydslBinderCustomizer方法添加到存储库接口来自定义这些绑定，如下所示：

interface UserRepository extends CrudRepository,

                               QuerydslPredicateExecutor,             

                               QuerydslBinderCustomizer {             

@Override

default void customize(QuerydslBindings bindings, QUser user) {

  bindings.bind(user.username).first((path, value) -> path.contains(value)) 

  bindings.bind(String.class)

    .first((StringPath path, String value) -> path.containsIgnoreCase(value));

  bindings.excluding(user.password);                                         

}

}

QuerydslPredicateExecutor提供对特定 finder 方法的访问Predicate。

QuerydslBinderCustomizer存储库界面上定义的自动拾取和快捷方式@QuerydslPredicate(bindings=…)。

将username属性的绑定定义为简单contains绑定。

将String属性的默认绑定定义为不区分大小写的contains匹配。

password从Predicate解析中排除该属性。

你可以注册一个QuerydslBinderCustomizerDefaults从资源库或应用特定的绑定之前豆保持默认Querydsl绑定@QuerydslPredicate。

4.8.3. 存储库填充器

如果您使用 Spring JDBC 模块，您可能熟悉DataSource使用 SQL 脚本填充 a 的支持。存储库级别上也有类似的抽象，尽管它不使用 SQL 作为数据定义语言，因为它必须与存储无关。因此，填充器支持 XML（通过 Spring 的 OXM 抽象）和 JSON（通过 Jackson）来定义用于填充存储库的数据。

假设您有一个包含data.json以下内容的文件：

示例 53. JSON 中定义的数据

[ { "_class" : "com.acme.Person",

"firstname" : "Dave",

"lastname" : "Matthews" },

{ "_class" : "com.acme.Person",

"firstname" : "Carter",

"lastname" : "Beauford" } ]

您可以使用 Spring Data Commons 中提供的存储库命名空间的 populator 元素来填充存储库。要将前面的数据填充到您的PersonRepository，请声明一个类似于以下内容的填充器：

示例 54. 声明一个 Jackson 存储库填充器

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:repository="http://www.springframework.org/schema/data/repository"

xsi:schemaLocation="http://www.springframework.org/schema/beans

  https://www.springframework.org/schema/beans/spring-beans.xsd

  http://www.springframework.org/schema/data/repository

  https://www.springframework.org/schema/data/repository/spring-repository.xsd">

前面的声明导致data.json文件被 Jackson 读取和反序列化ObjectMapper。

JSON 对象解组到的类型是通过检查_classJSON 文档的属性来确定的。基础架构最终会选择合适的存储库来处理反序列化的对象。

要改为使用 XML 定义应填充存储库的数据，您可以使用该unmarshaller-populator元素。您将其配置为使用 Spring OXM 中可用的 XML marshaller 选项之一。有关详细信息，请参阅Spring 参考文档。以下示例显示了如何使用 JAXB 解组存储库填充器：

示例 55. 声明解组存储库填充器（使用 JAXB）

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:repository="http://www.springframework.org/schema/data/repository"

xmlns:oxm="http://www.springframework.org/schema/oxm"

xsi:schemaLocation="http://www.springframework.org/schema/beans

  https://www.springframework.org/schema/beans/spring-beans.xsd

  http://www.springframework.org/schema/data/repository

  https://www.springframework.org/schema/data/repository/spring-repository.xsd

  http://www.springframework.org/schema/oxm

  https://www.springframework.org/schema/oxm/spring-oxm.xsd">

  unmarshaller-ref="unmarshaller" />