3.5.4 Ux注解详解

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

我们默认视图已经基本可以用了，但实际业务中还是会有一些不大不小的自定义需求，写自定义视图又太麻烦，今天我们来学习一种更加轻量的模式即：后端研发可以通过注解来配置视觉交互。该系列注解以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天从入门到精通

史, 昂数式管理员

0 0

3.5.5 设计器的结合（改）

上一篇 2024年5月23日 am9:22

3.5.3 Action的类型

下一篇 2024年5月23日 am9:24

Oinone 7天入门到精通

4.4 Oinone的分布式体验进阶

在分布式开发中，每个人基本只负责自己相关的模块开发。所以每个研发就都需要一个环境，比如一般公司会有（N个）项目环境、1个日常环境、1个预发环境、1个线上环境。在整项目环境的时候就特别麻烦，oinone的好处是在于每个研发可以通过boot工程把需要涉及的模块都启动在一个jvm中进行开发，并不依赖任何环境，在项目开发中，特别方便。但当公司系统膨胀到一定规模，大到很多人都不知道有哪些模块，或者公司出于安全策略考虑，或者因为启动速度的原因（毕竟模块多了启动的速度也会降下来）。本文就给大家介绍oinone与经典分布式组织模式的兼容性一、模块启动的最小集我们来改造SecondModule模块，让该模块的用户权限相关都远程走DemoModule Step1 修改SecondModule的启动工程application-dev.yml文件除了base、second_core两个模块保留，其他模块都去除了。 pamirs: boot: init: true sync: true modules: – base – second_core 图4-4-1 SecondModule的application-dev.yml仅配置两个模块 Step2 去除boot工程的依赖去除SecondModule启动工程的pom依赖 <!– <dependency> <groupId>pro.shushi.pamirs.core</groupId> <artifactId>pamirs-resource-core</artifactId> </dependency> <dependency> <groupId>pro.shushi.pamirs.core</groupId> <artifactId>pamirs-user-core</artifactId> </dependency> <dependency> <groupId>pro.shushi.pamirs.core</groupId> <artifactId>pamirs-auth-core</artifactId> </dependency> <dependency> <groupId>pro.shushi.pamirs.core</groupId> <artifactId>pamirs-message-core</artifactId> </dependency> <dependency> <groupId>pro.shushi.pamirs.core</groupId> <artifactId>pamirs-international</artifactId> </dependency> <dependency> <groupId>pro.shushi.pamirs.core</groupId> <artifactId>pamirs-business-core</artifactId> </dependency> <dependency> <groupId>pro.shushi.pamirs.core</groupId> <artifactId>pamirs-apps-core</artifactId> </dependency> –> 图4-4-2 去除boot工程多余的依赖 Step3 重启SecondModule 这【远程模型】和【远程代理】均能访问正常图4-4-3 远程模型和远程代理菜单均能访问正常 Step4 SecondModule增加对模块依赖我们让SecondModule增加用户和权限模块的依赖，期待效果是：SecondModule会对用户和权限的访问都会走Dome应用，因为Demo模块的启动工程中包含了user、auth模块。修改pamirs-second-api的pom文件增加对user和auth的api包依赖 <dependency> <groupId>pro.shushi.pamirs.core</groupId> <artifactId>pamirs-user-api</artifactId> </dependency> <dependency> <groupId>pro.shushi.pamirs.core</groupId> <artifactId>pamirs-auth-api</artifactId> </dependency> 图4-4-4 修改pamirs-second-api的pom文件修改SecondModule类，增加依赖定义 @Module( dependencies = {ModuleConstants.MODULE_BASE, AuthModule.MODULE_MODULE, UserModule.MODULE_MODULE} ) 图4-4-5 配置SecondModule的依赖 Step5 修改RemoteTestModel模型为RemoteTestModel模型增加user字段 @Field.many2one @Field(displayName = "用户") private PamirsUser user; 图4-4-6 为RemoteTestModel模型增加user字段 Step6 重启系统看效果 mvn install pamirs-second工程，因为需要让pamirs-demo工程能依赖到最新的pamirs-second-api包重启pamirs-second和pamirs-demo 两个页面都正常图4-4-7 示例效果一图4-4-8 示例效果二二、PmetaOnline的NEVER指令（开发时环境共享）我们在4.1.2【模块之启动指令】一文中介绍过 “-PmetaOnline指令”，该参数用于设置元数据在线的方式，如果不使用该参数，则profile属性的默认值请参考服务启动可选项。-PmetaOnline参数可选项为： NEVER – 不持久化元数据，会将pamirs.boot.options中的updateModule、reloadMeta和updateMeta属性设置为false MODULE – 只注册模块信息，会将pamirs.boot.options中的updateModule属性设置为true，reloadMeta和updateMeta属性设置为false ALL – 注册持久化所有元数据，会将pamirs.boot.options中的updateModule、reloadMeta和updateMeta属性设置为true oinone的默认模式下元数据都是注册持久化到DB的，但当我们在分布式场景下新开发模块或者对已有模块进行本地化开发时，做为开发阶段我们肯定是希望复用原有环境，但不对原有环境照成影响。那么-PmetaOnline就很有意义。让我们还没有经过开发自测的代码产生的元数据仅限于开发本地环境，而不是直接影响整个大的项目环境 PmetaOnline指令设置为NEVER（举例） Step1 为DemoCore新增一个DevModel模型 package pro.shushi.pamirs.demo.api.model; import pro.shushi.pamirs.meta.annotation.Field; import pro.shushi.pamirs.meta.annotation.Model; @Model.model(DevModel.MODEL_MODEL) @Model(displayName = "开发阶段模型",summary="开发阶段模型，当PmetaOnline指令设置为NEVER时，本地正常启动但元数据不落库",labelFields={"name"}) public class DevModel extends AbstractDemoCodeModel{ public static final String MODEL_MODEL="demo.DevModel"; @Field(displayName = "名称") private String name; } 图4-4-9 为DemoCore新增一个DevModel模型 Step2 为DevModel模型配置菜单 @UxMenu("开发模型")@UxRoute(DevModel.MODEL_MODEL) class DevModelProxyMenu{} 图4-4-10 为DevModel模型配置菜单 Step3 启动Demo应用时指定-PmetaOnline 图4-4-11 启动Demo应用时指定-PmetaOnline Step4 重启系统看效果查看元数据图4-4-12 DB查看元数据变化菜单与页面能正常操作图4-4-13 开发模型菜单可正常操作图4-4-14 开发模型详情页面可正常操作 Step5 Never模式需注意的事项业务库需设定为本地开发库，这样才不会影响公共环境，因为对库表结构的修改还是会正常进行的如果不小心影响了公共环境，需要对公共环境进行重启恢复系统新产生的元数据（如：例子中的【开发模式】菜单）不受权限管控三、分布式开发约定设计约定跨模块的存储模型间继承，在部署时需要跟依赖模块配置相同数据源。这个涉及模块规划问题，比如业务上的user扩展模块，需要跟user模块一起部署。…

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

