原标题:Spring认证中国教育管理中心-Spring Data Couchbase教程七(Spring中国教育管理中心)
4.8.2.网络支持
支持存储库编程模型的 Spring Data 模块附带各种 Web 支持。Web 相关组件要求 Spring MVC JAR 位于类路径中。其中一些甚至提供与Spring HATEOAS 的集成。通常,通过使用@ EnableSpringDataWebSupportJavaConfig 配置类中的注释来启用集成支持,如以下示例所示:
示例 66. 启用 Spring Data web 支持
代码语言:javascript复制@Configuration
@EnableWebMvc
@EnableSpringDataWebSupport
class WebConfiguration {}
该@ EnableSpringDataWebSupport批注注册几个组件。我们将在本节后面讨论这些内容。它还检测类路径上的 Spring HATEOAS 并为其注册集成组件(如果存在)。
或者,如果您使用 XML 配置,则注册为 Spring beanSpringDataWebConfiguration或注册HateoasAwareSpringDataWebConfiguration为 Spring beans,如以下示例所示 (for SpringDataWebConfiguration):
示例 67. 在 XML 中启用 Spring Data Web 支持
代码语言:javascript复制<bean class="org.springframework.data.web.config.SpringDataWebConfiguration" />
<!-- If you use Spring HATEOAS, register this one *instead* of the former -->
<bean class="org.springframework.data.web.config.HateoasAwareSpringDataWebConfiguration" />
基本网络支持
上一节中显示的配置注册了一些基本组件:
- A使用DomainClassConverterClass让 Spring MVC 从请求参数或路径变量中解析存储库管理的域类的实例。
- HandlerMethodArgumentResolver让 Spring MVC从请求参数解析Pageable和Sort实例的实现。
- Jackson 模块用于反/序列化Point和 等类型Distance,或存储特定类型,具体取决于使用的 Spring 数据模块。
使用DomainClassConverter类
本DomainClassConverter类让你在Spring MVC中的控制器方法签名使用域类型直接使您不必手动通过资源库查找的情况下,如下例所示:
示例 68. 在方法签名中使用域类型的 Spring MVC 控制器
代码语言:javascript复制@Controller
@RequestMapping("/users")
class UserController {
@RequestMapping("/{id}")
String showUserForm(@PathVariable("id") User user, Model model) {
model.addAttribute("user", user);
return "userForm";
}
}
该方法User直接接收实例,无需进一步查找。实例可以通过让Spring MVCid先将path变量转换为域类的类型,最终通过调用findById(…)为域类型注册的repository实例来访问实例。
目前,必须实施存储库才有CrudRepository资格被发现进行转换。
用于分页和排序的 HandlerMethodArgumentResolvers
上一节中显示的配置片段还注册了 aPageableHandlerMethodArgumentResolver以及SortHandlerMethodArgumentResolver. 注册启用Pageable并Sort作为有效的控制器方法参数,如以下示例所示:
示例 69. 使用 Pageable 作为控制器方法参数
代码语言:javascript复制@Controller
@RequestMapping("/users")
class UserController {
private final UserRepository repository;
UserController(UserRepository repository) {
this.repository = repository;
}
@RequestMapping
String showUsers(Model model, Pageable pageable) {
model.addAttribute("users", repository.findAll(pageable));
return "users";
}
}
前面的方法签名导致 Spring MVC 尝试Pageable使用以下默认配置从请求参数中派生一个实例:
要自定义此行为,请分别注册一个实现 PageableHandlerMethodArgumentResolverCustomizer接口或SortHandlerMethodArgumentResolverCustomizer接口的 bean 。它的customize()方法被调用,让您更改设置,如以下示例所示:
代码语言:javascript复制@Bean SortHandlerMethodArgumentResolverCustomizer sortCustomizer() {
return s -> s.setPropertyDelimiter("<-->");
}
如果设置现有的属性MethodArgumentResolver不足以满足您的目的,请扩展其中一个 SpringDataWebConfiguration或启用 HATEOAS 的等效项,覆盖pageableResolver()orsortResolver()方法,并导入您的自定义配置文件而不是使用@Enable注释。
如果您需要从请求中解析多个Pageable或Sort实例(例如,对于多个表),您可以使用 Spring 的@Qualifier注释来区分一个。然后请求参数必须以${qualifier}_. 以下示例显示了生成的方法签名:
代码语言:javascript复制String showUsers(Model model,
@Qualifier("thing1") Pageable first,
@Qualifier("thing2") Pageable second) { … }
您必须填充thing1_page、thing2_page等。
Pageable传入方法的默认值相当于 a PageRequest.of(0, 20),但您可以使用参数@PageableDefault上的注解来自定义它Pageable。
Pageables 的超媒体支持
春天HATEOAS附带的表示模型类(PagedResources),它允许一个丰富的内容Page实例与必要的Page元数据,以及链接,让用户轻松地浏览网页。aPage到 a的转换PagedResources是由 Spring HATEOASResourceAssembler接口的实现完成的,称为PagedResourcesAssembler. 以下示例显示了如何使用 aPagedResourcesAssembler作为控制器方法参数:
示例 70. 使用 PagedResourcesAssembler 作为控制器方法参数
代码语言:javascript复制@Controller
class PersonController {
@Autowired PersonRepository repository;
@RequestMapping(value = "/persons", method = RequestMethod.GET)
HttpEntity<PagedResources<Person>> persons(Pageable pageable,
PagedResourcesAssembler assembler) {
Page<Person> 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
代码语言:javascript复制{ "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 模块
核心模块和一些特定于商店的模块附带一组杰克逊模块,用于 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。
以下域类型的数据绑定混合由公共基础设施注册。
代码语言:javascript复制org.springframework.data.geo.Distance
org.springframework.data.geo.Point
org.springframework.data.geo.Box
org.springframework.data.geo.Circle
org.springframework.data.geo.Polygon
单个模块可能会提供额外的SpringDataJacksonModules.
有关详细信息,请参阅商店特定部分。
Web 数据绑定支持
您可以使用 Spring Data 投影(在[projections] 中描述)通过使用JSONPath表达式(需要Jayway JsonPath或XPath表达式(需要XmlBeam)来绑定传入的请求负载,如以下示例所示:
示例 71. 使用 JSONPath 或 XPath 表达式的 HTTP 有效负载绑定
代码语言:javascript复制@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查询字符串中包含的属性派生查询。
考虑以下查询字符串:
代码语言:javascript复制?firstname=Dave&lastname=Matthews
给定User前面示例中的对象,您可以使用 将查询字符串解析为以下值 QuerydslPredicateArgumentResolver,如下所示:
代码语言:javascript复制QUser.user.firstname.eq("Dave").and(QUser.user.lastname.eq("Matthews"))
@ EnableSpringDataWebSupport当在类路径中找到 Querydsl 时 ,该功能会自动启用。
向@QuerydslPredicate方法签名添加 a提供了一个即用型Predicate,您可以使用 QuerydslPredicateExecutor.
类型信息通常从方法的返回类型中解析。由于该信息不一定与域类型匹配,因此使用 的root属性可能是个好主意QuerydslPredicate。
以下示例显示了如何@QuerydslPredicate在方法签名中使用:
代码语言:javascript复制@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<String, String> parameters) {
model.addAttribute("users", repository.findAll(predicate, pageable));
return "index";
}
}
将查询字符串参数解析为匹配Predicatefor User。
默认绑定如下:
- Object在简单的属性上eq。
- Object像属性一样的集合contains。
- Collection在简单的属性上in。
您可以通过bindings属性@QuerydslPredicate或使用 Java 8default methods并将QuerydslBinderCustomizer方法添加到存储库接口来自定义这些绑定,如下所示:
代码语言:javascript复制interface UserRepository extends CrudRepository<User, String>,
QuerydslPredicateExecutor<User>,
QuerydslBinderCustomizer<QUser> {
@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提供对Predicate.
QuerydslBinderCustomizer存储库界面上定义的自动拾取和快捷方式@QuerydslPredicate(bindings=…)。
将username属性的绑定定义为简单contains绑定。
将String属性的默认绑定定义为不区分大小写的contains匹配。
password从Predicate解析中排除该属性。
您可以 QuerydslBinderCustomizerDefaults在应用来自存储库或@QuerydslPredicate.