3.5.4 Ux注解详解

史, 昂 • 2024年5月23日 am9:23 • Oinone 7天入门到精通 • 1874 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天入门到精通

2.3 Oinone独特性之源，元数据与设计原则

让我们来揭开Oinone元数据的神秘面纱，了解它的核心组成、获取方式、面向对象特性以及带来的好处。您或许会想，这些特性能否解决企业数字化转型中互联网架构遇到的挑战呢？元数据是本文多次提到的重要概念。作为LCDP的基础，元数据支持企业所有研发范式。它数字化描述了软件本身，包括数据、行为和视图等方面。在描述数据时，元数据本身就是数据的数据；在描述行为时，它就是行为的数据；在描述视图时，它就是视图的数据。只有深入理解元数据，才能全面了解Oinone的其他特性。本章节将介绍元数据的整体概览（如下图2-3所示），带领您了解其核心组成、面向对象特性以及组织方式。请注意，本章节将不会详细展开元数据的细节，这些细节将在后续的相关章程中深入介绍。图2-3 元数据整体视图一：以下是元数据的核心组成介绍：模块(Module)：它是将程序划分成若干个子功能，每个模块完成了一个子功能，再把这些模块总起来组成一个整体。它是按业务领域划分和管理的最小单元，是一组功能、界面的集合。模型（Model）：Oinone一切从模型出发，是数据及对行为的载体。它是对所需要描述的实体进行必要的简化，并用适当的变现形式或规则把它的主要特征描述出来所得到的系统模仿品。它包括元信息、字段、数据管理器和自定义函数。同时遵循面向对象设计原则，包括封装、继承和多态。交互组件（UI Componment）：它用菜单、视图和Action来勾绘出模块的前端交互拓扑，并且用组件化的方式统一管理、布局和视图。它用Action来描述所有可操作行为。函数（Function）：它是Oinone可执行逻辑单元，跟模型绑定则对应模型的方法。它描述满足数学领域函数定义，含有三个要素：定义域A、值域C{f（x），x属于A}和对应法则f。其中核心是对应法则f，它是函数关系的本质特征。它满足面向对象原则，可以设置不同开放级别，本地与远程智能切换。元数据注册表：它以模块为单位的安装记录，在模块安装时，相关的元数据都会在元数据注册表中记录。二：元数据的产生方式，既可以通过代码注解扫描获取，也可以通过可视化编辑器直接添加。从代码注解中扫描获取，示例如下代码（如下图2-4所示）。 @Model.model(ResourceBank.MODEL_MODEL) @Model(displayName = "银行",labelFields = "name") public class ResourceBank extends IdModel { public static final String MODEL_MODEL = "resource.ResourceBank"; @Field.String @Field(required = true, displayName = "名称") private String name; @Field.String @Field(required = true, displayName = "银行识别号码", summary = "Bank Identifier Code, BIC 或者 Swift") private String bicCode; …… } 图2-4 从代码注解中扫描获取元数据可视化的编辑器添加元数据，具体介绍详见7.1《Oinone的设计器》章节三：Oinone是一种通用低代码开发平台，其元数据设计满足应用开发所需的所有元素，并支持所有研发范式。它基于元数据的具体实现秉承以下原则：部署与研发无关；以模型驱动，符合面向对象设计原则；代码与数据相互融合，编辑器产生的元数据以面向对象的方式继承扩展标准产品的元数据。这些原则的集合使整个平台能够实现以下功能特性：开发分布式应用与单体应用一样简单，部署方式由后期决定。如果要部署为分布式应用，则需要在boot工程中引入Oinone的rpc包。详见4.3《Oinone的分布式体验》一章节；面向对象的特性使得每个需求都可以是独立模块，独立安装与卸载，让系统像乐高积木一样搭建；支持两种元数据产生方式，融合的原则确保标准产品迭代与个性化保持独立，真正做到低无一体。四：这些特性刚好也解决了2.2《互联网架构作为最佳实践为何失效》一章节中客户挑战的三个刺眼问题互联网架构落地企业数字化转型面临的问题 Oinone应对的策略不是说敏捷响应吗？为什么改个需求这么慢，不单时间更长，付出的成本也更高了？特性1、特性2、特性3 不是说能力中心吗？当引入新供应商或有新场景开发的时候，为什么前期做的能力中心不能支撑了？特性2、特性3 不是说性能好吗？为什么我投入的物理资源更多了？特性1 表2-2互联网架构落地企业数字化转型面临的问题及Oinone应对策略

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

组件属性