自定义组件

1. 定义组件介绍平台提供了大多数的通用组件，面对企业个性话需求、复杂的业务场景，我们也提供了自定义组件的能力，帮助企业更快实施业务需求。自定义组件包含“组件画廊”“组件排序”“元件画廊”“元件属性设计”四个页面。 1.1 组件与元件在介绍如何自定义组件前，需要先了解以下概念：组件：页面设计的组件库中看到的是组件。每个组件都有自己的属性面板，通过属性、字段决定组件逻辑，而自定义组件就是需要构建出组件自身的属性信息，再结合业务配置组件的属性、使用组件。一个组件在不同的业务类型、视图类型、单值/多值，其属性面板是不同的，不同业务类型、视图类型、单值/多值的组合我们成为元件，多种组合即为多个元件，所以一个组件包括多个元件。元件：一个组件可以对应多个元件。在创建时明确元件所适用的字段业务类型、单/多值、视图类型，在画布中切换元件时，会结合当前组件的字段业务类型、单/多值、所在视图类型确定可以使用哪一个元件。此处切换的也是元件。示例：创建一个“下拉选”的组件，其中可以包含“下拉单选”“下拉多选”两个元件。“下拉选”组件从组件库中拖入时，设置单值时使用“下拉单选”元件，设置多值时使用“下拉多选”元件。 2. 组件管理 2.1 组件创建在组件画廊页面，点击添加组件，在弹窗中完善信息创建组件。 2.2 组件操作自定义组件支持“搜索、删除、作废、查看引用关系、管理元件、编辑、低无一体、排序”的操作。搜索：默认搜索可见组件，可切换“全部、可用、废弃”搜索组件，也可使用组件名称搜索。删除：若组件未被引用，则可以直接删除。作废：组件作废后，不可在画布中展示，不可在组件切换时使用，但已使用的数据不影响。查看引用关系：可以查看存在引用关系的页面，支持点击跳转到对应页面的设计页面。仅当组件无引用关系时才支持删除。管理元件：点击进入元件的管理页面。编辑：可修改组件名称、组件图表、组件描述。低无一体：比较复杂，在第5章中单独讲解。排序：进入排序页，可拖动排序自定义组件。自定义组件会插在系统组件之后。可以点击“查看排序结果”选项页查看最终排序结果。排序同样会更新画布中的组件库顺序。 3. 元件管理 3.1 元件创建在元件画廊页面，点击添加元件，在弹窗中完善信息创建一个元件。 3.2 元件操作元件支持“删除、作废、查看引用关系、编辑、设计元件属性”的操作。删除：若元件未被引用，则可以直接删除。作废：元件作废后，不影响原来已使用的元件，无法新添加、使用该元件。查看引用关系：可以查看存在引用关系的页面，支持点击跳转到对应页面的设计页面。仅当元件无引用关系时才支持删除。此处的引用关系数量会小于等于组件引用关系的数量。编辑：可修改元件名称、支持视图类型、元件描述。设计元件属性：比较复杂，将在第4章中单独讲解。 4. 设计元件属性元件属性设计页面主要操作集中在这三部分，分别是①视图切换②属性面板设计区③复制功能视图切换：元件创建时选择的支持视图类型，在①区域平铺可切换对应视图的属性面板进行设计。属性面板设计区：可将组件拖入属性面板设计区进行设计，设计的是自定义组件的属性面板，左侧组件库和页面设计的组件库相同，仍然支持创建字段或使用模型字段，右侧进行元数据面板、属性面板设置。复制功能：可将已设置好的属性面板复制到其他视图，提高设计效率。 5. 低无一体低无一体简单讲就是组件代码上传，通过载入代码使组件在设计页面和实现页面可见和交互。系统内置的属性不满足需求时，要用低无一体写代码，定制属性，比如从模型中拖拽设计就是内置的属性，从组件库中设置，就要配合低无一体，否则无效。首次进入组件设计或组件中的元件变更时需要生成SDK。生成结束后展示SDK生成时间，并且“下载模版工程”按钮可用。点击下载模版工程，会自动下载模板工程。在模版工程中编写前端代码。根据实际需求上传JS、CSS文件后提交即可。

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

