前端视图的元数据与数据的传递、交互

汤乾华 • 2024年10月8日 am11:50 • 前端 • 阅读 2602

在阅读本篇文章之前，您需要学习以下知识点：

1: 元数据

视图的元数据

在日常开发中，我们会经常遇到自定义的字段、动作、视图需要界面设计器配置的数据，这些数据可能是当前页面的字段，也有可能动作，那么如何获取呢？

视图元数据分为两种：
1: 当前视图(metadataRuntimeContext)
2: 根视图(rootRuntimeContext)

那么这两种类型怎么区分呢？

举个例子：
1: 如果当前字段是在表单中，那么当前视图就是表单，根视图就表单的父级视图，如果只有一个表单视图，那么当前视图就是根视图。
2: 如果当前视图是表单，但是表单里面有个表格，对于表格字段而言，当前视图就是表格，根视图就是表单。

当前视图的元数据(`metadataRuntimeContext`)

在前端，我们通过 metadataRuntimeContext 来获取视图的元数据，例如：

export class CustomFormStringFieldSingleWidget extends FormStringFieldSingleWidget {
  protected mounted(): void {
    console.log(this.metadataRuntimeContext);
  }

    /**
  * 界面设计器配置的动作
  */
  @Widget.Reactive()
  protected get modelActions() {
    return this.metadataRuntimeContext.model.modelActions
  }

   /**
  * 界面设计器配置的字段
  */
  @Widget.Reactive()
  protected get modelFields() {
    return this.metadataRuntimeContext.model.modelFields
  }
}

属性名	类型	可选性	描述
`viewAction`	`RuntimeViewAction`	是	运行时跳转动作（通过跳转动作创建的运行时上下文具备该属性）
`module`	`RuntimeModule`	否	运行时模块
`model`	`RuntimeModel`	否	运行时模型
`view`	`RuntimeView`	否	运行时视图
`viewLayout`	`DslDefinition \\| undefined`	否	视图布局 DSL，从运行时视图解析获得
`viewDsl`	`DslDefinition \\| undefined`	否	视图模板 DSL，从运行时视图解析获得
`viewTemplate`	`DslDefinition`	否	视图最终执行 DSL，从运行时视图解析获得或根据布局 DSL 和模板 DSL 合并生成
`getModel`	`(model: string, isBelong?: boolean) => GetModelResult \\| undefined`	否	获取模型，返回获取的模型和所在的运行时上下文
`getModelField`	`(data: string, isBelong?: boolean) => GetModelFieldResult \\| undefined`	否	获取模型字段，返回获取的模型字段和所在的运行时上下文
`getRequestModelFields`	`(options?: GetRequestModelFieldsOptions) => RequestModelField[]`	否	获取请求字段
`getDefaultValue`	`() => Promise<Record<string, unknown>>`	否	获取默认值
`getInitialValue`	`() => Promise<Record<string, unknown>>`	否	获取初始值

运行时模型(`model`)

属性名	类型	可选性	描述
`id`	`string`	是	模型 id
`model`	`string`	否	模型编码
`name`	`string`	否	技术名称
`modelFields`	`RuntimeModelField[]`	否	模型字段
`modelActions`	`RuntimeAction[]`	否	模型动作
`type`	`ModelType`	是	模型类型
`module`	`string`	是	模块编码
`moduleName`	`string`	否	模块名称
`moduleDefinition`	`RuntimeModule`	是	模块定义
`pks`	`string[]`	是	主键
`uniques`	`string[][]`	是	唯一键
`indexes`	`string[][]`	是	索引
`sorting`	`string`	是	排序
`label`	`string`	是	显示标题
`labelFields`	`string[]`	是	标题字段

可通过modelFields、modelActions获取界面设计器配置的模型字段、模型动作。

当前视图的 dsl(`viewDsl`)

视图的 DSL，从运行时视图解析获得，如果模型中的modelFields、modelActions获取不到的对应的字段、动作，那么可从该属性中获取

默认值(`getDefaultValue`)

用来获字段的默认值（界面配置器配置的）

根视图的元数据(`rootRuntimeContext`)

根视图的元数据结构跟当前视图的元数据类似。

视图数据

视图数据是贯穿于应用程序前端和视图层的关键数据，它承载了应用逻辑到用户界面之间的桥梁作用。

在 oinone 前端中，常见的视图数据分为如下几种：

1: 表单数据(formData)
2: 列表数据(dataSource)
3: 根视图数据(rootData)
4: 当前字段、动作所在的区域数据(activeRecords)
5: 按钮打开弹窗、抽屉的时候，按钮所在的区域数据(openerActiveRecords)

formData

formData 是一个对象，对象中的每个属性对应一个表单项，表单项的值就是该属性的值。所有的表单字段都可以通过this.formData来访问，也可以通过this.formData.xxx来获取某个字段的值。

dataSource

dataSource 是一个数组，数组中的每个元素对应一个列表项，列表项的值就是该元素。所有的列表字段都可以通过this.dataSource来访问，也可以通过this.dataSource[0].xxx来获取某个列表字段的值。

rootData

