大数据学习之Neo4j的自定义函数开发
本文转载自科多大数据
一、背景介绍
用户自定义函数，顾名思义就是开发一些个性化方法去解决复杂的业务逻辑问题。虽然它的功能还不够强大，但是足够去扩展和提升Neo4j的一些常用命令功能。
在Neo4j中，自定义函数是需求利用Java语言去独立开发，然后生成.jar文件去部署在图数据库的安装目录plugin中，如果是集群的话，每台服务器都需要部署。再重新启动图数据库才能生效。
对于自定义函数的调用，它跟常用的Cypher方法一样，只是函数名的规范会有限定，比如自定义函数join，它在Java工程中的目录结构为org.neo4j.examples，因此它在调用时的规范写法为org.neo4j.examples.join(参数)。
另外，自定义函数的结果输出类型很多，具体如下所示：
• java.lang.Boolean or boolean
• java.lang.Double or double
• java.lang.Long or long
• java.lang.Number
• java.lang.Object
• java.lang.String or string
• java.util.List
• java.util.Map
• org.neo4j.graphdb.Node
• org.neo4j.graphdb.Relationship
• org.neo4j.graphdb.Path
• org.neo4j.graphdb.spatial.Geometry
• org.neo4j.graphdb.spatial.Point
• Map
• List
当然，现有的Neo4j图数据库也包含了很多自定义的函数，你可以在正式实践之前去初步了解一下，在命令框输入：CALL dbms.procedures()即可查询到，结果输出包含了函数名、用法说明和功能描述。你后期的开发也可以按照这样的规范标准来。
二、基础准备
在了解完背景介绍之后，除了部署好Java和Neo4j的环境之外，你最好去按照好Maven软件，并配置到IDE中，因为它可以极大简化你开发的工作量。
其中，对于Maven的安装，请自行百度。不过这里提示一点，Java的版本需要为1.8，IDE可以选择最新的STS，Maven可以选择3.3.9版本。而对于IDE中Maven的配置，也请自行百度。
在安装部署结束，你可以通过CMD命令窗口输入：mvn -version去确认是否成功。
一切完成之后，现在就正式在IDE中去创建Maven工程，其中Group Id填写cn.lpwanger(你也可以更换)，Artifact Id填写neo4jFuns，点击Finish即可。
接下来，我们还需要在Maven工程的pom.xml文件引入一些依赖包，分别如下：
org.neo4j.driver
neo4j-java-driver
1.4.0
org.neo4j
neo4j
3.4.9
org.neo4j.test
neo4j-harness
3.4.9
test
你也可以直接通过Maven中央仓库去搜索。如果有些公司不能从外网下载的话，你可以在pom.xml配置私库地址，从公司的私库中去下载。
一切完成之后，我们就可以正式实践去开发属于自己的第一个自定义函数了。
三、实践开发
这里给出一个官方的参考例子，原理都很好理解。
我们先在src/main/java目录下的cn.lpwanger.neo4jFuns创建一个类，命名为Join，具体代码如下：
import org.neo4j.procedure.Name;
import org.neo4j.procedure.Procedure;
import org.neo4j.procedure.UserFunction;
public class Join
{
@UserFunction
@Description("cn.lpwanger.neo4jFuns.join(['s1','s2',...],delimiter) - join the given strings with the given delimiter.")
public String join(
@Name("strings")List strings,
@Name(value = "delimiter",defaultValue = ",") String delimiter) {
if (strings == null || delimiter == null) {
return null;
}
return String.join(delimiter, strings);
}
}
注释理解：
@UserFunction，它缺失的函数名是package-name.functionName，例如cn.lpwanger.neo4jFuns.join，当然也可以通过name参数去修改函数名，如@UserFunction(
name = "package.function" )。
@Description是函数的功能描述说明，它的内容会在Neo4j浏览器中调用dbms.functions()时显示。。
@Name("strings")
List<String> strings是函数的参数说明。
@Procedure( name =
"customers.create", mode = Mode.WRITE )，它属于用户自定义的过程，mode的值代表执行模式，更多的含义如下所属：
• Mode.READ –对图执行只读操作
• Mode.WRITE - 对图执行读写操作
• Mode.SCHEMA –操作数据库模式，例如创建索引、限制等
• Mode.DBMS –系统操作，但是不包括图操作
• Mode.DEFAULT –缺省是Mode.READ
该函数的目的在于通过指定的分隔符去拼接列表中的所有字符串元素，就比如['a','b']最终返回'a,b'值。
完成这一步之后，在正式生成.jar文件之前，建议大家都去做一个单元测试，这是一个良好的开发习惯。
因此，我们继续在src/test/java目录下的cn.lpwanger.neo4jFuns创建一个测试类：JoinTest，具体代码如下：
import org.junit.Rule;
import org.junit.Test;
import org.neo4j.driver.v1.*;
import org.neo4j.harness.junit.Neo4jRule;
import staticorg.hamcrest.core.IsEqual.equalTo;
import static org.junit.Assert.assertThat;
public class JoinTest
{
@Rule
public Neo4jRule neo4j = new Neo4jRule()
.withFunction( Join.class );
@Test public voidshouldAllowIndexingAndFindingANode() throws Throwable { try( Driver driver =GraphDatabase.driver( neo4j.boltURI() , Config.build().withEncryptionLevel(Config.EncryptionLevel.NONE ).toConfig() ) ) { Session session =driver.session(); String result = session.run( "RETURNexample.join(['Hello', 'World']) ASresult").single().get("result").asString(); assertThat( result,equalTo( "Hello,World" ) ); } }
}
最后右键JoinTest.java类，通过Run As点击JUnit Test去运行，如果assertThat结果输出为True就测试通过。
最后，你就可以生成neo4jFuns.jar包，放置于neo4j的plugins目录下，重新启动neo4j服务即可生效，执行下面的命令可以验证：
WITH ['a','b'] as value RETURNcn.lpwanger.neo4jFuns.join(value);
结果输出："a,b"，那就说明添加成功。
以后你也可以结合实际的业务需求去开发更多的自定义函数，提高Cypher语言处理图数据库的便捷性。
四、参考文献
[1] 6.2. User-defined functions - Chapter6. Extending Neo4j
[2] 6.1. Procedures - Chapter 6. ExtendingNeo4j
[3] User Defined Procedures and Functions -Neo4j Grap...