1. 通用属性介绍组件和其属性之前，先介绍一些大部分组件通用支持的一些基础属性。 1.2 标题标题是字段在当前页面的展示名称，标题默认为字段名称，可以修改。 1.2 占位提示在未填写内容时，输入框或选择框内的浅色提示文字，仅用于提示，不会影响字段的值。 1.3 描述说明一个字段的描述信息，通常用于说明当前字段的范围、注意事项等。描述说明大部分在组件的下方显示，特殊的是，分组的描述说明在标题的左侧。 1.4 默认值创建数据时，有些字段大概率都是相同值，可设置默认值，减少添加人员的操作步骤，提高录入数据效率。 1.5 只读设为只读时，字段可见，但不可编辑。除了只读和非只读的对立选项，也可以设置条件只读，在设置的条件下才只读，条件不符合则非只读。 1.6 禁用设为禁用时，字段可见，但不可编辑。除了禁用和非禁用的对立选项，也可以设置条件禁用，在设置的条件下才禁用，条件不符合则非禁用。 1.7 隐藏设为隐藏时，字段不可见，也不可编辑。但是在页面设计时，隐藏的组件也会展示，效果如下图。除了隐藏和非隐藏的对立选项，也可以设置条件隐藏，在设置的条件下才隐藏，条件不符合则非隐藏。 1.8 必填控制字段在当前页面是否必填，若设置为必填则在标题前会有红色的*作为标识。除了必填和非必填的对立选项，也可以设置条件必填，在设置的条件下才必填，条件不符合则非必填。 1.9 标题排列方式字段的标题可以自定义横向排列还是纵向排列。每个字段组件都支持设置，设置后之间互不影响。除了组件支持自定义，表单、分组、选项卡也可以设置排列方式，对于这种布局容器类组件，设置后会将其容器内的所有组件的标题排列方式都改为所设置的值。 1.10 宽度定义在页面中的宽度：占整行的比例，一般可选项有1/4、1/3、1/2、2/3、3/4、1。其中1/2表示占当前行的一半；1表示占当前行一整行；以此类推。部分组件特殊，如富文本仅支持宽度为1，即占一整行。 2. 分组分组是一个布局类组件，类似一个容器，可以把业务含义相近的内容放在这个分组容器内。 2.1 属性 2.1.1 标题分组可以定义一个标题名称，标题显示在分组左上角，可以不设置标题。 2.1.2 描述说明分组的描述说明显示在分组标题右侧。 2.1.3 标题排列方式分组中的标题排列方式属性并不是控制分组的标题，而是控制分组内组件的标题。设置后对分组内的所有组件生效。 3. 选项卡选项卡是一个布局类组件，类似一个容器，每个选项卡可以添加多个选项页，可以把业务含义相近的内容放在选项卡的选项页容器内。 3.1 选项卡属性 3.1.1 选项页排列方式选中选项卡，可选择选项卡中的选项页排列方式：水平排列、竖直排列。默认是水平排列，效果如下图。 3.1.2 标题排列方式选项卡中的标题排列方式控制选项卡内组件的标题。设置后对选项卡内的所有组件生效。 3.2 选项页属性 3.2.1 标题选中选项页，显示选项页的属性设置，选项卡中的每个选项页支持设置标题。 3.2.2 标题排列方式选项页中的标题排列方式控制选项页内组件的标题。设置后对选项页内的所有组件生效。同一个选项卡，不同选项页之间的标题排列方式可以不同。 4. 单行文本单行文本输入框，常用于记录名称、身份证号或其他普通的文字内容。 4.1 创建字段单行文本仅支持创建「文本」业务类型的字段，填写规则、内容和模型设计器端创建字段一致。 4.2 表单属性 4.2.1 通用属性在表单中，单行文本可以设置一些通用的属性：标题、占位提示、描述说明、默认值、只读、隐藏、禁用、必填、标题排列方式、宽度。 4.2.2 文本类型文本类型选项为文本或密码。若设置为文本，输入时内容是可见的；若设置为密码，输入时是不可见的密码形态，如下图： 4.2.3 最小/大长度设置输入框输入内容的长度，输入框会根据设置的值进行校验。最大长度默认为创建字段时填写的长度，且设置的最大长度不可以大于字段的长度最小长度默认为空，为空则为不限制最小长度 4.2.4 输入格式设置输入格式为网址或者身份证时，会进行格式的校验无：默认为无，不会校验内容网址：进行网址校验身份证：进行身份证号校验，设置后，需要输入正确的身份证号 4.2.5 显示计数器当需要用户关注输入内容长度时，可以开启显示计数器，在输入时会实时显示当前内容的长度。 4.2.6 显示清除按钮若开启了清除按钮，则在输入框有内容时，点击清除按钮一键清除已有内容 5. 多行文本多行文本输入框，常用于记录字数较多的文字，如意见、复杂备注等。 5.1 创建字段多行文本仅支持创建「多行文本」业务类型的字段，填写规则、内容和模型设计器端创建字段一致。 5.2 表单属性 5.2.1 通用属性在表单中，单行文本可以设置一些通用的属性：标题、占位提示、描述说明、默认值、只读、隐藏、禁用、必填、标题排列方式、宽度。 5.2.2 最小/大长度设置输入框输入内容的长度，输入框会根据设置的值进行校验。 -最大长度默认为创建字段时填写的长度，且设置的最大长度不可以大于字段的长度 -最小长度默认为空，为空则为不限制最小长度 5.2.3 显示计数器当需要用户关注输入内容长度时，可以开启显示计数器，在输入时会实时显示当前内容的长度。 5.2.5 显示清除按钮若开启了清除按钮，则在输入框有内容时，点击清除按钮一键清除已有内容 6. 整数整数输入框，常用于输入整数的天数、数量等，如果会出现小数，请使用小数组件。 6.1 创建字段整数仅支持创建「整数」业务类型的字段，填写规则、内容和模型设计器端创建字段一致。 6.2 表单属性 6.2.1 通用属性在表单中，整数可以设置一些通用的属性：标题、占位提示、描述说明、默认值、只读、隐藏、禁用、必填、标题排列方式、宽度。 6.2.2 最小/大值设置整数输入框输入内容的最值，输入框会根据设置的最值进行校验。最大值可设置的范围根据字段填写的长度转换，如设置长度为3，则最大值最大不可以超过999 截图 6.2.3 显示千分位数字过长时，不便于查看，可开启显示千分位。 7. 小数小数输入框，常用于输入金额、单价等，会出现小数的数值。 7.1 创建字段小数仅支持创建「浮点型」业务类型的字段，填写规则、内容和模型设计器端创建字段一致。 7.2 表单属性 7.2.1 通用属性在表单中，小数可以设置一些通用的属性：标题、占位提示、描述说明、默认值、只读、隐藏、禁用、必填、标题排列方式、宽度。 7.2.2 最小/大值设置小数输入框输入内容的最值，输入框会根据设置的最值进行校验。最大值可设置的范围根据字段填写的长度转换，如设置长度为3，则最大值最大不可以超过999 7.2.3 保留小数位数支持设置小数的保留位数，设置后在页面中输入内容时，将进行校验可设置的保留小数位数不可大于该字段的精度，如字段精度为2，则组件属性中的小数位数最大只能为2； 7.2.4 显示千分位数字过长时，不便于查看，可开启显示千分位。 8. 下拉单选从多个选项中下拉选择一个数据，作为数据值。选项可以是关联模型的数据，也可以是数据字典或布尔型开关。 8.1 创建字段下拉单选支持创建三种业务类型的字段，分别是：多对一、布尔型、数据字典。多对一：创建字段时需要选择关联的模型，关联模型的数据将作为下拉选项；布尔型：下拉选项默认只有是、否；数据字典：创建字段时需要选择数据字典，其数据字典项将作为下拉选项 8.2 表单属性 8.2.1 通用属性在表单中，下拉单选可以设置一些通用的属性：标题、占位提示、描述说明、只读、隐藏、禁用、必填、标题排列方式、宽度。 8.2.2 选项类型…

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

资源

翻译应用是管理翻译规则的应用，以模型为基础、维护字段的翻译值，支持导入、导出 1. 操作步骤 Step1：导出所有翻译项； Step2：线下翻译； Step3：导入翻译项； Step4：刷新远程资源； Step5：页面右上角可切换语言，查看翻译效果。 2. 新增翻译翻译是具体到模型字段，其中需要区分出是否字典；源语言、目标语言，是在资源中维护的语言，可在资源中维护需要翻译的语言；翻译项则是模型字段，默认翻译项为激活状态，关闭后维护的翻译项无效。 3. 导出、导入不勾选导出：导出所有需要翻译的翻译项，包括模块、字段，源术语、翻译值等，其中如果已经翻译过的内容，会体现在翻译值中；勾选导出：导出勾选模型的翻译项。导入：导入翻译项，平台会根据模型拆分为多条数据。 4. 刷新远程资源导入翻译项后，点击“刷新远程资源”按钮。 5. 查看翻译内容页面右上角切换语言，查看翻译效果。

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

第4章 Oinone的高级特性

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

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日
1.6K000