3.2.1 构建第一个Module

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

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

Like (0)

史, 昂数式管理员

0 0

3.2.2 启动前端工程

Previous 2024年5月23日 am9:54

3.2 Oinone以模块为组织

Next 2024年5月23日

Oinone 7天入门到精通

特别说明

教材进度目前还在编写整改中，特别是目录上带（改）字样的本版本教材针对4.0，相对3.0增加的特性有：通用能力部分：比如权限、审计、国际化、系统配置、集成可视化等新版权限：交互优化，同时支持子管理员新版审计，支持在线配置审计规则系统配置，提供多种风格，让伙伴基础风格不在需要自定义主题和组件新增集成设计器，通过连接器让应用api和数据库集成资产化管理，通过数据流进行接口逻辑编排，并提供统一的开放平台设计器部分：加强界面设计器部分对移动端、主题、自定义组件等支持，同时完善对数据管理操作、增加各类常用业务组件，加强对树形与及联的支持，表格视图搜索优化流程设计器增加：审批员选择自定义逻辑、转交人选择自定义逻辑，支持手工触发、支持数据事务、支持调用模型函数可视化设计器：增加自定义图表功能、增强下钻能力模块管理：增加新增、多端配置等支持内核机制：性能优化：通过gql层面解决业务研发过程中1+N性能问题，权限性能优化，分布式缓存性能优化，整体性能提升2倍以上针对多租户应用无状态的支持，低无一体支持本地调试 5.0的核心新特性预告，特性会在开发过程中陆续推出供大家体验，但完整体验时间为2024年6月份新增打印设计功能导出的默认交互增强以及导入导出模版设计默认导入导出在交互时可以指定字段导入导出模版可图形化设计多模型AI集成设计器器自定义组件、自定义图表交互友好性增强自定义组件，属性面板设计模版化，解决设计组件属性面板的时候不知道有哪些默认属性。增强组件与动作的结合灵活性组件增加是否有子组件的通用属性，有子组件的组件具备组件拖拽区增强UX注解能力，原本只有设计器支持的，后端UX注解也进行对应支持后端低无一体功能开放（原本该功能只在saas版本上提供），方便咱们做应急和简单应用的时，以无代码为主，低代码为辅的模式。通过低无一体可以通过低代码的方式来解决无代码无法支撑的功能。工作流增强增加循环审批节点增加分支汇集节点增强并行流程能力，比如分支汇集节点可以设置：所有并行节点处理完或只要一条处理完就继续执行。

史, 昂
2024年5月23日
2.3K001
4.5 研发辅助

这里都是一些提升研发效率的小工具

史, 昂
Oinone 7天入门到精通 2024年5月23日
1.6K000
3.3 Oinone以模型为驱动

模型（model）：Oinone一切从模型出发，是数据及对行为的载体：是对所需要描述的实体进行必要的简化，并用适当的变现形式或规则把它的主要特征描述出来所得到的系统模仿品。模型由元信息、字段、数据管理器和自定义函数构成；符合面向对象设计原则包括：封装、继承、多态。本章会带大家快速而全方位地认识Oinone的模型。会从以下几个维度去对模型展开详细介绍。构建第一个Model 模型的类型模型的数据管理器模型的继承模型编码生成器枚举与数据字典字段序列化方式字段类型之基础与复合字段类型之关系与引用

史, 昂
Oinone 7天入门到精通 2024年5月23日
1.6K000
4.1.13 Action之校验

在3.5.3【Action的类型】一文中有涉及到“ServerAction之校验”部分，本文介绍一个特殊的写法，当内置函数和表达式不够用的时候，怎么扩展。还是拿PetShopProxyAction举例，修改如下： package pro.shushi.pamirs.demo.core.action; ……引依赖类 @Model.model(PetShopProxy.MODEL_MODEL) @Component public class PetShopProxyAction extends DataStatusBehavior<PetShopProxy> { ……其他代码 // @Validation(ruleWithTips = { // @Validation.Rule(value = "!IS_BLANK(data.code)", error = "编码为必填项"), // @Validation.Rule(value = "LEN(data.shopName) < 128", error = "名称过长，不能超过128位"), // }) @Validation(check = "checkName") @Action(displayName = "启用") @Action.Advanced(rule="activeRecord.code !== undefined && !IS_BLANK(activeRecord.code)") public PetShopProxy dataStatusEnable(PetShopProxy data){ data = super.dataStatusEnable(data); data.updateById(); return data; } @Function public Boolean checkName(PetShopProxy data) { String field = "name"; String name = data.getShopName(); boolean success = true; if (StringUtils.isBlank(name)) { PamirsSession.getMessageHub() .msg(Message.init() .setLevel(InformationLevelEnum.ERROR) .setField(field) .setMessage("名称为必填项")); success = false; } if (name.length() > 128) { PamirsSession.getMessageHub() .msg(Message.init() .setLevel(InformationLevelEnum.ERROR) .setField(field) .setMessage("名称过长，不能超过128位")); success = false; } return success; } ……其他代码 } 图4-1-13-1 PetShopProxyAction扩展配置注： check属性指定了校验函数名称，命名空间必须与服务器动作一致。校验函数的入参必须与服务器动作一致使用PamirsSession#getMessageHub方法可通知前端错误的属性及需要展示的提示信息，允许多个。

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

4.2.3 框架之SPI机制

SPI(Service Provider Interface)服务提供接口，是一套用来被第三方实现或者扩展的API，它可以用来启用框架扩展和替换组件，简单来说就是用来解耦，实现组件的自由插拔，这样我们就能在平台提供的基础组件外扩展新组件或覆盖平台组件。目前定义SPI组件 ViewWidget 视图组件 FieldWidget 字段组件 ActionWidget 动作组件表4-2-3-1 目前定义SPI组件前提知识点使用 TypeScript 装饰器(注解)装饰你的代码 1. 通过注解定义一种SPI接口(Interface) @SPI.Base<IViewFilterOptions, IView>('View', ['id', 'name', 'type', 'model', 'widget']) export abstract class ViewWidget<ViewData = any> extends DslNodeWidget { } 图4-2-3-1 代码示意 2. 通过注解注册提供View类型接口的一个或多个实现 @SPI.Base<IViewFilterOptions, IView>('View', ['id', 'name', 'type', 'model', 'widget']) export abstract class ViewWidget<ViewData = any> extends DslNodeWidget { } 图4-2-3-2 代码示意 3. 视图的xml内通过配置来调用已定义的一种SPI组件 <view widget="form" model="demo.shop"> <field name="id" /> </view> 图4-2-3-3 代码示意图4-2-3-4 组件继承示意图当有多个服务提供方时，按以下规则匹配出最符合条件的服务提供方 SPI匹配规则 SPI组件没有严格的按匹配选项属性限定，而是一个匹配规则按widget最优先匹配，配置了widget等于是指定了需要调用哪个widget，此时其他属性直接忽略按最大匹配原则（匹配到的属性越多优先级越高）按后注册优先原则

史, 昂
2024年5月23日
1.9K000

Please Login to Comment

3.2.1 构建第一个Module

一、后端工程脚手架

二、后端工程结构介绍

三、pom.xml介绍

pamirs-domo-api

pamirs-demo-core

pamirs-demo-boot

四、DemoModule的定义

配置注解

配置扫描路径

命名规范

五、DemoModule的启动

相关推荐

特别说明

4.5 研发辅助

3.3 Oinone以模型为驱动

4.1.13 Action之校验

4.2.3 框架之SPI机制

Leave a Reply