3.5.7.5 自定义动作

动作是什么

动作(action)描述了终端用户的各种操作。这些操作可以涉及多个层面,包括但不限于:

  1. 页面间的跳转:用户可以通过动作从一个页面跳转到另一个页面。

  2. 业务交互:动作可以触发与后端服务的交互,例如提交表单、请求数据等。

  3. 界面操作:动作可以用于打开模态对话框、抽屉(侧边栏)等界面元素。

作用场景

Oinone 平台内置了一系列的基础动作,默认实现了常见的功能,如页面跳转、业务交互和界面操作等。这些内置动作旨在满足大多数标准应用场景的需求,简化开发过程,提高开发效率。以下是一些常见的内置动作示例:

  1. 页面跳转:允许用户在不同页面间导航。

  2. 业务交互:支持与后端服务的数据交互,如提交表单。

  3. 界面操作:提供动态返回上一页、校验表单、关闭弹窗等。

自定义动作的需求场景

尽管内置动作覆盖了许多常规需求,但在某些复杂或特定的业务场景中,可能需要更加个性化的处理。这些场景可能包括:

  • 特殊的业务逻辑:需要执行不同于标准流程的特定业务操作。
  • 个性化的用户界面:标准的 UI 组件无法满足特定的设计要求。
  • 高级交互功能:需要实现复杂的用户交互和数据处理。

扩展和定制动作

为了满足这些特定需求,Oinone 平台支持通过继承和扩展来自定义动作。开发者可以通过以下步骤实现自定义动作:

  1. 继承基类:从平台提供的动作基类继承,这为自定义动作提供了基础框架和必要的接口。

  2. 实现业务逻辑:在继承的基础上,添加特定的业务逻辑实现。

  3. 自定义界面:根据需要调整或完全重写界面组件,以符合特定的UI设计。

  4. 集成测试:确保自定义动作在各种情况下的稳定性和性能。

最佳实践

  • 明确需求:在进行扩展之前,清楚地定义业务需求和目标。
  • 重用现有功能:尽可能利用平台的内置功能和组件。
  • 保持一致性:确保自定义动作与平台的整体风格和标准保持一致。
  • 充分测试:进行全面的测试,确保新动作的稳定性和可靠性。

案例分析

假设有一个场景,需要一个特殊的数据提交流程,该流程不仅包括标准的表单提交,还涉及复杂的数据验证和后续处理。在这种情况下,可以创建一个自定义动作,继承基础动作类并实现特定的业务逻辑和用户界面。

自定义动作

自定义跳转动作

示例工程目录

以下是需关注的工程目录示例,main.ts更新导入./action,action/index.ts更新导出./custom-viewactioin:

image.png

图3-5-7-24 自定义跳转动作工程目录示例

步骤 1: 创建自定义动作类

首先,您创建了一个名为 CustomViewAction 的类,这个类继承自 RouterViewActionWidget。这意味着自定义动作是基于路由视图动作的,这通常涉及页面跳转或导航。

import {ActionWidget, RouterViewActionWidget, SPI} from '@kunlun/dependencies';
import CustomViewActionVue from './CustomViewAction.vue';

@SPI.ClassFactory(
    ActionWidget.Token({
        model: 'resource.ResourceCity',
        name: 'redirectCreatePage'
    })
)
export class CustomViewAction extends RouterViewActionWidget {
    public initialize(props) {
        super.initialize(props);
        this.setComponent(CustomViewActionVue);
        return this;
    }
}

图3-5-7-24 自定义跳转动作组件(TS)代码示例

  • @SPI.ClassFactory: 这是一个装饰器,用于向平台注册这个新的动作。
  • ActionWidget.Token: 通过这个Token,指定了这个动作与特定模型 (resource.ResourceCity) 关联,并给这个动作命名 (redirectCreatePage).
步骤 2: 初始化和设置组件

在 initialize 方法中,调用了父类的初始化方法,并设置了自定义的 Vue 组件。

public initialize(props) {
  super.initialize(props);
  this.setComponent(CustomViewActionVue);
  return this;
}

图3-5-7-24 初始化和设置组件

步骤 3: 定义 Vue 组件

在 CustomViewAction.vue 文件中,定义了自定义动作的视觉表示。

<template>
  <div class="view-action-wrapper">
    自定义挑战跳转动作
  </div>
</template>

<script lang="ts">
import { defineComponent } from 'vue'

export default defineComponent({
  inheritAttrs: false,
  name: 'ViewActionComponent'
})
</script>

<style lang="scss">
.view-action-wrapper {
}
</style>

图3-5-7-24 自定义跳转动作组件(Vue)代码示例

步骤 4: 效果如下

image.png

图3-5-7-24 自定义跳转动作效果示例

自定义服务器动作

示例工程目录

以下是需关注的工程目录示例,action/index.ts更新导出./custom-serveraction:

image.png

图3-5-7-24 自定义服务器动作工程目录示例

步骤 1: 创建自定义动作类

首先, 创建了一个名为 CustomServerAction 的类,这个类继承自 ServerActionWidget。这表明您的自定义动作主要关注服务器端的逻辑。

import {ActionWidget, ServerActionWidget, SPI, Widget} from '@kunlun/dependencies';
import CustomServerActionVue from './CustomServerAction.vue';

@SPI.ClassFactory(
    ActionWidget.Token({
        model: 'resource.ResourceCity',
        name: 'delete'
    })
)
export class CustomServerAction extends ServerActionWidget {
    public initialize(props) {
        super.initialize(props);
        this.setComponent(CustomServerActionVue);
        return this;
    }

    @Widget.Method()
    public clickAction() {
        // 这里断点试试看
        return super.clickAction()
    }
}

图3-5-7-24 自定义服务器动作组件(TS)示例

  • @SPI.ClassFactory: 这个装饰器用于向平台注册新的动作。

  • ActionWidget.Token: 这里指定了动作与 resource.ResourceCity 模型相关联,动作名为 delete。

步骤 2: 初始化和设置组件

在 initialize 方法中,调用了父类的初始化方法,并将 Vue 组件与动作关联。

public initialize(props) {
  super.initialize(props);
  this.setComponent(CustomServerActionVue);
  return this;
}

图3-5-7-24 初始化和设置组件

步骤 3: 定义动作行为

重写了 clickAction 方法,这是触发服务器动作的主要入口点。在这个方法中,您可以添加自定义逻辑,然后调用 super.clickAction() 来执行默认的服务器动作。

@Widget.Method()
  public clickAction() {
    // 这里可以添加自定义逻辑
    return super.clickAction();
  }

图3-5-7-24 定义动作行为

步骤 4: Vue 组件
<template>
  <div class="server-action-wrapper" @click="clickAction">
    自定义服务器动作
  </div>
</template>

<script lang="ts">
import { defineComponent } from 'vue'

export default defineComponent({
  inheritAttrs: false,
  name: 'ServerActionComponent',
  props: ['clickAction']
})
</script>

<style lang="scss">
.server-action-wrapper {
}
</style>

图3-5-7-24 自定义服务器动作组件(Vue)示例

Vue 组件定义了如何在前端显示和触发这个动作。

<style lang="scss">
  .server-action-wrapper {
    // 样式定义
  }
</style>

图3-5-7-24 Vue组件定义显示和触发

  • 这个模板中的 @click="clickAction" 是触发动作的关键部分。
步骤 5: 样式和行为

同样,为该组件定义了样式,并通过 defineComponent 创建了 Vue 组件。

<style lang="scss">
  .server-action-wrapper {
    // 样式定义
  }
</style>

图3-5-7-24 Vue组件定义样式

效果

image.png

图3-5-7-24 自定义服务区动作效果示例

Oinone社区 作者:史, 昂原创文章,如若转载,请注明出处:https://doc.oinone.top/oio4/9268.html

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

(0)
史, 昂的头像史, 昂数式管理员
上一篇 2024年5月23日 am9:10
下一篇 2024年5月23日 am9:12

