这是本节的多页打印视图。 点击此处打印.

返回本页常规视图.

扩展开发

面向开发人员的扩展开发指南

本章节预期读者为开发人员,包括Java技术栈的后端开发和React技术栈的前端开发。

帮助开发人员了解如何通过编码方式实现:

  1. 前后端组件开发
  2. 前后端手写代码
  3. 风格定制开发
  4. 集成连接
  5. 平台基础设施的SPI扩展

前端相关文档请访问V8前端开放平台

1 - Ctp-Studio手册

Ctp-Studio的使用

2 - 代码管理规范

代码管理规范,代码的版本管理和编译构建。

通过Ctp-Studio统一管理私有化部署环境客户的前后端手写代码。

通过Ctp-Studio对前后端组件进行版本管理、编译构建。

所有私有化部署环境的定制开发代码均需提交到git上进行统一管理。

不包含aPaaS上开发的前后端手写代码。

前后端手写代码的编译构建由私有化部署环境的流水线进行编译构建。

后端代码管理

分类 存放位置 备注
后端扩展代码 customize_v8/{corpId}-{corpName}/backend/app/{appName} 后端自定义微流程,事件监听实现等。
后端组件代码 customize_v8/{corpId}-{corpName}/backend/component/{componentName} 后端组件,SPI jar

corpId:客户ID,下同。

corpName:客户名称,下同。

appName:UDC应用的名称。

componentName:组件名称。

前端代码管理

分类 存放位置 备注
前端扩展代码 customize_v8/{corpId}-{corpName}/frontend/app/{appName} 前端自定义页面
前端组件代码 customize_v8/{corpId}-{corpName}/frontend/component/{componentName} 前端组件
前端jssdk扩展代码 customize_v8/{corpId}-{corpName}/frontend/jssdk/{xxx} jssdk扩展
前端css扩展代码 customize_v8/{corpId}-{corpName}/frontend/css/{xxx} css扩展

3 - 后端手写代码

编写后端手写代码,实现低代码应用的自定义逻辑。

自定义微流程开发

自定义函数开发

第三方实体的使用

4 - 前端手写代码

扩展前端组件,编写自定义页面。

自定义页面开发

自定义页面,就是手写代码的方式,实现用户的自定义开发页面的需求。自定义核心是在补足,页面形态相对比较复杂的情况下,可通过手写代码的方式进行开发实现。

:::color4 ⚠️ 注:平台提供了多层次扩展能力,组件的扩展、Iframe的嵌套等,若存在无法实现的场景和交互时,优先考虑通过扩展局部的方式实现。

这种模式下,页面的其他控件依旧可以享受平台后续迭代带来的便利。

若一旦使用了自定义页面,则后续的页面的维护只能通过代码的方式进行维护。

故,慎用!!!

:::

此处为语雀卡片,点击链接查看

开发前序准备

  1. 使用 React.js 进行基本开发
  2. 对应环境的Git仓库,账号,密码(需要授权申请,找对应的负责人沟通申请)
  3. 基本的前端开发环境(Node,VSCode……..)

开发流程

自定义页面的开发流程核心分为是五个步骤

生成代码工程

在 低代码设计器中创建页面

  1. 首先进入 UDC 页面设计器. 在设计器中创建实体,以及自定义页面。
  2. 保存页面后,点击页面右上角 “测试” 即可进行应用发布。

新建自定义页面

发布当前应用

Git拉取源码

从 GIT 仓库 获取生成好的应用源代码

获取应用的源代码前,我们需要拿到应用的唯一标识“应用ID(appId)”或 “应用名称(appName)”,可通过下面图示获取

接下来我们进入 GIT 仓库, 通过 “应用名称(appName)” 找到对应的前端代码仓库,将代码克隆到本地。

工程首次创建时,可以使用此demo, 解压后,将代码拷贝到工程中。另外我们还需要创建对应手写页面的文件,文件名与设计器中创建的页面标识一致。 如: /pc/src/pages/${pageName}/customPage.tsx

:::color5 ⚠️ Git的账号密码,需要单独的授权开通,故若没有账号密码,可找对应的技术负责人沟通

仓库地址 : https://v8git.seeyonv8.com/dashboard/groups

应用手写代码一般位于extend>frontend的group下,具体位置需要根据环境实际设置而定

Git分支管理

git仓库的分支于应用的设计版本一致,如应用的设计版本为1.0,则git仓库的分支也为1.0

:::

本地代码调试

确定页面标识/页面URI

首先我们找到在设计器中定义的页面的 URL , 在设计器-菜单-“查看页面属性” 中 找到页面标识   页面URI

确定代码目录

…进入 应用源代码目录后, 就可以看到 pc/mobile 两个终端的 代码。

比如我们进入 PC 目录中 ,根据页面标识 找到 customPage.tsx 文件, 此文件就是 支持 开发者实现自定义代码的文件。

:::

安装依赖

  1. 如果 调试 PC 端代码 则进入 pc 目录执行 yarn install 以便安装前端 NPM 包
  2. 如果 调试 Mobile 端代码 则进入 mobile 目录执行 yarn install 以便安装前端 NPM 包

调整 webpack 代理

修改 webpack-overrides-custom.jshostName 变量值为当前开发/调试环境地址

本地启动

  1. 如果 调试 PC 端代码 则进入 pc 目录执行 yarn start
  2. 如果 调试 Mobile 端代码 则进入 mobile 目录执行 yarn start

启动成功后进入浏览器输入地址就可以访问了

下面是一个示例:

  1. 本地登录: http://localhost:3000/login
  2. 登录成功后,访问具体的页面http://localhost:3000/main/portal/hh3881652103519948446/zidingyiyemian
  • main/portal: 固定的主应用地址
  • hh3881652103519948446: 当前应用的英文名称
  • zidingyiyemian: 当前应用下某个具体页面的 URL

前后端接口交互

  1. 后端提供 restFull API
  2. 前端通过 fetch 等工具 调用restFull API

Git推送页面代码

自己添加的自定义代码 调试完成后, 重新 push 到 远程 GIT 仓库

使用正常的 GIT 提交 推送流程, 将代码推送到远程仓库中

发布

回到设计态重新 点击 “发布/构建/测试” 按钮

自定义参照开发

自定义原生APP适配层

5 - 风格定制

通过CSS覆写和组件样式默认值定制风格。

CSS覆写

组件风格和默认值定制

6 - 集成开发

集成开发指南

连接器

OpenAPI & 能力接入

组织同步 (同步、映射规则、人员卡片)

单点登录

事项集成

栏目集成(门户Portlet规范)

消息集成

融合流程

第三方BPM集成

移动平台集成

IM集成

集成应用

文档中台集成

7 -

8 -

9 -

10 -