序章：
さまざまなプラットフォーム、さまざまなテクノロジー、さまざまなストレージと展開方法、および必要性の欠如の場合、「アプリケーションデータの非相互運用性」の鉄板をまだ蹴っていない開発者はいないと言っても過言ではありません。インターフェイス、アプリケーションシステムが異なります。通信が困難です。ビジネス要件の継続的な拡大に伴い、アプリケーションは多様化とパーソナライズに向けて絶えず開発されています。将来のビジネスと古いテクノロジースタックとの矛盾もますます顕著になり、必要なインターフェイスの数も増えています。
インターフェイス開発をシンプルかつ迅速に行う方法は、私たちが検討する必要のある問題になっています。最近、私は非常に香りのよいオープンソースプラグインを掘り起こしました。技術文書を注意深く調べた後、アムウェイに提供することにしました。
オープンソースプラグインTapdataPDK
GitHubリンク：github.com/tapdata/ida…
このプロジェクトの発行元は、リアルタイムデータサービスプラットフォームを専門とする国内の起業家チームであるTapdataです。関係者によると、このオープンソースウィジェットは、コア製品のオープンソースの足がかりでもあります。チームのリアルタイムデータ同期かなり成熟した強み。
PDKは、データインターフェイステクノロジーから抽象化されたオープンソースプラグイン開発フレームワークです。ソースプラグインインターフェイスまたはターゲットプラグインインターフェイスを介して、Tapdataのソースまたはターゲットとしての新しいデータベースの適応と互換性を迅速に実現できるため、Tapdata Cloud製品と今後のオープンソースを迅速に実現できます。Tapdata、さまざまな異種データソースからターゲットデータベースまたはプラットフォームへのリアルタイムデータドッキング機能への無料アクセス。
PDKコネクタの開発仕様によると、データソースとターゲットの開発により、データリンクの開発プロセスを簡素化できます。詳細な開発計画と組み込みのTDDテストにより、新しいデータソースとターゲットの開発を簡単かつ迅速に完了できます。 。
サポートの種類は次のとおりです。
- アクセスデータベース： MySQL、Oracle、PostgreSQLなど。
- SaaS 製品へのアクセス： Salesforce、vikaテーブル、ゴールドデータフォーム、ZohoCRMなど。
- カスタムデータソースへのアクセス：プライベートプロトコルデータソースに接続できます
クイックスタートターゲットデータベースアクセス
現在、PDKチームは技術文書を公開しています。詳細については、GitHub（github.com/tapdata/ida… ）にアクセスしてください。
環境を整える
- Java 8
- Maven
- ギット
- IntelliJ IDEA
ソースコードをダウンロードしてコンパイルする
git clone https://github.com/tapdata/idaas-pdk.git
cd idaas-pdk
mvn clean install
复制代码ターゲットデータベースのコネクタプロジェクトを作成します
たとえば、グループはio.tapdata、データベース名はXDB、バージョンバージョンは0.0.1です。次のコマンドを使用してコネクタプロジェクトを作成します。
-
ターゲットデータベースがテーブルを作成する必要がない場合
./bin/tap template --type target --group io.tapdata --name XDB --version 0.0.1 --output ./connectors
复制代码ItelliJ IDEAでidaas-pdkを開くと、idaas-pdk/connectorsの下にxdb-connectorプロジェクトが表示されます。
- spec.jsonにconfigOptionsを入力します
configOptionsがTapdataサイトに統合された後、データベース接続アドレス、ユーザー名、パスワードなど、コネクターを使用する際のユーザーの入力項目を構成します。
{
...
"configOptions":{
"connection":{
"type":"object",
"properties":{
"host":{
"type": "string",
"title": "Host",
"x-decorator": "FormItem",
"x-component": "Input"
},
"port":{
"type": "number",
"title": "Port",
"x-decorator": "FormItem",
"x-component": "Input"
}
}
}
}
}
复制代码- ターゲットデータベースにアクセスするためのコードを記述します
@TapConnectorClass("spec.json")
public class XDBConnector extends ConnectorBase implements TapConnector {
@Override
public void discoverSchema(TapConnectionContext connectionContext, Consumer<List<TapTable>> consumer) {
//TODO Load tables from database, connection information in connectionContext#getConnectionConfig
//Sample code shows how to define tables.
consumer.accept(list(
//Define first table
table("empty-table1"),
//Define second table
table("empty-table2"))
));
}
@Override
public void connectionTest(TapConnectionContext connectionContext, Consumer<TestItem> consumer) {
//Assume below tests are successfully, below tests are recommended, but not required.
//Connection test
//TODO execute connection test here
consumer.accept(testItem(TestItem.ITEM_CONNECTION, TestItem.RESULT_SUCCESSFULLY));
//Login test
//TODO execute login test here
consumer.accept(testItem(TestItem.ITEM_LOGIN, TestItem.RESULT_SUCCESSFULLY));
//Read test
//TODO execute read test by checking role permission
consumer.accept(testItem(TestItem.ITEM_READ, TestItem.RESULT_SUCCESSFULLY));
//Write test
//TODO execute write test by checking role permission
consumer.accept(testItem(TestItem.ITEM_WRITE, TestItem.RESULT_SUCCESSFULLY));
}
private void writeRecord(TapConnectorContext connectorContext, List<TapRecordEvent> tapRecordEvents, Consumer<WriteListResult<TapRecordEvent>> writeListResultConsumer) {
//TODO write records into database
//Below is sample code to print received events which suppose to write to database.
AtomicLong inserted = new AtomicLong(0); //insert count
AtomicLong updated = new AtomicLong(0); //update count
AtomicLong deleted = new AtomicLong(0); //delete count
for(TapRecordEvent recordEvent : tapRecordEvents) {
if(recordEvent instanceof TapInsertRecordEvent) {
//TODO insert record
inserted.incrementAndGet();
} else if(recordEvent instanceof TapUpdateRecordEvent) {
//TODO update record
updated.incrementAndGet();
} else if(recordEvent instanceof TapDeleteRecordEvent) {
//TODO delete record
deleted.incrementAndGet();
}
}
//Need to tell incremental engine the write result
writeListResultConsumer.accept(writeListResult()
.insertedCount(inserted.get())
.modifiedCount(updated.get())
.removedCount(deleted.get()));
}
private void queryByFilter(TapConnectorContext connectorContext, List<TapFilter> filters, Consumer<List<FilterResult>> listConsumer){
//Filter is exactly match.
//If query by the filter, no value is in database, please still create a FitlerResult with null value in it. So that flow engine can understand the filter has no value.
}
}
复制代码-
ターゲットデータベースがテーブルを作成する必要がある場合
./bin/tap template --type targetNeedTable --group io.tapdata --name XDB --version 0.0.1 --output ./connectors
复制代码ItelliJ IDEAでidaas-pdkを開くと、idaas-pdk/connectorsの下にxdb-connectorプロジェクトが表示されます。
- spec.jsonにconfigOptionsを入力します
configOptionsがTapdataサイトに統合された後、データベース接続アドレス、ユーザー名、パスワードなど、コネクターを使用する際のユーザーの入力項目を構成します。
{
...
"configOptions":{
"connection":{
"type":"object",
"properties":{
"host":{
"type": "string",
"title": "Host",
"x-decorator": "FormItem",
"x-component": "Input"
},
"port":{
"type": "number",
"title": "Port",
"x-decorator": "FormItem",
"x-component": "Input"
}
}
}
}
}
复制代码- spec.jsonにdataTypes（型式）を入力します
dataTypes 用于描述该 Connector 接入数据库的所有字段的范围，以及转换到对应的 TapType。 源端数据库也会提供相同的 dataTypes 描述， 这样当源端数据流入到 Tapdata 里时， 会结合源端 dataTypes 的字段描述信息结合源端库表的字段信息， 通过 Tapdata 的中立数据结构进入到 Tapdata 的数据流中， 当数据要流入到目标数据库之前，Tapdata 会根据这些信息， 在目标库的 dataTypes 中找到最佳的存储字段， 通过 TapField 的 originType 告知给 PDK 开发者， 用以建表。
{
...
"dataTypes":{
"boolean":{"bit":8, "unsigned":"", "to":"TapNumber"},
"tinyint":{"bit":8, "to":"TapNumber"},
"smallint":{"bit":16, "to":"TapNumber"},
"int":{"bit":32, "to":"TapNumber"},
"bigint":{"bit":64, "to":"TapNumber"},
"largeint":{"bit":128, "to":"TapNumber"},
"float":{"bit":32, "to":"TapNumber"},
"double":{"bit":64, "to":"TapNumber"},
"decimal[($precision,$scale)]":{"bit": 128, "precision": [1, 27], "defaultPrecision": 10, "scale": [0, 9], "defaultScale": 0, "to": "TapNumber"},
"date":{"byte":3, "range":["0000-01-01", "9999-12-31"], "to":"TapDate"},
"datetime":{"byte":8, "range":["0000-01-01 00:00:00","9999-12-31 23:59:59"],"to":"TapDateTime"},
"char[($byte)]":{"byte":255, "to": "TapString", "defaultByte": 1},
"varchar[($byte)]":{"byte":"65535", "to":"TapString"},
"string":{"byte":"2147483643", "to":"TapString"},
"HLL":{"byte":"16385", "to":"TapNumber", "queryOnly":true}
}
}
复制代码- 编写接入目标数据库的代码
@TapConnectorClass("spec.json")
public class XDBConnector extends ConnectorBase implements TapConnector {
@Override
public void discoverSchema(TapConnectionContext connectionContext, Consumer<List<TapTable>> consumer) {
//TODO Load schema from database, connection information in connectionContext#getConnectionConfig
//Sample code shows how to define tables with specified fields
consumer.accept(list(
//Define first table
table("empty-table1")
//Define a field named "id", origin field type, whether is primary key and primary key position
.add(field("id", "varchar").isPrimaryKey(true).partitionKeyPos(1))
.add(field("description", "string"))
.add(field("name", "varchar"))
.add(field("age", "int")))
));
}
@Override
public void connectionTest(TapConnectionContext connectionContext, Consumer<TestItem> consumer) {
//Assume below tests are successfully, below tests are recommended, but not required.
//Connection test
//TODO execute connection test here
consumer.accept(testItem(TestItem.ITEM_CONNECTION, TestItem.RESULT_SUCCESSFULLY));
//Login test
//TODO execute login test here
consumer.accept(testItem(TestItem.ITEM_LOGIN, TestItem.RESULT_SUCCESSFULLY));
//Read test
//TODO execute read test by checking role permission
consumer.accept(testItem(TestItem.ITEM_READ, TestItem.RESULT_SUCCESSFULLY));
//Write test
//TODO execute write test by checking role permission
consumer.accept(testItem(TestItem.ITEM_WRITE, TestItem.RESULT_SUCCESSFULLY));
}
@Override
public void registerCapabilities(ConnectorFunctions connectorFunctions, TapCodecRegistry codecRegistry) {
connectorFunctions.supportWriteRecord(this::writeRecord);
connectorFunctions.supportQueryByFilter(this::queryByFilter);
//If database need insert record before table created, then please implement the below two methods.
connectorFunctions.supportCreateTable(this::createTable);
connectorFunctions.supportDropTable(this::dropTable);
//If database need insert record before table created, please implement the custom codec for the TapValue that data types in spec.json didn't cover.
//TapTimeValue, TapMapValue, TapDateValue, TapArrayValue, TapYearValue, TapNumberValue, TapBooleanValue, TapDateTimeValue, TapBinaryValue, TapRawValue, TapStringValue
codecRegistry.registerFromTapValue(TapRawValue.class, "text", tapRawValue -> {
if (tapRawValue != null && tapRawValue.getValue() != null)
return toJson(tapRawValue.getValue());
return "null";
});
}
private void writeRecord(TapConnectorContext connectorContext, List<TapRecordEvent> tapRecordEvents, Consumer<WriteListResult<TapRecordEvent>> writeListResultConsumer) {
//TODO write records into database
//Below is sample code to print received events which suppose to write to database.
AtomicLong inserted = new AtomicLong(0); //insert count
AtomicLong updated = new AtomicLong(0); //update count
AtomicLong deleted = new AtomicLong(0); //delete count
for(TapRecordEvent recordEvent : tapRecordEvents) {
if(recordEvent instanceof TapInsertRecordEvent) {
//TODO insert record
inserted.incrementAndGet();
PDKLogger.info(TAG, "Record Write TapInsertRecordEvent {}", toJson(recordEvent));
} else if(recordEvent instanceof TapUpdateRecordEvent) {
//TODO update record
updated.incrementAndGet();
PDKLogger.info(TAG, "Record Write TapUpdateRecordEvent {}", toJson(recordEvent));
} else if(recordEvent instanceof TapDeleteRecordEvent) {
//TODO delete record
deleted.incrementAndGet();
PDKLogger.info(TAG, "Record Write TapDeleteRecordEvent {}", toJson(recordEvent));
}
}
//Need to tell incremental engine the write result
writeListResultConsumer.accept(writeListResult()
.insertedCount(inserted.get())
.modifiedCount(updated.get())
.removedCount(deleted.get()));
}
private void queryByFilter(TapConnectorContext connectorContext, List<TapFilter> filters, Consumer<List<FilterResult>> listConsumer){
//Filter is exactly match.
//If query by the filter, no value is in database, please still create a FitlerResult with null value in it. So that flow engine can understand the filter has no value.
}
private void dropTable(TapConnectorContext connectorContext, TapDropTableEvent dropTableEvent) {
TapTable table = connectorContext.getTable();
//TODO implement drop table
}
private void createTable(TapConnectorContext connectorContext, TapCreateTableEvent createTableEvent) {
//TODO implement create table.
TapTable table = connectorContext.getTable();
LinkedHashMap<String, TapField> nameFieldMap = table.getNameFieldMap();
for(Map.Entry<String, TapField> entry : nameFieldMap.entrySet()) {
TapField field = entry.getValue();
String originType = field.getOriginType();
//originType is the data types defined in spec.json
//TODO use the generated originType to create table.
}
}
}
复制代码开发完成之后通过 TDD 进行测试验证
提供 configOptions 里需要用户填写的内容的 json 文件， 例如上述 configOptions 里要求用户填写的是数据库的 Host 和 Port， 那么 tdd 的 xdb_tdd.json 文件内容如下：
{
"connection": {
"host": "192.168.153.132",
"port": 9030,
}
}
复制代码执行 TDD 测试命令：
./bin/tap tdd --testConfig xdb_tdd.json ./connectors/xdb-connector
复制代码当 TDD 测试没有通过， 请根据错误提示修改对应错误，直至通过 TDD测试；
当 TDD 测试通过后， PDK Connector 就处于可以提交 Pull Request 的状态。
如何提交到 PDK 开源项目
① fork idaas-pdk， 基于远程的 main 分支建立本地分支
② 根据要接入数据库名称， 在 idaas-pdk/connectors 目录下新建模块， 命名规范为 {数据库小写名称}-connector， 例如接入数据库的名称为 XDB， 模块名称为 xdb-connector
③ 开发者根据官方 API 文档完成接入数据库的开发实现
④ 通过 TDD 测试后， 提交 PR 到 idaas-pdk
⑤ 官方团队 Review 提交的 PR 之后合并代码
彩蛋
興味のある学生は、急いで開発しないでください。公式の無料バージョンでは、30の一般的なデータソース/ターゲット間のリアルタイムデータ接続が連続して実現されていることがわかります。アクセスしたいデータベースがすでに含まれている場合は、直接使用できます。 Tapdata Cloud（tapdata.net/tapdata-clo…Tapdata PDKの自己開発、高速アクセス。
TapdataCloudで現在サポートされているデータ接続タイプ
現在、Tapdataは、開発者向けのプラグインエコロジカル共同構築グループを開設しました。開発プロセス中に技術的な交換とサポートを提供できます。興味のある学生は、コードをスキャンしてフォローし、グループに参加するよう招待できます。
。
。