3.2.1 构建第一个Module

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

所有环境准备就绪，就让我们踏上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天入门到精通

3.1.2 环境准备（windows版）

一、后端基础环境准备安装JDK1.8 ，高于1.8_221以上（下载地址见书籍【附件一】）打开Windows环境变量配置页此电脑 => 右键属性 => 系统高级设置 => 环境变量配置环境变量在用户环境变量中新建变量为JAVA_HOME的项,值为JDK安装之后的路径图3-1-27 新建环境变量JAVA_HOM 编辑变量为Path的项添加一个值%JAVA_HOME%\bin 图3-1-28 添加一个环境变量值%JAVA_HOME%\\bin PowerShell或者CMD中验证，输出类似信息为安装配置成功图3-1-29 验证JAVA是否安装成功安装 Apache Maven 3.8+ （下载地址见书籍【附件一】）删除Maven安装目录下的conf/settings.xml 配置mvn的settings，下载附件settings-open.xml，并重命名为settings.xml,建议直接放在【C:\Users\你的用户名.m2】下面。下载地址见oinone开源社区群公告，也可以联系oinone合作伙伴或服务人员配置环境变量在用户环境变量中新建变量为M2_HOME的项,值为Maven安装路径图3-1-30 新建变量M2_HOME 编辑变量为Path的项添加一个值%M2_HOME%\bin 图3-1-31 添加一个值%M2_HOME%\\bin 验证图3-1-32 验证Maven是否安装成功安装 Jetbrains IDEA （下载地址见书籍【附件一】）插件安装下载地址密码: mdji 如果IDEA安装了Lombok插件,请禁用Lombok插件点击菜单项File => Settings => Plugins 图3-1-33 插件管理页面操作示意下载插件包 (联系Oinone官方客服) 图3-1-35 操作指引图3-1-36 操作指引安装MySQL 8 （下载地址见书籍【附件一】）解压下载的ZIP安装包, 复制到自定义安装目录设置环境变量 MYSQL_BASE_DIR 提换成MySQL安装目录路径把 %MYSQL_BASE_DIR%\bin 加入到系统环境变量中在PowerShell中可以使用 Get-Command mysqld 命令验证环境变量是否配置成功，执行成功输出mysqld的所在路径初始化在命令行中执行 mysqld –initialize-insecure –user=mysql 安装 mysqld -install 启动MySQL服务 mysqld -install 设置root用户密码 alter user \’root\’@\’localhost\’ identified with mysql_native_password by \’oinone\’; flush privileges; 安装DB GUI工具 Datagrip、MySQLWorkbench、DBEaver 选其一 ### 安装Git （下载地址见书籍【附件一】）安装GraphQL测试工具Insomnia（下载地址见书籍【附件一】）安装RocketMQ（下载地址见书籍【附件一】）修改安装目录下bin中对应文件的默认配置 a. runserver.cmd文件内容 -Xms2g -Xmx2g为 -Xms1g -Xmx1g b. runbroker.cmd文件内容 -Xms2g -Xmx2g为 -Xms1g -Xmx1g，以及-XX:G1HeapRegionSize=1m 启动RocketMQ NameServer命令 RocketMQ安装目录\bin\mqnamesrv.cmd start 启动RocketMQ Broker命令 RocketMQ安装目录\bin\mqbroker.cmd -n localhost:9876 停止 RocketMQ命令 mqshutdown.cmd broker mqshutdown.cmd namesrv 安装ElasticSearch 版本 8.4.1（下载地址见书籍【附件一】）（非必须） ES运行时需要JDK18及以上版本JDK运行环境, ES安装包中包含了一个JDK18版本 set JAVA_HOME=ES安装路径\jdk 启动 ES安装路径\bin\elasticsearch.bat 停止 ctrl+c 或者关闭cmd、PowerShell的窗口安装Redis （下载地址见书籍【附件一】）解压安装包到安装目录在PowerShell进入到Redis安装目录在PowerShell中执行.\redis-server.exe，输出图中类似信息（如下图3-35所示）：图3-1-37 验证redis是否安装成功新开PowerShell窗口, 进入到Redis安装目录, 执行 .\redis-cli.exe回车，输入 ping 回车输出 PONG即表示Redis安装成功图3-1-38 验证redis是否安装成功 Zookeeper安装（下载地址见书籍【附件一】）解压安装, 在 PowerShell中执行 tar zxvf 安装包路径(tar.gz包) -C Zk安装目录进入 Zk安装目录\conf\ 复制 zoo_sample.cfg文件为 zoo.cfg 修改zoo.cfg文件的内容（其中dataDir需要自己设定） tickTime=2000…

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