数据编码

1. 什么是数据编码当模型中的字段数据需要有一定的编码规定，可以在模型中设计模型或字段的数据编码。编码预览：实时展示规则设置后的编码。 2. 编码前/后缀编码前缀：必须以字母开头，且仅支持数字或字母，最多8个字符。编码后缀：必须以字母开头，且仅支持数字或字母，最多8个字符。 3. 格式化日期开关默认关闭，即数据编码中不包含日期。开关打开后，默认的日期格式为“年年年年月月日日”，也可以切换成“年年月月日日、年年月月、年年年年、年年”。序列归零周期：与格式化日期选择有关，若选择为“年年年年月月日日”，则可选“年、月、日”，选择为“年年年年”，则只可选“年”数据编码序列会按照设置的这个周期归零。 4. 编码序列编码方式：可选择连续序列或非连续序列，选择会影响后续包含哪些设置。序列长度：序列包含多少位数字，可以设置1 – 18之间的整数。序列起始值：数据编码序列的起始值，默认值为3。当编码方式设置为非连续序列时，展示其余两个配置项。步长类型：默认值为“自定义步长”，也可以设置成“1 – 10之间随机步长”。步长：当选择“自定义步长”时，设置的步长即为真实步长。当选择“1 – 10之间随机步长”时，实际步长为1 – 设置值之间的随机整数。

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

