跳到主要内容

私有化环境中开发自定义组件库

前置条件​

  • Node.js 环境
  • 安装 Cloudbase CLI
  • 私有化部署环境
  • 环境中具备安装 npm 包能力，或者提前预制的 node_modules

在私有化环境控制台中创建自定义组件库​

打开私有化环境控制台的组件库管理页面， 创建一个新的组件库。

下载组件库模版代码​

如果当前环境可以访问公网，可以通过 tcb lowcode create <刚刚新建的组件库标识> --skip-validate 下载模版代码

如果当前环境无法访问公网，可以直接在GitHub 下载压缩包再自行上传。

修改组件库配置​

组件库代码中有一个cloudbaserc.json 文件。 如果不是CLI创建的，则文件中的 lowcodeCustomComponents.name 字段需要修改为对应组件库标识。假设创建的组件库标识为mydemo

注意

私有化环境中需要在cloudbaserc.json中有额外的私有化环境相关配置

私有化配置在lowcode.privateSettings字段

credential 字段是私有化控制台中生成的API Key

endpoints中需要配置 editor和cliApi字段分别表示 私有化环境中的编辑器和cliApi入口

privateUin 是私有化环境的用户uin

除私有化相关配置外的字段与公有云一致 https://docs.cloudbase.net/lowcode/custom-components/config/config-comps

下面是一个cloudbaserc.json 的完整实例

{
  "envId": "{{_envId}}",
  "lowcodeCustomComponents": { //这个字段跟公有云一致
    "name": "mydemo", // 组件库标识
    "configRoot": "./src/configs",
    "platformRoot": {
      "web": {
        "entry": "./src/web",
        "components": "./src/web/components",
        "actions": "./src/web/actions"
      },
      "mp": {
        "entry": "./src/mp"
      }
    }
  },
  "lowcode": { // 私有化特殊配置
    "privateSettings": {
      "credential": {
        "secretId": "xxxxx",
        "secretKey": "xxxxx"
      },
      "endpoints": {
        "editor": "http://lcap.o.wedagns.tcs230.fsphere.cn/v2/dev.html",
        "cliApi": "http://node-api.o.wedagns.tcs230.fsphere.cn/api/v1/cliapi"
      },
      "privateUin": "909619400"
    }
  }
}

调试/发布以及在应用中使用组件库​

发布以及调试功能使用方法与公有云一致。 详见