Spring-data-neo4j实例入门
本文通过一个简单的电影和演员的实例简要介绍如何使用spring-data-neo4j访问neo4j数据库。
关于图数据库的理论以及使用场景不在本文的讨论访问，关于图数据库和关系数据库的比较也不在本文的讨论范围。 本文主要介绍一个简单的使用场景，就是Movie和Person， person和movie的关系有actor和director， 一个movie可能有多个person担任actor， 同时也可能有多个director。 也就是person和movie之间存在ACTED_IN和DIRECTED者两条关系，在图数据库中，就是，一个person可能指向多个movie， 指向同一个movie时也可能有两条线，分别为ACTED_IN和DIRECTED关系。
- 安装neo4j数据库
- 在Maven项目添加spring-data-neo4j和相关依赖
- 编写domain对象
- *继承Neo4jRepository接口
- 实现service
- 在Controller中访问
- 运行截图
- 总结
1， 安装neo4j数据库
网上关于如何安装neo4j数据库的介绍很多本文就不再赘述。 笔者采用默认安装。 访问地址为http://127.0.0.1:7474/browser/， 数据库访问的协议是bolt://localhost
2， 添加java项目依赖。
主要是spring-boot-starter-data-neo4j添加该依赖，参考spring boot guide。
<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.yq</groupId>
<artifactId>demo-data-neo4j</artifactId>
<version>0.1.0</version>
...
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-neo4j</artifactId>
</dependency>
<dependency>
<groupId>org.neo4j</groupId>
<artifactId>neo4j</artifactId>
<version>3.2.9</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.neo4j</groupId>
<artifactId>neo4j-ogm-embedded-driver</artifactId>
<version>${neo4j-ogm.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.neo4j</groupId>
<artifactId>neo4j-ogm-bolt-driver</artifactId>
<version>${neo4j-ogm.version}</version>
</dependency>
<!-- lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</dependencies>
...
</project>
3， 编写domain对象
本文中的有两个对象Movie和Person，都比较简单。 代码如下. 需要注意的是要加上@NoArgsConstructor
和@NodeEntity， 其中@NoArgsConstructor自动为我们创建一个无参数的构造函数，这个spring-ogm会用到。@NodeEntity表示这个是neo4j数据库中的node。
//也就是演员指向电影
@Relationship(type = “DIRECTED”, direction = Relationship.OUTGOING)
private List dMovies;
表示演员到movie存在一条关系，就是person会指向movie，我们没有在关系上添加属性，可以在以后的例子中再扩展成，分别担任什么角色，或者是主导演还是副导演等等。
@lombok.Data
@NoArgsConstructor
@NodeEntity
public class Movie{
@Id
@GeneratedValue
private Long id;
private String title;
private String category;
private int revenue;
public Movie (String title, String category, int revenue) {
this.title = title;
this.category = category;
this.revenue = revenue;
}
}@lombok.Data
@NoArgsConstructor
@NodeEntity
public class Person{
@Id
@GeneratedValue
private Long id;
private String firstName;
private String lastName;
private int height;
public Person (String firstName, String lastName, int height) {
this.firstName = firstName;
this.lastName = lastName;
this.height = height;
}
@Relationship(type = "ACTED_IN", direction = Relationship.OUTGOING)
private List<Movie> aMovies;
//也就是演员指向电影
@Relationship(type = "DIRECTED", direction = Relationship.OUTGOING)
private List<Movie> dMovies;
//Entities handled by the OGM must have one empty public constructor to allow the library to construct the objects.
public void addActMovie(Movie movie) {
if (this.aMovies == null) {
this.aMovies = new ArrayList<>();
}
this.aMovies.add(movie);
}
public void addDirectMovie(Movie movie) {
if (this.dMovies == null) {
this.dMovies = new ArrayList<>();
}
this.dMovies.add(movie);
}
}4，继承Neo4jRepository接口
Neo4jRepository就如同spring jpa中的JpaRepository一样， 已经帮我们实现很多save、delete、findAll、 findOne、分页等功能，还能根据方法的名字和查询关系字符串自动组成And， or GT LT等等。
MovieRepository中的findByTitle方法会自动按照title帮我们查询Movie，就相当于MATCH (n:Movie) WHERE n.title = {title} RETURN n
而findByRevenueGreaterThan(int revenue);方法就相当于MATCH (n:Movie) WHERE n.revenue > {revenue} RETURN n
public interface MovieRepository extends Neo4jRepository<Movie, Long> {
Movie findByTitle(@Param("title") String title);
Collection<Movie> findByRevenueGreaterThan(int revenue);
}PersonRepository和MovieRepository类似就不展示了，详细可见代码。 欢迎加start和fork。
5， 实现service
一般而言单个repository只是实现该对象的自身的一下CRUD，如果我们要做业务上的操作，需要在service中完成，比如完成演员到movie的关系添加， 在service中，有个方法addActor2Movie。该放到先调用PersonRepository查询person是否存在，然后调用MovieRepository查询movie是否存在，如果都存在就调用person的方法addActMovie,然后保存person对象， 否则就报错。
6， 在Controller中访问
完成domain， repository和service就可以访问数据， 我们这是使用controller只是为了展示数据。
第一个controller， PersonController 会有个init方法帮我们初始化插入一些数据，然后可以findAll或者findByfirstName
第二个controller， MovieController会展示所有movie以及按照revenue查询movie
代码示例
@RestController
@RequestMapping("/movie")
public class MovieController {
@Autowired
MovieRepository movieRepository;
@GetMapping("/all")
public Iterable<Movie> findAll() {
return movieRepository.findAll();
}
@GetMapping("/findByReveueGT")
public Iterable<Movie> findByRevenueGT(@RequestParam Integer revenue) {
return movieRepository.findByRevenueGreaterThan(revenue);
}
}PersonController代码可参看github代码。 。
7, 添加上@EnableNeo4jRepositories注解
需要在@SpringBootApplication注解的类上加上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);
}
}8， 运行截图
运行之前的需要配置一下application.properties.
spring.data.neo4j.uri=bolt://localhost
spring.data.neo4j.username=neo4j
spring.data.neo4j.password=neo4j第一张是我们完成数据初始化以及按照likeName进行查询
第二张是neo4j的数据
第三张按照电影revenue进行查询。
总结
使用spring-data-neo4j访问neo4j数据库，就是通过domain（加上nodeEntiry注解）和Neo4jRepository完成数据库的对访问和操作。
待续
本文只是简单的根据name或者大于关系进行查询，对于复杂的查询我们添加@Query注解，关于如何编写Query等内容下一篇再讨论。