连接器SDK —— 30分钟快速开发

连接器SDK —— 30分钟开发一个新连接器

宝软数字 · 技术深度解读 · 2026年12月12日

在企业系统集成的世界里,有一个广为流传的"诅咒":第一个系统集成用两周,第十个系统集成还是用两周。原因是每次对接新的业务系统,你都要重头处理它的认证方式、API风格、数据格式、分页逻辑、错误码体系——这些底层细节虽然各不相同,但开发模式是高度重复的。

EIOS连接器SDK的设计目标就是打破这个诅咒:让开发者在30分钟内完成一个新系统的对接,并且代码质量不因速成而妥协。这篇文章将完整展示SDK的设计思路、核心抽象和使用流程。如果你负责企业系统集成,这套方法论可以作为你内部集成框架的设计参考。

一、SDK设计哲学:约定大于配置,但配置多于编码

在开始SDK的技术细节之前,先理解它的设计哲学。这五个原则决定了SDK的一切架构选择:

1. 骨架代码零手写。通过CLI脚手架工具自动生成连接器项目的目录结构、TypeScript类型定义、单元测试模板、配置文件骨架。开发者不需要从空白文件开始,而是在一个有完整结构的项目中填充业务逻辑。

2. 三大核心抽象不可绕过。每个连接器必须实现AuthProvider(认证)、ProtocolAdapter(协议适配)、SchemaMapper(数据映射)三个接口。这不是限制,而是保障——只要实现了这三个接口,连接器的所有平台特性(健康检查、速率限制、日志审计、监控指标)都是免费获得的。

3. 配置优先于编码。凡是能通过配置文件声明的——API端点URL、请求方法、字段映射规则、分页风格——就不要写代码。SDK支持在YAML配置文件中描述80%的连接器行为,只有20%的特殊逻辑(复杂认证流程、自定义数据转换)需要TypeScript实现。

4. 测试是SDK的一等公民。每个连接器项目自动生成集成测试骨架。SDK内置了请求录制/回放功能,可以在不连接真实系统的情况下运行测试——这对CI/CD管道至关重要。

5. 本地开发即可体验完整流程。SDK内置了一个Mock Server,可以模拟目标系统的API响应,开发者在没有真实系统访问权限的情况下也能开发和调试连接器。

为什么30分钟?这不是营销话术。对于标准的REST API对接场景,一个有经验的开发者在30分钟内可以完成的步骤是:CLI生成项目骨架(30秒)→ 在YAML配置文件中填写API端点和字段映射(10分钟)→ 实现OAuth2 Provider(如果SDK内置的不满足需求,5-10分钟)→ 运行生成的测试并修正(5分钟)→ 注册到本地平台验证(5分钟)。对于标准场景,几乎不需要写代码。对于复杂场景(如SOAP对接、自定义加密),30分钟是完成骨架对接的时间,完整的生产级打磨需要额外的1-2天。
连接器SDK开发六步法

二、SDK核心抽象:三个接口,四大核心类

EIOS连接器SDK围绕三大接口构建,每个接口对应连接器架构的一层:

1. IAuthProvider —— 认证接口

定义连接器如何获取和刷新认证凭证。SDK内置了四个实现:

如果你的目标系统使用了非标准的认证方式(比如自定义的签名算法),继承BaseAuthProvider并实现authenticate()refresh()方法即可。

2. IProtocolAdapter —— 协议适配接口

定义连接器如何向目标系统发送请求并解析响应。SDK内置四个实现:

3. ISchemaMapper —— 数据映射接口

定义如何将源系统的数据Schema映射到EIOS规范Schema。支持声明式(YAML配置)和编程式(TypeScript转换函数)。

这三大接口之上,SDK提供了一个ConnectorBase抽象类。任何实现了这三个接口的连接器,自动获得:

框架的力量:传统开发中,这些横切关注点(日志、监控、限流、缓存)通常占连接器代码量的40-60%,而且是bug的高发区。SDK将它们下沉为框架能力后,开发者完全不用关心这些——就像用Spring Boot不需要关心HTTP请求的解析一样。
ConnectorBase自动获得的六大能力

三、实战:六步开发一个用友U8连接器

让我们以一个真实的场景来展示SDK的开发流程。目标是开发一个连接器,对接用友U8 ERP系统,让AI Agent可以查询销售订单和库存数据。

第一步:CLI脚手架生成项目骨架(30秒)

运行SDK CLI命令生成标准的连接器项目结构:

脚手架自动生成了目录结构、TypeScript配置、package.json、连接器元数据文件、认证配置文件、API端点配置文件、Schema映射配置文件、单元测试和集成测试骨架文件。开发者在生成的项目中只需要关注业务逻辑,不需要配置构建工具链。

第二步:定义连接器元数据(2分钟)

在连接器元数据文件中声明连接器的基本信息和能力:名称、版本、描述、支持的资源类型(销售订单、库存、客户等)、支持的操作(查询、写入、订阅)、依赖的认证方式。这些元数据会被平台的Connector Registry使用。

第三步:配置认证方式(3分钟)

用友U8通常使用用户名密码加上数据库直连方式。在认证配置文件中声明使用database认证类型,配置连接字符串、用户名、密码(支持从环境变量或密钥管理服务注入)。

第四步:配置API端点和数据查询(10分钟)

