写文章
  1. Oinone社区首页
  2. Oinone 7天入门到精通

3.2.1 构建第一个Module

史, 昂 • • Oinone 7天入门到精通 • 阅读 1985

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

一、后端工程脚手架

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

  1. 新建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脚本

  1. Linux/Unix/Mac 需要执行以下命令添加执行权限
chmod +x archetype-project-generate.sh

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

  1. 根据脚本中的注释修改项目变量（demo工程可无需编辑）
  2. 执行脚本
./archetype-project-generate.sh

二、后端工程结构介绍

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

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

3.2.1 构建第一个Module

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

  1. 工程结构说明
工程名 包名 说明
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的依赖管理

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

3.2.1 构建第一个Module

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

pamirs-domo-api

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

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

pamirs-demo-core

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

3.2.1 构建第一个Module

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

pamirs-demo-boot

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

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

3.2.1 构建第一个Module

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

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

3.2.1 构建第一个Module

图3-2-1-9 yml文件

四、DemoModule的定义

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

3.2.1 构建第一个Module

图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的启动

  1. 修改yml文件中数据源配置，数据库地址与密码修改为自己本地

  2. 配置license,否则启动会报错，获取授权文件请找官方客户

3.2.1 构建第一个Module

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

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

3.2.1 构建第一个Module

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

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

3.2.1 构建第一个Module

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

  1. 把模式变为INSTALL再次启动

3.2.1 构建第一个Module

3.2.1 构建第一个Module

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

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

3.2.1 构建第一个Module

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

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

    a. 创建一个demo项目

3.2.1 构建第一个Module

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

3.2.1 构建第一个Module

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

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

3.2.1 构建第一个Module

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

3.2.1 构建第一个Module

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

3.2.1 构建第一个Module

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

c. 创建一个请求 command+N

3.2.1 构建第一个Module

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

3.2.1 构建第一个Module

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

3.2.1 构建第一个Module

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

3.2.1 构建第一个Module

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

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

3.2.1 构建第一个Module

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

e. 查看schema 文档

3.2.1 构建第一个Module

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

3.2.1 构建第一个Module

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

3.2.1 构建第一个Module

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

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

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

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

赞 (0)
史, 昂的头像史, 昂数式管理员
0 0
上一篇 2024年5月23日 am9:54
下一篇 2024年5月23日

