SpringBoot官方网站例子--使用NEO4J访问图形数据库

本次我们讲述使用Springboot来操作 NEO4J增加和查找消息。图形数据库在实际开发中经常用到，可以用来金融行业反欺诈多维关联分析场景；社交网络图谱，获得人与人之间的关系;企业关系图谱。Neo4j是一个高性能的NOSQL图形数据库，是当今最流行的图数据库,基于 节点+关系 的架构，保存了图形数据的基本元素。同时，数据库也支持通过基础数据元素和独特的CQL查询语法，快速方便的检索、构建复杂的图表关系结果。本例你可以学到NEO4J安装和使用。

我利用业余时间，翻译了Spring官网的例子，方便中文不好的同学，将陆续发到头条上，欢迎大家关注，也可以上我个人BLOG：itmanclub.com，上面有已经翻译过的。

SpringBoot官方网站例子–使用NEO4J访问图形数据库
正文：

程序结构

└── src
 └── main
 └── java
 └── hello

pom.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>

 <groupId>org.springframework</groupId>
 <artifactId>gs-accessing-data-neo4j</artifactId>
 <version>0.1.0</version>

 <parent>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-parent</artifactId>
 <version>2.1.6.RELEASE</version>
 </parent>

 <properties>
 <java.version>1.8</java.version>
 </properties>

 <dependencies>
 <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-data-neo4j</artifactId>
 </dependency>
 </dependencies>

 <build>
 <plugins>
 <plugin>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-maven-plugin</artifactId>
 </plugin>
 </plugins>
 </build>

</project>

Spring Boot将会你做如下的事:

• 将 classpath 里面所有用到的jar包构建成一个可执行的 JAR 文件，方便执行你的程序
• 搜索public static void main()方法并且将它当作可执行类
• 根据springboot版本，去查找相应的依赖类版本，当然你可以定义其它版本。
  ** 创建一个Neo4j服务器**

在构建此应用程序之前，需要设置NEO4J服务器，NEO4J有一个开源服务器，您可以免费安装：

https://neo4j.com/download/community-edition/

安装后，采用默认配置，通过下面命令启动他：

$ neo4j start

启动后您应该看到这样的消息：

Starting Neo4j.
Started neo4j (pid 96416). By default, it is available at http://localhost:7474/
There may be a short delay until the server is ready.
See /usr/local/Cellar/neo4j/3.0.6/libexec/logs/neo4j.log for current status.

默认情况下，NEO4J的用户名/密码为neo4j/neo4j。但是，它要求更改新的帐户密码。为此，请执行以下命令：

$ curl -v -u neo4j:neo4j -X POST localhost:7474/user/neo4j/password -H "Content-type:application/json" -d "{\"password\":\"secret\"}"

这会将密码从neo4j更改为secret（在生产中不能执行某些操作！）完成后，你就准备好基础环境了。

** 定义简单实体**

Neo4j需要实体及其之间关系，假设您正在建模一个系统，在该系统中为每个人存储一个记录。但您还需要跟踪每一个人的同事关系（本例中的队友）。使用Neo4j，您可以通过一些简单的注释来捕获所有这些内容。

src/main/java/hello/Person.java

package hello;

import java.util.Collections;
import java.util.HashSet;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;

import org.neo4j.ogm.annotation.GeneratedValue;
import org.neo4j.ogm.annotation.Id;
import org.neo4j.ogm.annotation.NodeEntity;
import org.neo4j.ogm.annotation.Relationship;
@NodeEntity
public class Person {
 @Id @GeneratedValue private Long id;
 private String name;

 private Person() {
 // Empty constructor required as of Neo4j API 2.0.5
 };
 public Person(String name) {
 this.name = name;
 }
 /**
 * Neo4j并没有真正的双向关系,意味着当查询忽略关系的方向。
 * https://dzone.com/articles/modelling-data-neo4j
 */
 @Relationship(type = "TEAMMATE", direction = Relationship.UNDIRECTED)
 public Set<Person> teammates;

 public void worksWith(Person person) {
 if (teammates == null) {
 teammates = new HashSet<>();
 }
 teammates.add(person);
 }
 public String toString() {

 return this.name + "'s teammates => "
 + Optional.ofNullable(this.teammates).orElse(
 Collections.emptySet()).stream()
 .map(Person::getName)
 .collect(Collectors.toList());
 }

 public String getName() {
 return name;
 }
 public void setName(String name) {
 this.name = name;
 }
}

这里有一个只有一个属性的Person类，即name。

在本指南中，为了简洁起见，省略了典型的getter和setter。

Person类被注释为@NodeEntity。当neo4j存储它时，它会导致创建一个新的节点。此类还具有标记为@GraphId的ID。Neo4j在内部使用@GraphId跟踪数据。

下一个重要的部分是一组队友。这是一个简单的·Set·，但标记为@Relationship。这意味着该集合中的每个成员也应该作为单独的个人节点存在。

注意方向是如何设置为无向的。这意味着当您查询队友关系时，Spring Data Neo4j 将忽略关系的方向。

使用worksWith()，您可以轻松地将人员链接到一起。

最后，您有一个方便的toString()方法来打印出这个人的名字和他的同事。

** 创建简单查询 **

Spring Data Neo4j专注于在Neo4j中存储数据，但它继承了Spring Data Commons项目的功能，包括派生查询的能力。本质上，您不必学习Neo4j的查询语言，只需编写一些方法，本查询就是为您编写的。