数据字典

1. 什么是数据字典数据字典是一些固定字典项的集合，可作为多选或单选的选项，例如人员性别、员工属相、杭州市下属的行政区等都是数据字典。选择一个应用/模块下的一个小模块，可以查看其中包含的自定义字典（自建的数据字典）和系统字典。可以通过导入或添加创建自定义字典。 2. 数据字典基本操作删除：系统字典不支持删除，无法批量删除自定义数据字典，若数据字典已经被字段、页面等引用时，也无法删除这个数据字典。隐藏/可见：自定义字典、系统字典都可以操作隐藏和可见，隐藏和可见不影响数据字典在字段、页面等处的使用。查看引用关系：点击查看引用关系，展开弹窗，展示该数据字典和字段、视图的引用关系。修改：若数据字典已经被引用，无法删除其中的字典项。若无引用关系则可以任意修改。 3. 数据字典导入点击“导入数据字典”按钮，弹出窗口，可根据图中引导进行数据字典的导入。在经典模式下，导入数据字典会新建数据字典。在专家模式下，数据字典导入的模板中包含字段“字典编码”，若导入的字典编码不存在则会新建数据字典，若导入的字典编码已存在则会修改字典编码的设置，新建和修改的动作会校验是否符合规范。 4. 数据字典创建 4.1 专家模式（低代码模式）字典项类型有“二进制、文本、整数”三种可选，选择二进制时，字典项值需要选择存储在数据库二进制中的第几位。系统根据字典项值去查找字典项名称，因此字典项值不可重复。数据字典的api名称、代码名称、描述可不填，部分系统会赋默认值。字典项中字典项名称和字典项值必填，api名称和字典项描述不填系统会赋默认值。 4.2 经典模式（无代码模式）经典模式下只需要填写字典名称，添加字典项即可。系统会自动将字典项类型设置为“二进制”，并将字典项按照创建的先后顺序设置字典项值的位数。字典项类型、字典项值释义可参照专家模式的解释。

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

3.5.7.7 自定义主题

