3.1 环境搭建

相关推荐

• Oinone 7天入门到精通

  3.3.1 构建第一个Model

  定义模型，并配上相应的菜单或配置模块的homepage为该模型，模块就具备了可访问的该模型对应的列表页、新增页、修改页、删除记录和导入导出功能。 都说oinone是以model为驱动，对于模型的理解，希望通过本节跟给大家带来一个初步的认识。 一、构建宠物店铺模型 package pro.shushi.pamirs.demo.api.model; import pro.shushi.pamirs.meta.annotation.Field; import pro.shushi.pamirs.meta.annotation.Model; import pro.shushi.pamirs.meta.base.IdModel; import java.sql.Time; @Model.model(PetShop.MODEL_MODEL) @Model(displayName = "宠物店铺",summary="宠物店铺") public class PetShop extends IdModel { public static final String MODEL_MODEL="demo.PetShop"; @Field(displayName = "店铺名称",required = true) private String shopName; @Field(displayName = "开店时间",required = true) private Time openTime; @Field(displayName = "闭店时间",required = true) private Time closeTime; } 图3-3-1-1 构建宠物店铺模型 配置注解 模型类必需使用@Model注解来标识当前类为模型类。 可以使用@Model.model、@Fun注解模型的模型编码（也表示命名空间），先取@Model.model注解值，若为空则取@Fun注解值，若皆为空则取全限定类名。 使用@Model.model注解配置模型编码，模型编码唯一标识一个模型。 请勿使用Query和Mutation作为模型编码和技术名称的结尾。 上方示例使用Model注解和Field注解来定义一个实体模型。displayName属性最终会作为label展现在前端界面上。 更多Model的详细元数据描述介绍参见4.1.6【模型元数据详解】一文 模型命名规范 模型属性 默认取值规范 命名规则规范 name 默认取model.model的点分割最后一位 1仅支持数字、字母2必须以字母开头3长度必须小于等于128个字符 module 无默认值开发人员定义规范示例：{项目名称}_{模块功能示意名称} 1仅支持数字、大写或小写字母、下划线2必须以字母开头3不能以下划线结尾4长度必须小于等于128个字符 model 默认使用全类名，取lname的值开发人员定义规范示例：{项目名称}.{模块功能示意名称}.{简单类名} 1仅支持数字、字母、点2必须以字母开头3不能以点结尾4长度必须小于等于128个字符 display_name 空字符串 1长度必须小于等于128个字符 lname 符合java命名规范，真实的java全类名，无法指定，要符合model的约束，即为包名+类名 lname是不能定义的，为全类名：包名+类名，和model一样的校验规则：包名和类名的校验 summary 默认使用displayName属性 1不能使用分号2长度必须小于等于128个字符 descripition NULL，注解无法定义 1长度必须小于等于65535个字符 table 默认使用name字段生成表名时，table字段的命名规则约束同样生效（大小驼峰命名转为下划线分割的表名称） 1仅支持数字、字母、下划线2长度必须小于等于128个字符（此限制为系统存储约束，与数据库本身无关） type java属性类型与数据库存储类型可执行转换即可 ModelTypeEnum枚举值 表3-3-1-1 模型命名规范 字段命名规范 字段属性 默认取值规范 命名规则规范 name 默认使用java属性名 1仅支持数字、字母2必须以小写字母开头3长度必须小于等于128个字符 field 默认使用java属性名 与name使用相同命名规则约束 display_name 默认使用name属性 1长度必须小于等于128个字符 lname 使用java属性名，符合java命名规范，真实的属性名称，无法指定 与name使用相同命名规则约束 column 列名为属性名的小驼峰转下划线格式 1仅支持数字、字母、下划线2长度必须小于等于128个字符（此限制为系统存储约束，与数据库本身无关） summary 默认使用displayName属性 1不能使用分号2长度必须小于等于500个字符 表3-3-1-2 字段命名规范 我们重启Demo应用以后，打开Insomnia刷新GraphQL的schema，就可以看到PetShop默认对应的读写服务了 图3-3-1-2 PetShopQuery默认读写服务 图3-3-1-3 PetShopMutatiom默认读写服务 配置模块的主页为宠物商店的列表页 为了方便大家对模型有个更加直观的了解，接下来我们通过前端交互来感受下。 在3.2.2【启动前端工程】一文中，在模块下拉列表中“oinoneDemo工程”还是不能点击的。是因为该模块没有配置主页，我们现在把主页设置为宠物商店的列表页，只需要在DemoModule这个类上增加一个注解@UxHomepage(@UxRoute(PetShop.MODEL_MODEL))，关于该注解的更多说明请查看4.1.4一文中的【UxHomepage注解详解】部分 package pro.shushi.pamirs.demo.api; import org.springframework.stereotype.Component; import pro.shushi.pamirs.boot.base.ux.annotation.action.UxRoute; import pro.shushi.pamirs.boot.base.ux.annotation.navigator.UxHomepage; import pro.shushi.pamirs.demo.api.model.PetShop; import pro.shushi.pamirs.meta.annotation.Module; import pro.shushi.pamirs.meta.base.PamirsModule; import pro.shushi.pamirs.meta.common.constants.ModuleConstants; @Component @Module( name = DemoModule.MODULE_NAME, displayName = "oinoneDemo工程", version = "1.0.0", dependencies = {ModuleConstants.MODULE_BASE} ) @Module.module(DemoModule.MODULE_MODULE) @Module.Advanced(selfBuilt = true, application = true) @UxHomepage(@UxRoute(PetShop.MODEL_MODEL)) public class DemoModule implements PamirsModule { public static final String MODULE_MODULE = "demo_core"; public…

  史, 昂

  2024年5月23日

  2.1K001
• Oinone 7天入门到精通

  2.1 数字化时代软件业的另一个本质变化

  随着企业从信息化向数字化转变，软件公司提供的产品也由传统的企业管理软件向企业商业支撑软件发展。这一变化带来了许多技术上的挑战和机遇。在之前的章节中，我们提到企业的视角已经从内部管理转向业务在线和生态在线协同，这也带来了一系列新的需求。但是，我们常常会忽视这一变化所带来的对系统要求的变化。在本章中，我们将探讨这些技术上的变化，以及这些变化所带来的机遇和挑战。 图2-1 从信息化到数字化软件本质变化 在信息化时代，企业的业务围绕着内部管理效率展开，借鉴国外优秀的管理经验，企业将其管理流程固化下来，典型的例子是ERP项目。这类项目上线后往往长期稳定，不轻易更改，因此信息化时代软件的技术流派侧重于通过模型对业务进行全面支持。例如，SAP具有丰富的配置能力，将已有企业管理思想抽象到极致。其功能基本上可以通过配置来实现，因此其模型设计特别复杂。但是，我们也应该清楚地了解到，配置是面向已知问题的。在数字化时代，创新和业务迭代速度非常快，这种方法可能就不太适合了。我们知道，模型抽象是在设计时具有前瞻性的，一旦不适合，修改起来就会异常困难。 随着数字化时代的到来，企业主的关注点已经从单一企业内部管理转变为了围绕企业上下游价值链的协同展开。这种变化给企业信息化系统提出了更高的要求，例如业务需求的响应速度、系统性能和用户体验等方面。现在，企业对软件不仅是管理需求的承载，更是业务在线化的承载。传统的重模型设计软件模式已经不再适用，因为业务本身不断创新和变化。因此，数字化时代需要新的软件技术流派，这种流派必须是轻模型加上低代码技术的结合体。通过模型抽象80%的通用场景，剩余的20%个性化需求可以通过技术手段来完成。这样的设计可以让每家企业的研发人员轻松理解模型，而不像ERP模型那样异常复杂，无法进行修改。此外，配合低代码技术可以快速研发和上线。如果说配置化是面向已知问题的，那么低代码就是面向未知问题设计的。虽然低代码的概念可以追溯到上个世纪80年代，当时是为了满足企业内部部门之间有协同需求，但又没有专业软件支撑，定制化开发又不划算的辅助场景。但现在它的核心原因是企业数字化的核心场景不稳定，变化很快，每家企业都有强烈的个性化需求。因此，低代码成为解决这些问题的核心手段，数字化时代的低代码需要具备处理复杂场景的能力，而不仅仅是围绕着内部管理展开。 企业在数字化转型的过程中需要考虑到不仅是成熟的全链路业务解决方案，还要应对数字化场景的快速变化和持续创新的需求。为此，Oinone打造了一站式低代码商业支撑平台，从业务与技术两个维度来帮助企业建立开放、链接、安全的数字化平台。这将在水平和垂直两个维度上全面推动企业数字化转型。 另外，低代码的另一个好处是完成了软件本身的数字化建设。通过基于元数据设计，元数据成为软件中数据、逻辑和交互的数据，软件结合AI可以有更多的创造可能。想象一下，AI了解软件的元数据后可以自我运作，人在极少情况下才需要参与，人机交互也会发生大的改变。未来的软件交互不再需要研发提前预设，而是能够实现用户所需即所呈现的效果。作为一家帮助企业进行数字化转型的软件公司，请问您的数字化转型是否已经完成呢？

  史, 昂

  2024年5月23日

  1.7K000
• Oinone 7天入门到精通

  数据大屏

  1. 业务场景 数据大屏是利用相应的系统来分析数据，通过图形的形式为企业提供客观、直接的数据分析结果，让业务人员和企业决策者直观面对数据背后的信息，实时监测企业数据，给予更直观的决策场景体验，助力企业数字化运营升级。 2. 操作流程 1）进入数据可视化，进入数据大屏tab，维护分组信息； 2）在二级分组名称后点击“+”【添加数据大屏】，对数据大屏进行设计； 3）创建完成后可以【编辑】数据大屏； 4）数据大屏完善后，可以点击【发布】数据大屏，则数据大屏此时可以被显示器引用播放； 5）如果数据大屏有更新，则可以点击【更新发布】； 6）如果数据大屏数据不再可以公开使用，则需要通过【隐藏】功能将数据大屏的引用权限收起，但不影响已被使用的数据大屏； 7）隐藏后可以【取消隐藏】，数据大屏恢复隐藏前的状态和功能，可以被引用 。 3. 操作流程图解 3.1 创建分组 1）操作流程：创建分组 2）操作路径：数据可视化-数据大屏-创建分组 3）点击搜索框后的「+」创建一级分组，输入一级分组名称后，点击一级分组后的「+」创建二级分组，输入二级分组名称后，此时分组创建完成，可以在二级分组下创建数据大屏 3.2 编辑分组名称 1）操作流程：选择分组-编辑分组名称 2）操作路径：数据可视化-数据大屏-编辑分组名称 3）鼠标移动至需要修改的分组上，点击出现的「编辑图标」，可以修改分组名称，修改后分组名称实时更新 3.3 删除分组 1）操作流程：选择分组-删除分组 2）操作路径：数据可视化-数据大屏-删除分组 3）鼠标移动至需要删除的分组上，当分组下无报表时出现「删除图标」，可以点击图标后删除分组，删除一级分组时对应所有的二级分组也会被删除，删除后消失，只有分组下没有数据大屏的分组才能直接删除成功 3.4 创建数据大屏 1）操作流程：选择二级分组-创建数据大屏 2）操作路径：数据可视化-数据大屏-二级分组-创建数据大屏 3）鼠标移动至需要创建数据大屏的二级分组上，出现「+」，点击图标后=需要填写数据大屏标题 a数据大屏标题：最大支持20个字，支持汉字、数字、大小写字母、-；同个一级分组下不允许重复； 4）输入标题后进入设计页面 3.5 编辑数据大屏 1）操作流程：选择数据大屏-编辑数据大屏 2）操作路径：数据可视化-数据大屏-二级分组-数据大屏-编辑数据大屏 3）只能编辑未发布或者已发布但没有被隐藏的数据大屏，且存在三种编辑情况 a. 第一种：点击数据大屏标题后的编辑图标，仅能编辑数据大屏标题； b. 第二种：点击数据大屏中的数据大屏标题、备注后的编辑图标，可以直接编辑数据大屏标题； c. 第三种：点击【编辑】按钮，进入数据大屏设计页面，带出已有的组件内容，编辑时的规则与创建时一致，编辑后可以点击保存进行更新，如果未保存直接返回，则编辑无效； 4）编辑后实时生效，数据大屏信息保持展示最新效果 3.6 删除数据大屏 1）操作流程：选择数据大屏-删除数据大屏 2）操作路径：数据可视化-数据大屏-二级分组-数据大屏-删除数据大屏 3）未发布或者已发布但没有被隐藏的数据大屏，并且没被引用，才展示数据大屏菜单名称后的删除图标 4）删除后数据大屏消失 3.7 复制 1）操作流程：选择数据大屏-复制数据大屏 2）操作路径：数据可视化-数据大屏-二级分组-数据大屏-复制数据大屏 3）点击【复制】按钮，复制成功，名称为copy of 原数据大屏标题，展示在原数据大屏分组的最后一个 3.8 发布 1）操作流程：选择数据大屏-发布数据大屏 2）操作路径：数据可视化-数据大屏-二级分组-数据大屏-发布 3）选择单个未发布且没有被隐藏的数据大屏，点击【发布】按钮，数据大屏状态变为已发布，展示最近发布时间； 4）如果数据大屏发布后有更新内容，会展示的更新类型：更新数据大屏信息/更新数据大屏内容 3.9 查看最近一次发布的版本 1）操作流程：选择数据大屏-查看最近一次发布的版本 2）操作路径：数据可视化-数据大屏-二级分组-数据大屏-更新发布数据大屏 3）当数据大屏发布后有更新，在最近发布时间左侧展示【查看】，在最近发布时间下展示更新的类型，点击查看可以查看最近发布的版本 3.10 更新发布 1）操作流程：选择数据大屏-更新发布数据大屏 2）操作路径：数据可视化-数据大屏-二级分组-数据大屏-更新发布数据大屏 3）选择单个已发布且没有被隐藏的数据大屏，并且该数据大屏在上次发布后有所更新，可以点击【更新发布】按钮，将最新的数据大屏内容发布至业务系统，业务系统引用的数据大屏为最新内容； 4）如果更新了内容，但未点击更新发布，则展示的仍是上次发布的数据大屏 3.11 隐藏 1）操作流程：选择数据大屏-隐藏数据大屏 2）操作路径：数据可视化-数据大屏-二级分组-数据大屏-隐藏数据大屏 3）数据大屏默认不隐藏，点击数据大屏左侧的是否隐藏可以切换 a. 未发布的数据大屏，较隐藏前，不可以操作【发布】，可以【取消隐藏】； b. 已发布的数据大屏，较隐藏前，只能操作【导出图片、导出excel、取消隐藏】； 4）隐藏后的数据大屏不可以被用于展示在其他大屏上，但不影响已经被引用的数据 3.12 取消隐藏 1）操作流程：选择数据大屏-取消隐藏数据大屏 2）操作路径：数据可视化-数据大屏-二级分组-数据大屏-取消隐藏数据大屏 3）隐藏后的数据大屏可以取消隐藏，切换是否隐藏=否，取消隐藏后，数据大屏恢复隐藏前的状态和功能，可以被引用 3.13 查看引用 1）流程：选择图表-查看被哪些报表/数据大屏/页面引用 2）操作路径：数据可视化-数据大屏-二级分组-数据大屏-更多-查看引用 3）选择具体的数据大屏，查看当前数据大屏被引用的所有信息 3.14 不允许别人编辑 1）流程：选择数据大屏-不允许别人编辑 2）操作路径：数据可视化-数据大屏-二级分组-数据大屏-更多-不允许别人编辑 3）选择自己创建的数据大屏，对数据大屏是否允许其他人编辑进行设置；如果设置为不允许，则其他人无法编辑数据大屏 3.15 不允许别人引用 1）流程：选择图表-更多-不允许别人引用 2）操作路径：数据可视化-数据大屏-二级分组-数据大屏-更多-不允许别人引用 3）选择自己创建的数据大屏，对数据大屏是否允许他人引用进行设置；如果设置为不允许，则其他人无法选择到 3.16 导出图片 1）操作流程：选择数据大屏-导出图片 2）操作路径：数据可视化-数据大屏-二级分组-数据大屏-导出图片 3）选择数据大屏后，点击【导出图片】按钮可以将当前数据大屏导出为图片 3.17 导出EXCEL 1）操作流程：选择数据大屏-导出EXCEL 2）操作路径：数据可视化-数据大屏-二级分组-数据大屏-数据大屏导出EXCEL 3）选择数据大屏后，点击【导出EXCEL】按钮可以将当前数据大屏包含的图表导出为EXCEL 4. 数据大屏设计页面 4.1 缩放自适应 1）流程：创建数据大屏-进入数据大屏设计页面 2）操作路径：数据可视化-数据大屏-创建/编辑-设计页面 3）进入页面后，默认按照当前屏幕展示最适合的数据大屏尺寸，可以通过+、-进行自定义缩放，每次缩放10% 4.2 全屏 1）流程：创建数据大屏-进入数据大屏设计页面 2）操作路径：数据可视化-数据大屏-创建/编辑-设计页面 3）进入页面后，设置完成，可以【全屏】查看效果，按esc退出全屏 4.3 保存 1) 流程：创建数据大屏-进入数据大屏设计页面 2) 操作路径：数据可视化-数据大屏-创建/编辑-设计页面 3) 进入页面后，设置完成后进行保存，数据大屏保持最新内容 4.4 添加、编辑、删除组件 1）流程：创建数据大屏-进入数据大屏设计页面 2）操作路径：数据可视化-数据大屏-创建/编辑-设计页面 3）可以添加图表、文本、通用标题、倒计时、时间器、图片、轮播图、视频、边框等组件；图表组件中，一个图表只能添加一次，其他组件不限制数量； 4）所有组件添加后均可进行设置样式，有编辑权限的图表组件可以通过【编辑】图标直接进入图表设计页面； 5）添加后均可删除，删除后组件不再展示在数据大屏画布中，可以重新添加 4.5 数据大屏设置 1）操作流程：创建数据大屏-进入数据大屏设计页面 2）操作路径：数据可视化-数据大屏-创建/编辑-设计页面 3）设置数据大屏时可以设置屏幕的宽高、背景颜色、背景图片、主题 a. 宽高：根据数据大屏需要投放的屏幕大小进行设置； b. 背景颜色：当数据大屏无图片背景时可以调整背景颜色； c. 背景图片：支持为数据大屏上传一张图片作为背景； d. 主题模版：可任选其一，需要先选定模版后再进行设计，不然设计完后再修改模版，会清空已选组件。 4.6 图表组件设置 1）操作流程：创建数据大屏-进入数据大屏设计页面 2）操作路径：数据可视化-数据大屏-创建/编辑-设计页面 3）拖入图表组件，可与边框合为一体，可以设置图表的显示内容、边框信息、动画效果、刷新频率 a. 图表显示内容：展示标题、副标题、描述、标签、图例，一屏展示条数，原图表有的内容在设置展示后展示在数据大屏，原图表没有的内容设置展示后不生效； b. 边框信息：包括边框样式、背景颜色、边框线条颜色、展示边框标题、边框标题内容、边框标题颜色、边框标题字体大小； c. 动画效果：可以设置自动轮播，为是时可以设置结束后停顿时长、速度、切换形式； d. 刷新频率：设置图表获取数据的频率，自动刷新、刷新频率。 4.7 文本组件设置 1）操作流程：创建数据大屏-进入数据大屏设计页面 2）操作路径：数据可视化-数据大屏-创建/编辑-设计页面 3）拖入文本组件后，可以输入多行文本，可以设置内容、对齐方式、字体大小、字体加粗、字体颜色、背景颜色、边框样式、文字滚动、结束后停顿、速度 4）当文字滚动开启时，文字会按照一行展示，通过设置结束后停顿和速度来控制文字滚动的效果 4.8 通用标题组件设置…

  史, 昂

  2024年6月20日

  1.9K000
