3.2.1 构建第一个Module

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

所有环境准备就绪，就让我们踏上oinone的奇妙之旅吧。先搞个demo模块【展示名为“oinone的Demo工程”，名称为“demoCore”，编码为“demo_core”】试试看，本节学习目的就是能把它启动起来，有个大概的认知。

一、后端工程脚手架

使用如下命令来利用项目脚手架生成启动工程：

新建archetype-project-generate.sh脚本，或者直接下载archetype-project-generate.sh

#!/bin/bash

# 项目生成脚手架
# 用于新项目的构建

# 脚手架使用目录
# 本地 local
# 本地脚手架信息存储路径 ~/.m2/repository/archetype-catalog.xml
archetypeCatalog=local

# 以下参数以pamirs-demo为例

# 新项目的groupId
groupId=pro.shushi.pamirs.demo

# 新项目的artifactId
artifactId=pamirs-demo

# 新项目的version
version=1.0.0-SNAPSHOT

# Java包名前缀
packagePrefix=pro.shushi

# Java包名后缀
packageSuffix=pamirs.demo

# 新项目的pamirs platform version
pamirsVersion=4.7.8

# Java类名称前缀
javaClassNamePrefix=Demo

# 项目名称 module.displayName
projectName=OinoneDemo

# 模块 MODULE_MODULE 常量
moduleModule=demo_core

# 模块 MODULE_NAME 常量
moduleName=DemoCore

# spring.application.name
applicationName=pamirs-demo

# tomcat server address
serverAddress=0.0.0.0

# tomcat server port
serverPort=8090

# redis host
redisHost=127.0.0.1

# redis port
redisPort=6379

# 数据库名
db=demo

# zookeeper connect string
zkConnectString=127.0.0.1:2181

# zookeeper rootPath
zkRootPath=/demo

mvn archetype:generate \
  -DinteractiveMode=false \
  -DarchetypeCatalog=${archetypeCatalog} \
  -DarchetypeGroupId=pro.shushi.pamirs.archetype \
  -DarchetypeArtifactId=pamirs-project-archetype \
  -DarchetypeVersion=${pamirsVersion} \
  -DgroupId=${groupId} \
  -DartifactId=${artifactId} \
  -Dversion=${version} \
  -DpamirsVersion=${pamirsVersion} \
  -Dpackage=${packagePrefix}.${packageSuffix} \
  -DpackagePrefix=${packagePrefix} \
  -DpackageSuffix=${packageSuffix} \
  -DjavaClassNamePrefix=${javaClassNamePrefix} \
  -DprojectName="${projectName}" \
  -DmoduleModule=${moduleModule} \
  -DmoduleName=${moduleName} \
  -DapplicationName=${applicationName} \
  -DserverAddress=${serverAddress} \
  -DserverPort=${serverPort} \
  -DredisHost=${redisHost} \
  -DredisPort=${redisPort} \
  -Ddb=${db} \
  -DzkConnectString=${zkConnectString} \
  -DzkRootPath=${zkRootPath}

图3-2-1-1 新建archetype-project-generate.sh脚本

Linux/Unix/Mac 需要执行以下命令添加执行权限

chmod +x archetype-project-generate.sh

图3-2-1-2 添加执行权限

根据脚本中的注释修改项目变量（demo工程可无需编辑）
执行脚本

./archetype-project-generate.sh

二、后端工程结构介绍

通过脚手架生成的demo工程是我们2.4.1【oinone独特性之单体与分布式的灵活切换】一文中介绍的单模块工程结构，属于入门级的一种，麻雀虽小五脏俱全，特别适合新手学习。

结构示意图（如下图3-2-4所示）

图3-2-1-4 结构示意图

工程结构说明

工程名	包名	说明
pamirs-demo-api		对外api包，如果有其他模块需要依赖demo模块，则可以在其pom中引入pamirs-demo-api包
	constant	常量的包路径
	enumeration	枚举类的包路径
	model	该领域核心模型的包路径
	service	该领域对外暴露接口api的包路径
	tmodel	存放该领域的非存储模型如：用于传输的临时模型
	DemoModule	该类是Demo模块的定义