第4章 Oinone的高级特性

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

4.1.6 模型之元数据详解

介绍Model相关元数据，以及对应代码注解方式。大家还是可以通读并练习每种不同的使用方式，这个是oinone的设计精华所在。当您不知道如何配置模型、字段、模型间的关系、以及枚举都可以到这里找到。一、模型元数据安装与更新使用@Model.model来配置模型的不可变更编码。模型一旦安装，无法在对该模型编码值进行修改，之后的模型配置更新会依据该编码进行查找并更新；如果仍然修改该注解的配置值，则系统会将该模型识别为新模型，存储模型会创建新的数据库表，而原表将会rename为废弃表。如果模型配置了@Base注解，表明在studio中该模型配置不可变更；如果字段配置了@Base注解，表明在studio中该字段配置不可变更。注解配置模型类必需使用@Model注解来标识当前类为模型类。可以使用@Model.model、@Fun注解模型的模型编码（也表示命名空间），先取@Model.model注解值，若为空则取@Fun注解值，若皆为空则取全限定类名。模型元信息模型的priority，当展示模型定义列表时，使用priority配置来对模型进行排序。模型的ordering，使用ordering属性来配置该模型的数据列表的默认排序。模型元信息继承形式：不继承（N）同编码以子模型为准（C）同编码以父模型为准（P）父子需保持一致，子模型可缺省（P=C）注意：模型上配置的索引和唯一索引不会继承，所以需要在子模型重新定义。数据表的表名、表备注和表编码最终以父模型配置为准；扩展继承父子模型字段编码一致时，数据表字段定义以父模型配置为准。名称描述抽象继承同表继承代理继承多表继承基本信息 displayName 显示名称 N N N N summary 描述摘要 N N N N label 数据标题 N N N N check 模型校验方法 N N N N rule 模型校验表达式 N N N N 模型编码 model 模型编码 N N N N 高级特性 name 技术名称 N N N N table 逻辑数据表名 N P=C P=C N type 模型类型 N N N N chain 是否是链式模型 N N N N index 索引 N N N N unique 唯一索引 N N N N managed 需要数据管理器 N N N N priority 优先级，默认100 N N N N ordering 模型查询数据排序 N N N N relationship 是否是多对多关系模型 N N N N inherited 多重继承 N N N N unInheritedFields 不从父类继承的字段 N N N N unInheritedFunctions 不从父类继承的函数 N N N N 高级特性-数据源 dsKey 数据源 N P=C P=C N 高级特性-持久化 logicDelete 是否逻辑删除 P P P N logicDeleteColumn 逻辑删除字段 P P P N logicDeleteValue 逻辑删除状态值 P P P N logicNotDeleteValue 非逻辑删除状态值 P P P N underCamel 字段是否驼峰下划线映射 P P P N capitalMode 字段是否大小写映射…

史, 昂
2024年5月23日
1.5K000
3.5.6 DSL配置大全（略）

因为默认视图很难满足客户的个性化需求，所以日常开发中view的配置是避免不了的。本系列篇是比较全面地介绍View配置的各个方面涉及：视图、字段、动作、布局等

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

第5章 Oinone的CDM

史, 昂
2024年5月23日
1.7K000

登录后才能评论

3.2.1 构建第一个Module

一、后端工程脚手架

二、后端工程结构介绍

三、pom.xml介绍

pamirs-domo-api

pamirs-demo-core

pamirs-demo-boot

四、DemoModule的定义

配置注解

配置扫描路径

命名规范

五、DemoModule的启动

相关推荐

3.1.2 环境准备（windows版）

第4章 Oinone的高级特性

4.1.6 模型之元数据详解

3.5.6 DSL配置大全（略）

第5章 Oinone的CDM

Leave a Reply