这是连接器开发中最核心的一步。在端点配置文件中,用YAML声明每个资源的查询方式。最关键的部分包括:SQL查询的表和字段、需要的参数(如日期范围、订单状态、客户编码等)、输出字段列表和类型、分页策略。

第五步:映射Schema(5分钟)

在Schema映射配置文件中,定义用友U8的数据库字段到EIOS规范Schema的映射。包括直接映射(字段名相同或相近)、转换映射(枚举值转换、日期格式转换)、计算映射(从数据库中的多个表关联计算得到规范Schema中的一个业务字段)。

第六步:运行测试、注册上线(不到10分钟)

SDK生成的测试骨架包含了认证正确性测试、基本查询测试、Schema映射正确性测试、错误处理测试(SQL语法错误、超时、认证失败等)和性能基线测试。运行测试确保通过后,在平台管理界面一键注册——连接器就上线了。AI Agent立即可以通过自然语言查询用友U8中的销售订单和库存。

真实的30分钟:对于标准场景(REST API + OAuth2 + JSON数据),一个熟悉SDK的开发者确实能在30分钟内完成端到端的连接器开发。对于复杂场景(SOAP + 自定义加密 + 复杂Schema映射),骨架可以在30分钟内跑通第一个"hello world"查询,但生产级的打磨需要1-2天。重要的是——即使1-2天,相比传统集成开发动辄2-4周的时间,依然是巨大的效率提升。
六步开发连接器流程图

四、测试能力:请求录制/回放和Mock Server

连接器开发的痛点之一是测试依赖真实系统。目标系统可能没有测试环境、可能API有速率限制、可能是生产系统不容打扰。SDK通过两个能力解决了这个问题:

请求录制/回放

当连接器第一次连接真实系统时,SDK可以开启录制模式——拦截所有发出的请求和接收的响应,序列化为文件存储。之后在CI/CD管道中或本地开发时,开启回放模式——SDK不发出真实的网络请求,而是从录制文件中匹配请求并返回录制的响应。

录制/回放带来的收益:

Mock Server

对于尚未对接的系统,SDK内置的Mock Server可以根据API文档(OpenAPI Spec、WSDL、GraphQL Schema)自动生成模拟响应。开发者可以在拿到真实系统访问权限之前就开始连接器开发,Mock Server返回的数据虽然不完全真实,但格式和结构是正确的。

工作流革命:传统集成开发中,最耗时的环节不是写代码,而是"等"—等IT开通系统账号、等安全审批、等测试环境搭建。录制/回放和Mock Server将连接器开发从"必须依赖真实系统"变成了"大部分时间独立工作",将等待时间从数天压缩到零。
录制回放与Mock Server架构

五、连接器的发布与生态:从本地到分享

一个连接器开发完成并通过测试后,它不只是你公司的私有资产。EIOS平台支持连接器的三级发布模式:

Level 1:私有连接器

只在你的企业EIOS实例中可见和使用。适用于对接自研系统、内部工具或任何不想对外暴露的连接器。

Level 2:租户内共享连接器

在同一个多租户组织内共享。适用于集团型企业——总部开发一个ERP连接器,所有子公司共享使用,但每个子公司有自己的认证配置。

Level 3:公共连接器市场

将连接器发布到EIOS连接器市场,供所有平台用户使用。公共连接器需要额外的安全审查和文档要求,但一旦上架,就能被其他企业一键安装使用。

这个三级发布模式的设计逻辑是:让连接器的价值随着使用范围的扩大而指数增长。一个企业开发的连接器可以惠及其他企业,而所有企业共享的连接器生态又让每个企业的AI平台更加强大。

生态飞轮:每个新增的连接器让EIOS平台对所有用户的价值都增加了——就像一个App Store。当前平台已经有超过80个连接器,覆盖ERP(SAP、用友、金蝶)、CRM(Salesforce、HubSpot)、OA(飞书、钉钉、企业微信)、电商(Shopify、有赞)、数据库(MySQL、PostgreSQL、Oracle)等主流企业系统。这个生态的增长速度,将决定企业AI平台能连接到多少真实业务数据。
连接器三级发布模式与生态飞轮

六、连接器SDK的未来方向

当前的SDK已经显著降低了连接器开发的门槛,但我们知道还有更大的进步空间。接下来的三个方向是:

AI辅助连接器生成。输入一个API文档的URL或OpenAPI Spec文件,AI自动生成连接器项目的完整代码——包括认证配置、端点声明、Schema映射规则。人工只需要审核和修正,而不需要从零开始编写任何配置文件。初步原型已经可以将标准REST API的连接器生成时间从30分钟降到3分钟。

连接器运行时热更新。当前的连接器更新需要重启服务。热更新机制可以让连接器在不停服的情况下更新配置和代码——这对于需要7x24小时运行的AI平台至关重要。

跨连接器的查询优化。当AI Agent的一个问题需要从多个连接器获取数据时(如"对比华东区客户从ERP的采购数据和从CRM的服务工单数据"),跨连接器的查询优化可以自动识别依赖关系、并行执行独立查询、合并结果——而不需要AI Agent手动编排这些步骤。

连接器SDK的本质是为企业数据打开大门。门开得越多,AI能看到的世界越大,能为企业创造的价值就越深。30分钟一个新连接器的目标,不只是为了快——而是为了让连接不再是瓶颈,让企业的每一份数据都能被AI理解和利用。

30分钟连接一个系统,亲眼看看

预约EIOS连接器SDK演示,现场体验从零到一的连接器开发

预约交流