3.5.4 Ux注解详解

史, 昂 • 2024年5月23日 am9:23 • Oinone 7天入门到精通 • 1649 views

我们默认视图已经基本可以用了，但实际业务中还是会有一些不大不小的自定义需求，写自定义视图又太麻烦，今天我们来学习一种更加轻量的模式即：后端研发可以通过注解来配置视觉交互。该系列注解以Ux开头，例如@UxHomepage、@UxMenu、@UxAction、@UxView、@UxWidget等等。

视图XML的配置优先级大于在代码上的注解，也就是代码上的注解影响的是默认展示逻辑。

一、Ux家族图谱

我们先简单通过家族图谱做个简单了解，脑海里有一个影响当有需要的时候知道能不能做，深入了解还需要大家多多动手去尝试

图3-5-4-1 Ux家族图谱

二、默认视图后端配置举例

在下面的代码片段中UxTable、UxForm、UxDetail、UxTableSearch都有涉及，几个特殊点做些解释其他的留大家自行测试

Group分组的配置逻辑：为了不让一个分组内的字段不断的写Group，所以采取了第一个字段写了Group，到下一个出现的group之间的字段都自动归为一个Group
搜素整体不展示可以用“@UxTable(enableSearch = false)”配置在模型的类上。
字段搜索用“UxTableSearch”配置在模型的字段上，其特殊逻辑是只要你配了一个字段，系统就不自动补充了，例子中表格页的搜索栏只会留下店铺名称和店铺编码

……其他代码
//@UxTable(enableSearch = false)，整体不支持搜索
public class PetShop extends AbstractDemoIdModel {
    public static final String MODEL_MODEL="demo.PetShop";

    @Field(displayName = "店铺编码")
    @UxForm.FieldWidget(@UxWidget(group = "Form基础数据"))//Form分组
    @UxTableSearch.FieldWidget(@UxWidget())//支持搜索
    private String code;

    @Field(displayName = "店铺编码2")
    @Field.Sequence(sequence = "DATE_ORDERLY_SEQ",prefix = "C",size=6,step=1,initial = 10000,format = "yyyyMMdd")
    private String codeTwo;

    @UxTableSearch.FieldWidget(@UxWidget())//支持搜索
    @UxTable.FieldWidget(@UxWidget(invisible = "true"))//表格中不展示支持搜索
    @Field(displayName = "店铺名称",required = true,immutable=true)
    private String shopName;

    @Field(displayName = "一年内新店")
    @UxForm.FieldWidget(@UxWidget(widget = "Switch",group = "Form基础数据"))//Switch,Checkbox可以切换着看，字段可选widget参考【字段的配置】一文
    private Boolean oneYear;

    @Field(displayName = "开店时间",required = true)
    @UxDetail.FieldWidget(@UxWidget(invisible = "true"))//详情不展示
    private Time openTime;

    @Field(displayName = "闭店时间",required = true)
    @UxDetail.FieldWidget(@UxWidget(invisible = "true"))//详情不展示
    private Time closeTime;
    …… 其他代码
}

图3-5-4-2 默认视图后端配置举例

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

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

Oinone 7天从入门到精通

Like (0)

史, 昂数式管理员

0 0

3.5.5 设计器的结合（改）

Previous 2024年5月23日 am9:22

3.5.3 Action的类型

Next 2024年5月23日 am9:24

Oinone 7天入门到精通

企业个性化配置

