相关推荐

• 后端

  框架之MessageHub(信息提示)

  框架之信息概述 后端除了可以返回错误信息以外，还可以返回调试、告警、成功、信息等级别的信息给前端。但是默认情况下前端只提示错误信息，可以通过前端的统一配置放开提示级别，有点类似后端的日志级别。 框架之MessageHub 在oinone平台中，我们怎么做到友好的错误提示呢？接下来介绍我们的MessageHub，它为自定义错误提示提供无限的可能。 何时使用 错误提示是用户体验中特别重要的组成部分，大部分的错误体现在整页级别，字段级别，按钮级别。友好的错误提示应该是怎么样的呢？我们假设他是这样的 与用户操作精密契合 当字段输入异常时，错误展示在错误框底部 按钮触发服务时异常，错误展示在按钮底部 区分不同的类型 错误 成功 警告 提示 调试 简洁易懂的错误信息 不同信息类型的举例 package pro.shushi.pamirs.demo.core.action; import org.springframework.stereotype.Component; import pro.shushi.pamirs.demo.api.model.PetCatItem; import pro.shushi.pamirs.demo.api.model.PetType; import pro.shushi.pamirs.meta.annotation.Action; import pro.shushi.pamirs.meta.annotation.Model; import pro.shushi.pamirs.meta.api.dto.common.Message; import pro.shushi.pamirs.meta.api.session.PamirsSession; import pro.shushi.pamirs.meta.enmu.ActionContextTypeEnum; import pro.shushi.pamirs.meta.enmu.InformationLevelEnum; import pro.shushi.pamirs.meta.enmu.ViewTypeEnum; @Model.model(PetType.MODEL_MODEL) @Component public class PetTypeAction { @Action(displayName = "消息",bindingType = ViewTypeEnum.TABLE,contextType = ActionContextTypeEnum.CONTEXT_FREE) public PetType message(PetType data){ PamirsSession.getMessageHub().info("info1"); PamirsSession.getMessageHub().info("info2"); PamirsSession.getMessageHub().error("error1"); PamirsSession.getMessageHub().error("error2"); PamirsSession.getMessageHub().msg(new Message().msg("success1").setLevel(InformationLevelEnum.SUCCESS)); PamirsSession.getMessageHub().msg(new Message().msg("success2").setLevel(InformationLevelEnum.SUCCESS)); PamirsSession.getMessageHub().msg(new Message().msg("debug1").setLevel(InformationLevelEnum.DEBUG)); PamirsSession.getMessageHub().msg(new Message().msg("debug2").setLevel(InformationLevelEnum.DEBUG)); PamirsSession.getMessageHub().msg(new Message().msg("warn1").setLevel(InformationLevelEnum.WARN)); PamirsSession.getMessageHub().msg(new Message().msg("warn2").setLevel(InformationLevelEnum.WARN)); return data; } } 查询运行返回和效果 1）系统提示的返回结果 2）系统提示示例效果

  望闲

  2024年5月14日

  2.0K000
