阅读198 返回首页    go 阿里云 go 技术社区[云栖]

Spring Data 官方文档》4.7 Spring Data扩展

4.7 Spring Data扩展

这部分说明Spring Data一系列的扩展功能,可以使Spring Dta使用多样的上下文.目前大部分集成是针对Spring MVC.

4.7.1 Querydsl扩展

Querydsl是一个框架,通过它的流式API构建静态类型的SQL类查询。多个Spring Data模块通过QueryDslPredicateExecutor与Querydsl集成。
例29 QueryDslPredicateExecutor接口

1 public interface QueryDslPredicateExecutor<T> {
2   T findOne(Predicate predicate); ①
3     Iterable<T> findAll(Predicate predicate); ②
4     long count(Predicate predicate); ③
5     boolean exists(Predicate predicate); ④
6     // … more functionality omitted.
7 }

① 查询并返回一个匹配Predicate的单例实体

②查询并返回所有匹配Predicate的实体

③ 返回匹配Predicate的实体数量

④ 返回是否存在一个匹配Predicate的实体

为了简单的使用Querydsl功能,在你的仓库接口继承QueryDslPredicateExecutor.

例30 在仓库集成QueryDsl

1 interface UserRepository extends CrudRepository<User, Long>,
2 QueryDslPredicateExecutor<User> {
3 }

像上面这样就可以使用Querydsl的Predicate书写类型安全的查询

1 Predicate predicate = user.firstname.equalsIgnoreCase("dave").and(user.lastname.startsWithIgnoreCase("mathews"));
2 userRepository.findAll(predicate);

4.7.2 Web支持

注意
本节包含Spring Data Web支持的文档是在1.6范围内的Spring Data Commons实现的.因为支持新引入的内容改变了很多东西，我们保留了旧行为的文档在”遗留Web支持”部分.

如果模块支持仓库编程模型，那么Spring Data模块附带了各种Web模块支持.Web关联的东西需要Spring MVC的JAR包位于classpath路径下,它们中有些甚至提供了Spring HATEOAS集成.一般情况,集成方式支持使用@EnableSpringDataWebSupport注解在你的JavaConfig配置类.
例31 启用Spring Data web支持

1 @Configuration
2 @EnableWebMvc
3 @EnableSpringDataWebSupport
4 class WebConfiguration {}

@EnableSpringDataWebSupport注解注册了一些组件，我们将在稍后讨论.注解还将在类路径上检测Spring HATEOAS，如果才在将为其注册集成组件.
作为可选项,如果你使用XML配置,注册SpringDataWebSupport或者HateoasWareSpringDataWebSupport作为Spring bean:
例32 用XML启用Spring Data web支持

1 <bean class="org.springframework.data.web.config.SpringDataWebConfiguration" />
2 <!-- If you're using Spring HATEOAS as well register this one *instead* of the former -->
3 <bean class= "org.springframework.data.web.config.HateoasAwareSpringDataWebConfiguration"/>

基本Web支持
上面展示的的配置设置将注册几个基本组件：

  • 一个DomainClassConverter启用Spring MVC来根据请求参数或路径变量管理仓例实体类的实例
  • HandlerMethodArgumentResolver实现让Spring MVC从请求参数解析Pageable和Sort实例

实体类转换
DomainClassConverter允许你在Spring MVC控制器方法签名中直接使用实体类型,因此你不必手动的通过仓库查询实例:
例33 一个Spring MVC控制器在方法签名中使用实体类型

1 @Controller
2 @RequestMapping("/users")
3 public class UserController {
4   @RequestMapping("/{id}")
5   public String showUserForm(@PathVariable("id") User user, Model model) {
6     model.addAttribute("user", user);
7     return "userForm";
8   }
9 }

如你所见,方法直接接收一个User实例并没有更进一步的查询是否必要.实例可以通过Spring MVC将路径变量转换为实体类的id类型并最终通过在实体类型注册的仓库实例上调用findOne(…)访问实例转换得到.

注意
当前的仓库必须实现CrudRepository做好准备被发现来进行转换.

为了分页和排序分解方法参数
上面的配置片段还注册了一个PageableHandlerMethodArgumentResolver和一个SortHandlerMethodArgumentResolver实例.注册使得Pageable和Sort成为有效的控制器方法参数.
例34 使用Pageable作为控制器方法参数

01 @Controller
02 @RequestMapping("/users")
03 public class UserController {
04   @Autowired UserRepository repository;
05   @RequestMapping
06   public String showUsers(Model model, Pageable pageable) {
07     model.addAttribute("users", repository.findAll(pageable));
08     return "users";
09   }
10 }</blockquote>

这个方法签名将使Spring MVC尝试使用下面的默认配置从请求参数中转换一个Pageable实例:

表1 请求参数转换Pageable实例
请求参数转换Pageable实例
为了定制行为,可以继承SpringDataWebConfiguration或者启用等效的HATEOAS并覆盖pageableResolver()或sortResolver()方法并导入你的自定义配置文件替代@Enable-注解.
有一种情况你需要多个Pageable或Sort实例从请求转换(例如处理多个表单),你可以使用Spring的@Qualifier注解来互相区别.请求参数必须以${qualifier}为前缀.这样一个方法的签名像这样:

1 public String showUsers(Model model,
2                         @Qualifier("foo")Pagebale first,
3                         @Qualifier("bar") Pageable second) {
4   ...
5 }

你必须填充foo_page和bar_page等.
默认的Pageable在方法中处理等价于一个new PageRequest(0, 20),但是可以使用@PageableDefaults注解在Pageable参数上定制.
Hypermedia支持分页
Spring HATEOAS包装了一个代表模型的类PageResources ,它可以使用Page实例包装必要的Page元数据内容作为连接让客户端导航页面.一个页面到一个PageResources的转换被Spring HATEOAS的ResourceAssembler接口实现PagedResourcesAssembler来完成.
例35 使用一个PagedResourcesAssembler作为控制器方法参数

01 @Controller
02 class PersonController {
03   @Autowired PersonRepository repository;
04   @RequestMapping(value = "/persons", method = RequestMethod.GET)
05   HttpEntity<PagedResources<Person>> persons(Pageable pageable,
06                                              PagedResourcesAssembler assembler) {
07     Page<Person> persons = repository.findAll(pageable);
08     return new ResponseEntity<>(assembler.toResources(persons), HttpStatus.OK);
09   }
10 }

像上面这样配置将允许PageResourcesAssembler作为控制器方法的一个参数.在这调用toResources(…)方法有以下作用:

  • Page的内容将PageResources实例的内容
  • PageResources将获得PageMetadata实例,该实例由Page和基础的PageRequest中的信息填充
  • PageResources获得prev和next连接,添加这些依赖在页面.这些链接将指向uri方法的调用映射.页码参数根据PageableHandlerMethodArgumentResolver添加到参数以在后面被转换

假设我们有30个Person实例在数据库.你现在可以触发一个GET请求 https://localhost:8080/persons, 你将可以看到类似下面的内容:

01 { "links" : [ { "rel" : "next",
03 ],
04 "content" : [
05 … // 20 Person instances rendered here
06 ],
07 "pageMetadata" : {
08 "size" : 20,
09 "totalElements" : 30,
10 "totalPages" : 2,
11 "number" : 0
12 }
13 }

你可以看到编译生成了正确的URI，并且还会提取默认配置转换参数到即将到来的请求中的Pageable.这意味着,如果你改变配置,链接也将自动跟随改变.默认情况下，编译指向控制器执行的方法，但是这可以被一个自定义链接作为基本构建来构成分页的Link重载PagedResourcesAssembler.toResource（…）方法定制.
Querydsl web 支持
那些整合了QueryDSL的存储可能从Request查询字符串中的属性驱动查询.
这意味着前面例子的查询字符串可以给出User的对象

1 ?firstname=Dave&lastname=Matthews

可以被转换为

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

使用QuerydslPredicateArgumentResolver.

注意
当在类路径上找到Querydsl时，该功能将在@EnableSpringDataWebSupport注解中自动启用

添加一个@QuerydslPredicate到一个方法签名将提供一个就绪的Predicate,可以通过QueryDslPredicateExecutor执行.

提示
类型信息通常从返回方法上解析.由于这些信息不一定匹配实体类型,使用QuerydslPredicate的root属性可能是个好主意.

01 @Controller
02 class UserController {
03   @Autowired UserRepository repository;
04   @RequestMapping(value = "/", method = RequestMethod.GET)
05   String index(Model model, @QuerydslPredicate(root = User.class) Predicate predicate,  ①
06               Pageable pageable, @RequestParam MultiValueMap<String, String>
07     parameters) {
08         model.addAttribute("users", repository.findAll(predicate, pageable));
09         return "index";
10   }
11 }

①为User转换匹配查询字符串参数的Predicate

默认的绑定规则如下:

  • Object在简单属性上如同eq
  • Object在集合作为属性如同contains
  • Collection在简单属性上如同in

这些绑定可以通过@QuerydslPredicate的bindings属性定制或者使用Java8default methods给仓库接口添加QuerydslBinderCustomizer

01 interface UserReposotory extends CurdRepository<User, String>,
02   QueryDslPredicateExecutor<User>,  ①
03   QuerydslBinderCustomizer<QUser> {  ②
04     @Override
05     default public void customize(QuerydslBindings bindings, QUser user) {
06       bindings.bind(user.username).first((path, value) -> path.contains(value));  ③
07       bindings.bind(String.class).first((StringPath path, String value) -> path.containsIgnoreCase(value));  ④
08       bindings.excluding(user.password);  ⑤
09     }
10   }

① QueryDslPredicateExecutor为Predicate提供特殊的查询方法提供入口
② 在仓库接口定义QuerydslBinderCustomizer将自动注解@QuerydslPredicate(bindings=…)
③ 为username属性定义绑定,绑定到一个简单集合
④ 为String属性定义默认绑定到一个不区分大小写的集合
⑤ 从Predicate移除密码属性

仓库填充

如果你使用Spring JDBC模块,你可能熟悉在DataSource使用SQL脚本来填充.一个类似的抽象在仓库级别可以使用,尽管它不是使用SQL作为数据定义语言,因为它必须由存储决定.填充根据仓库支持XML(通过Spring的OXM抽象)和JSON(通过Jackson)定义数据.
假设你有一个文件data.json内容如下:
例36 JSON定义的数据

1 [ { "_class" : "com.acme.Person",
2      "firstname" : "Dave",
3       "lastname" : "Matthews" },
4       { "_class" : "com.acme.Person",
5      "firstname" : "Carter",
6       "lastname" : "Beauford" } ]

你可以容易的根据Spring Data Commons提供仓库的命名空间填充元素填充你的仓库.为了填充前面的数据到你的PersonRepository,像下面这样配置:
例37 声明一个Jackson仓库填充

01 <?xml version="1.0" encoding="UTF-8"?>
05     xsi:schemaLocation="https://www.springframework.org/schema/beans
09     <repository:jackson2-populator locations="classpath:data.json" />
10   </beans>

这样的声明可以让data.json文件可以被一个Jackson的ObjectMpper读取和反序列化.
JSON将要解析的对象类型由检查JSON文档的_class属性决定.基本组件将最终选择合适的仓库去处理反序列化的对象.
要使用XML定义数据填充仓库,你可以使用unmarshaller-populator元素.你配置它使用Spring OXM提供给你的XML装配选项.在Spring reference documentation查看更多细节.
例38 声明一个装配仓库填充器(使用JAXB)

01 <?xml version="1.0" encoding="UTF-8"?>
03       xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
04       xmlns:repository="https://www.springframework.org/schema/data/repository"
05       xmlns:oxm="https://www.springframework.org/schema/oxm"
06       xsi:schemaLocation="https://www.springframework.org/schema/beans
12       <repository:unmarshaller-populator locations="classpath:data.json"
13         unmarshaller-ref="unmarshaller" />
14       <oxm:jaxb2-marshaller contextPath="com.acme" />
15     </beans>

遗留web支持

Spring MVC的实体类绑定
如果正在开发Spring MVC web应用,你通常必须从URL中解析实体类的id.默认的,你的任务是转化请求参数或URL参数到实体类并将它移交给下面或直接在实体上操作业务逻辑.这看起来像下面这样:

01 @Controller
02 @RequestMapping("/users")
03 public class UserController {
04   private final UserRepository userRepository;
05  
06   @Autowired
07   public UserController(UserRepository userRepository) {
08     Assert.notNull(repository, "Repository must not be null!");
09     this.userRepository = userRepository;
10   }
11  
12   @RequestMapping("/{id}")
13   public String showUserForm(@PathVariable("id") Long id, Model model) {
14     // Do null check for id
15     User user = userRepository.findOne(id);
16     // Do null check for user
17     model.addAttribute("user", user);
18     return "user";
19   }
20 }

首先你为每个控制器定义一个依赖的仓库来查找它们分别管理的实体.查询实体也是样板,因为它总是一个findOne(…)调用.幸运的Spring提供了方法来注册自定义组件,允许一个String值转换到一个属性类型.
属性编辑
Spring3.0之前JavaPropertyEditors被使用.为了集成这些,Spring Data提出一个DomainClassPropertyEditorRegistrar来查询所有注册到ApplicatonContext的Spring Data仓库和一个定制的PropertyEditor来管理实体类.

01 <bean class="….web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
02   <property name="webBindingInitializer">
03     <bean class="….web.bind.support.ConfigurableWebBindingInitializer">
04       <property name="propertyEditorRegistrars">
05         <bean class=
06           "org.springframework.data.repository.support.DomainClassPropertyEditorRegistrar"/>
07       </property>
08     </bean>
09   </property>
10 </bean>

如果你已经像上面这样配置Spring MVC,你可以向下面这样配置你的控制器,从而减少不清晰和样板式的代码

1 @Controller
2 @RequestMapping("/users")
3 public class UserController {
4   @RequestMapping("/{id}")
5   public String showUserForm(@PathVariable("id") User user, Model model) {
6     model.addAttribute("user", user);
7     return "userForm";
8   }
9 }

最后更新：2017-05-19 11:01:49

  上一篇：go  《HttpClient 官方文档》第三章 HTTP 状态管理
  下一篇：go  《Log4j2官方文档》从Log4j 1.x迁移