pamirs-demo-boot		demo模块的启动类
	boot	启动类的包路径
	DemoApplication	Demo模块的应用启动类，遵循spring boot 规范
	resources/config/application-dev.yml	研发环境的yml配置文件，遵循spring boot 规范
	resources/bootstrap.yml	启动的yml配置文件，遵循spring boot 规范
pamirs-demo-core
	action	模型对外交互的行为的包路径
	init	模块初始化工作的包路径
	manager	manager是 service的一些公共逻辑，不会定义为独立的function的类
	service	service是对应api工程中service接口的实现类，是模型的function

表3-2-1-1 工程结构说明

三、pom.xml介绍

父pom的依赖管理

一个是启动包依赖
a. pamirs-boot里是有我们多种启动模式依赖包。教程只介绍标准启动模式
b. pamirs-base-standard

图3-2-1-5 父pom的依赖管理

pamirs-domo-api

一个标准java工程，可以看出只是依赖了，我们的pamirs-base-standard

图3-2-1-6 pamirs-domo-api

pamirs-demo-core

一个标准java工程，可以看出只是依赖了，我们的pamirs-demo-api

图3-2-1-7 pamirs-domo-core

pamirs-demo-boot

把启动的时候，需要启动的module（模块）对应的jar，进行依赖引入。这样就可以在我们的yml文件中进行启动module的配置

所需module（模块）对应的jar（如下图3-2-8所示）

图3-2-1-8 所需module（模块）对应的jar包依赖

yml文件基础配置，boot工程的yml配置详见4.1.1【模块之yml文件结构详解】一文

图3-2-1-9 yml文件

四、DemoModule的定义

到此我们一个oinone中的一个module对应的工程就介绍完了。到目前为止跟一般的spring boot的工程没有太多区别，就多做了一个DemoModule的定义，oinone的所有Module都继承自PamirsModule。

图3-2-1-10 DemoModule的定义

配置注解

通过@Module的name属性配置模块技术名称，前端与后端交互协议使用模块技术名称来定位模块。

通过@Module的displayName属性配置模块展示名称，在产品视觉交互层展现。

通过@Module的version属性配置模块版本，系统会比较版本号来决定模块是否需要进行升级。

通过@Module的priority属性配置模块优先级（数字越小，优先级越高），系统会根据优先级取优先级最高的应用设置的首页来作为整个平台的首页。

通过@Module的dependencies属性和exclusions属性来配置模块间的依赖互斥关系，值为模块编码数组。如果模块继承了另一模块的模型或者与另一模块的模型建立了关联关系，则需要为该模块的依赖模块列表配置另一模块的模块编码。

通过@Module.module配置模块编码，模块编码是模块在系统中的唯一标识。

通过@Module.Advanced的selfBuilt属性配置模块是否为平台自建模块。

通过@Module.Advanced的application属性配置模块是否为应用（具有视觉交互页面的模块）。模块切换组件只能查看到应用。

通过@UxHomepage注解配置首页。@UxHomepage注解的model属性指定跳转页面的模型编码，name属性指定跳转页面的视图动作，默认为列表页。如果配置首页为列表页且未定义ViewAction，系统会根据首页配置自动生成。

更多Module的详细元数据描述，详见4.1.4【模块元数据详解】一文

配置扫描路径

设置扫描模型配置的包路径：

使用packagePrefix方法来配置模块需要扫描模型配置的包路径
使用dependentPackagePrefix方法来配置依赖模块的模型配置的包路径；如果不配置，会默认根据依赖模块的配置扫描模型配置的包路径扫描依赖模型
不同模块包路径包含会导致模型加载模块出问题

命名规范

属性	默认取值规则	命名规范
module	无默认值开发人员定义规范示例： {项目名称}_{模块功能示意名称}	使用下划线命名法仅支持数字、大写或小写字母、下划线必须以字母开头不能以下划线结尾长度必须小于等于128个字符
name	无默认值	使用大驼峰命名法仅支持数字、字母必须以字母开头长度必须小于等于128个字符

表3-2-1-2 命名规范

五、DemoModule的启动

修改yml文件中数据源配置，数据库地址与密码修改为自己本地
配置license,否则启动会报错，获取授权文件请找官方客户

图3-2-1-11 license未配置

需要为启动或依赖模块配置扫描路径，配置扫描路径：pmairs是我们的oinone的基础包（必选），himalaya，tanggula是我们的业务模型基础包（可选），pro.shushi.pamirs.demo是我们测试项目包路径（必选，只不过它也在pamirs路径下，不填也不错)