相关推荐

  • 业务审计

    整体介绍 业务审计是指通过跟踪用户在平台业务应用中的各类行为操作以及关联的数据变化，支撑企业业务审计所需。平台提供可视化审计规则配置，根据审计规则记录行为日志，其中日志包括登录日志、应用日志； 登录日志：记录平台用户登录行为。 应用日志：针对已订阅的审计规则记录用户操作信息，是用户在各应用中操作行为留痕记录。 审计规则：业务审计中，数据变化订阅记录的规则，是记录应用日志的规则。 操作入口：应用中心——业务审计应用。

    史, 昂的头像 史, 昂
    Oinone 7天入门到精通 2024年6月20日
    1.0K00
  • 2.4.3 Oinone独特性之低无一体 Oinone 7天入门到精通

    2.4.3 Oinone独特性之低无一体

    当今企业软件开发行业，低代码和无代码已经成为热门话题。它们的优势很明显：加速软件开发周期、减少代码开发时间、降低开发成本、易于维护等等。而 Oinone 作为一个低无一体的开发平台，更是在这些优势上做出了巨大的创新。 技术亮点 低代码-在不改变研发习惯的前提下，提升效率降低难度（如下图2-15所示） 一、提高专业开发人员效率 低代码开发模式大大降低了繁琐、重复的工作，模型定义完后，数据 API、数据管理器、基础管理的界面都不需要再进行开发。同时，低代码模式让分布式微服务架构的系统开发变得简单，研发人员不需要考虑分布式部署能力和大数据能力，也不需要去关心一些业务无关的通用能力，如权限、导入导出、国际化翻译、消息、审计等。这样，开发人员可以专注于业务研发，从而大幅提高开发效率。 二、提升系统扩展性 在研发标品的时候，低代码模式让开发人员不再需要关心系统的扩展性。与传统模式不同，低代码模式更加注重元数据的管理，这样就可以更好地保障系统扩展性。 三、保留研发人员习惯 Oinone 平台非常开放，满足开发人员的各种习惯，比如原有的 IDE 环境、熟悉的 Spring Boot 工程结构等。而且在 Oinone 的低代码模式下，研发人员还可以通过无代码方式，在线可视化地修改应用。这样，即使在使用低代码模式的情况下，开发人员也可以保留原有的习惯，提升开发效率。 四、提供更加开放的解决方案 Oinone 提供了非常开放的解决方案，让开发人员可以自由定制和组合各种功能。当行业出现特殊的功能需求时，开发人员可以整合成平台组件，并集成到应用中。Oinone的低代码模式具有高度的开放性和灵活性，这使得它在与其他低代码平台的比较中具有明显的优势。相比其他低代码平台，Oinone不会在无法满足特定需求的情况下限制开发人员的创造力（如下图2-16所示）。 图2-15 Oinone低代码特性介绍 图2-16 Oinone低代码的被集成特性示意图 无代码-五大设计器覆盖研发方方面面，让业务、实施也能参与 它是LCDP的产品化呈现，是冰山露在外面大家看得到的，核心还是在LCDP本身。这部分实时在演进迭代，如您有想体验最新版本，可以在Oinone官网：https://www.oinone.top注册。 设计器 说明 产品展示 模型设计器 1.以模型为驱动，当有模型、数据字典、数据编码等设计功能，我们就可以完整地定义产品数据模型，模型设计器默认整体呈现区别于普通ER图，以当前模型为核心视角展开，可以点击关联模型切换主视角。2.多种模式可切换：专家与经典切换，图与表模式的切换 界面设计器 1.界面设计器旨在帮助用户快速搭建页面；2.所见即所得和根据不同视图类型设计契合的搭建交互就变得尤为重要；3.多端页面设计能力。 流程设计器 1.为业务流程和审批流程提供可自动执行的流程模型，通过定义流转过程中的各个动作、规则，以此实现流程自动化；2.流程可以跨应用设计，不同应用的模型之间可以通过同一流程执行。 逻辑设计器 1.组件化、可视化逻辑编排，逻辑动态变更、动态管理，实施验证。 数据可视化 1.从内部系统模型获取数据内容后，根据业务需求自定义图表，目的是为企业提供更高效的数据分析工具；2.可以智取业务系统模型，系统自动解析选择的模型、接口、表格中的字段后进行数据分析；3.降低对数据分析人员的研发能力要求，提升数据分析的效率 表2-3 Oinone无代码-五大设计器简述 真正的低无一体，体现在一体化的融合能力上 在开发核心产品时，我们主要采用低代码开发，辅以无代码的开发方式。你可以参考我们的低代码开发基础入门教程中3.5.5【设计器的结合】的文章。 而在实施或者处理临时需求时，我们主要采用无代码的开发方式，低代码作为辅助。这种模式比较特殊，只在SaaS模式下提供。如果你发现某个客户个性化部分无法通过无代码设计器完成，我们提供了一个“低无一体”模块，可以反向生成API代码，生成对应的扩展工程和API依赖包，再由专业研发人员基于扩展工程，利用API包进行开发并上传至平台，可以参考关于7.4【Oinone的低无一体】的文章。 场景 融合形式 具体操作 标准产品以低代码开发为主，以无代码为辅助 标品开发时结合无代码设计器来完成页面开发，可以把设计后的页面元数据装载为标准产品的一部分。详细教程见：3.5.5【设计器的结合】一文 项目交付以无代码为主，以低代码为辅助 当有特殊需求设计器无法支持时，则可以通过低无一体应用的代码模式来完成。支持了两种使用模式：上传jar包模式、源码托管模式。详细教程见：7.4【Oinone的低无一体】一文 表2-4 不同场景适配方式说明 实现原理 本章节我们将从以下三个方面来解读Oinone的低无一体。 一：低无一体的设计原则及好处：真正的低无一体平台应该确保标准产品迭代与个性化保持独立，让软件企业具备为客户提供在线化的快速响应、个性化定制、持续更新等服务的能力，让企业客户能够真正自主做到敏捷响应和快速创新。所以Oinone的元数据融合方案跟其他平台有所区别（如下图2-17所示）。 图2-17 Oinone与其他平台的元数据融合对比图 二：低无一体中低与无的关系：无代码是低代码平台的图形化呈现，是低代码的一个子集，它将无限接近低代码的能力，同时也将成为低代码平台的必备特征，是通过低代码开发的标准产品的二开配套工具。 三：低无一体中低与无的定位：通过表2-3可以看出，低代码和无代码在Oinone的体系中相互融合，共同构成了一个完整的低无一体模式，提供更加开放、灵活和可扩展的解决方案，让用户能够更加轻松地完成开发和实施。 低代码模式 无代码模式 用户群体 专业研发 产品经理、需求分析师、直接业务人员 支撑场景 企业全场景软件以及二开 企业全场景软件以及二开，专业化场景比较高的则需低代码支持 核心能力 不改变研发习惯，提升研发效率 可视化编程无需专业编程语言知识 核心定位 开发标准模块 标准模块的二开无标品支撑场景的新模块开发 表2-3 Oinone低代码开发平台的两种开发模式对比

    史, 昂的头像 史, 昂
    2024年5月23日
    1.1K00
  • 流程 Oinone 7天入门到精通

    流程

    1. 流程介绍 日常工作和生活中到处都存在各种各样的流程，例如业务开展中的产品研发流程、产品制作流程、订单发货流程等，也有管控分险的费用报销流程、员工请假审批流程、项目立项流程等。流程设计器可以帮助公司实现流程的数字化，规范流程操作，减少人工操作并留存痕迹，提高工作效率和安全性。 2. 流程的组成 流程设计器主要包含基本操作和流程设计两个部分。前者包含了流程的新增、删除、复制、停用/启用、编辑、搜索。后者包含单一流程的基础信息修改、流程设计、参数配置、保存、发布。 2.1 流程的基本操作 流程页面有两种显示方式，默认为平铺显示的模式，可以点击切换为列表详情显示的模式。 2.1.1 新增 平铺显示和列表详情模式下点击左上角的创建按钮即可新增一个流程，点击后进入流程设计页面，流程名默认为“未命名流程”，可自行修改。 2.1.2 删除 遇到流程创建有误，没有使用过且将来也不会使用该流程，可以删除流程。需要注意的是，删除流程的前提是该流程已停用，并且该流程从未执行过。 2.1.3 复制 遇到流程节点动作相似度较高的情况可以使用复制流程的功能，点击按钮后生成一个“原流程名-复制”的流程，并且进入新流程的流程设计界面。 2.1.4 停用/启用 流程需要更新或暂时不用时可以使用停用功能。流程停用后将不会执行流程中的动作，正在执行中的流程不受停用影响，会正常执行直到流程结束。 点击启用按钮，流程恢复启用状态，可正常触发。 2.1.5 编辑 点击编辑进入该流程的设计页面。 2.1.6 搜索 页面最上方的是搜索区，可以按照流程名称、触发方式、启用状态、更新状态进行筛选搜素，点击重置按钮修改搜索条件。

    史, 昂的头像 史, 昂
    2024年1月20日
    97900
  • 文件 Oinone 7天入门到精通

    文件

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

    史, 昂的头像 史, 昂
    2024年6月20日
    86600
  • 4.2.3 框架之SPI机制 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日
    94200

Leave a Reply

登录后才能评论