平台除了帮助企业快速解决业务需求外，还提供了企业文化、风格个性化能力，本章节详细介绍个性化配置。包括：登陆页配置、企业形象配置、系统风格配置。系统配置配置入口配置入口：右上角登陆账号——系统配置——全局配置——登陆页配置、企业形象配置、系统风格配置。登陆页配置用户自定义登陆页的主题，一共有六个主题可选择，分别为：图一：左侧是图片，右侧是登录输入框，Logo在左上角；图二：右左侧是图片，右侧是登录输入框，Logo在左上角；图三：底图是图片，登录输入框浮在页面左侧，Logo在左上角；图四：底图是图片，登录输入框浮在页面中间，Logo在左上角；图五：底图是图片，登录输入框浮在页面右侧，Logo在左上角；图六：底图是图片，登录输入框浮在页面中间，Logo在登录框上方。页面背景上传登录页背景，支持上传jpg、png格式的图片或mp4、mov、avi格式视频。尺寸建议为1920*1080px，文件大小不超过50MB。登录页logo：指配置登录页左上角的logo图标。预览：配置后可在右侧电脑中点击全屏预览效果。配置示例企业形象配置企业形象配置：可设置企业信息、业务应用导航栏logo、浏览器logo，设置完成之后，点击发布之后设置生效。系统风格配置系统风格配置，可设置主题（浅色、深色）、尺寸（大、中、小），配置后可全屏预览，发布后即可更换成对应的风格。下载代码可进行自定义风格。

史, 昂
2024年6月20日
1.5K000
Oinone 7天入门到精通

特别说明

教材进度目前还在编写整改中，特别是目录上带（改）字样的本版本教材针对4.0，相对3.0增加的特性有：通用能力部分：比如权限、审计、国际化、系统配置、集成可视化等新版权限：交互优化，同时支持子管理员新版审计，支持在线配置审计规则系统配置，提供多种风格，让伙伴基础风格不在需要自定义主题和组件新增集成设计器，通过连接器让应用api和数据库集成资产化管理，通过数据流进行接口逻辑编排，并提供统一的开放平台设计器部分：加强界面设计器部分对移动端、主题、自定义组件等支持，同时完善对数据管理操作、增加各类常用业务组件，加强对树形与及联的支持，表格视图搜索优化流程设计器增加：审批员选择自定义逻辑、转交人选择自定义逻辑，支持手工触发、支持数据事务、支持调用模型函数可视化设计器：增加自定义图表功能、增强下钻能力模块管理：增加新增、多端配置等支持内核机制：性能优化：通过gql层面解决业务研发过程中1+N性能问题，权限性能优化，分布式缓存性能优化，整体性能提升2倍以上针对多租户应用无状态的支持，低无一体支持本地调试 5.0的核心新特性预告，特性会在开发过程中陆续推出供大家体验，但完整体验时间为2024年6月份新增打印设计功能导出的默认交互增强以及导入导出模版设计默认导入导出在交互时可以指定字段导入导出模版可图形化设计多模型AI集成设计器器自定义组件、自定义图表交互友好性增强自定义组件，属性面板设计模版化，解决设计组件属性面板的时候不知道有哪些默认属性。增强组件与动作的结合灵活性组件增加是否有子组件的通用属性，有子组件的组件具备组件拖拽区增强UX注解能力，原本只有设计器支持的，后端UX注解也进行对应支持后端低无一体功能开放（原本该功能只在saas版本上提供），方便咱们做应急和简单应用的时，以无代码为主，低代码为辅的模式。通过低无一体可以通过低代码的方式来解决无代码无法支撑的功能。工作流增强增加循环审批节点增加分支汇集节点增强并行流程能力，比如分支汇集节点可以设置：所有并行节点处理完或只要一条处理完就继续执行。

史, 昂
2024年5月23日
2.2K001
Oinone 7天入门到精通

登录日志

1. 登录日志登录日志：记录企业成员/用户登录平台的历史明细，包括登录时间、位置、IP、登录设备、登录平台等信息，登录平台包括：PC Web、小程序、H5、APP。登录日志不需要通过审计规则订阅，平台会记录每位用户的登录日志。操作支持导出、查看详情。

史, 昂
2024年6月20日
1.4K000
Oinone 7天入门到精通

3.5.7.4 自定义页面