• Oinone 7天入门到精通

  4.5.1 研发辅助之插件-结构性代码

  研发辅助意在 消灭研发过程中的重复性工作提升研发效率，如结构性代码 提供生产示例性代码，如果根据模型生成导入导出、view自定义配置等经常性开发 一、插件安装 根据自身Idea版本下载插件并安装： 版本 插件 2023.1 pamirs-source-maker-1.0.0-2023.1.zip(2.4 MB) 2021.1 pamirs-source-maker-1.0.0-2021.1.zip(2.4 MB) 2021.2 pamirs-source-maker-1.0.0-2021.2.zip(2.4 MB) 2021.3 pamirs-source-maker-1.0.0-2021.3.zip(2.4 MB) 2022.1 pamirs-source-maker-1.0.0-2022.1.zip(2.4 MB) pamirs-source-maker-1.0.0-223-EAP-SNAPSHOT(2.4 MB) 表4-5-1-1 插件列表 二、研发辅助之配置式结构性代码生成器 我们在开发过程中为了日后代码易于维护和修改，往往会做工程性的职责划分。 除去模型外会有 代理模型和代理模型Action来负责前端交互 以面向接口的形式来定义函数，就会有api和实现类之分 如果项目有多端，那么如代理模型和代理模型Action又要为每一个端构建一份 在大型项目的初始阶段，我们需要手工重复做很多事情，特别麻烦。现在用oinone的研发辅助插件的结构性代码生成器，就可以避免前面的重复工作 插件执行的配置文件 <?xml version="1.0" encoding="utf-8" ?> <oinone> <makers> <!– 根据模型生成代理类、代理类的Action、Service、ServiceImpl –> <maker> <!– 选择模型所在位置 –> <modelPath>/Users/oinone/Documents/oinone/demo/pamirs-second/pamirs-second-api/src/main/java/pro/shushi/pamirs/second/api/model</modelPath> <!– 代理模型、代理模型Action生成相关配置信息 –> <proxyModules> <module> <!– 代理模型和代理模型Action的生成位置信息 –> <generatePath>/Users/oinone/Documents/oinone/demo/pamirs-second/pamirs-second-api/src/main/java/pro/shushi/pamirs/second/api</generatePath> <!– 代理模型和代理模型Action的模块前缀 –> <modulePrefix>second</modulePrefix> <!– 代理模型和代理模型Action的模块名，代理模型和代理模型Action类名为moduleName+模型名+"Proxy"+"Action" –> <moduleName>second</moduleName> <!– 代理模型和代理模型Action的包名,实际包名为 packageName+".proxy"或packageName+".action"–> <packageName>pro.shushi.pamirs.second.api</packageName> </module> </proxyModules> <!– 根据模型生成api，包括service（写方法）和queryService（读方法） –> <apiModule> <!– service和queryService的生成位置信息 –> <generatePath>/Users/oinone/Documents/oinone/demo/pamirs-second/pamirs-second-api/src/main/java/pro/shushi/pamirs/second/api</generatePath> <!– service和queryService的模块前缀 –> <modulePrefix>second</modulePrefix> <!– service和queryService的模块名 –> <moduleName>second</moduleName> <!– service和queryService的包名,实际包名为 packageName+".service" –> <packageName>pro.shushi.pamirs.second.api</packageName> </apiModule> <!– 根据模型生成api实现类，包括serviceImpl（写方法）和queryServiceImpl（读方法） –> <coreModule> <!– serviceImpl和queryServiceImpl的生成位置信息 –> <generatePath>/Users/oinone/Documents/oinone/demo/pamirs-second/pamirs-second-core/src/main/java/pro/shushi/pamirs/second/core</generatePath> <!– serviceImpl和queryServiceImpl的模块前缀 –> <modulePrefix>second</modulePrefix> <!– serviceImpl和queryServiceImpl的模块名 –> <moduleName>second</moduleName> <!– serviceImpl和queryServiceImpl的包名,实际包名为 packageName+".service" –> <packageName>pro.shushi.pamirs.second.core</packageName> </coreModule> </maker> </makers> </oinone> 图4-5-1-1 插件执行的配置文件 三、研发辅助之多模型结构性代码生成器 是配置式结构性代码生成器的补充，应对开发后期维护中新增模型的场景。它的不同点在于只要选择模型文件就可以，不需要专门编写xml文件。生成的文件默认就在模型所在路径下 Step1 菜单栏上找到oinone，并点击子菜单【多模型结构性代码生成器】 图4-5-1-2 多模型结构性代码生成操作步骤一 Step2 设置必要的信息 模型前缀 模型的所属模块 代理模型的模块 这三个信息分别用于构建 代理模型的MODEL_MODEL = 模型前缀.代理模型的模块.代理模型类名 服务的FUN_NAMESPACE = 模型前缀.代理模型的模块.服务类名 图4-5-1-3 多模型结构性代码生成操作步骤二 Step3 选择为哪些模型生成对应的结构性代码 图4-5-1-4 多模型结构性代码生成操作步骤三 Step4 代码在模型所在目录 生成的文件默认就在模型所在路径下，您可以手动拖动到对应的包路径当中去 图4-5-1-5 多模型结构性代码生成操作步骤四

  史, 昂

  2024年5月23日

  1.5K000