要了解这是如何工作的，请创建一个查询人员节点的接口。

src/main/java/hello/PersonRepository.java

package hello;

import org.springframework.data.repository.CrudRepository;

public interface PersonRepository extends CrudRepository<Person, Long> {
 Person findByName(String name);
}

PersonRepository扩展了GraphRepository接口，并插入它要操作的类型：Person。这个接口有很多操作，包括标准的CRUD（创建、读取、修改、删除）操作，都可以开箱即用。

但您可以根据需要定义其他查询，只需声明它们的方法即可。在本例中，您添加了findByName，它查找Person类型的节点，并查找与name匹配的节点。您还拥有 findByTeammatesName，

它可以查找个人节点、同时取队友字段的每个条目，并根据队友的姓名进行匹配。

** 访问Neo4j的权限**

Neo4j社区版需要凭据才能访问它，这可以通过几个属性进行配置：

spring.data.neo4j.username=neo4j
spring.data.neo4j.password=secret

这包括默认用户名neo4j和我们之前新设置密码。

不要在源存储库中存储真正的登录信息，而是在运行时使用SpringBoot的属性覆盖来配置它们。

有了这个，让我们把它连接起来看看它是什么样子的！

** 创建Application类**

src/main/java/hello/Application.java

package hello;

import java.util.Arrays;
import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.data.neo4j.repository.config.EnableNeo4jRepositories;
@SpringBootApplication
@EnableNeo4jRepositories
public class Application {

 private final static Logger log = LoggerFactory.getLogger(Application.class);

 public static void main(String[] args) throws Exception {
 SpringApplication.run(Application.class, args);
 }

 @Bean
 CommandLineRunner demo(PersonRepository personRepository) {
 return args -> {
 personRepository.deleteAll();
 Person dufu = new Person("杜甫");
 Person sushi = new Person("苏轼");
 Person libai = new Person("李白");
 List<Person> team = Arrays.asList(dufu, sushi, libai);
 log.info("Before linking up with Neo4j...");
 team.stream().forEach(person -> log.info("\t" + person.toString()));
 personRepository.save(dufu);
 personRepository.save(sushi);
 personRepository.save(libai);

 dufu = personRepository.findByName(dufu.getName());
 dufu.worksWith(sushi);
 dufu.worksWith(libai);
 personRepository.save(dufu);

 sushi = personRepository.findByName(dufu.getName());
 sushi.worksWith(libai);
 // 我们已经苏轼和杜甫是同事
 personRepository.save(sushi);

 // 我们已经知道李白和苏轼、杜甫是同事

 log.info("Lookup each person by name...");
 team.stream().forEach(person -> log.info(
 "\t" + personRepository.findByName(person.getName()).toString()));
 };
 }

}

@SpringBootApplication包含如下注解:

• @Configuration 将类标记为应用程序上下文的bean定义源。
• @EnableAutoConfiguration 告诉SpringBoot根据类路径设置、其他bean和各种属性设置开始添加bean。
• @ComponentScan 告诉Spring在hello包中查找其他组件、配置和服务。

您注意到没有一行XML吗？也没有web.xml文件。这个Web应用程序是100%纯Java，您不必麻烦的基础配置。

只要这些存储库包含在@SpringBootApplication类的同一个包（或子包）中，SpringBoot就会自动处理这些存储库。为了更好地控制注册过程，可以使用@EnableNeo4jRepositories注释。

默认情况下，@EnableNeo4jRepositories将扫描当前包中任何扩展了Spring Data 存储库接口的接口。如果您的项目布局有多个项目，并且没有找到您的存储库，请使用它的basePackageClasses=MyRepository.class告诉Spring Data Neo4j按类型扫描不同的根包。

您可以自动连接前面定义的PersonRepository实例。Spring Data Neo4j将动态地实现该接口，并插入所需的查询代码以满足接口的要求。

在本例中，您创建了三个本地人， 杜甫, 苏轼 和 李白。最初，它们只存在于内存中，并且没有人是任何人的队友。

首先，你找到杜甫，指出他和苏轼和李白一起工作，然后保存起来。记住，队友关系被标记为无向，即双向。这意味着苏轼和李白也将被更新。

这就是为什么当你需要更新苏轼的时候，首先从Neo4j那里获取记录是至关重要的。在把杜甫加入名单之前，你需要了解苏轼队友的最新情况。

为什么没有获取李白并添加任何关系的代码？因为你已经有了！杜甫早些时候把李白列为队友，苏轼也是。这意味着没有必要再更新李白的关系。您可以在迭代每个团队成员并将其信息打印到控制台时看到它。

** 运行你的程序(STS下，Maven可参考前面文章)**

你会看见如下的输出:

Before linking up with Neo4j...
 dufu's teammates => []
 sushi's teammates => []
 libai's teammates => []

Lookup each person by name...
 dufu's teammates => [sushi, libai]
 sushi's teammates => [dufu, libai]
 libai's teammates => [sushi, dufu]

从输出中可以看到，最初没有人通过任何关系进行连接。然后，在加入人员后，他们被捆绑在一起。最后，您可以看到根据队友查找人员的便捷性。

祝贺你！您刚刚设置一个嵌入式NEO4J服务器，存储一些简单的相关实体，并开发一些快速查询。

如果您有兴趣使用基于超媒体的RESTful前端轻松地公开 Neo4j存储库，那么您可能希望使用REST读取访问Neo4j Data。