Skip to main content

Objects Designer · Data Source 使用介绍

Translation in progressThis guide is currently available in Simplified Chinese. A translated version will be added later.

Data Source 用于描述 Spark 如何连接外部数据。它是 Business Object 映射、DataList / ProTable 模型查询以及应用发布前校验的基础资产。

当前 Objects Designer 支持两种可新建的 Data Source：

类型用途主要配置
MySQL 数据库（JDBC）将 Business Object 映射到 MySQL 表主机、端口、数据库、用户名、密码
REST API连接 HTTP API，为 API 映射或对象动作提供基础连接Endpoint、Method、Timeout、认证方式、Secret 引用

进入 Data Source​

  1. 打开目标应用的 Spark Designer。
  2. 选择要编辑的开发版本。
  3. 进入 Objects Designer（当前界面中也会显示为 Business Object / 对象）。
  4. 在左侧导航的 Data 分组中选择 Sources / 数据源。

Data Source 列表会显示名称、编码、类型、连接地址、各环境状态和是否启用。

Objects Designer 的 Data Source 列表建议截取 Sources 页面全景，保留类型、连接地址、DEV/TEST/PROD 状态与 New Source 按钮。images/data-source-list.webp
截图待补充

创建 MySQL/JDBC Data Source​

  1. 在 Data Source 列表点击 New Source。
  2. 选择 MySQL 数据库。数据源创建后，类型不再允许修改。
  3. 在 DEV 环境填写：
    • Host：数据库主机名或 IP
    • Port：MySQL 默认为 3306
    • Database：数据库名称
    • Username / Password：连接账号与密码
  4. 填写易识别的 Data Source Alias。
  5. 如需固定编码，在首次保存前填写 Data Source Key；留空时系统会自动生成。
  6. 点击 Test Connection，确认连接参数可用。
  7. 点击 Save。
数据源编码保存后不可修改

Data Source Key 用于让不同设计版本稳定找到同一组环境连接。首次保存前请确认命名清晰，不要将环境名写入 Key。

MySQL/JDBC Data Source 配置截图时应对主机、用户名和数据库名做脱敏处理，密码必须保持隐藏。images/data-source-jdbc-config.webp
截图待补充

创建 REST API Data Source​

  1. 点击 New Source，选择 API。
  2. 填写当前环境的 API Endpoint。
  3. 选择 HTTP Method：GET、POST、PUT 或 PATCH。
  4. 设置 Timeout，当前最小值为 1000 ms。
  5. 选择认证方式：
    • NONE：不携带认证信息
    • BEARER：使用 Bearer Token
    • BASIC：使用 Basic Authentication
    • API_KEY：使用指定的 Header 传递 API Key
  6. 除 NONE 外，需填写 Credential Secret；API_KEY 还需填写 Header 名称。
  7. 填写 Alias、Key 和描述，保存 Data Source。

REST API 的环境校验会检查 Endpoint、Method、Timeout、认证方式和 Secret 引用是否完整。为避免 POST、PUT 或 PATCH 对外部系统产生副作用，校验不会发送这个业务请求。

REST API Data Source 配置建议展示 Endpoint、Method、Timeout 和 Auth Type；请使用测试地址并隐藏 Secret 标识。images/data-source-rest-api-config.webp
截图待补充

配置 DEV、TEST 和 PROD​

JDBC 和 REST API Data Source 都按环境管理物理连接：

  • DEV 必须明确配置。
  • TEST 和 PROD 默认可以启用 复用 DEV 数据源设置。
  • 关闭复用后，需为当前环境填写独立连接。
  • 复用是对 DEV 有效配置的动态引用，不是拷贝一份密码或参数。
  • 显式配置的 TEST / PROD 连接失败时，系统不会静默回退到 DEV。

已保存的 Data Source 可以使用 Validate All Environments 一次检查三个环境。列表中的环境标记会区分已配置、已连接、有效与校验失败。

DEV / TEST / PROD 环境配置建议选中 TEST 或 PROD，展示“复用 DEV”开关、继承状态和 Validate All Environments 操作。images/data-source-environment-profiles.webp
截图待补充

与 Business Object 配合使用​

Data Source 保存后，它还只表示“如何连接”。要在 Page Designer 中展示业务数据，还需要：

  1. 在 Objects Designer 中建立 Business Object 及字段。
  2. 为对象创建 JDBC 或 REST API Mapping。
  3. 将对象字段映射到数据库列或 JSON Path。
  4. 保存并校验 Mapping。
  5. 在 Page Designer 的 DataList、ProTable、DataForm 或 Select 中选择对应的 Business Object。

进入 TEST 或 PROD 发布前，Spark 会对已被活动 Mapping 或 Collector 引用的 Data Source 进行预检查。无效的连接、Schema 契约或 API 配置会阻止发布。

安全与命名建议​

  • 不要把真实密码、Token 或 API Key 写入名称、描述、文档和截图。
  • 使用 Secret / Credential 引用管理 API 认证信息。
  • Alias 面向人员阅读，例如“订单库”；Key 面向稳定引用，例如 order-db。
  • 不要在 Key 中添加 dev、test 或 prod；同一个 Key 已经可以管理三个环境。
  • 删除 Data Source 前先检查 Business Object Mapping 引用。被对象使用的 Data Source 不能直接删除。
Last updated on