Repository的概念
在Spring中有Repository的概念,repository原意指的是仓库,即数据仓库的意思。Repository居于业务层和数据层之间,将两者隔离开来,在它的内部封装了数据查询和存储的逻辑。这样设计的好处有两个:
- 降低层级之间的耦合:更换、升级ORM引擎(Hibernate)并不会影响业务逻辑
- 提高测试效率:如果在测试时能用Mock数据对象代替实际的数据库操作,运行速度会快很多
Repository和DAO的区别
DAO是传统MVC中Model的关键角色,全称是Data Access Object。DAO直接负责数据库的存取工作,乍一看两者非常类似,但从架构设计上讲两者有着本质的区别:
Repository蕴含着真正的OO概念,即一个数据仓库角色,负责所有对象的持久化管理。DAO则没有摆脱数据的影子,仍然停留在数据操作的层面上。Repository是相对对象而言,DAO则是相对数据库而言,虽然可能是同一个东西 ,但侧重点完全不同。
三种Repository介绍
在Spring和Spring Data JPA中,有三种Repository接口方便开发者直接操作数据仓库。
它们之间的关系如下:
CrudRepository
<S extends T> S save(S entity);
<S extends T> Iterable<S> save(Iterable<S> entities);
T findOne(ID id);
boolean exists(ID id);
Iterable<T> findAll();
Iterable<T> findAll(Iterable<ID> ids);
long count();
void delete(ID id);
void delete(T entity);
void delete(Iterable<? extends T> entities);
void deleteAll();
CrudRepository类如其名,可以胜任最基本的CRUD操作。其中save方法在可两用,参数中不存在主键时执行insert操作,存在主键则执行update操作,相当于是一个upsert操作。
PagingAndSortingRepository
Iterable<T> findAll(Sort sort);
Page<T> findAll(Pageable pageable);
PagingAndSortingRepository继承了CrudRepository接口,增加了分页和排序的方法。
分页
要达到分页的目的,需要传入一个Pageble接口对象,controller中代码如下:
@GetMapping("")
public ResponseEntity<?> getList(
@RequestParam(value="page", defaultValue="0") int page,
@RequestParam(value="size", defaultValue="10") int size ) {
Pageable pageable = new PageRequest(page, size);
return new ResponseEntity<Object>(userService.getUserList(pageable), HttpStatus.OK);
}
<说明>
- @RequestParam注解,表明了需要传入URL参数page和size,用于计算分页的offset值。
- PageRequest是Pageable的实现类,传入初始化page和size即可生成分页参数。
在Service中,仅需加入pageable对象即可达到分页的效果。代码如下:
public Iterable<User> getUserList(Pageable pageable) {
return userRepo.findAll(pageable);
}
此时在POSTMAN中输入访问地址:’127.0.0.1:8080/user?page=0&size=5’,得到以下结果:
{
"content": [
{ "id": 12, "name": "F1" },
{ "id": 13, "name": "A" },
{ "id": 14, "name": "B" },
{ "id": 15, "name": "C" },
{ "id": 16, "name": "D" }
],
"last": false,
"totalPages": 3,
"totalElements": 11,
"size": 5,
"number": 0,
"numberOfElements": 5,
"first": true,
"sort": null
}
从结果可以看出,不仅在content中有查询的数组信息,还包括totalPages等分页信息。
排序
与分页类似,要达到排序的目录,仅需要传入Sort对象即可,controller中代码如下:
@GetMapping("")
public ResponseEntity<?> getList(
@RequestParam(value="page", defaultValue="0") int page,
@RequestParam(value="size", defaultValue="10") int size ) {
Sort sort = new Sort(Sort.Direction.DESC, "name");
// Pageable pageable = new PageRequest(page, size);
return new ResponseEntity<Object>(userService.getUserList(sort), HttpStatus.OK);
}
同样的,在Service中需要新增接口,如下:
public Iterable<User> getUserList(Sort sort) {
return userRepo.findAll(sort);
}
此时在POSTMAN中输入访问地址:’127.0.0.1:8080/user’,得到以下结果:
[
{ "id": 22, "name": "K" },
{ "id": 21, "name": "J" },
{ "id": 20, "name": "I" },
{ "id": 19, "name": "H" },
{ "id": 18, "name": "G" },
{ "id": 12, "name": "F1" },
{ "id": 17, "name": "E" },
{ "id": 16, "name": "D" },
{ "id": 15, "name": "C" },
{ "id": 14, "name": "B" },
{ "id": 13, "name": "A" }
]
得到的正是name属性按DESC排序的结果列表
排序后分页
PagingAndSortingRepository提供了分页和排序的接口,那如果两者都要做,该怎么写呢?
其实在Pageable中,还可以传入Sort属性,这样就可以在分页中达到排序的目的。
同样的,把Controller代码稍稍调整一下:
@GetMapping("")
public ResponseEntity<?> getList(
@RequestParam(value="page", defaultValue="0") int page,
@RequestParam(value="size", defaultValue="10") int size ) {
Sort sort = new Sort(Sort.Direction.DESC, "name");
Pageable pageable = new PageRequest(page, size, sort);
return new ResponseEntity<Object>(userService.getUserList(pageable), HttpStatus.OK);
}
<说明>
- Sort对象作为PageRequest的第三个参数传入。
这样调整以后,UserService这边就不在需要入参为Sort的getUserList接口了。
此时在POSTMAN中输入访问地址:’127.0.0.1:8080/user?page=0&size=5’,得到以下结果:
{
"content":[
{"id":22,"name":"K"},
{"id":21,"name":"J"},
{"id":20,"name":"I"},
{"id":19,"name":"H"},
{"id":18,"name":"G"}
],
"totalPages":3,
"totalElements":11,
"last":false,"size":5,
"number":0,
"first":true,
"numberOfElements":5,
"sort":[{
"direction":"DESC",
"property":"name",
"ignoreCase":false,
"nullHandling":"NATIVE",
"ascending":false,
"descending":true
}]
}
sort显然不应该出现在应答结果中,以后的代码会将它去除出去。
JpaRepository
List<T> findAll();
List<T> findAll(Sort sort);
List<T> findAll(Iterable<ID> ids);
<S extends T> List<S> save(Iterable<S> entities);
void flush();
<S extends T> S saveAndFlush(S entity);
void deleteInBatch(Iterable<T> entities);
void deleteAllInBatch();
T getOne(ID id);
@Override
<S extends T> List<S> findAll(Example<S> example);
@Override
<S extends T> List<S> findAll(Example<S> example, Sort sort);
JpaRepository则进一步在PagingAndSorting的基础上,扩展了部分功能:
- 查询列表(返回值为List)
- 批量删除
- 强制同步
- Example查询
这部分将在以后的内容中不断细化。