Spring Data Neo4j简介

曾经终败给现在 2022-09-18 04:55 318阅读 0赞

本文来源于我在InfoQ中文站原创的文章，原文地址是：[http://www.infoq.com/cn/news/2013/11/spring-data-neo4j-intro][http_www.infoq.com_cn_news_2013_11_spring-data-neo4j-intro]

[Neo4j][]是一款非常流行的开源图型NoSQL数据库。它完全支持ACID数据库事务属性，由于其良好的图数据模型设计，Neo4j的速度非常快。对于连接的数据操作，Neo4j的速度要比传统的关系型数据库快1000倍。[Spring Data][]是[Spring][]的一个核心项目，其下涵盖了如[Spring Data JPA][]、[Spring Data MongoDB][]、[Spring Data Redis][]、[Spring for Hadoop][]等子项目，而[Spring Data Neo4j][]也是Spring Data下的一个重要子项目，它提供了高级的特性以将注解的实体类映射到Neo4j图型数据库上。其模板编程模型类似于我们熟知的Spring模板，为与图的交互提供了基础，此外也用于高级的仓库支持。该项目旨在为NoSQL数据库操作提供便捷的支持。

为了能让读者快速上手Spring Data Neo4j，[Daniel Bartl][]开发了一个初学者入门示例，通过该示例，新手可以迅速掌握Spring Data Neo4j的核心概念与操作，也能进一步理解图型数据库的设计理念。

该示例是个购物系统，因此要能计算出其他用户的浏览结果供当前用户参考，现在很多电商都提供了这个特性。由于用户与商品之间的联系是很容易使用图来表达的，因此该示例将使用Neo4j来表示结点以及结点之间的关系。

**Spring Data Neo4j简介**

首先来介绍一下Spring Data。这是SpringSource的一个项目，旨在为NoSQL数据库提供Spring的编程模型以及便捷性。Spring Data支持各种NoSQL数据库，如Redis、Riak以及MongoDB等等。它还为Hadoop等MapReduce实现提供了一个抽象层。

Spring Data Neo4j起步于2010年，你可以在Neo4j网站上找到很多有价值的资源。目前最棒的指南就是由该项目的主开发者Michael Hunger所编写的“[Good Relationships][]”，这本指南提供了免费的下载，也有相应的[HTML版本][HTML]。其中有些Spring Data Neo4j代码示例位于[Spring Data Neo4j Git仓库][Spring Data Neo4j Git]上。此外，O’Reilly也有一本关于Spring Data Neo4j的[图书][Link 1]。

**为何不使用核心Neo4j？**

当然了，你也可以只使用核心Neo4j或是构建自己的集成方案。但如果你过去曾有过其他的Spring项目开发经验，那么你就会发现Spring的好处了。作为一名软件工程师，你不想关注于实体映射或是事务管理等细节信息。你只要了解这些概念就行了，剩下的事情Spring会帮你处理，这相当于Spring中的Hibernate支持一样：

*  通用的Spring与Spring Data基础设施。你可以轻松将Neo4j嵌入到Spring框架所管理的现有应用当中。
 *  通过注解来声明结点以及结点之间的关系。
 *  代码很容易理解。
 *  实体状态由图型数据库所维护。
 *  支持Neo4j服务器。

**如何使用Spring Data Neo4j？**

如果使用Maven，那么你可以通过将如下配置添加到pom.xml中将Spring Data Neo4j引入到项目中来（除了Spring与Neo4j的依赖外）：

![1.PNG][]

通过如下Spring上下文来设置Neo4j：

![2.PNG][]

Neo4j配置的“storeDirectory”属性可以是任意的目录，Neo4j数据库将会存储在那里。接下来开始实现代表图模型的结点与关系实体。

**如何声明结点实体？**

创建如下的类来表示结点实体：

![3.PNG][]

在Spring框架中getters与setters对于属性访问是必须的。你还可以实现自己的额外的方法。一个典型的Neo4j实体一般是个经典的JavaBean，包含了属性以及访问器。此外，我们还建议实现equals与hashCode方法，因为有时Spring Data Neo4j会比较对象来判断结点与关系映射。

**如何创建结点实体间的关系？**

Spring Data可以通过3种不同的方式来处理结点间的关系，到底选择哪一种取决于两个方面：需要建模的关系类型（1对1还是1对多）以及是简单关系还是复杂关系。复杂关系拥有额外的属性。

1对1关系非常简单：父结点通过属性来引用子节点（需要实现访问器），无需注解。Spring Data会处理所有其他事情。

在简单的1对多关系中，你需要在父结点中添加一个包含子结点的集合（参见上述代码示例）。除此之外，你还需要通过@RelatedTo(type = “relationshipType”) 对集合添加注解，如下所示：

![4.PNG][]

复杂关系能够展示出Spring Data强大的图建模能力。你可以通过额外的属性对真实世界的关系建模，为了做到这一点，你需要创建用于存储关系属性的关系实体。此外，还需要通过注解（@StartNode与@EndNode）来指定父结点和子结点。参加如下代码示例：

![5.PNG][]

要注意@Fetch属性。在很多情况下，在加载完特定的实体后，并不是所有相关的1对多对象都需要加载出来。当加载了一个结点实体后，Spring Data的默认行为只是取得标识相关对象的ID列表。这种方式类似于Hibernate等框架的延迟加载机制。如果不希望这样，那可以在相应的结点实体上添加@Fetch注解。

一般来说，将关系类型作为常量定义在单独的类中是个好做法，因为这些字符串会用在不同类中的不同结点上。我们的图模型在结点间存在两种关系类型，因此这个类如下代码所示：

![6.PNG][]

**如何加载实体及实体间的关系？**

要想访问实体与关系，我们需要创建自己的接口并继承Spring的GraphRepository接口，如下代码所示：

![7.PNG][]

如你所见，这个图仓库是个接口，只定义了函数名、返回值与Cypher查询（如果需要的话）。这非常方便，因为框架并不需要相应的实现。根据上面声明的参数以及父接口“GraphRepository”，Spring Data可以创建出与Neo4j核心API交互的代理对象。要想了解更多细节信息，请参阅关于[仓库的文档][Link 2]。如果不熟悉Cypher，那么请看看这个[Cypher指南][Cypher]。然而，有时自己实现GraphRepository也是必要的，在这种情况下，你可以编写一个类并继承该接口。

**Spring Data Neo4j有哪些限制？**

Spring Data Neo4j有如下一些限制：

*  现在，它无法运行同时包含DISTINCT与ORDER BY的Cypher查询。
 *  如果遇到问题，日志消息不太直观。

**关于示例**

该示例展示了一个购物系统的图仓库部分，重点是获得其他用户也查看过的商品。比如说，如果浏览过“奶酪比萨”页面的用户也看过“培根披萨”页面，那么这对于寻找“奶酪比萨”的用户也会很有用。

你可以在[SpringDataNeo4jProductUserTest类][SpringDataNeo4jProductUserTest]中找到一些测试用例。

**如何运行示例？**

要想运行示例，你需要先安装好Maven。如果不熟悉Maven，那么可以阅读这篇[文章][Link 3]来了解Maven的使用。

示例代码位于github上，地址是[https://github.com/comsysto/spring-data-neo4j-showcase][https_github.com_comsysto_spring-data-neo4j-showcase]。

**遇到问题怎么办？**

在准备这个示例时，我们遇到了一些挑战，相信你可能也会遇到：

*  小心索引。如果使用id，那么应该在代码中将其声明为唯一的。
 *  如果使用的关系有属性，那么应该使用@RelatedToVia。
 *  初始化所有集合，比如说上述示例中使用的HashSet。
 *  不要将graphId作为id。被删除结点的graphId会被Neo4j重用，并且在删除前一个后会用来表示另一个对象。
 *  对于关系的开始与结束结点使用@Fetch，否则在加载结点时是不会获取他们的。
 *  不要修改getters与setters，因为他们会被框架用来保存值。
 *  使用简单的语句来开始Cypher查询，然后不断扩展直到达到自己的目标。
 *  小心Cypher查询中的字符串 转义。Neo4j核心API中的字符串转义与Spring Data的不同。

**如何扩展示例？**

你可以根据自己的需要扩展示例。比如说，可以向结点实体添加更多的属性等。

**关于Neo4j的学习资源**

上文已经提到过，该项目的主开发者Michael Hunger所编写的“Good Relationships”一书是最佳的学习资源，该书已经由InfoQ发布，感兴趣的读者可以免费[下载][Good Relationships]学习。另外，该书的中文版也将于不久之后发布，欢迎广大读者届时关注。

[http_www.infoq.com_cn_news_2013_11_spring-data-neo4j-intro]: http://www.infoq.com/cn/news/2013/11/spring-data-neo4j-intro
[Neo4j]: http://www.neo4j.org/
[Spring Data]: http://projects.spring.io/spring-data
[Spring]: http://spring.io
[Spring Data JPA]: http://projects.spring.io/spring-data-jpa
[Spring Data MongoDB]: http://projects.spring.io/spring-data-mongodb
[Spring Data Redis]: http://projects.spring.io/spring-data-redis
[Spring for Hadoop]: http://projects.spring.io/spring-hadoop
[Spring Data Neo4j]: http://www.springsource.org/spring-data/neo4j
[Daniel Bartl]: http://java.dzone.com/users/danielbartl
[Good Relationships]: http://www.infoq.com/minibooks/good-relationships-spring-data
[HTML]: http://static.springsource.org/spring-data/data-graph/snapshot-site/reference/html/
[Spring Data Neo4j Git]: https://github.com/SpringSource/spring-data-neo4j/tree/master/spring-data-neo4j-examples
[Link 1]: http://shop.oreilly.com/product/0636920024767.do
[1.PNG]: http://infoqstatic.com/resource/news/2013/11/spring-data-neo4j-intro/zh/resources/1.PNG
[2.PNG]: http://infoqstatic.com/resource/news/2013/11/spring-data-neo4j-intro/zh/resources/2.PNG
[3.PNG]: http://infoqstatic.com/resource/news/2013/11/spring-data-neo4j-intro/zh/resources/3.PNG
[4.PNG]: http://infoqstatic.com/resource/news/2013/11/spring-data-neo4j-intro/zh/resources/4.PNG
[5.PNG]: http://infoqstatic.com/resource/news/2013/11/spring-data-neo4j-intro/zh/resources/5.PNG
[6.PNG]: http://infoqstatic.com/resource/news/2013/11/spring-data-neo4j-intro/zh/resources/6.PNG
[7.PNG]: http://infoqstatic.com/resource/news/2013/11/spring-data-neo4j-intro/zh/resources/7.PNG
[Link 2]: http://static.springsource.org/spring-data/data-graph/snapshot-site/reference/html/#d5e1351
[Cypher]: http://www.neo4j.org/learn/cypher
[SpringDataNeo4jProductUserTest]: https://github.com/comsysto/spring-data-neo4j-showcase/blob/master/src/test/java/com/comsysto/neo4j/showcase/SpringDataNeo4jProductUserTest.java
[Link 3]: http://maven.apache.org/run-maven/index.html
[https_github.com_comsysto_spring-data-neo4j-showcase]: https://github.com/comsysto/spring-data-neo4j-showcase