相关推荐

  • 构件类

    1.构件类 1.1 延时 当下一个节点动作需要一段时间之后再发生时,可以使用延时节点。延时节点包含两种延时方式:1、延至指定日期,2、延时一段时间。 选择延至指定日期时,可以选择延至模型字段的时间或自定义时间,如果模型字段只包含日期则必填指定时辰。如果选择自定义则需要分别指定日期和时辰。 选择延时一段时间时,至少需要填“天、小时、分钟”中的一项。 1.2 条件分支 使不同条件的数据执行不同的分支流程。需要设置分支条件、添加满足条件的动作、也可以增删条件分支。 必须将分支条件填写完整流程才能正常进行。当只有两个分支时点击删除任一分支会删除整个条件分支。 1.3 审批分支 审批分支是一种特殊的条件分支。审批分支只能添加在审批节点下方。因为审批只存在通过和拒绝两种条件,所以无法添加其他条件,并且点击任意条件的叉都会删除整个条件分支。同时若审批节点被删除,审批分支也会同时删除。 1.4 子流程 一些高度重复的流程节点可以创建成子流程,在主流程中引用子流程,减少流程的重复配置。选择子流程时只能选择当前流程中有用到的模型下并且在启用状态的子流程,也可以在创建子流程节点处设置新增子流程。子流程的执行方式有两种:子流程可以和后续节点同时执行,也可以设置子流程执行完后再执行后续节点。 子流程与普通正常流程不同,不包含触发方式,普通流程流转到子流程节点即为子流程的触发条件,添加完节点动作之后发布即可。在不新增数据的情况下,子流程中只能使用该子流程对应模型的字段数据。

    2024年5月23日
    89700
  • 3.3.7 字段之序列化方式

    本文核心是带大家全面了解oinone的序列方式,包括支持的序列化类型、注意点、如果新增客户化序列化方式以及字段默认值的反序列化。 一、数据存储的序列化 (举例) 使用@Field注解的serialize属性来配置非字符串类型属性的序列化与反序列化方式,最终会以序列化后的字符串持久化到存储中。 ### Step1 新建PetItemDetail模型、并为PetItem添加两个字段 PetItemDetail继承TransientModel,增加两个字段,分别为备注和备注人 package pro.shushi.pamirs.demo.api.tmodel; import pro.shushi.pamirs.meta.annotation.Field; import pro.shushi.pamirs.meta.annotation.Model; import pro.shushi.pamirs.meta.base.TransientModel; import pro.shushi.pamirs.user.api.model.PamirsUser; @Model.model(PetItemDetail.MODEL_MODEL) @Model(displayName = "商品详情",summary = "商品详情",labelFields = {"remark"}) public class PetItemDetail extends TransientModel { public static final String MODEL_MODEL="demo.PetItemDetail"; @Field.String(min = "2",max = "20") @Field(displayName = "备注",required = true) private String remark; @Field(displayName = "备注人",required = true) private PamirsUser user; } 图3-3-7-1 PetItemDetail继承TransientModel 修改PetItem,增加两个字段petItemDetails类型为List和tags类型为List,并设置为不同的序列化方式,petItemDetails为JSON(缺省就是JSON,可不配),tags为COMMA。同时设置 @Field.Advanced(columnDefinition = varchar(1024)),防止序列化后存储过长 package pro.shushi.pamirs.demo.api.model; import pro.shushi.pamirs.demo.api.tmodel.PetItemDetail; import pro.shushi.pamirs.meta.annotation.Field; import pro.shushi.pamirs.meta.annotation.Model; import pro.shushi.pamirs.meta.enmu.NullableBoolEnum; import java.math.BigDecimal; import java.util.List; @Model.model(PetItem.MODEL_MODEL) @Model(displayName = "宠物商品",summary="宠物商品",labelFields = {"itemName"}) public class PetItem extends AbstractDemoCodeModel{ public static final String MODEL_MODEL="demo.PetItem"; @Field(displayName = "商品名称",required = true) private String itemName; @Field(displayName = "商品价格",required = true) private BigDecimal price; @Field(displayName = "店铺",required = true) @Field.Relation(relationFields = {"shopId"},referenceFields = {"id"}) private PetShop shop; @Field(displayName = "店铺Id",invisible = true) private Long shopId; @Field(displayName = "品种") @Field.many2one @Field.Relation(relationFields = {"typeId"},referenceFields = {"id"}) private PetType type; @Field(displayName = "品种类型",invisible = true) private Long typeId; @Field(displayName = "详情", serialize = Field.serialize.JSON, store = NullableBoolEnum.TRUE) @Field.Advanced(columnDefinition = "varchar(1024)") private List<PetItemDetail> petItemDetails; @Field(displayName = "商品标签",serialize = Field.serialize.COMMA,store = NullableBoolEnum.TRUE,multi = true) @Field.Advanced(columnDefinition = "varchar(1024)") private…

    2024年5月23日
    94900
  • 4.1.18 框架之网关协议-Variables变量

    我们在应用开发过程有一种特殊情况在后端逻辑编写的时候需要知道请求的发起入口,平台利用GQL协议中的Variables属性来传递信息,本文就介绍如何获取。 一、前端附带额外变量 属性名 类型 说明 scene String 菜单入口 表4-1-18-1 前端附带额外变量 图4-1-18-1 variables信息中的scene 二、后端如何接收variables信息 通过PamirsSession.getRequestVariables()可以得到PamirsRequestVariables对象。 三、第一个variable(举例) Step1 修改PetTalentAction,获取得到前端传递的Variables package pro.shushi.pamirs.demo.core.action; ……类引用 @Model.model(PetTalent.MODEL_MODEL) @Component public class PetTalentAction { ……其他代码 @Function.Advanced(type= FunctionTypeEnum.QUERY) @Function.fun(FunctionConstants.queryPage) @Function(openLevel = {FunctionOpenEnum.API}) public Pagination<PetTalent> queryPage(Pagination<PetTalent> page, IWrapper<PetTalent> queryWrapper){ String scene = (String)PamirsSession.getRequestVariables().getVariables().get("scene"); System.out.println("scene: "+ scene); ……其他代码 } ……其他代码 } 图4-1-18-2 修改PetTalentAction Step2 重启验证 点击宠物达人不同菜单入口,查看效果 图4-1-18-3 示例效果(一) 图4-1-18-4 示例效果(二)

    2024年5月23日
    77000

Leave a Reply

登录后才能评论