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 Repository 导出到 Web。它通过将 Repository 导出到可通过几种不同方式配置的 RESTful URL 来提供一致的交互 API。
Spring Data REST 支持顶级实体(由 Spring Data Repository 直接管理的领域对象)的 CRUD 操作,只需编写一行代码,定义一个扩展 Spring Data CrudRepository
接口的接口即可。完成这些后,您的实体将拥有完整的 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 Resource 表示形式来访问所有实体和集合。访问这些 RESTful URL 的用户代理不需要特殊了解后端实体由哪个数据存储管理,而且最重要的是,您无需编写任何代码即可获得该功能!
MongoDB 支持
Spring Data REST 1.1 现在支持导出 MongoDB CrudRepository
实现。相同的 HTTP 语义适用于 MongoDB @Document
实体和 JPA 实体。当然支持 GET、POST、PUT、DELETE,也支持 @DBRef
。您可以使用 GET、POST、PUT 和 DELETE 查看和管理两个文档之间的关系,并且可以根据您的 @Query
定义导出 finder 方法。请参阅 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 Web 应用。但是当您将 Spring Data REST 添加到您自己的服务中时,事情会变得非常有趣。
Spring HATEOAS 作者 Oliver Gierke 创建了一个示例应用程序,演示了在现代 Web 应用程序中使用 HATEOAS 原则。它被称为 spring-restbucks,是 Jim Webber、Savas Parastatidis 和 Ian Robinson 在《REST in Practice》一书中描述的 Restbucks 应用程序的实现,该书是关于 REST 服务的系统性理论:《REST 实战》。
混合使用 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 Filter,它的工作效果将远优于 1.0 版本中 JSONP 的实现方式。当该过滤器普遍可用时,JSONP 支持不仅可以添加到 Spring Data REST 中,还可以添加到几乎任何基于 Servlet 的 REST 资源中。
安装与文档
要开始尝试使用 Spring Data REST,请查看参考文档,了解其概况,然后通过简单地将 spring-data-rest-webmvc
artifact(目前在SpringSource 里程碑仓库中为 1.1.0.M1)添加到您的项目中,从而在您自己的应用程序中开始使用它,然后导入 Spring Data REST 配置,就像您在 spring-restbucks 应用程序中看到的那样。
在 CONFESS_2013 了解更多信息
如果您计划参加 4 月第一周在维也纳举行的 CONFESS_2013 会议,那么您可以在我关于将实体直接导出到 Web 的演讲中了解所有关于 Spring Data REST 的信息。
链接
Spring Data REST 主页 | GitHub 上的源代码 | 参考文档