图3-2-1-12 扫描逻辑配置

启动应用，我们会发现会报错。这个错误主要因为Oinone默认的是RELOAD（重启）模式，这种模式下只会从数据库中读取已安装模块并与yml文件中配置需要加载的模块对比。如果数据库中没有则会报没有安装过**模块，而我们是第一次启动，前面必然没有安装过模块，所以我们要把模式变为INSTALL，启动参数详见4.1.2【模块之启动指令】一文。如果整个平台第一次启动则回报 'base_sequence_config' doesn't exist

图3-2-1-13 启动应用的报错提示

把模式变为INSTALL再次启动

图3-2-1-14 把模式变为INSTALL再次启动

查看日志，看到对应启动字样才代表启动完成，而非Spring Boot的启动完成日志。我们的oinone的启动是在Spring Boot 启动完以后异步启动的

图3-2-1-15 启动成功日志

打开GraphQL客户端Insomnia看对应服务是否暴露

a. 创建一个demo项目

图3-2-1-16 Insomnia操作示意-创建一个新项目

图3-2-1-17 Insomnia操作示意-命名为demo

b. 为demo项目创建一个请求集合

图3-2-1-18 Insomnia操作示意-创建一个请求集合（第一步）

图3-2-1-19 Insomnia操作示意-创建一个请求集合（第二步）

图3-2-1-20 Insomnia操作示意-创建一个请求集合（第三步）

c. 创建一个请求 command+N

图3-2-1-21 Insomnia操作示意-创建一个请求

图3-2-1-22 Insomnia操作示意-选POST模式

图3-2-1-23 Insomnia操作示意-输入服务地址

图3-2-1-24 Insomnia操作示意-切换body结构为GQL

d. 检验结果，对应后端提供的服务已经有提示了

图3-2-1-25 Insomnia操作示意-检验结果

e. 查看schema 文档

图3-2-1-26 Insomnia操作示意-查看API文档

图3-2-1-27 Insomnia操作示意-查看API文档

图3-2-1-28 Insomnia操作示意-查看API文档

恭喜第一个oinone的模块已经启动完成，在下一文中我们通过页面来看看oinone的系统的庐山真面目。

Oinone社区作者：史, 昂原创文章，如若转载，请注明出处：https://doc.oinone.top/oio4/9228.html

访问Oinone官网:https://www.oinone.top获取数式Oinone低代码应用平台体验

Oinone 7天从入门到精通

史, 昂数式管理员

0 0

3.2.2 启动前端工程

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

3.2 Oinone以模块为组织

下一篇 2024年5月23日

高级视图

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

3.5.6.4 动作的配置