主题是什么 Oinone框架提供了强大的主题定制功能，使得平台可以轻松适应和遵循公司的品牌和UI规范。通过自定义主题，你可以调整颜色、间距、圆角等视觉元素，从而使Oinone更好地融入到特定行业的需求和公司标准中。以下是关于如何定制主题的关键点和步骤：关键点使用CSS变量： Oinone使用CSS变量 (Css Var) 来实现主题定制。 CSS变量提供了一种高效且灵活的方式来定义和使用样式。全面定制：可以定制的范围广泛，包括颜色、字体、间距、边框、圆角等。通过调整这些元素，可以确保UI符合公司的视觉标准。定制步骤了解CSS变量：首先，了解如何在CSS中使用变量。查看Oinone现有的CSS变量列表，以了解哪些样式可以被定制。定义公司的UI规范：根据公司的品牌指南，定义一套UI规范。包括颜色方案、字体样式、元素尺寸等。应用自定义样式：在Oinone的样式表中，使用定义的CSS变量来覆盖默认样式。确保在适当的地方应用这些自定义样式。作用场景 Oinone平台提供了灵活的主题定制选项，包括内置的六套主题样式，涵盖深色和浅色模式以及不同的尺寸选项（大、中、小）。这些主题可以适应不同的业务需求和项目特性，同时提供了定制工具，方便用户根据公司的UI规范进行调整。下面是主题作用场景的详细说明：主题选项内置主题：六套主题：包括深色和浅色模式，以及大、中、小尺寸。用户可以通过系统设置功能轻松切换不同的主题。可定制性：提供CSS变量的JSON文件，方便用户下载和修改。允许用户根据具体需求定制颜色、字体、间距等样式变量。应用场景公司UI规范对齐：首先根据公司的UI规范调整一份基础主题。这有助于确保平台的外观与公司品牌一致。项目和业务适应性：在不同项目或业务场景中，可以基于公司UI规范进行微调。这提供了项目特定的灵活性，同时保持整体的品牌一致性。实施建议初始设置：初始时，选择一个接近公司标准的内置主题作为起点。通过系统设置功能体验不同的主题效果。定制和微调：下载并修改CSS变量的JSON文件，以符合公司的UI标准。对于特定项目或业务场景，根据需要进行进一步的微调。自定义主题自定义主题功能允许在Oinone平台上创建和应用独特的视觉风格，以适应特定的业务需求和品牌标准。以下是自定义主题的步骤和示例，用于指导如何在Oinone平台上实现这一功能。示例工程目录以下是需关注的工程目录示例，main.ts更新导入./theme：图3-5-7-24 自定义主题目录示例步骤 1: 创建主题定义主题变量：创建一个包含主题样式变量的JavaScript文件。例如，可以定义一个名为OinoneTheme的新主题，并设置相应的CSS变量。图3-5-7-24 自定义主题代码示例注册主题：使用registerTheme函数注册自定义主题。这个函数将新主题添加到可用主题列表中。步骤 2: 应用主题在主入口文件中引用：在main.ts文件中引入自定义主题，并在VueOioProvider配置中指定。图3-5-7-24 自定义主题应用配置示例效果图3-5-7-24 自定义黑色主题效果示例主题叠加： Oinone支持多个主题变量同时存在，后导入的主题变量会覆盖前面导入的。内置主题 Oinone平台内置了以下六个主题变量，你可以在自定义主题时参考或扩展它们： ‘default – large’ ‘default – medium’ ‘default – small’ ‘dark – large’ ‘dark – medium’ ‘dark – small’ 扩展变量在定义主题变量时，根据业务需求可以添加不存在的变量，作为变量的扩展。示例 { "custom-color": "#新的辅助颜色", "button-padding": "10px 20px", // …其他自定义变量 } 图3 – 5 – 7 – 24 扩展主题变量查找主题变量在Oinone平台上，通过DOM调试器查找主题变量是一种有效的方式，允许用户定位并获取相应组件的主题变量。以下是执行这一步骤的详细说明：步骤：使用DOM调试器：在浏览器中打开Oinone平台，进入需要查找主题变量的页面。使用浏览器的开发者工具或DOM调试器（通常可通过右键点击页面元素并选择“检查”打开）。选择目标组件：在DOM调试器中，通过选择器工具或直接点击页面上的组件，选中你想要查找主题变量的目标组件。查看样式和主题变量：在选中的组件上，浏览开发者工具中的“样式”或“计算”选项卡。可以通过查看样式表中的相关样式规则，找到组件所使用的主题变量。 4标识主题变量：主题变量通常以 –oio 为前缀。标识出你感兴趣的主题变量，记录下变量名和当前的取值。示例：假设你想查找某个按钮组件的主题变量，可以通过以下步骤：在DOM调试器中选中按钮组件。在“样式”或“计算”选项卡中查看相关样式规则。找到以 –oio 为前缀的主题变量，如 –oio-button-pirmary-background。记录该主题变量的取值，例如 #3498db。图3-5-7-24 DOM调试器查询主题变量

史, 昂
2024年5月23日
1.1K000