rootData 是一个数组，如果当前视图是列表，那么 rootData 是列表的数据源。如果当前视图是表单，那么 rootData 是表单的数据源，其中的第 0 项是当前表单的数据。

activeRecords

activeRecords 是一个数组

1: 表单视图的动作
    1.1: activeRecords 是表单的数据源，其中的第 0 项是当前表单的数据。
2: 表格视图上方的动作
    2.1: activeRecords 是当前选中的行数据，其中的第 0 项是对应的数据。
3: 表格的行内动作
    3.1: activeRecords 是当前行数据，其中的第 0 项是对应的数据。

openerActiveRecords

openerActiveRecords 是一个数组，用于保存当前页面的 opener 页面选中的数据。

1: 比如 行内动作 点击打开弹窗，弹窗里面的字段或者动作可以通过 openerActiveRecords 获取 行内 数据.
2: 比如 表单中的动作 点击打开弹窗，弹窗里面的字段或者动作可以通过 openerActiveRecords 表单 数据.

特殊数据

activeTreeContext 树组件的选中数据

activeTreeContext 树组件的选中数据，可以获取到选中的数据，以及选中的数据的父级数据，用于左树右表的视图.

常见场景：

场景 1: 左树右表的视图，表格上方的创建按钮点击打开弹窗，弹窗里面要获取左树选中的数据，用于创建数据.
方案：点击弹窗里面的创建按钮时，通过 this.metadataRuntimeContext.view?.activeTreeContext 获取到左树选中的数据

class CustomActon extends ServerActionWidget {
  protected async executeAction(action: RuntimeServerAction, submitValue: SubmitValue){
    const treeContext = this.metadataRuntimeContext.view?.activeTreeContext || {}
    submitValue.records = {
      ...submitValue.records,
      ...treeContext
    }
    super.executeAction(action, submitValue)
  }
}

场景 2: 左树右表的视图，表格上方的创建按钮点击打开新页面，新页面里面要获取左树选中的数据，用于创建数据.
方案：点击新页面里面的创建按钮时，可通过URL参数获取到左树选中的数据

class CustomActon extends ServerActionWidget {
  protected async executeAction(action: RuntimeServerAction, submitValue: SubmitValue){
    const treeContext = JSON.parse(this.getUrlParameters().context).activeTreeContext || {}
    submitValue.records = {
      ...submitValue.records,
      ...treeContext
    }
    super.executeAction(action, submitValue)
  }
}

searchBody 搜索条件、searchConditions 固定查询条件

参考文章

Oinone社区作者：汤乾华原创文章，如若转载，请注明出处：https://doc.oinone.top/frontend/18209.html

访问Oinone官网:https://www.oinone.top获取数式Oinone低代码应用平台体验

汤乾华数式员工

0 0

数据可视化创建图表

上一篇 2024年10月8日 am10:37

前端初阶知识点讲解

下一篇 2024年10月8日 pm5:55

组件

oio-button 按钮

主按钮：用于主行动点，一个操作区域只能有一个主按钮。默认按钮：用于没有主次之分的一组行动点。虚线按钮：常用于添加操作。文本按钮：用于最次级的行动点。链接按钮：一般用于链接，即导航至某位置。以及四种状态属性与上面配合使用。危险：删除/移动/修改权限等危险操作，一般需要二次确认。禁用：行动点不可用的时候，一般需要文案解释。加载中：用于异步操作等待反馈的时候，也可以避免多次提交。 API 按钮的属性说明如下：属性说明类型默认值版本 block 将按钮宽度调整为其父宽度的选项 boolean false disabled 按钮失效状态 boolean false icon 设置按钮的图标类型 v-slot – loading 设置按钮载入状态 boolean | { delay: number } false type 设置按钮类型 primary | ghost | dashed | link | text | default default 事件事件名称说明回调参数版本 click 点击按钮时的回调 (event) => void 支持原生 button 的其他所有属性。

汤乾华
2023年12月18日
601001
API&SDK 文档

「前端」动作API

概述在 oinone 前端平台中，提供了四种动作跳转动作（页面跳转、打开弹窗、抽屉）服务端动作（调用接口）客户端动作（返回上一页、关闭弹窗等）链接动作（打开执行的链接）快速开始 // 基础使用示例 import { executeViewAction, executeServerAction, executeUrlAction } from '@kunlun/dependencies'; // 示例 1: 基础页面跳转（去创建页面） executeViewAction(action); // 示例 2: 带参数的页面跳转（查询ID为123的数据）,去编辑、详情页 executeViewAction(action, undefined, undefined, { id: '123' }); // 示例 3: 页面跳转的参数，用最新的，防止当前页面的参数被带到下一个页面 executeViewAction(action, undefined, undefined, { id: '123' , preserveParameter: true}); // 示例 4: 调用服务端接口 const params = { id: 'xxx', name: 'xxx' }; await executeServerAction(action, params); await executeServerAction(action, params, { maxDepth: 2 }); // 接口数据返回的数据层级是3层 -> 从0开始计算, 默认是2层 // 执行链接动作 executeUrlAction(action); API 详解 executeViewAction 参数名描述类型必填默认值 — action 视图动作 RuntimeViewAction true router 路由实例 Router false undefined matched 路由匹配参数 Matched false undefined extra 扩展参数 object false {} target 规定在何处打开被链接文档（可参考 a 标签的 target） string false undefined executeServerAction 参数名描述类型必填默认值 action 服务端动作 RuntimeServerAction true param 传递给后端的参数 object true context 配置接口返回的数据层级（默认是两层） {maxDepth: number} false executeUrlAction 参数名描述类型必填默认值 action 链接动作 IURLAction true