在3.5.3【Action的类型】一文中，我们介绍Action的几种类型，以及组合动作。通用配置配置项可选值默认值作用 name 动作名称 label 显示名称 icon 图标 type primary defaultlink primary 按钮类型样式，支持主要样式、次要样式以及链接样式。 bizStyle defaultsuccesswarningdangerinfo default 按钮业务样式，支持成功（green）、警告（yellow）、危险（red）、信息（grey）四种样式。 invisible truefalse condition false 展示规则，有简单的true/false显隐，也支持复杂的表达式 disabled truefalse condition 根据动作上下文类型进行自动推断是否禁用自动推断规则：当上下文类型为【单行】时，相当于使用表达式LIST_COUNT(context.activeRecords) != 1当上下文类型为【多行】时，相当于使用表达式LIST_COUNT(context.activeRecords) <= 1当上下文类型为【单行或多行】时，相当于使用表达式LIST_COUNT(context.activeRecords) == 0 disabledTitle string 根据动作上下文类型进行自动推断禁用悬浮提示表3-5-6-12 动作通用配置二次确认配置二次确认框默认支持两种模式，对话框和气泡框；对话框图3-5-6-51 对话框提示气泡框图3-5-6-52 气泡框警告配置项配置项可选值默认值作用备注 confirm string 二次确认提示文字配置后开启二次确认 confirmType POPPER（气泡提示框） MODAL（对话框） POPPER 确认框类型 confirmPosition TM（按钮上方） BM（按钮下方） LM（按钮左侧） RM（按钮右侧） BM 确认框位置气泡框该配置生效 enterText 确定确定按钮文字 cancelText 取消取消按钮文字表3-5-6-13 配置项弹出层动作配置（窗口动作ViewAction）目前平台对于弹出层支持了两种展示形式。弹窗（modal/dialog）和抽屉（drawer）支持两种配置方式【内嵌视图配置】和【引用已有页面】，内嵌视图配置优先于引用已有页面。内嵌视图配置该配置对于弹窗和抽屉均适用。 <action name="窗口动作名称" label="创建"> <view model="模型编码" type="form"> <template slot="form" widget="form"> <field data="id" invisible="true" /> <field data="code" label="编码" widget="Input" /> <field data="name" label="名称" widget="Input" /> </template> <template slot="footer"> <action name="$$internal_DialogCancel" label="关闭" type="default" /> <action name="create" label="确定" /> </template> </view> </action> 图3-5-6-53 内嵌视图配置引用已有页面配置该配置对于弹窗和抽屉均适用。 <view model="模型编码" type="form"> <template slot="form" widget="form"> <field data="id" invisible="true" /> <field data="code" label="编码" widget="Input" /> <field data="name" label="名称" widget="Input" /> </template> <template slot="footer"> <action name="$$internal_DialogCancel" label="关闭" type="default" /> <action name="create" label="确定" /> </template> </view> 图3-5-6-54 引用已有页面示例 <action name="窗口动作名称" label="创建" resViewName="$viewName$" /> 图3-5-6-55 引用已有页面弹窗当窗口动作的路由方式（target）为dialog时，内嵌视图/引用页面将以弹窗形式展示在页面上。配置项配置项可选值默认值作用 title…

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

工作台

有工作台权限的用户，默认登录页为工作台，也可以通过APP Finder进入工作台。 1. 快捷处理右上角消息中会气泡展示未处理或未读的操作，点击展开后可以点过去进行快捷处理。 2. 查看、处理流程 2.1 流程查看流程管理页面共同点： 1包含选项分类筛选 2包含标签筛选 3包含应用下拉选筛选 4包含根据流程名称搜素流程管理页面名词解释：待办：当前登录用户未处理的流程节点我发起的：当前登录用户人为触发的流程（模型触发）抄送：抄送给当前登录用户的节点（审批/填写）我已办结：由当前登录用户完成人工/自动同意、人工拒绝或人工填写的节点无需办理：当前登录用户转交的任务/被退回、被撤销、被或签、被其他分支任务拒绝的还未办理的任务站内信：当前登录用户收到的站内信 2.2 流程处理每条流程数据下方有动作，点击进入流程处理页面，大致分为详情页和操作页。待办中点击“审批/填写”会进入流程操作页。审批操作页可能包含“同意、拒绝、退回、加签、转交、返回”，填写操作页可能包含“提交、暂存”，审批操作页包含哪些动作由流程设计决定。我发起的、抄送、我已办结、无需处理点击“查看”会进入流程详情页。 3. 应用快捷入口应用中心中星标的收藏应用会展示在此处，点击可快捷进入应用。应用中心中已安装的应用点击星标即可收藏。

史, 昂
2024年6月20日
725000
3.4 Oinone以函数为内在

函数（Function）：是oinone可管理的执行逻辑单元，跟模型绑定则对应模型的方法描述满足数学领域函数定义，含有三个要素：定义域A、值域C{f（x），x属于A}和对应法则f。其中核心是对应法则f，它是函数关系的本质特征满足面向对象原则，可设置不同开放级别，本地与远程智能切换。本章会带大家更加详细地了解Function的方方面面，主要以几下几个维度构建第一个Function 函数的开放级别与类型函数的相关特性函数元数据详解

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

文件

文件应用下包含“导入/导出模版、导入任务、导出任务”三个菜单。其中导入/导出任务菜单比较常用。导入/导出模版当前版本会为租户的表格视图自动创建导出模版，此处可进行编辑、查看详情的操作。导入任务导入任务可以下载导入文档，点击详情可以查看该条记录的导入结果，任务信息分组中可以查看错误信息。导出任务和导入任务一致，导出任务菜单中可以下载导出文档，点击详情可以查看该条记录的导出结果，任务信息分组中可以查看错误信息。

史, 昂
2024年6月20日
885000

登录后才能评论