模块(module):是按业务领域划分和管理的最小单元，是一组功能、界面的集合。
带大家快速认识下如何构建一个oinone的模块并启动它。我会从以下几个维度去介绍模块的构建与启动方式、模块详解。让大家直观且全方位地了解oinone的模块所包含的内容
构建第一个Module
启动前端工程
应用中心
Oinone社区 作者：史, 昂原创文章，如若转载，请注明出处：https://doc.oinone.top/oio4/9227.html
访问Oinone官网:https://www.oinone.top获取数式Oinone低代码应用平台体验
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 通用标题组件设置…
本节为小伙伴们介绍，Function的面向对象的特性：继承与多态； 一、继承 我们在3.4.1【构建第一个Function】一文中伴随模型新增函数和独立类新增函数绑定到模型部分都是在父模型PetShop新增了sayHello的Function，同样其子模型都具备sayHello的Function。因为我们是通过Function的namespace来做依据的，子模型在继承父模型的sayHello函数后会以子模型的编码为namespace，名称则同样为sayHello。 二、多态（举例） oinone的多态，我们只提供覆盖功能，不提供重载，因为oinone相同name和fun的情况下不会去识别参数个数和类型。 Step1 为PetShop新增hello函数 package pro.shushi.pamirs.demo.api.model; …… //import @Model.model(PetShop.MODEL_MODEL) @Model(displayName = "宠物店铺",summary="宠物店铺",labelFields ={"shopName"} ) @Model.Code(sequence = "DATE_ORDERLY_SEQ",prefix = "P",size=6,step=1,initial = 10000,format = "yyyyMMdd") public class PetShop extends AbstractDemoIdModel { public static final String MODEL_MODEL="demo.PetShop"; …… //省略其他代码 @Function(openLevel = FunctionOpenEnum.API) @Function.Advanced(type= FunctionTypeEnum.QUERY) public PetShop sayHello(PetShop shop){ PamirsSession.getMessageHub().info("Hello:"+shop.getShopName()); return shop; } @Function(name = "sayHello2",openLevel = FunctionOpenEnum.API) @Function.Advanced(type= FunctionTypeEnum.QUERY) @Function.fun("sayHello2") public PetShop sayHello(PetShop shop, String s) { PamirsSession.getMessageHub().info("Hello:"+shop.getShopName()+",s:"+s); return shop; } @Function(openLevel = FunctionOpenEnum.API) @Function.Advanced(type= FunctionTypeEnum.QUERY) public PetShop hello(PetShop shop){ PamirsSession.getMessageHub().info("Hello:"+shop.getShopName()); return shop; } } 图3-4-3-1 为PetShop新增hello函数 Step2 为PetShopProxyB新增对应的三个函数 其中PetShopProxyB新增的hello函数，在java中是重载了hello，在代码中new PetShopProxyB()是可以调用父类的sayHello单参方法，也可以调用本类的双参方法。但在oinone的体系中对于PetShopProxyB只有一个可识别的Function就是双参的sayHello package pro.shushi.pamirs.demo.api.proxy; import pro.shushi.pamirs.demo.api.model.PetCatItem; import pro.shushi.pamirs.demo.api.model.PetShop; import pro.shushi.pamirs.meta.annotation.Field; import pro.shushi.pamirs.meta.annotation.Function; import pro.shushi.pamirs.meta.annotation.Model; import pro.shushi.pamirs.meta.api.session.PamirsSession; import pro.shushi.pamirs.meta.enmu.FunctionOpenEnum; import pro.shushi.pamirs.meta.enmu.FunctionTypeEnum; import pro.shushi.pamirs.meta.enmu.ModelTypeEnum; import java.util.List; @Model.model(PetShopProxyB.MODEL_MODEL) @Model.Advanced(type = ModelTypeEnum.PROXY,inherited ={PetShopProxy.MODEL_MODEL,PetShopProxyA.MODEL_MODEL} ) @Model(displayName = "宠物店铺代理模型B",summary="宠物店铺代理模型B") public class PetShopProxyB extends PetShop { public static final String MODEL_MODEL="demo.PetShopProxyB"; @Field.one2many @Field(displayName = "萌猫商品列表") @Field.Relation(relationFields = {"id"},referenceFields = {"shopId"}) private List<PetCatItem> catItems; @Function(openLevel = FunctionOpenEnum.API) @Function.Advanced(type= FunctionTypeEnum.QUERY) public PetShop sayHello(PetShop shop){ PamirsSession.getMessageHub().info("PetShopProxyB Hello:"+shop.getShopName()); return shop; } @Function(name = "sayHello2",openLevel = FunctionOpenEnum.API) @Function.Advanced(type= FunctionTypeEnum.QUERY) @Function.fun("sayHello2") public PetShop sayHello(PetShop shop,String hello){ PamirsSession.getMessageHub().info("PetShopProxyB say:"+hello+","+shop.getShopName()); return shop; } @Function(openLevel = FunctionOpenEnum.API)…
一、多端协议 协议内容格式 请求头 头信息 headerMap "sec-fetch-mode" -> "cors" "content-length" -> "482" "sec-fetch-site" -> "none" "accept-language" -> "zh-CN,zh;q=0.9" "cookie" -> "pamirs_uc_session_id=241af6a1dbba41a4b35afc96ddf15915" "origin" -> "chrome-extension://flnheeellpciglgpaodhkhmapeljopja" "accept" -> "application/json" "host" -> "127.0.0.1:8090" "connection" -> "keep-alive" "content-type" -> "application/json" "accept-encoding" -> "gzip, deflate, br" "user-agent" -> "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.192 Safari/537.36" "sec-fetch-dest" -> "empty" 图4-1-15-1 头信息 headerMap 请求地址 requestUrl 例如 http://127.0.0.1:8090/pamirs/DemoCore?scene=redirectListPage HTTP参数键值对 parameterMap url中queryString在服务端最终会转化为参数键值对。 请求体格式 请求体格式采用GraphQL协议。请求体格式分为API请求和上下文变量。以商品的test接口为例，请求格式如下。 API请求格式 query{ petShopProxyQuery { queryPage(page: {currentPage: 1, size: 1}, queryWrapper: {rsql: "(1==1)"}) { content { income id code creater { id nickname } relatedShopName shopName petTalents { id name } items { id itemName } } size totalPages totalElements } } } 图4-1-15-2 API请求格式 上下文变量 variables 请求策略requestStrategy 名称 类型 说明 checkStrategy CheckStrategyEnum 校验策略：RETURN_WHEN_COMPLETED -?全部校验完成再返回结果RETURN_WHEN_ERROR -?校验错误即返回结果 msgLevel InformationLevelEnum 消息级别：DEBUG("debug", "调试", "调试"),INFO("info", "信息", "信息"),WARN("warn", "警告", "警告"),SUCCESS("success", "成功", "成功"),ERROR("error", "错误", "错误")不设置，则只返回错误消息；上方消息级别清单，越往下级别越高。只有消息的级别高于或等于该设定级别才返回，否则会被过滤。 onlyValidate Boolean 只校验不提交数据 表4-1-15-1 请求策略requestStrategy 上下文变量式例如下。 { "requestStrategy": { "checkStrategy": "RETURN_WHEN_COMPLETED", "msgLevel":"INFO" } } 图4-1-15-3 上下文变量式例 响应体格式 协议响应内容包括data、extensions和errors三部分，extensions和errors是可缺省的。data部分为业务数据返回值。应用业务层可以在extensions中添加API返回值之外的扩展信息。extensions中包含success、messages和extra三部分，success标识请求是否成功。如果业务正确处理并返回，则errors部分为空；如果业务处理返回失败，则将错误信息添加到errors中。 正确响应格式示例如下。 { "data": { "petShopProxyQuery": { "queryPage": { "content": [ { "id": "246675081504233477", "creater": { "id": "10001" }, "relatedShopName": "oinone宠物店铺001", "shopName": "oinone宠物店铺001", "petTalents": […
在中后台业务场景中，大部分的请求时候是可以被枚举的，比如创建、删除、更新、查询。在上文中，我们讲了httpClient如何自定义请求，来实现自己的业务诉求。本文中讲到的Request是离业务更近一步的封装，他提供了开箱即用的API，比如insertOne、updateOne，它是基于HttpClient做的二次封装，当你熟悉Request时，在中后台的业务场景中，所有的业务接口自定义将事半功倍。 一、Request详细介绍 元数据-model 获取模型实例 import { getModel } from '@kunlun/dependencies' getModel('modelName'); 图4-2-5-1 获取模型实例 清除所有缓存的模型 import { cleanModelCache } from '@kunlun/dependencies' cleanModelCache(); 图4-2-5-2 清除所有缓存的模型 元数据-module 获取应用实例，包含应用入口和菜单 import { queryModuleByName } from '@kunlun/dependencies' queryModuleByName('moduleName') 图4-2-5-3 获取应用实例 查询当前用户所有的应用 import { loadModules } from '@kunlun/dependencies' loadModules() 图4-2-5-4 查询当前用户所有的应用 query 分页查询 import { queryPage } from '@kunlun/dependencies' queryPage(modelName, { pageSize: 15, // 一次查询几条 currentPage, 1, // 当前页码 condition?: '' // 查询条件 maxDepth?: 1, // 查几层模型出来，如果有2，会把所有查询字段的关系字段都查出来 sort?: []; // 排序规则 }, fields, variables, context) 图4-2-5-5 分页查询 自定义分页查询-可自定义后端接口查询数据 import { customQueryPage } from '@kunlun/dependencies' customQueryPage(modelName, methodName, { pageSize: 15, // 一次查询几条 currentPage, 1, // 当前页码 condition?: '' // 查询条件 maxDepth?: 1, // 查几层模型出来，如果有2，会把所有查询字段的关系字段都查出来 sort?: []; // 排序规则 }, fields, variables, context) 图4-2-5-6 自定义分页查询 查询一条-根据params匹配出一条数据 import { queryOne } from '@kunlun/dependencies' customQueryPage(modelName, params, fields, variables, context) 图4-2-5-7 根据params匹配出一条数据 自定义查询 import { customQuery } from '@kunlun/dependencies' customQuery(methodName, modelName, record, fields, variables, context) 图4-2-5-8 自定义查询 update import { updateOne } from '@kunlun/dependencies' updateOne(modelName, record, fields, variables, context) 图4-2-5-9 update insert import { insertOne } from '@kunlun/dependencies' insertOne(modelName, record, fields, variables, context) 图4-2-5-10 insert delete import { deleteOne } from '@kunlun/dependencies'…
1.通知类 1.1 站内信 当流程节点需要向用户发送消息或提示时使用站内信这个节点动作。接收人的选取类似审批节点的审批人，通知内容必填，配置完成，保存即可。 节点触发后，接收人会在全渠道运营平台-工作台-我的消息中查看到站内信。 1.2 邮件 当需要向指定邮箱发送邮件时使用邮件这个节点动作。可直接输入邮箱号，或者按照员工、部门、角色来选择，给接收人登记的邮箱发送邮件，也可以选择模型中的邮箱来发送邮件，若人员重复时只会发送一次邮件。填写主题，填写正文时可以调用当前流程中的一些模型字段的变量。 1.3 短信 发送短信需要在工作流-系统设置-短信模板中创建一个短信模板，阿里云模版新增需要一段时间审核，审核通过后就可以正常使用短信节点。短信的接收人与邮件的操作方式一致，之后选择短信模板，并且确定好变量的对应关系即可。