汤乾华
2025年3月21日
665000
前端

如何关闭table的checkbox？

需要修改xml的配置将xml中的fields改成table，并将配置加上 // 原来的写法 <template slot=”fields” > … </template> // 配置后的写法 <template slot=”table” checkbox=”false”> … </template>

oinone
2023年11月1日
803000
组件

前端自定义组件之多页面步骤条

本文将讲解如何通过自定义，实现多页面的步骤条组件。其中每个步骤的元素里都对应界面设计器的一个页面。以下是代码实现和原理分析。代码实现 NextStepWidget 多页面步骤条 ts 组件 import { CallChaining, createRuntimeContextByView, customMutation, customQuery, RuntimeView, SPI, ViewCache, Widget, DefaultTabsWidget, BasePackWidget } from '@oinone/kunlun-dependencies'; import { isEmpty } from 'lodash-es'; import { MyMetadataViewWidget } from './MyMetadataViewWidget'; import NextStep from './NextStep.vue'; import { IStepConfig, StepDirection } from './type'; @SPI.ClassFactory(BasePackWidget.Token({ widget: 'NextStep' })) export class NextStepWidget extends DefaultTabsWidget { public initialize(props) { this.titles = props.template?.widgets?.map((item) => item.title) || []; props.template && (props.template.widgets = []); super.initialize(props); this.setComponent(NextStep); return this; } @Widget.Reactive() public get invisible() { return false; } // 配置的每一步名称 @Widget.Reactive() public titles = []; // region 上一步下一步配置 // 步骤配置，切换的顺序就是数组的顺序，模型没有限制 @Widget.Reactive() public get stepJsonConfig() { let data = JSON.parse( this.getDsl().stepJsonConfig || '[{"model":"resource.ResourceCountry","viewName":"国家form"},{"model":"resource.ResourceProvince","viewName":"省form"},{"model":"resource.ResourceCity","viewName":"市form"}]' ); return data as IStepConfig[]; } // 切换上一步下一步 @Widget.Method() public async onStepChange(stepDirection: StepDirection) { // 没有激活的，说明是初始化，取第一步 if (!this.activeStepKey) { const step = this.stepJsonConfig[0]; if (step) { this.activeStepKey = `${step.model}_${step.viewName}`; await this.initStepView(step); } return; } // 获取当前步骤的索引 if (this.currentActiveKeyIndex > -1) { await this.onSave(); // 获取下一步索引 const nextStepIndex = stepDirection === StepDirection.NEXT ? this.currentActiveKeyIndex + 1 : this.currentActiveKeyIndex – 1; // 在索引范围内，则渲染视图 if (nextStepIndex >= 0 && nextStepIndex < this.stepJsonConfig.length) { const nextStep = this.stepJsonConfig[nextStepIndex];…

银时
2025年7月21日
612000
前端

【界面设计器】树形表格

阅读之前你应该：熟悉模型的增删改查相关内容。【界面设计器】模型增删改查基础

张博昊
2024年4月19日
1.0K001

登录后才能评论

shao 2024年11月25日

支持其他的国家的语言，需要在资源里面创建，如果有其他的疑问，也可以群内联系我们哈

评论于 6.4 国际化之多语言
xiao3 2024年11月25日

只支持英语吗？如何添加其他语种？

评论于 6.4 国际化之多语言
psyy 2024年8月21日

1.4 Oinone对软件特性的思考，技术原理一段，几余（几->冗） 1.4 Oinone对软件特性的思考，协同演进一段，新特生（生->性）

评论于 1.4 Oinone对软件特性的思考
望闲 2024年6月21日

感谢反馈，已修正

评论于 1.5 Oinone与行业对比
xinf 2024年6月14日

bug反馈：采用无一体设计 -> 采用低无一体设计

评论于 1.5 Oinone与行业对比

前端视图的元数据与数据的传递、交互

视图的元数据

当前视图的元数据(metadataRuntimeContext)

运行时模型(model)

当前视图的 dsl(viewDsl)

默认值(getDefaultValue)

根视图的元数据(rootRuntimeContext)

视图数据

formData

dataSource

rootData

activeRecords

openerActiveRecords

特殊数据

activeTreeContext 树组件的选中数据

searchBody 搜索条件、searchConditions 固定查询条件

相关推荐

oio-button 按钮

「前端」动作API

如何关闭table的checkbox？

前端自定义组件之多页面步骤条

【界面设计器】树形表格

Leave a Reply

当前视图的元数据(`metadataRuntimeContext`)

运行时模型(`model`)

当前视图的 dsl(`viewDsl`)

默认值(`getDefaultValue`)

根视图的元数据(`rootRuntimeContext`)