Oinone协同开发使用手册

相关推荐

• 开发实践

  项目中常用的 Tools 工具类

  模型拷贝工具类 KryoUtils.get().copy(modelData); ArgUtils.convert(DataReport.MODEL_MODEL, DataDesignerReport.MODEL_MODEL, report); pro.shushi.pamirs.framework.common.utils.ObjectUtils#clone(T) Rsql工具类 RsqlParseHelper.parseRsql2Sql(queryWrapper.getModel(), rsql); RSQLHelper.getRsqlValues(sql.getOriginRsql(), fieldSet); 序列化工具类 后端使用的JSON序列化 JsonUtils.toJSONString(nodes); 前端使用的JSON序列化 PamirsJsonUtils.toJSONString(nodes, SerializerFeature.DisableCircularReferenceDetect, SerializerFeature.WriteDateUseDateFormat, SerializerFeature.BrowserCompatible); 生成ID //根据模型生成id Long generate = (Long) Spider.getDefaultExtension(IdGenerator.class).generate(PamirsTableInfo.fetchKeyGenerator(Teacher.MODEL_MODEL)); //生成id Long l = Long.valueOf(UidGeneratorFactory.getCachedUidGenerator().getUID()); 权限相关 // 获取权限路径path AccessResourceInfoSession.getInfo().getOriginPath(); 其他 PamirsSession相关 PamirsSession.isAdmin() # 是否admin用户 PamirsSession.getUserId() # 获取登录用户ID PamirsSession.getRequestVariables() PamirsSession.getContext().getModelCache().get(PetShop.MODEL_MODEL).getTable(); # 获取模型信息 PamirsSession.getContext().getExtendCache(ActionCacheApi.class).get(Teacher.MODEL_MODEL, "importArchivesInfo") # 获取函数信息

  yexiu

  2025年5月8日

  1.0K010
