关于Spring Data Rest的两项技术疑问:资源概念与CrudRepository方法暴露
Spring Data Rest 技术疑问解答
一、Method与Resource的区别及Spring Data Rest中Resource的定义
- Resource(资源):在Spring Data Rest里,Resource就是对外暴露的实体数据集合或单个实体,对应REST架构的核心资源概念。比如你提到的
contacts就是一个资源,它对应数据库中的联系人数据表,外部可通过/contacts访问这个资源集合,通过/contacts/{id}访问单个联系人资源。每个资源都有专属URI,作为数据的唯一标识。 - Method(方法):指对Resource执行的HTTP操作,比如GET、POST、PUT、DELETE等,对应CRUD的查、增、改、删动作。比如配置里的
get-contacts就是对contacts资源执行GET查询集合的方法,delete-contact是对单个contact资源执行DELETE删除的方法。简言之,Resource是操作的对象,Method是针对该对象的具体动作。
二、CrudRepository方法未全部暴露的原因
Spring Data Rest默认仅暴露符合REST风格的常用CRUD端点,不会把CrudRepository的所有方法都直接映射为HTTP接口,具体原因和规则如下:
- REST风格适配逻辑
findAllById:该方法接收ID集合查询多个实体,但REST规范中查询集合的标准方式是GET /contacts,若需按ID过滤,通常通过请求参数(如/contacts?id=1&id=2)实现,Spring Data Rest默认不会为该方法单独生成端点,你可通过自定义查询方法或手动配置暴露。existsById:该方法用于判断实体是否存在,Spring Data Rest默认不单独暴露此端点,因为可通过GET /contacts/{id}间接判断——返回200表示存在,404表示不存在,这更契合REST设计理念,无需额外的exists接口。
- 默认暴露规则
Spring Data Rest默认暴露与标准HTTP方法对应的CrudRepository方法:POST /contacts→save(创建实体)GET /contacts→findAll(查询集合)GET /contacts/{id}→findById(查询单个实体)PUT /contacts/{id}→save(更新实体)PATCH /contacts/{id}→ 部分更新实体DELETE /contacts/{id}→deleteById(删除实体)
像findAllById、existsById这类方法,因无对应的标准REST端点语义,默认不暴露。若需暴露,可在Repository接口上使用@RestResource注解指定,示例代码:
@RestResource(path = "find-all-by-id", rel = "find-all-by-id") List<Contact> findAllById(Iterable<Long> ids); - 结合你提供的配置示例
示例中仅包含创建、查询集合、删除单个、部分更新、查询单个、更新单个这些标准REST操作,以及自定义的getAllByStatus、getAllByCreatedBy方法和deleteById(对应DELETE /contacts/{id}),完全符合Spring Data Rest的默认暴露规则,findAllById和existsById不在默认暴露列表中,因此未出现在配置里。
内容的提问来源于stack exchange,提问作者AMZ
相关产品推荐
相关产品推荐

