splashsync/toolkit

Splash Sync连接器开发者工具包

镜像概述

Splash Sync连接器开发者工具包是Splash Sync官方提供的Docker镜像，专为连接器开发者设计，旨在简化Splash Sync生态系统中连接器的开发、测试与调试流程。该镜像集成了开发所需的运行时环境、依赖管理工具和调试组件，为开发者提供开箱即用的工作环境。

核心功能与特性

• 完整开发环境：预配置PHP运行时（Splash Sync核心技术栈）、Composer依赖管理器及代码质量检测工具
• 测试框架：内置单元测试和集成测试工具，支持自动化验证连接器功能完整性
• 调试工具：集成Xdebug调试组件，支持远程调试和断点调试
• 示例代码：包含连接器开发示例，覆盖常见集成场景
• 文档集成：内置Splash Sync API文档和开发指南，便于离线查阅

使用场景与适用范围

• 连接器开发：构建新的Splash Sync连接器，实现第三方系统与Splash Sync的双向数据同步
• 连接器测试：验证连接器在不同数据场景下的兼容性和稳定性
• 问题诊断：调试已部署连接器的同步异常或性能问题
• 学习培训：作为Splash Sync连接器开发的教学环境

使用方法与配置说明

前提条件

• Docker Engine 20.10+
• Docker Compose 2.0+（可选）
• 网络连接（用于拉取镜像和依赖）

基础使用

拉取镜像

bash
docker pull splashsync/toolkit:latest

启动开发容器

bash
docker run -it --rm \
  -v $(pwd)/my-connector:/app \
  -e SPLASH_ENV=development \
  -e SPLASH_DEBUG=true \
  -p 8080:80 \
  splashsync/toolkit:latest

Docker Compose配置示例

yaml
version: '3.8'
services:
  dev-toolkit:
    image: splashsync/toolkit:latest
    volumes:
      - ./my-connector:/app           # 挂载本地连接器代码
      - composer-cache:/root/.composer # 持久化Composer缓存
    environment:
      - SPLASH_ENV=development
      - SPLASH_DEBUG=true
      - SPLASH_API_ENDPOINT=https://api.splashsync.com
      - SPLASH_API_KEY=your_developer_key
    ports:
      - "8080:80"  # Web服务器端口
      - "9003:9003" # Xdebug调试端口
    tty: true

volumes:
  composer-cache:

核心操作命令

安装项目依赖

bash
docker exec -it [container_id] composer install

运行单元测试

bash
docker exec -it [container_id] vendor/bin/phpunit tests/Unit

启动调试服务器

bash
docker exec -it [container_id] php -S 0.0.0.0:80 -t public/

环境变量配置

卷挂载说明

注意事项

• 开发环境中建议始终启用SPLASH_DEBUG=true以获取详细错误信息
• 生产环境禁止使用此工具包，仅用于开发测试场景
• 敏感配置（如API密钥）建议通过环境变量注入，避免硬编码
• 本地代码目录需符合Splash Sync连接器目录结构规范，否则可能导致工具异常