页面是什么在Oinone前端体系中，页面是一个核心概念，它代表着终端用户所看到的当前视图。这个视图可以有多种形式，主要取决于页面是如何定义和构建的。在深入理解页面之前，我们需要了解两个关键的功能：自定义布局和自定义母版。作用场景自定义布局提供了布局调整的强大功能，但在某些情况下，它可能无法完全满足特定的需求。这时，自定义页面就显得尤为重要。自定义页面是对自定义布局的补充，允许开发者从更深层次自由地控制和设计用户界面。当标准布局无法实现所需的视觉效果或功能时，自定义页面提供了更高的灵活性。开发者可以通过自定义页面来实现独特的布局设计，添加特定的交互元素，或者整合复杂的业务逻辑，以创造独特且丰富的用户体验。自定义页面自定义视图组件允许开发者定义和使用特定于业务需求的视图布局。下面是一个具体的示例，展示了如何定义、注册和使用通过 setComponent 结合 TypeScript 和 Vue 的自定义视图组件。示例工程目录以下是需关注的工程目录示例，main.ts更新导入./view：图3-5-7-48 自定义页面工程目录示例 1. 定义 TypeScript 组件首先，我们定义了一个名为 CustomViewWidget 的 TypeScript 组件，并在该组件中通过 setComponent 结合 Vue 单文件组件。 import { BaseElementWidget, BaseElementViewWidget, SPI, ViewWidget } from '@kunlun/dependencies'; import CustomViewVue from './CustomView.vue'; @SPI.ClassFactory(BaseElementWidget.Token({ widget: 'CustomViewWidget' })) export class CustomViewWidget extends BaseElementViewWidget { public initialize(props) { super.initialize(props); this.setComponent(CustomViewVue); return this; } } 图3-5-7-49 定义TypeScript组件代码示例 2. Vue 单文件组件其次，我们创建了对应的 Vue 单文件组件 CustomView.vue，用于展示自定义视图的具体内容。 <template> <div class="custom-view-wrapper"> <h1>自定义视图</h1> </div> </template> <script lang="ts"> import { defineComponent } from 'vue'; export default defineComponent({ inheritAttrs: false, name: 'ViewComponentVue' }); </script> <style lang="scss"> .custom-view-wrapper {} </style> 图3-5-7-50 定义Vue组件代码示例 3. 注册自定义视图布局接下来，我们使用 registerLayout 函数注册了一个表格视图布局，并在其中引入了通过 setComponent 结合的自定义视图组件。 import { registerLayout, ViewType } from "@kunlun/dependencies"; export const registerCustomView = () => { registerLayout( ` <view type="TABLE"> <element widget="CustomViewWidget" /> </view> `, { viewType: ViewType.Table, moduleName: 'resource', model: 'resource.ResourceCountryGroup' } ); }; registerCustomView(); 图3-5-7-51 注册自定义视图布局代码示例效果图3-5-7-52 自定义页面效果示例 4. 自定义视图在表格中的应用当我们注册了自定义视图后，它就可以在表格视图中被使用。在表格视图的布局中，我们通过标签将自定义视图嵌套在表格中，从而覆盖了表格的默认布局 5. 入参一致性值得强调的是，registerLayout 函数和自定义布局的规则是一致的，这意味着开发者可以在自定义布局中使用与 registerLayout 相同的入参规则，从而实现更加灵活和统一的视图布局设计与内置组件结合 1. 注册视图元素布局首先，我们使用 registerLayout 函数注册了一个表格视图的布局。这个布局包含了搜索框、操作栏、以及一个自定义视图组件。 import { registerLayout, ViewType } from "@kunlun/dependencies"; import { CustomViewWidget } from…

史, 昂
2024年5月23日
1.7K000
Oinone 7天入门到精通

3.3.3 模型的数据管理器

