Guides - Custom Plugins - 《图数据库 HugeGraph v0.11 使用手册》

HugeGraph不仅开源开放，而且要做到简单易用，一般用户无需更改源码也能轻松增加插件扩展功能。
HugeGraph支持多种内置存储后端，也允许用户无需更改现有源码的情况下扩展自定义后端。
HugeGraph支持全文检索，全文检索功能涉及到各语言分词，目前已内置8种中文分词器，也允许用户无需更改现有源码的情况下扩展自定义分词器。

后端存储
序列化器
自定义配置项
分词器

HugeGraph提供插件接口HugeGraphPlugin，通过Java SPI机制支持插件化
HugeGraph提供了4个扩展项注册函数：registerOptions()、registerBackend()、registerSerializer()、registerAnalyzer()
插件实现者实现相应的Options、Backend、Serializer或Analyzer的接口
插件实现者实现HugeGraphPlugin接口的register()方法，在该方法中注册上述第3点所列的具体实现类，并打成jar包
插件使用者将jar包放在HugeGraph Server安装目录的plugins目录下，修改相关配置项为插件自定义值，重启即可生效

1 新建一个maven项目

1.1 项目名称取名：hugegraph-plugin-demo

1.2 添加`hugegraph-core` Jar包依赖

maven pom.xml详细内容如下：

2 实现扩展功能

2.1 扩展自定义后端

2.1.1 实现接口BackendStoreProvider

可实现接口：com.baidu.hugegraph.backend.store.BackendStoreProvider
或者继承抽象类：com.baidu.hugegraph.backend.store.AbstractBackendStoreProvider

以RocksDB后端RocksDBStoreProvider为例：

public class RocksDBStoreProvider extends AbstractBackendStoreProvider {
    protected String database() {
        return this.graph().toLowerCase();
    }
    @Override
    protected BackendStore newSchemaStore(String store) {
    }
    @Override
    protected BackendStore newGraphStore(String store) {
        return new RocksDBGraphStore(this, this.database(), store);
    }
    @Override
    public String type() {
        return "rocksdb";
    }
    @Override
    public String version() {
    }
}

2.1.2 实现接口BackendStore

BackendStore接口定义如下：

2.1.3 扩展自定义序列化器

public interface GraphSerializer {
    public BackendEntry writeVertex(HugeVertex vertex);
    public BackendEntry writeVertexProperty(HugeVertexProperty<?> prop);
    public HugeVertex readVertex(HugeGraph graph, BackendEntry entry);
    public BackendEntry writeEdge(HugeEdge edge);
    public BackendEntry writeEdgeProperty(HugeEdgeProperty<?> prop);
    public HugeEdge readEdge(HugeGraph graph, BackendEntry entry);
    public BackendEntry writeIndex(HugeIndex index);
    public HugeIndex readIndex(HugeGraph graph, ConditionQuery query, BackendEntry entry);
    public BackendEntry writeId(HugeType type, Id id);
    public Query writeQuery(Query query);
}
public interface SchemaSerializer {
    public BackendEntry writeVertexLabel(VertexLabel vertexLabel);
    public VertexLabel readVertexLabel(HugeGraph graph, BackendEntry entry);
    public BackendEntry writeEdgeLabel(EdgeLabel edgeLabel);
    public EdgeLabel readEdgeLabel(HugeGraph graph, BackendEntry entry);
    public BackendEntry writePropertyKey(PropertyKey propertyKey);
    public PropertyKey readPropertyKey(HugeGraph graph, BackendEntry entry);
    public BackendEntry writeIndexLabel(IndexLabel indexLabel);
    public IndexLabel readIndexLabel(HugeGraph graph, BackendEntry entry);

2.1.4 扩展自定义配置项

增加自定义后端时，可能需要增加新的配置项，实现流程主要包括：

增加配置项容器类，并实现接口com.baidu.hugegraph.config.OptionHolder
提供单例方法public static OptionHolder instance()，并在对象初始化时调用方法OptionHolder.registerOptions()
增加配置项声明，单值配置项类型为ConfigOption、多值配置项类型为ConfigListOption

以RocksDB配置项定义为例：

2.2 扩展自定义分词器

分词器需要实现接口，以实现一个SpaceAnalyzer空格分词器为例。

package com.baidu.hugegraph.plugin;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;
import com.baidu.hugegraph.analyzer.Analyzer;
public class SpaceAnalyzer implements Analyzer {
    @Override
    public Set<String> segment(String text) {
        return new HashSet<>(Arrays.asList(text.split(" ")));
    }
}

3 实现插件接口，并进行注册

并且HugeGraphPlugin提供了4个静态方法用于注册扩展项：

registerOptions(String name, String classPath)：注册配置项
registerBackend(String name, String classPath)：注册后端（BackendStoreProvider）
registerSerializer(String name, String classPath)：注册序列化器
registerAnalyzer(String name, String classPath)：注册分词器

下面以注册SpaceAnalyzer分词器为例：

package com.baidu.hugegraph.plugin;
public class DemoPlugin implements HugeGraphPlugin {
    @Override
    public String name() {
        return "demo";
    }
    @Override
    public void register() {
        HugeGraphPlugin.registerAnalyzer("demo", SpaceAnalyzer.class.getName());
    }
}

4 配置SPI入口

确保services目录存在：hugegraph-plugin-demo/resources/META-INF/services
在services目录下建立文本文件：com.baidu.hugegraph.plugin.HugeGraphPlugin
文件内容如下：com.baidu.hugegraph.plugin.DemoPlugin

5 打Jar包

通过maven打包，在项目目录下执行命令mvn package，在target目录下会生成Jar包文件。使用时将该Jar包拷到目录，重启服务即可生效。

Custom Plugins