Spring Data 团队很高兴宣布使用 RESTful 语义将领域对象导出到 Web 的下一步重要进展:Spring Data REST 1.1.0.M1 现已在 SpringSource 里程碑仓库中可用。
Spring Data REST 主页 | GitHub 上的源码 | 参考文档
将领域对象导出到 Web
Spring Data REST 是一组 Spring MVC 组件,您可以将其添加到自己的 Spring MVC 应用中,使用 RESTful、HATEOAS 语义将您的 Spring Data Repositories 导出到 Web。通过将 Repository 导出到可以通过几种不同方式配置的 RESTful URL,它提供了一个一致的交互 API。
Spring Data REST 通过字面上只写一行代码来定义一个扩展 Spring Data 的 CrudRepository
接口的接口,从而支持顶级实体(由 Spring Data Repository 直接管理的那些领域对象)的 CRUD 操作。完成后,您的实体就具备了完整的 RESTful 语义。您可以使用遵循 HATEOAS 原则、可发现的标准 URL 创建新实体、更新现有实体和删除它们。这意味着访问您的 Spring Data REST 应用的用户代理无需预先了解您正在导出哪些资源。它可以通过对 JSON 中提供的 URL 进行连续调用来发现存在哪些实体以及这些实体上存在哪些关系。这些“链接”是 HATEOAS REST 应用的真正基础和力量所在。
彻底的改变
版本 1.1 几乎是彻底重写。它不仅比 1.0 更易于配置,并且更好地符合 Spring 3.2 过渡对 Spring MVC 的期望,而且 Spring Data REST 内部最大的变化在于它现在支持 JPA 以外的其他类型的 Spring Data Repository 实现。无论使用何种底层数据存储,CRUD 和关系管理(如果数据存储支持)的 HTTP 语义保持不变。
这意味着现在可以在同一个 Spring Data REST 应用中导出 JPA 实体和 MongoDB 实体,并使用通用的 URL 结构以及所有实体和集合的标准 Spring HATEOAS 资源表示来访问这些实体。访问这些 RESTful URL 的用户代理无需了解底层实体由哪个数据存储管理,最重要的是,您无需编写任何代码即可获得该功能!
MongoDB 支持
Spring Data REST 1.1 现在支持导出 MongoDB CrudRepository
实现。适用于 MongoDB @Document
实体的 HTTP 语义与适用于 JPA 实体的相同。当然支持 GET、POST、PUT、DELETE,@DBRef
也支持。您可以使用 GET、POST、PUT 和 DELETE 查看和管理两个文档之间的关系,并且可以根据您的 @Query
定义导出查找方法。请参考 spring-data-mongodb 参考文档,了解对象映射与 JPA 风格映射的不同之处以及查询定义的工作原理的完整详细信息。
Gemfire 支持
Spring Data REST 1.1 现在支持将使用高性能 Gemfire 数据库 的实体导出到不同的 Region。阅读 Spring Data Gemfire 文档,了解广泛的配置选项以及 Gemfire 中的 POJO 映射与其他映射技术的不同之处的完整解释。
接下来将支持 Neo4J
Spring Data REST 1.1 现已准备好在下一版本 spring-data-neo4j 2.3 中支持 Neo4J GraphRepository
。当该版本正式发布(应与 Spring Data REST 1.1 RELEASE 同时或之前发布)时,您将能够使用标准的 HATEOAS 语义访问 @NodeEntity
及其关系,就像您使用其他数据存储一样。
将其添加到现有应用中
Spring Data REST 的设计方式允许您,如果愿意,为 Spring Data REST 应用创建一个完整的应用。毕竟它只是一个标准的 Spring MVC webapp。但当您将 Spring Data REST 添加到您自己的服务中时,事情就会变得非常有趣。
Spring HATEOAS 作者 Oliver Gierke 创建了一个示例应用,演示了在现代 Web 应用中使用 HATEOAS 原则。它被称为 spring-restbucks,是 Rest 服务系统神学中描述的 Restbucks 应用的一个实现:Jim Webber、Savas Parastatidis 和 Ian Robinson 合著的 REST in Practice。
混合 REST 服务
通过将 Spring Data REST 与您的其他 RESTful 服务混合使用,您可以实现 Spring Data REST 导出的领域对象(无需编写任何代码即可暴露的对象)与那些不代表实际实体而是代表流程的服务之间的无缝集成。您可以在 spring-restbucks 应用中看到支付服务如何与领域对象 CRUD 交互的示例,其中信用卡支付处理由自定义控制器处理,而对象 CRUD 由 Spring Data REST 处理。您的自定义控制器实际上可以 piggyback 到 Spring Data REST URL 上,以便在整个应用中保持一致且简单的 URL 结构,无论该 URL 是指您的自定义控制器、Spring Data REST JPA Repository 还是任何其他支持的 Repository 风格。
并非排他性
使用 Spring Data REST 并非非此即彼。如果您不想将所有 Repository 暴露给 Web 客户端,没问题!有几种不同的方法可以关闭 Repository 的功能。您可以在源代码中嵌入注解,或者如果您无法访问或只是不能添加 Spring Data REST 注解,可以使用流畅的 DSL 风格配置来告诉 Spring Data REST 如何暴露您的资源。在您的应用中使用 Spring Data REST 并非意味着您只能采用一种方式。Spring Data REST 的结构设计使其可以与您现有应用良好配合,因此您可以整合您想要的 Spring Data REST 功能,同时仍然保留您习惯在 Spring MVC 控制器中创建的所有自定义编码服务。
JSONP 支持将移至过滤器
Spring Data REST 1.0 内置的 JSONP 支持已从核心框架中移除,取而代之的是即将推出的通用 JSONP Servlet 过滤器,该过滤器将比 1.0 版本中 JSONP 的实现方式工作得更好。当该过滤器正式可用时,JSONP 支持不仅可以添加到 Spring Data REST 中,还可以添加到几乎任何基于 Servlet 的 REST 资源中。
安装和文档
要开始尝试 Spring Data REST,请查看 参考文档,了解概况,然后通过简单地将 spring-data-rest-webmvc
artifact(当前版本为 1.1.0.M1,位于 SpringSource 里程碑仓库中)的依赖项添加到您的应用中,然后导入 Spring Data REST 配置,就像您在 spring-restbucks 应用中看到的那样,即可开始使用。
在 CONFESS_2013 了解更多
如果您计划参加四月第一周在维也纳举行的 CONFESS_2013,那么您可以在我关于将实体直接导出到 Web 的演讲中了解所有关于 Spring Data REST 的信息。
链接
Spring Data REST 主页 | GitHub 上的源码 | 参考文档