介绍Module相关元数据,以及对应代码注解方式。大家还是可以通读下,以备不时之需
如您还不了解Module的定义,可以先看下2.3【oinone独特之源,元数据与设计原则】一文对Module的描述,本节主要带大家了解Module元数据构成,能让小伙伴非常清楚oinone从哪些维度来描述Module,
一、元数据说明
ModuleDefinition
元素数据构成 | 含义 | 对应注解 | 备注 |
---|---|---|---|
displayName | 显示名称 |
@Module( displayName=””, name=””, version=””, category=””, summary=””, dependencies={“”,””}, exclusions={“”,””}, priority=1L ) |
|
name | 技术名称 | ||
latestVersion | 安装版本 | ||
category | 分类编码 | ||
summary | 描述摘要 | ||
moduleDependencies | 依赖模块编码列表 | ||
moduleExclusions | 互斥模块编码列表 | ||
priority | 排序 | ||
module | 模块编码 | @Module.module(“”) | |
dsKey | 逻辑数据源名 | @Module.Ds(“”) | |
excludeHooks | 排除拦截器列表 | @Module.Hook(excludes={“”,””}) | |
website | 站点 |
@Module.Advanced( website=”http://www.oinone.top”, author=”oinone”, description=”oinone”, application=false, demo=false, web=false, toBuy=false, selfBuilt=true, license=SoftwareLicenseEnum.PEEL1, maintainer=”oinone”, contributors=”oinone”, url=”http://git.com” ) |
|
author | module的作者 | ||
description | 描述 | ||
application | 是否应用 | ||
demo | 是否演示应用 | ||
web | 是否web应用 | ||
toBuy | 是否需要跳转到website去购买 | ||
selfBuilt | 自建应用 | ||
license | 许可证 |
默认PEEL1 可选范围: GPL2 GPL2ORLATER GPL3 GPL3ORLATER AGPL3 LGPL3 ORTHEROSI PEEL1 PPL1 ORTHERPROPRIETARY |
|
maintainer | 维护者 | ||
contributors | 贡献者列表 | ||
url | 代码库的地址 | ||
boot | 是否自动安装的引导启动项 |
@Boot 加上该注解代表: 启动时会自动安装,不管yml文件的modules是否配置 |
|
moduleClazz | 模块定义所在类 | 只有用代码编写的模块才有 | |
packagePrefix | 包路径,用于扫描该模块下的其他元数据 | ||
dependentPackagePrefix | 依赖模块列对应的扫描路径 | ||
state | 状态 | 系统自动计算,无需配置 | |
metaSource | 元数据来源 | ||
publishCount | 发布总次数 | ||
platformVersion | 最新平台版本 | 本地与中心平台的版本对应。做远程更新时会用到 | |
publishedVersion | 最新发布版本 |
表4-1-4-1 ModuleDefinition
UeModule
是对ModuleDefinition的继承,并扩展了跟前端交互相关的元数据
元素数据构成 | 含义 | 对应注解 | 备注 |
---|---|---|---|
homePage Model | 跳转模型编码 | @UxHomepage( @UxRoute( ) |
对应一个ViewAction,如果UxRoute只配置了模型,则默认到该模型的列表页 |
homePage Name | 视图动作或者链接动作名称 | ||
logo | 图标 | @UxAppLogo(logo=””) |
表4-1-4-2 UeModule
二、元数据,代码注解方式
Module
Module
├── displayName 显示名称
├── name 技术名称
├── version 安装版本
├── category 分类编码
├── summary 描述摘要
├── dependencies 依赖模块编码列表
├── exclusions 互斥模块编码列表
├── priority 排序
├── module 模块编码
│ └── value
├── Ds 逻辑数据源名
│ └── value
├── Hook 排除拦截器列表
│ └── excludes
├── Advanced 更多配置
│ ├── website 站点
│ ├── author 作者
│ ├── description 描述
│ ├── application 是否为应用
│ ├── demo 是否演示应用
│ ├── web 是否web应用
│ ├── toBuy 是否需要跳转到website去购买
│ ├── selfBuilt 是否自建应用
│ ├── license 许可证,枚举默认:PEEL1
│ ├── maintainer 维护者
│ ├── contributors 贡献者
│ └── url 代码库地址
相关Ux注解
与模块相关的交互类注解
UxHomepage
UxHomepage 模块主页
└── UxRoute
UxAppLogo
UxAppLogo
└── logo 图标
Oinone社区 作者:史, 昂原创文章,如若转载,请注明出处:https://doc.oinone.top/oio4/9279.html
访问Oinone官网:https://www.oinone.top获取数式Oinone低代码应用平台体验