1配置
1.1Maven依赖
<!--neo4j -->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-neo4j</artifactId>
</dependency>
1.2yml配置
spring:data:neo4j:uri: bolt://localhost:7687username: neo4jpassword: 123456database: neo4j
1.3neo扫包
@SpringBootConfiguration
@EnableNeo4jRepositories(basePackages = "com.**.repo")
public class NeoConfig {}
2入门代码
2.1代码结构
2.2node
如下所示,这是我们的一个实际的节点,我们以该节点为例,创建一个UserNode
//如果你没有使用lombook,请自己手动生成对应的get/set
@Data
@NodeEntity("User")
public class UserNode {@Id@GeneratedValueprivate Long id;private String userName;private int userAge;private String userSex;
}
2.3repo
@Repository
public interface UserRepository extends Neo4jRepository<UserNode, Long> {}
2.4service
public interface UserService {void saveUser(UserNode userNode);UserNode getUserById(Long id);
}@Service
public class UserServiceImpl implements UserService{@Autowiredprivate UserRepository userRepository;@Overridepublic void saveUser(UserNode userNode) {userRepository.save(userNode);}@Overridepublic UserNode getUserById(Long id) {return userRepository.findById(id).orElse(null);}}
2.5controller
@RestController
public class UserController {@Autowiredprivate UserService userService;@PostMapping("/user")@ApiOperationSupport(order = 1)@ApiOperation(value = "新增用户节点")public R<String> savePerson(@RequestBody UserNode userNode) {userService.saveUser(userNode);return R.ok();}@GetMapping("/user/id{id}")@ApiOperationSupport(order = 2)@ApiOperation(value = "根据ID获取用户节点")public R<UserNode> getUserById(@PathVariable Long id) {UserNode user = userService.getUserById(id);return R.ok(user);}
}
如果出现以下错误
The client is unauthorized due to authentication failure.
解决方法:找到你安装neo4j的路径下的conf文件夹,neo4j.conf,找到
#dbms.security.auth_enabled=false
将前面的注释#去掉,然后重启neo4j,在重启项目即可。
2.6验证
通过接口创建User节点,老王 ,然后再neo4j中查询,看能否查到
根据上面neo4j为我们生成的ID,使用这个ID进行查询,看能否查询到数据
3spring data neo详解
3.1节点
下面是我们实体类节点中常用的注解。
//表明这个类和节点进行映射
@NodeEntity//节点的主键ID
@Id//如果ID为null,生成默认的ID值
@GeneratedValue//节点的关系
@Relationship
/*
Relationship.UNDIRECTED关系的起点和终点之间没有方向性
Relationship.OUTGOING 表示关系只能从起点指向终点(默认值)
Relationship.INCOMING 表示关系只能从终点指向起点
*///java类属性名和neo4j属性名映射
@Property
接下来我们看一个例子。
我们定义了一个UserNode类和User标签节点进行映射,并且,该用户和其他用户存在RELATION的关系
@Data
@NodeEntity("User")
public class UserNode {@Id@GeneratedValueprivate Long id;private String userName;private int userAge;private String userSex;//和当前这个用户有关系的用户@Relationship(type = "RELATION")private List<UserNode> userNodes;
}
现在我们要实现,根据西子找出关系为RELATION的User节点
使用我们之前的接口,根据西子的id,查询西子信息即可
如果我们使用无向的关系,如下所示,就会出现循环嵌套(西子->老司->西子->老司),然后堆栈溢出。
@Relationship(type = "RELATION", direction = Relationship.UNDIRECTED)
private List<UserNode> userNodes;
如果我们使用反向的关系,那么根据西子查询,就查询不到了,但是根据念念,能查到西子和老司,因为西子和老司都指向念念,此时关系是逆向的,从终点到起点进行匹配。
@Relationship(type = "RELATION", direction = Relationship.INCOMING)
private List<UserNode> userNodes;
3.2Neo4jRepository
加粗样式还记得上面我们的入门案例嘛,我们编写了一个UserRepository来继承了Neo4jRepository,然而我们却没有任何的实现,这是因为Neo4jRepository默认提供了一些常用的方法来满足我们的增删查改
@Repository
public interface UserRepository extends Neo4jRepository<UserNode, Long> {}
使用save方法将实体对象保存到Neo4j数据库中。
- 如果实体对象的ID为空,则新建一个节点并将实体对象保存到该节点上;
- 如果实体对象的ID不为空,则更新该节点的属性值。
<S extends T> S save(S entity);<S extends T> S save(S s, int depth);<S extends T> Iterable<S> save(Iterable<S> ses, int depth);<S extends T> Iterable<S> saveAll(Iterable<S> entities);
因此当我们定义主键id,尽量使用包装类型,比如如果你的主键id设置为数字的,那么不要使用基本数据类型的int、long,而是使用包装类型的Integer、Long,并且最好是建议将新增和修改的UserNode拆成两个,在新增的时候没有属性id,在修改的时候有属性id,防止在新增的时候误传了id,变成修改操作。当然你也可通过其他方式,来进行区分新增或者更新,然后再新增的时候,将id设置为null。
那么S save(S entity)和S save(S s, int depth)有什么区别?
我们先看如下这个关系
@Data
@NodeEntity("User")
public class UserNode {@Id@GeneratedValueprivate Long id;private String userName;private int userAge;private String userSex;//和当前这个用户有关系的用户@Relationship(type = "老公", direction = Relationship.OUTGOING)private UserNode husband;@Relationship(type = "同事", direction = Relationship.OUTGOING)private UserNode colleague;
}match(u1:User{userName:"西子"})-[f1:老公]->(u2)-[f2:同事]->(u3) return u1,u2,u3
可以看到现在西子18岁,小跟班12岁,孙悟空无年龄
@Repository
public interface UserRepository extends Neo4jRepository<UserNode, Long> {List<UserNode> findByUserName(String userName);
}
UserNode 西子 = userRepository.findByUserName("西子").get(0);
//将西子和西子老公小跟班的年龄都设置为15岁
西子.setUserAge(15);
西子.getHusband().setUserAge(15);//Neo4jRepository 只能查询直接关联,因此查询不到小跟班的同事孙悟空
UserNode 孙悟空 = userRepository.findByUserName("孙悟空").get(0);
孙悟空.setUserAge(15);
西子.getHusband().setColleague(孙悟空);//我们这里将西子、小跟班、孙悟空的年龄都修改为18岁,然后只保存西子
userRepository.save(西子);
我们发现结果中,我们虽然只保存西子这个节点,但是西子的子节点,以及子节点的子节点都会被保存00.
现在我们使用S save(S s, int depth),先设置为0,发现只保存西子,没有保存小跟班和孙悟空
西子.setUserAge(18);
西子.getHusband().setUserAge(18);
孙悟空.setUserAge(18);userRepository.save(西子, 0);
<S extends T> S save(S entity); //会将关联到的子节点,甚至子节点的子节点也会保存<S extends T> S save(S s, int depth); //按照深度保存,0代表不保存子节点,1代表保存1级子节点
3.3自定义操作
3.3.1findBy属性字段
先说结论,有兴趣你就看分析过程,没兴趣就直接背结论。
- 接口的findBy属性字段这个方法中的属性字段要和NodeEntity中的属性必须对应上
- 根据NodeEntity中的属性名,生成cypher语句,如果属性名被Property修饰,那么就用Property的值
之前的案例中我们通过Neo4jRepository来演示自带的一些方法,下面的这些方法,我们就不在逐一演示,总的来说,分成三大部分,分别是保存(新增/修改)、查询、删除,而且大多都是根据ID来的,实际开发中可能不符合我们需要,那么我们如何实现这种既不用写cypher,又能实现查询和删除嗯?(注意:保存一般都是根据主键ID保存)
以查询为例,现在我们想通过名称查询,这是我们之前案例中定义的一个根据名称查询,当时没有说为什么,现在我们来研究一下。
@Repository
public interface UserRepository extends Neo4jRepository<UserNode, Long> {List<UserNode> findByUserName(String userName);
}
为什么我们定义了一个接口,然后这个接口什么实现也没有的情况下,这个接口却能按照userName这个属性进行查询?
我们先配置一个打印日志
logging:level:org.neo4j.ogm.drivers.bolt.request.BoltRequest: DEBUG
如果上述配置配置完毕以后,并没有生效,请看这里面的neo4j使用中常见的问题Spring Data NEO日志无法打印cyper日志
我们观察下面日志,可以发现,当我们执行了我们定义的接口findByUserName以后,接着会执行一个cypher语句,因此很奇怪,这个cypher是按照什么规则生成的?答案是按照我们定义的方法名来生成的。
当然通过观察发现,不难看出,那就是这里面,java类属性、neo4j节点属性,java接口名我们都是叫做userName
如此我们把findByUserName改成findByName,启动项目就报错了,错误提示很明显,那就是在UserNode中没有name这个属性
No property name found for type UserNode!
那么我们在UserNode中把userName也改成name试试。结果发现,启动项目没有报错。
在我们执行查询的时候,当然也查询不到数据,因为我们发现,此时生成的cypher是查询name属性,但是我们的neo4j中的所User这个标签的节点都没有name这个属性,或者说就算有name这个属性, 也没有name为西子的节点。
那可能会有人问,那要是我的数据库中的节点名称和我java类的属性名称,不一样那该怎么办?那就使用@Property
@Property("userName")
private String name;
3.3.2findBi属性字段总结
Spring Data Neo4j 中的 findByXXXXX 方法是根据方法名中的关键字和参数名来生成查询语句的,因此方法名的命名规则是非常重要的,需要严格遵守。但是如果你有使用Spring Data JPA的经验的话,将会变得特别简单因为,这个规则就是和JPA规则一样的。
有兴趣的可以来看一下Spring Data Jpa 语法规则
Spring Data Neo4j 提供了一组基于命名约定的查询方法,这些方法可以让您使用方法名称来定义查询,而无需编写任何查询语句。这些方法通常以 findBy 开头,后面跟着属性名称,以便指定要匹配的属性。以下是一些常用的 findBy 方法:findByProperty(property):根据指定属性的值进行查询。
findByPropertyIn(Collection<T> values):查询指定属性值在给定集合中的所有实体。
findByPropertyNotIn(Collection<T> values):查询指定属性值不在给定集合中的所有实体。
findByPropertyIsNull():查询指定属性值为 null 的所有实体。
findByPropertyIsNotNull():查询指定属性值不为 null 的所有实体。
findByPropertyLike(String pattern):查询指定属性值匹配给定模式的所有实体。
findByPropertyStartingWith(String prefix):查询指定属性值以给定前缀开头的所有实体。
findByPropertyEndingWith(String suffix):查询指定属性值以给定后缀结尾的所有实体。
findByPropertyContaining(String substring):查询指定属性值包含给定子字符串的所有实体。
findByPropertyOrderByPropertyAsc():根据指定属性的升序顺序返回所有实体。
findByPropertyOrderByPropertyDesc():根据指定属性的降序顺序返回所有实体。
其中 Property 表示实体类中的属性名称,T 表示属性的数据类型,Collection<T> 表示属性值的集合。除了上述方法之外,Spring Data Neo4j 还支持许多其他的查询方法,例如 findFirstByProperty、findTop5ByProperty 等。这些方法的命名约定都遵循 findBy 开头的规则,只是在方法名称的末尾添加了一些限制条件。