数据管理器和数据构造器是Oinone为模型自动赋予的Function是内在数据管理能力，数据管理器针对存储模型是方便在大家编程模式下可以利用数据管理器Function快速达到相关数据操作的目的。数据构造器则主要用于模型进行初始化时字段默认值计算和页面交互数据管理器只有存储模型才有数据管理器。如果@Model.Advanced注解设置了dataManager属性为false，则表示在UI层不开放默认数据管理器。开放级别为API则表示UI层可以通过HTTP请求利用4.1.15【Pamirs标准网关协议】进行数据交互。模型默认数据读管理器函数编码描述开放级别 queryByPk 根据主键查询单条记录，会进行主键值检查 Local、Remote queryByEntity 根据实体查询单条记录 Local、Remote、Api queryByWrapper 根据查询类查询单条记录 Local、Remote queryListByEntity 根据实体查询返回记录列表 Local、Remote queryListByWrapper 根据查询类查询记录列表 Local、Remote queryListByPage 根据实体分页查询返回记录列表 Local、Remote queryListByPageAndWrapper 根据查询类分页查询记录列表 Local、Remote queryPage 分页查询返回分页对象，分页对象中包含记录列表 Local、Remote、Api countByEntity 按实体条件获取记录数量 Local、Remote countByWrapper 按查询类条件获取记录数量 Local、Remote 表3-3-3-1 模型默认数据读管理器模型默认数据写管理器函数编码描述开放级别 createOne 提交新增单条记录 Local、Remote createOrUpdate 新增或更新，需要为模型设置唯一索引，如果数据库检测到索引冲突，会更新数据，若未冲突则新增数据 Local、Remote updateByPk 根据主键更新单条记录，会进行主键值检查 Local、Remote updateByUniqueField 条件更新，条件中必须包含唯一索引字段 Local、Remote updateByEntity 按实体条件更新记录 Local、Remote、Api updateByWrapper 按查询类条件更新记录 Local、Remote createBatch 批量新增记录 Local、Remote createOrUpdateBatch 批量新增或更新记录 Local、Remote updateBatch 根据主键批量更新记录，会进行主键值检查 Local、Remote deleteByPk 根据主键删除单条记录，会进行主键值检查 Local、Remote deleteByPks 根据主键批量删除，会进行主键值检查 Local、Remote deleteByUniqueField 按条件删除记录，条件中必须包含唯一索引字段 Local、Remote deleteByEntity 根据实体条件删除 Local、Remote、Api deleteByWrapper 根据查询类条件删除 Local、Remote createWithField 新增实体记录并更新实体字段记录 Local、Remote、Api updateWithField 更新实体记录并更新实体字段记录 Local、Remote、Api deleteWithFieldBatch 批量删除实体记录并删除关联关系 Local、Remote、Api 表3-3-3-2 模型默认数据写管理器如果模型继承IdModel，模型会自动设置主键设置为id，则会继承queryById、updateById和deleteById函数。 queryById（详情，根据ID查询单条记录，开放级别为Remote） updateById（提交更新单条记录，根据ID更新单条记录，开放级别为Remote） deleteById（提交删除单条记录，根据ID删除单条记录，开放级别为Remote）如果模型继承CodeModel，模型也会继承IdModel的数据管理器，编码字段code为唯一索引字段。在新增数据时会根据编码生成规则自动设置编码字段code的值，继承queryByCode、updateByCode和deleteByCode函数。 queryByCode（详情，根据code查询单条记录，开放级别为Remote） updateByCode（提交更新单条记录，根据code更新单条记录，开放级别为Remote） deleteByCode（提交删除单条记录，根据code删除单条记录，开放级别为Remote）没有主键或唯一索引的模型，在UI层不会开放默认数据写管理器。 #### 使用场景图3-3-3-1 数据管理器使用场景数据构造器模型数据构造器 construct：供前端新开页面构造默认数据使用。所有模型都拥有construct构造器，默认会将字段上配置的默认值返回给前端，另外可以在子类中覆盖construct方法。数据构造器 construct函数的开放级别为API，函数类型为QUERY查询函数，系统将识别模型中的以construct命名的函数强制设置为API开放级别和QUERY查询类型。可以使用@Field的defaultValue属性配置字段的默认值。注意，枚举的默认值为枚举的name。

史, 昂
2024年5月23日
2.1K101