• Oinone 7天入门到精通

  3.5.7.2 自定义母版

  母版是什么 在业务系统中，母版是一种全局通用的组件，用于包裹每个页面的元素。这个概念类似于 PPT 中的母版，它定义了页面的整体结构、样式和布局，使得系统具有一致的外观和风格。 特点： 全局通用：母版是全局性的，适用于系统中的每个页面，确保一致性的用户体验。 包裹元素：母版包裹每个页面的元素，定义了整体的结构和布局。 外观一致性：通过统一的母版设计，系统达到外观和风格的一致性。 与 PPT 母版的类比： 在母版的概念上，与 PPT 中的母版类似，都是用于定义整体结构和样式，确保每个页面都具有一致的外观。 默认母版范围: 图3-5-7-20 默认母版范围 作用场景 在系统中，我们提供了多个纬度的母版，包括全局、应用和页面纬度。这样的设计允许根据不同的业务场景选择合适的母版纬度，以满足不同层次的定制需求。 母版纬度： 全局母版： 覆盖系统中所有页面，确保全局的一致性和统一的用户体验。 定义全局性的结构、样式和布局。 应用母版： 适用于特定应用或模块，定制化程度介于全局和页面之间。 允许在不同应用间实现一定的差异化。 页面母版： 面向具体页面，提供最大的定制化空间。 允许在不同页面中定义不同的结构和样式。 选择纬度： 业务场景决定：根据具体的业务场景和需求选择合适的母版纬度。 定制化需求：如果需要全局一致性，选择全局母版；如果在应用层面有特定需求，选择应用母版；如果需要最大的灵活性和定制化，选择页面母版。 参数说明： 在系统中，使用 registerMask 注册母版时，需要提供两个参数。第一个参数是母版的 XML，第二个参数用于控制母版的注册行为，包括 module、moduleName、model 和 actionName。 母版 XML（第一个参数）： 提供母版的 XML 描述，定义了母版的结构和样式。 控制参数（第二个参数）： module：指定模块的名称。 moduleName：指定模块的显示名称。 model：指定母版所属的模型。 actionName：指定母版的操作名称，可以是字符串或字符串数组。 全局母版 可以使用 registerMask 注册母版。当第二个参数为 {} 时，即代表注册全局母版。 示例工程目录 以下是需关注的工程目录示例，并确保导入导出依赖正确： 图3-5-7-21 全局纬度注册母版工程目录示例 示例代码 以下是一个示例代码： import { registerMask } from '@kunlun/dependencies'; /** * mask: 在做系统时，我们通常会把外层的布局(菜单、顶部导航)等抽出公共组件，公共组件会抽离全局通用。类似ppt母版的概念即为Mask * registerMask 第二个入参为{}即注册了全局得母版 * * 和默认母版相比移除右上角消息、语言切换、用户 * `<block> * <widget widget="notification" /> * <widget widget="divider" /> * <widget widget="language" /> * <widget widget="divider" /> * <widget widget="user" /> * </block>` */ const registerGlobalMask = () => { registerMask(` <mask> <multi-tabs /> <header> <widget widget="app-switcher" /> </header> <container> <sidebar> <widget widget="nav-menu" height="100%" /> </sidebar> <content> <breadcrumb /> <block width="100%"> <widget width="100%" widget="main-view" /> </block> </content> </container> </mask>`, {}); } registerGlobalMask(); 图3-5-7-22 全局纬度注册母版代码示例 复制这段代码执行下registerGlobalMask()试试看吧 效果 右上角消息、语言切换、用户被移除。 图3-5-7-23 全局纬度注册母版效果示例 应用母版 在系统中，可以使用 registerMask 注册母版。当第二个参数为 {moduleName: ‘resource’} 时，即注册了 resource（资源）应用的母版。 示例工程目录 以下是需关注的工程目录示例，更新导出./moduleMask： 图3-5-7-24 应用纬度注册母版工程目录示例 示例代码 以下是一个示例代码： /** * registerMask 第二个入参为{moduleName: 'resource'}即注册了resource(资源)应用的母版 * * resource来源: 通常是浏览器url上的module * * 和默认模版相比拿掉了菜单 * `<sidebar> * <widget widget="nav-menu" height="100%"…

  史, 昂

  2024年5月23日

  1.9K000