• 开发实践

  Oinone如何支持构建分布式项目

  分布式调用下的[强制]约束 1、[强制]分布式调用情况下base库和redis需共用；2、[强制]如果环境有设计器，设计器的base库和redis保持一致也需与项目中的保持一致；3、[强制]相同base库下，不同应用的相同模块的数据源需保持一致；4、[强制]项目中需引入分布式缓存包。参考下文的分布式包依赖 分布式支持 1、分布式包依赖 1) 父pom的依赖管理中先加入pamirs-distribution的依赖 <dependency> <groupId>pro.shushi.pamirs</groupId> <artifactId>pamirs-distribution</artifactId> <version>${pamirs.distribution.version}</version> <type>pom</type> <scope>import</scope> </dependency> 2) 启动的boot工程中增加pamirs-distribution相关包 <!– 分布式服务发布 –> <dependency> <groupId>pro.shushi.pamirs.distribution</groupId> <artifactId>pamirs-distribution-faas</artifactId> </dependency> <!– 分布式元数据缓存 –> <dependency> <groupId>pro.shushi.pamirs.distribution</groupId> <artifactId>pamirs-distribution-session</artifactId> </dependency> <dependency> <groupId>pro.shushi.pamirs.distribution</groupId> <artifactId>pamirs-distribution-gateway</artifactId> </dependency> 3）启动工程的Application中增加类注解@EnableDubbo @EnableDubbo public class XXXStdApplication { public static void main(String[] args) throws IOException { StopWatch stopWatch = new StopWatch(); stopWatch.start(); // ……………………………… log.info("XXXX Application loading…"); } } 2、修改bootstrap.yml文件 注意序列化方式：serialization: pamirs 以下只是一个示例（zk为注册中心），注册中心支持zk和Nacos；Nacos作为注册中心参考：https://doc.oinone.top/kai-fa-shi-jian/5835.html spring: profiles: active: dev application: name: pamirs-demo cloud: service-registry: auto-registration: enabled: false pamirs: default: environment-check: true tenant-check: true — spring: profiles: dev cloud: service-registry: auto-registration: enabled: false config: enabled: false uri: http://127.0.0.1:7001 label: master profile: dev nacos: server-addr: http://127.0.0.1:8848 discovery: enabled: false namespace: prefix: application file-extension: yml config: enabled: false namespace: prefix: application file-extension: yml dubbo: application: name: pamirs-demo version: 1.0.0 registry: address: zookeeper://127.0.0.1:2181 protocol: name: dubbo port: -1 serialization: pamirs scan: base-packages: pro.shushi cloud: subscribed-services: metadata-report: disabled: true 3、模块启动的最⼩集 pamirs: boot: init: true sync: true modules: – base – sequence – 业务工程的Module 4、业务模型间的依赖关系 服务调用方(即Client端)，在启动yml中modules不安装服务提供方的Module 服务调用方(即Client端)，项目的pom中只依赖服务提供方的API（即模型和API的定义） 服务调用方(即Client端)，项目模块定义（即模型Module定义），dependencies中增加服务提供方的Modeule. 如下面示例代码中的FileModule @Module( name = DemoModule.MODULE_NAME, displayName = "oinoneDemo工程", version = "1.0.0", dependencies = {ModuleConstants.MODULE_BASE, CommonModule.MODULE_MODULE, FileModule.MODULE_MODULE, SecondModule.MODULE_MODULE/**服务提供方的模块定义*/ } )…

  shao

  2024年2月20日

  1.3K000
• 后端

  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.6K000
• 后端

  Oinone设计器部署参数说明

  概述 Oinone提供两种设计器部署方式，合作伙伴可以自行选择适合自己的部署方式。 Docker配置参数 环境变量 ARG_ENV：指定spring.profiles.active（默认：dev） ARG_LIFECYCLE：指定-Plifecycle（默认：INSTALL） JVM_OPTIONS：jvm参数 PROGRAM_ARGS：程序参数 JVM_OPTIONS和PROGRAM_ARGS参数说明 java [JVM_OPTIONS?] -jar boot.jar [PROGRAM_ARGS?] 端口说明 PS：以下为目前设计器镜像的全部端口，不同类型镜像的端口由于内置服务不同，使用的端口数量不同，但端口号是完全一致的。 80：前端服务端口（设计器访问入口） 8091：后端服务端口 8093：后端EIP服务端口 20880：Dubbo端口 3306：内置MySQL端口 2181：内置Zookeeper端口 6379：内置Redis端口 9876/10991：内置RocketMQ端口 9999：内置本地OSS默认端口 挂载目录说明（挂载虚拟卷） /opt/pamirs为镜像的工作目录，所有挂载目录均在该目录下。 /opt/pamirs/ext：应用配置文件目录；包含application.yml、logback.xml、license.lic等配置文件 /opt/pamirs/nginx/vhost：Nginx配置文件目录 /opt/pamirs/logs：后端服务日志目录 /opt/mq/conf/broker.conf：RocketMQ的broker配置文件 /opt/pamirs/outlib：非设计器内置包的外部加载目录（外部库），可以添加任何jar包集成到设计器中。 /opt/pamirs/dist：前端服务目录 /opt/pamirs/static：前端静态文件目录；LOCAL类型的OSS上传和下载目录； docker run启动常用参数 -e：指定环境变量 -p：指定端口映射 -v：指定挂载目录（挂载虚拟卷） docker run [OPTIONS] IMAGE [COMMAND] [ARG…] docker compose启动常用配置 services: container: image: $IMAGE container_name: $CONTAINER_NAME restart: always # docker run -e environment: KEY1: VALUE1 KEY2: VALUE2 … # docker run -p ports: – $machinePort1:$containerPort1 – $machinePort2:$containerPort2 … # docker run -v volumes: – $machinePath1:$containerPath1 – $machinePath2:$containerPath2 … docker compose常用命令 # 使用docker-compose.yaml启动 docker compose up -d # 使用docker-compose.yaml停止并删除容器 docker compose down -v # 指定配置文件启动 docker compose -f config.yaml up -d # 指定配置文件停止并删除容器 docker compose -f config.yaml down -v JAR包方式启动 下载Oinone专属启动器 oinone-boot-starter.zip 启动命令变化 # 原命令 java -jar boot.jar # 变更后命令 boot-starter java -jar boot.jar PS：更多命令可查看后端无代码设计器Jar包启动方法

  张博昊

  2024年11月4日

  1.6K000
• 后端

  自定义用户中心菜单

  使用扩展点实现用户中心菜单替换 1. 工程中引起pamirs-user-api <dependency> <groupId>pro.shushi.pamirs.core</groupId> <artifactId>pamirs-user-api</artifactId> </dependency> 2. 实现TopBarUserBlockAction的后置扩展 实现HookAfter后置扩展接口 @Hook(model = {TopBarUserBlock.MODEL_MODEL}, fun = {"construct"})添加Hook注解注明是TopBarUserBlock模型的construct函数的后置扩展。 增加用户中心菜单 @Component @Order(1) @SPI.Service public class MyTopBarActionExt implements TopBarActionExtendApi { public void edit(List<TopBarAction> list) { list.add(new TopBarAction("top_demo", "top.Teacher", "uiView9a0caf1d574a42c9847a057a0c4a4ad1", ActionTypeEnum.VIEW, 1) .setDisplayName("商品管理") .setIcon("oinone-gongzuotai") ); } } 实现效果 替换原有的用户中心菜单 替换原有的菜单跳转 @Component public class DemoTopBarUserBlockDataHookAfter implements HookAfter { @Override @Hook(model = {TopBarUserBlock.MODEL_MODEL}, fun = {"construct"}) public Object run(Function function, Object ret) { if (ret == null) { return null; } TopBarUserBlock result = null; if (ret instanceof Object[]) { Object[] rets = (Object[]) ((Object[]) ret); if (rets.length == 1) { result = (TopBarUserBlock) rets[0]; //例：替换用户中心：修改密码菜单 //使用name和model查询出模型的ViewAction替换修改密码ViewAction ViewAction demoViewAction = PamirsSession.getContext().getExtendCache(ActionCacheApi.class).get(Dog.MODEL_MODEL, "changePassword"); //设置菜单的icon Map<String, Object> attributes = Optional.ofNullable(demoViewAction.getAttributes()).orElse(new HashMap<>()); attributes.put("icon", "oinone-xiugaimima"); demoViewAction.setAttributes(attributes); //UserViewAction第0个是修改密码ViewAction，使用自定义的ViewAction就可以实现替换 result.getUserViewAction().set(0, demoViewAction); } } else { result = (TopBarUserBlock) ret; } return result; } } 使用@UxRouteButton方式新增ViewAction，更多新增Action方式详见：Action的类型 @Model.model(Dog.MODEL_MODEL) @Component @UxRouteButton( action = @UxAction(name = "changePassword", displayName = "修改密码"), value = @UxRoute(model = Dog.MODEL_MODEL, openType = ActionTargetEnum.DIALOG)) public class DogAction { } 替换原有的个人设置头像跳转 修改点击头像绑定的跳转逻辑 @Order(10) @Component @SPI.Service public class DemoTopBarUserBlockDataApi implements TopBarUserBlockDataApi { @Override public TopBarUserBlock extendData(TopBarUserBlock data) { //例如增加一个菜单, PamirsDemo.MODEL_MODEL: 模型。 MenuuiMenu31f22466735a4abe8e0544b428ed88ac：viewAction的name。 Action demoViewAction =…

  yexiu

  2024年7月4日

  1.8K000