• 后端

  自定义RSQL占位符(placeholder)及在权限中使用

  1 自定义RSQL占位符常用场景 统一的数据权限配置 查询表达式的上下文变量扩展 2 自定义RSQL的模板 /** * 演示Placeholder占位符基本定义 * * @author Adamancy Zhang at 13:53 on 2024-03-24 */ @Component public class DemoPlaceHolder extends AbstractPlaceHolderParser { private static final String PLACEHOLDER_KEY = "${thisPlaceholder}"; /** * 占位符 * * @return placeholder */ @Override public String namespace() { return PLACEHOLDER_KEY; } /** * 占位符替换值 * * @return the placeholder replace to the value */ @Override protected String value() { return PamirsSession.getUserId().toString(); } /** * 优先级 * * @return execution order of placeholders, ascending order. */ @Override public Integer priority() { return 0; } /** * 是否激活 * * @return the placeholder is activated */ @Override public Boolean active() { return true; } } 注意事项 在一些旧版本中，priority和active可能不起作用，为保证升级时不受影响，请保证该属性配置正确。 PLACEHOLDER_KEY变量表示自定义占位符使用的关键字，需按照所需业务场景的具体功能并根据上下文语义正确定义。 为保证占位符可以被正确替换并执行，所有占位符都不应该出现重复，尤其是不能与系统内置的重复。 3 占位符使用时的优先级问题 多个占位符在进行替换时，会根据优先级按升序顺序执行，如需要指定替换顺序，可使用Spring的Order注解对其进行排序。 import org.springframework.core.annotation.Order; @Order(0) 4 Oinone平台内置的占位符 占位符 数据类型 含义 备注 ${currentUser} String 当前用户ID 未登录时无法使用 ${currentRoles} Set<String> 当前用户的角色ID集合 未登录时无法使用 5 如何覆盖平台内置的占位符？ 通过指定占位符的优先级，并定义相同的namespace可优先替换。 6 如何定义会话级别的上下文变量？ 在上述模板中，我们使用的是Oinone平台内置的上下文变量进行演示，通常情况下，我们需要根据实际业务场景增加上下文变量，以此来实现所需功能。 下面，我们将根据当前用户获取当前员工ID定义该上下文变量进行演示。 /** * 员工Session * * @author Adamancy Zhang at 14:33 on 2024-03-24 */ @Component public class EmployeeSession implements HookBefore { private static final String SESSION_KEY = "CUSTOM_EMPLOYEE_ID"; @Autowired private DemoEmployeeService demoEmployeeService; public static String getEmployeeId() { return PamirsSession.getTransmittableExtend().get(SESSION_KEY);…

  张博昊

  2024年3月24日

  2.2K001
• 后端

  Oinone离线部署设计器JAR包

  概述 Oinone平台为合作伙伴提供了多种部署方式，这篇文章将介绍如何在私有云环境部署Oinone平台JAR包。 本文以5.2.6版本为例进行介绍。 部署环境要求 包含全部中间件及设计器服务的环境要求 CPU：8 vCPU 内存（RAM）：16G以上 硬盘（HDD/SSD）：60G以上 仅设计器服务的环境要求 CPU：8 vCPU 内存（RAM）：8G以上 硬盘（HDD/SSD）：40G以上 部署准备 在部署环境创建部署目录 mkdir -p /home/admin/oinone-designer PS：为方便管理，所有Oinone部署所需文件都应该在该目录下存放。 服务器需要安装的中间件 JDK：jdk_1.8_221版本以上 下载地址 MySQL：8.0.26版本以上 下载地址 Redis：5.0.2版本以上 下载地址 安装教程 Zookeeper：3.5.8版本以上 下载地址 安装教程 Nginx：任意版本（推荐使用源码编译安装方式，并开启rewrite、https等功能模块） Linux安装教程 下载地址 使用Docker启动所有中间件 点击下载一键部署所有中间件套件包 middleware-kits.zip 部署清单 下面列举了文章中在本地环境操作结束后的全部文件： 设计器JAR包：pamirs-designer-boot-v5.2-5.2.6.jar 离线部署结构包：oinone-designer-jar-offline.zip 第三方数据库驱动包（非MySQL数据库必须） PS：如需一次性拷贝所有部署文件到部署环境，可以将文档步骤在本地环境执行后，一次性将所有文件进行传输。 在本地环境准备部署文件 下载离线部署结构包 oinone-designer-jar-offline.zip 下载部署JAR包 5.2.6版本发布日志 查看更多版本 找到独立部署所有设计器JAR标题，下面有对应的JAR包提供下载。 例如：https://oinone-jar.oss-cn-zhangjiakou.aliyuncs.com/install/oinone-designer/pamirs-designer-boot-v5.2-5.2.6.jar 后端服务部署 将部署JAR包移动到backend目录下，并重命名为oinone-designer.jar mv pamirs-designer-boot-v5.2-5.2.6.jar backend/oinone-designer.jar PS：该名称为startup.sh脚本的默认值，可根据实际情况自行修改 将Pamirs许可证移动到backend/config目录下，并重命名为license.lic mv oinone-demo_1730163770607.lic backend/config/license.lic 加载非MySQL数据库驱动（按需） 将驱动jar文件移动到backend/lib目录下即可。 以KDB8数据库驱动kingbase8-8.6.0.jar为例 mv kingbase8-8.6.0.jar backend/lib/ PS：backend/lib目录为非设计器内置包的外部加载目录（外部库），可以添加任何jar包集成到设计器中。 修改backend/startup.sh脚本 IP：修改为可被外部访问的IP地址 DB_BASE_：base库相关数据库连接配置 DB_PAMIRS_：pamirs库相关数据库连接配置 REDIS_：Redis相关配置 MQ_NAME_SERVER：RocketMQ的name-server连接地址 ZOOKEEPER_：Zookeeper相关配置 PS：若需要配置方言或其他参数，可直接修改backend/config/application.yml配置文件，变量仅用于简单配置场景 执行startup.sh脚本启动 sh startup.sh 执行完成后会打印三个路径 后端路径：backend root path: /path/to/backend 前端路径：frontend root path: /path/to/frontend Nginx配置路径：nginx services path: /path/to/nginx Nginx配置 在本地nginx服务中找到nginx.conf，并添加Nginx配置路径为加载目录 http { … include /path/to/nginx/*.conf; } 修改结构包中的default.conf第7行root配置为前端路径到dist目录下 server { … root /path/to/frontend/dist; } 修改结构包中的oss.conf第30行alias配置为前端路径到static目录下 server { … location /static { … alias /path/to/frontend/static; } } 访问服务 使用http://127.0.0.1:9090访问服务

  张博昊

  2024年11月1日

  1.9K000
• 部署

  【界面设计器】模型增删改查基础

  阅读之前 你应该： 已搭建包含界面设计器的基础环境。 对平台元数据有基本了解和认识。（如果不是特别清楚也没关系） 常用元数据简介 平台中包含了许多元数据，以这些元数据为基础，可以较为完整的描述了一个【应用】或【模块】的存储结构以及用户交互。 图解 “` mermaidgraph TDModule —> DataDictionaryModule —> Model Model —> FieldModel —> Function1(Function)Model —> Action Action —> ViewAction —> ViewAction —> ServerAction —> Function2(Function)Action —> UrlActionAction —> ClientAction“` 概念解释 模块（Module）：用于定义元数据的作用域。 数据字典（DataDictionary）：固定数据可选项。 模型（Model）：用于描述一个具体对象的集合。 字段（Field）：模型中字段，用于描述对象属性。 函数（Function）：模型中的函数，用于定义对象的服务端行为。 动作（Action）：模型中的动作，用于定义对象的交互行为。具体表现为以下四个行为。 跳转动作（ViewAction）：用于视图与视图之间的跳转。 视图（View）：用于定义主内容分发区的页面内容。 服务端动作（ServerAction）：用于客户端调用服务端行为。特殊的，当函数被作为API级别开放时，客户端也可以直接调用。 链接动作（UrlAction）：用于执行浏览器超链接行为。 客户端动作（ClientAction）：用于自定义客户端动作。 其他概念解释 应用（Application）：特殊的模块，可以被用户访问的模块。 模块依赖（ModuleDependencies）：模块与模块之间具备的一种关系，使得模块可以使用被依赖模块的相关元数据。 场景描述 在以下演示过程中，我们将通过【演示模块】这一应用来引导大家完成【商品】模型的增删改查操作。并根据实际应用场景，为大家提供模型增删改查的最佳实践。 创建第一个无代码应用 （基于低代码开发的应用，可以跳过这一步骤。） 登录进入系统后，将可以按照如下步骤进行操作。（为了方便演示和体验，可直接使用admin用户进入系统） 切换应用到应用中心 创建第一个应用 至此，你已经创建了一个【演示应用】，用于接下来的操作。 创建第一个无代码模型 （基于低代码开发的模型，可以跳过这一步骤。） 切换应用到模型设计器 在模型设计器切换视图为表模式 模型设计器具有表模式和图模式两种模型展示形式，表模式主要用于单个模型的管理，图模式主要用于查看多个模型之间的关联关系。 在这里我们使用表模式。 在模型设计器切换模块到【演示模块】 创建一个存储模型【商品】 在无代码模式中，只能选择【存储模型】和【传输模型】，其代表的含义为： 存储模型：创建模型时同步创建数据库表，具备数据存储能力。 传输模型：仅创建模型，不创建数据库表，不具备数据存储能力，仅作用户交互使用。 创建模型时，一定会继承一个父模型，在模型设计器创建模型都将默认继承【基础存储模型】，该模型中默认包含【编码】和【名称】两个业务字段，以及【ID】、【创建人ID】、【更新人ID】、【创建时间】、【更新时间】五个系统字段。 在专家模式中，可以查看模型的父模型进行查看，也可以在创建模型时修改父模型。这一功能在这里不进行演示。 在下面的操作中，我们仅需使用【编码】和【名称】这两个业务字段来创建相关视图。 创建第一个表格视图 切换应用到界面设计器 选择应用和模型 这里为了方便查看，我们可以使用【全部视图类型】。 创建表格视图 输入【页面标题】，修改【视图类型】为【表格】，直接点击确定即可。会自动进入【页面设计】。 页面设计 设计表格视图 从【组件库】-【模型】中将【编码】和【名称】两个【低代码字段】拖入【表格区】 小贴士： 在左侧组件库可以切换【组件】和【模型】。【组件】用于创建和选择字段，【模型】用于直接使用现有字段。 在模型面板可以查看当前选中字段所在模型。如未选择时，为当前视图模型。 对于存储模型而言，创建字段应该是一个谨慎的操作，在学习阶段尽可能从【模型】中使用现有字段。除非有创建新字段的需求。 大家可以自由发挥，将【编码】和【名称】拖入【列表搜索区】即可使用这两个字段进行搜索。单行文本默认使用模糊搜索。 为表格提供【创建商品】功能 从【组件库】-【组件】中将【跳转动作】组件拖入【动作区】，并填写相关的元数据信息，按图示输入完成后，点击保存即可。（具体解释在文章下方） 这里会创建一个【表单】视图，并绑定至当前动作。设计完表格视图后，我们需要设计表单视图。 为表格提供【编辑商品】功能 从【组件库】-【组件】中将【跳转动作】组件拖入【行内动作区】，并填写相关的元数据信息，按图示输入完成后，点击保存即可。 为表格提供【删除商品】功能 从【组件库】-【模型】中将【删除】动作分别拖入【动作区】和【行内动作区】即可。 将表格绑定到菜单，可以让用户访问 使用【显示母版】可以查看当前页面在母版中的预览效果 添加菜单项【商品管理】并【绑定当前视图】 发布表格视图，并返回列表页 至此，我们已完成了【表格】视图的基本功能设计。 接下来，我们需要设计刚刚在【创建商品】步骤时创建的【表单】视图。点击【商品表单】卡片任意区域进入【页面设计】。 设计表单视图 从【组件库】-【模型】中将【编码】和【名称】两个【低代码字段】拖入【表单区】 为表单提供【创建/更新】功能，使得表单可以提交数据到服务端 从【组件库】-【模型】中将【创建】动作拖入【动作区】 将【创建】动作的【是否隐藏】属性改为【条件隐藏】并设置表达式 从【组件库】-【模型】中将【更新】动作拖入【动作区】 将【更新】动作的【是否隐藏】属性改为【条件隐藏】并设置表达式 为表单提供【返回】功能 将【组件】-【客户端动作】拖入【动作区】添加【返回】功能 发布表单视图，并返回列表页 （同表格视图发布） 切换应用到应用中心，为应用设置首页 使用绑定菜单，将【商品管理】菜单设置为【演示模块】的应用首页。 切换应用到演示模块，查看刚刚设计的视图以及体验增删改查基本功能 至此，一个模型的全部增删改查功能已进行完整演示。下面将对上述步骤中可能产生的疑问点进行解释说明。 跳转动作元数据配置 动作名称：跳转动作的默认显示名称 数据控制类型：用于动作点击后的数据行为控制。 处理单条数据：携带当前可用数据的一行到目标页面中，仅一行，如果勾选了多行也仅有首行（首行按勾选顺序决定）。 处理多条数据：携带当前可用数据的多行到目标页面中，至少是两行。 处理单条或多条数据：携带当前可用数据的多行到目标页面中，至少是一行。 不进行数据处理：不携带任何数据到目标页面。 打开方式：用于动作点击后的跳转行为控制。 当前窗口打开：基本的页面跳转，不打开新的浏览器窗口或标签页。 新窗口打开：打开新的浏览器窗口或标签页。特殊的，使用了平台内置的多标签页时，将不再打开新的浏览器窗口或标签页，仅会在多标签页中添加一个新的标签页。 弹窗打开：使用弹窗打开，并渲染目标页面。 抽屉打开：使用抽屉打开，并渲染目标页面。 页面内容：界面设计器交互属性。 绑定已有视图：从平台中已存在的视图中选择视图作为目标页面。 创建新页面：输入视图相关信息，创建新视图并绑定到当前动作作为目标页面。 绑定页面：【绑定已有视图】时用于选择视图。 页面标题：【创建新页面】时使用的页面信息，与【界面设计器】中【创建视图】的【页面标题】一致。 页面模型：【创建新页面】时使用的页面信息，与【界面设计器】中【创建视图】的【模型】一致。 业务类型：【创建新页面】时使用的页面信息，与【界面设计器】中【创建视图】的【业务类型】一致。 视图类型：【创建新页面】时使用的页面信息，与【界面设计器】中【创建视图】的【视图类型】一致。 操作栏位置：【创建新页面】时使用的页面信息，与【界面设计器】中【创建视图】的【操作栏位置】一致。 禁用数据加载：打开目标页面时不发起服务端查询。 加载函数：打开目标页面时使用指定的加载函数发起服务端查询。 客户端动作元数据配置 动作名称：客户端动作的默认显示名称 客户端行为：平台内置的客户端行为 数据校验：同提交动作的数据校验功能 返回上一页/关闭弹窗/关闭抽屉 刷新数据：同提交动作的刷新当前视图功能 批量更新：在批量动作打开的弹窗中使用的特殊客户端动作 删除数据：在一对多(O2M)和多对多(M2M)使用表格组件时使用的删除功能 Q/A 跳转动作的数据控制类型该如何选择？ 通常情况下，我们可以通过目标页面是否需要携带数据以及携带的数据行数，来决定数据控制类型。 在演示内容中，从【表格】视图通过【创建】按钮跳转到表单时，通常我们不需要任何数据，因此我们选择【不进行数据处理】来实现这一目的。从【表格】视图通过【编辑】按钮跳转到表单时，通常我们在行内进行操作，并且我们一次只能编辑一行数据，因此我们选择【处理单条数据】。 【组件库】-【组件】中的动作和【组件库】-【模型】中的动作有什么区别？ 【组件库】-【组件】中的动作拖入页面时，会创建一个对应的动作，因此需要输入元数据相关信息。【组件库】-【模型】中的动作为当前模型中的【服务端动作】，因此拖入页面后无需输入元数据相关信息。 【删除】动作为什么可以显示在两个区域？ 在模型中内置的【删除】动作，其数据类型为【处理单条或多条数据】，因此可以在表格的【动作区】和【行内动作区】各放置一个。不仅如此，所有的数据类型为【处理单条或多条数据】的【服务端动作】都可以这样做。 表格的【创建】和【编辑】为什么一个使用【创建新页面】，另一个使用【绑定已有视图】？ 在新增【创建】这个【跳转动作】时，由于我们在当前模型下没有一个【表单】视图可以直接使用，因此在这里我们使用【创建新页面】的方式直接创建【表单】视图，并绑定至当前动作。 在新增【编辑】这个【跳转动作】时，由于我们在上一步骤已经创建了一个可以直接使用的【表单】视图，因此在这里我们使用【绑定已有视图】。 在演示内容中，我们假设【创建商品】和【编辑商品】使用的【表单】视图可以通过【是否隐藏】属性进行简单区分，因此采取了这样的演示操作。根据我们实践经验，在大多数场景中也的确如此。 表单的【创建】和【更新】配置的【条件隐藏】具有怎样的含义？ 在平台任何存储模型/代理模型（不包含中间模型）中，都具备ID这一系统字段。通过【不进行数据处理】的跳转动作跳转至【表单】视图时，ID不会在跳转时进行传递，因此在【表单】中的ID字段为空。通过【处理单条数据】的跳转动作跳转至【表单】视图时，ID会在跳转时进行传递（如URL上可以看到id属性），因此在【表单】中的ID字段不空。 根据这一特性，我们就可以通过【条件隐藏】区分当前这个视图的业务功能。 表单的【创建】可以通过当前视图数据.ID非空进行隐藏，即表示当前ID非空时隐藏（当前ID为空时显示）。 表单的【更新】可以通过当前视图数据.ID为空进行隐藏，即表示当前ID为空时隐藏（当前ID不空时显示）。

  oinone

  2023年11月1日

  8.6K001
• 后端

  Excel导入扩展点-整体导入（批量导入）

  1、【导入】在有些场景，需要获取Excel导入的整体数据，进行批量的操作或者校验 可以通过实现导入扩展点的方式实现，入参data是导入Excel的数据列表；业务可以根据实际情况进行数据校验 1）Excel模板定义，需要设置setEachImport(false) 2）导入扩展点API定义 pro.shushi.pamirs.file.api.extpoint.ExcelImportDataExtPoint#importData 3）示例代码参考： pro.shushi.pamirs.translate.extpoint.ResourceTranslationImportExtPoint#importData @Slf4j @Component @Ext(ExcelImportTask.class) public class ResourceTranslationImportExtPoint extends AbstractExcelImportDataExtPointImpl<List<ResourceTranslationItem>> { @Override //TODO 表达式，可以自定义，比如可以支持1个模型的多个【导入名称】的不同模板 @ExtPoint.Implement(expression = "importContext.definitionContext.model==\"" + ResourceTranslation.MODEL_MODEL + "\"") public Boolean importData(ExcelImportContext importContext, List<ResourceTranslationItem> dataList) { //TODO dataList就是excel导入那个sheet的所有内容 return true; } } 2、【导入】逐行导入的时候做事务控制 在模板中定义中增加事务的定义，并设置异常后回滚。参加示例代码： excel模板定义 @Component public class DemoItemImportTemplate implements ExcelTemplateInit { public static final String TEMPLATE_NAME = "商品导入模板"; @Override public List<ExcelWorkbookDefinition> generator() { //定义事务(导入处理中，只操作单个表的不需要事务定义。) //是否定义事务根据实际业务逻辑确定。比如：有些场景在导入前需要删除数据后在进行导入就需要定义事务 InitializationUtil.addTxConfig(DemoItem.MODEL_MODEL, ExcelDefinitionContext.EXCEL_TX_CONFIG_PREFIX + TEMPLATE_NAME); return Collections.singletonList( ExcelHelper.fixedHeader(DemoItem.MODEL_MODEL, TEMPLATE_NAME) .setType(ExcelTemplateTypeEnum.IMPORT) .createSheet("商品导入-sheet1") .createBlock(DemoItem.MODEL_MODEL) .addUnique(DemoItem.MODEL_MODEL,"name") .addColumn("name","名称") .addColumn("description","描述") .addColumn("itemPrice","单价") .addColumn("inventoryQuantity","库存") .build().setEachImport(true) //TODO 设置异常后回滚的标识，这个地方会回滚事务 .setHasErrorRollback(true) .setExcelImportMode(ExcelImportModeEnum.SINGLE_MODEL) ); } } 导入逻辑处理 @Slf4j @Component @Ext(ExcelImportTask.class) public class DemoItemImportExtPoint extends AbstractExcelImportDataExtPointImpl<DemoItem> implements ExcelImportDataExtPoint<DemoItem> { @Autowired private DemoItemService demoItemService; @Override @ExtPoint.Implement(expression = "importContext.definitionContext.model == \"" + DemoItem.MODEL_MODEL + "\"") public Boolean importData(ExcelImportContext importContext, DemoItem data) { ExcelImportTask importTask = importContext.getImportTask(); try { DemoItemImportTask hrExcelImportTask = new DemoItemImportTask().queryById(importTask.getId()); String publishUserName = Optional.ofNullable(hrExcelImportTask).map(DemoItemImportTask::getPublishUserName).orElse(null); data.setPublishUserName(publishUserName); demoItemService.create(data); } catch(PamirsException e) { log.error("导入异常", e); } catch (Exception e) { log.error("导入异常", e); } return Boolean.TRUE; } }

  望闲

  2023年12月7日

  2.2K000