mirror of
https://github.com/Tencent/tmagic-editor.git
synced 2026-09-25 13:26:22 +00:00
3eb8cc0614
补全方法的参数类型、返回值类型与详情说明，规范字段编辑器/字段配置/运行时 API 等文档。 Co-authored-by: Cursor <cursoragent@cursor.com>
93 lines
5.4 KiB
Markdown
93 lines
5.4 KiB
Markdown
# 代码块
|
||
代码块是一种低代码能力，tmagic-editor中对组件的逻辑干预主要通过代码块来进行支持
|
||
|
||
## 能力展示
|
||
代码块支持的能力有
|
||
- 1、在线编辑
|
||
- 2、参数定义，包括：参数类型定义
|
||
- 3、自动保存草稿
|
||
- 4、参数注释
|
||
下面将主要介绍代码块的实现原理，包含dsl结构定义，以及代码块挂载执行时机等
|
||
## 协议描述
|
||
我们将在线编写的代码内容保存在[DSL](../advanced/js-schema.md)中，与app同一层级，这样的好处是代码块可以在同一活动，不同页面中实现灵活编排。
|
||
类型定义参见[CodeBlockDSL](https://github.com/Tencent/tmagic-editor/blob/master/packages/schema/src/index.ts)。
|
||
|
||
```javascript
|
||
[{
|
||
id: 123456,
|
||
type: 'app',
|
||
items: [{
|
||
id: 222222,
|
||
type: 'page',
|
||
items: [{
|
||
id: 333,
|
||
type: 'comp-A'
|
||
}]
|
||
}],
|
||
codeBlocks: {
|
||
code_123: {
|
||
name: '代码块名称',
|
||
content: ()=>{},
|
||
params: [{
|
||
name: '参数1'
|
||
}]
|
||
}
|
||
}
|
||
}]
|
||
```
|
||
|
||
在页面中创建代码块也就是会将新的代码内容添加到DSL中的codeBlocks对象并保存下来，这里涉及的逻辑可以参见CodeBlock类中的[setCodeDslById](https://github.com/Tencent/tmagic-editor/blob/c143a5f7670ae61d80c1a2cfcc780cfb5259849d/packages/editor/src/services/codeBlock.ts#L107)方法。
|
||
并且可以在编辑器左侧的“代码块”tab下看到当前活动的代码块列表
|
||
<img src="/code-block.png" alt="代码块列表">
|
||
|
||
## 组件绑定
|
||
代码块的初衷是为了实现对组件逻辑的在线干预（代码执行的时机平台提供了组件created, mounted两个钩子），因此我们需要将创建的代码与组件进行关联。
|
||
<img src="https://vip.image.video.qpic.cn/vupload/20230228/4a34a11677585505930.png" alt="组件绑定代码块">
|
||
选中组件之后，在组件配置-高级tab下需要支持下拉选择代码块，以及代码参数的输入。由于每一个组件绑定代码块的需求都是相同的，因此这一部分我们可以抽出为公共的表单配置，相关的逻辑处理在[prop文件](https://github.com/Tencent/tmagic-editor/blob/master/packages/editor/src/utils/props.ts)中，我们在高级tab下统一添加了名为created和mounted两个配置项，表单组件使用了自定义的'code-select'。前面已经提过，表单组件会按照type字段来进行渲染，即 :is="${type}"，[CodeSelect](https://github.com/Tencent/tmagic-editor/blob/c143a5f7670ae61d80c1a2cfcc780cfb5259849d/packages/editor/src/fields/CodeSelect.vue)组件是在editor中自定义的
|
||
|
||
完成绑定的动作实质就是在组件配置中增加与代码块的映射关系
|
||
```javascript
|
||
[
|
||
{
|
||
id: '111',
|
||
type: 'comp_A',
|
||
created: {
|
||
hookType: 'code',
|
||
hookData: [
|
||
{
|
||
codeId: 'code_123',
|
||
params: {
|
||
age: 12,
|
||
studentName: 'lisa'
|
||
}
|
||
}
|
||
]
|
||
}
|
||
}
|
||
]
|
||
```
|
||
|
||
## 代码内容注入与执行
|
||
在实现代码块创建和绑定操作之后，DSL已经包含了代码块执行所需的所有信息，接下来我们在页面加载时对代码块进行解析，并在适当的时机运行。
|
||
|
||
由于代码块的执行时机为组件created，mounted，因此触发执行的动作需要在runtime中完成，对于VUE3来说，我们在组件对应的生命周期去触发就可以了，react则需要在类似的时间点去触发，详细请参见 runtime 相关源码（参考 [runtime 目录](https://github.com/Tencent/tmagic-editor/tree/master/runtime)下的 `vue-runtime-help` 与 `react-runtime-help`）
|
||
|
||
接收事件的动作是在[Core](https://github.com/Tencent/tmagic-editor/blob/c143a5f7670ae61d80c1a2cfcc780cfb5259849d/packages/core/src/Node.ts)中完成的，请记得前面提到过Core主要负责对组件进行跨框架管理与一些通用复杂逻辑的实现，触发时机各个框架不同，但接收事件并执行代码块的逻辑与框架无关。[Core/Node 中的 `listenLifeSafe`](https://github.com/Tencent/tmagic-editor/blob/c143a5f7670ae61d80c1a2cfcc780cfb5259849d/packages/core/src/Node.ts#L159)会对生命周期事件进行监听，并根据组件绑定的代码块ID拿到具体的代码内容，然后执行。在执行调用时我们以 `{ app, params }` 的形式传入了两个参数，其中 `app` 包含了全局的变量，`params` 为组件绑定时针对代码块传入的参数。
|
||
|
||
至此，我们就完成了代码块创建-绑定-注入-运行。与代码块功能相关的UI界面中我们也提供了丰富的插槽供开发者扩展，相关源码请见[sidebar/codeBlock](https://github.com/Tencent/tmagic-editor/tree/master/packages/editor/src/layouts/sidebar/code-block)。
|
||
|
||
## 代码块界面展示
|
||
侧边栏的代码块列表可以查看当前创建的代码块，以及每个代码块绑定的组件，点击代码块下方展示的组件icon可以在画布中选中该组件
|
||
<img src="/code-block-list.png" alt="代码块列表">
|
||
|
||
代码块编辑面板，可以在这里编写代码内容，申明参数
|
||
<img src="https://vip.image.video.qpic.cn/vupload/20230228/1fd2e11677637006239.png" alt="代码块编辑面板">
|
||
|
||
组件高级tab下绑定代码块，可以输入参数值，查看注释，打开代码编辑面板
|
||
<img src="https://vip.image.video.qpic.cn/vupload/20230301/b2c8431677637119126.png" alt="绑定代码块">
|
||
|
||
保存后点击预览，可以看到在控制台打出了我们打印的日志内容
|
||
<img src="https://vip.image.video.qpic.cn/vupload/20230301/672f8a1677637682103.png" alt="预览">
|
||
|
||
|