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

3.3.1 构建第一个Model

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

定义模型，并配上相应的菜单或配置模块的homepage为该模型，模块就具备了可访问的该模型对应的列表页、新增页、修改页、删除记录和导入导出功能。

都说oinone是以model为驱动，对于模型的理解，希望通过本节跟给大家带来一个初步的认识。

一、构建宠物店铺模型

package pro.shushi.pamirs.demo.api.model;

import pro.shushi.pamirs.meta.annotation.Field;
import pro.shushi.pamirs.meta.annotation.Model;
import pro.shushi.pamirs.meta.base.IdModel;

import java.sql.Time;

@Model.model(PetShop.MODEL_MODEL)
@Model(displayName = "宠物店铺",summary="宠物店铺")
public class PetShop extends IdModel {
    public static final String MODEL_MODEL="demo.PetShop";

    @Field(displayName = "店铺名称",required = true)
    private String shopName;

    @Field(displayName = "开店时间",required = true)
    private Time openTime;

    @Field(displayName = "闭店时间",required = true)
    private Time closeTime;
}

图3-3-1-1 构建宠物店铺模型

配置注解

模型类必需使用@Model注解来标识当前类为模型类。

可以使用@Model.model、@Fun注解模型的模型编码（也表示命名空间），先取@Model.model注解值，若为空则取@Fun注解值，若皆为空则取全限定类名。

使用@Model.model注解配置模型编码，模型编码唯一标识一个模型。

请勿使用Query和Mutation作为模型编码和技术名称的结尾。

上方示例使用Model注解和Field注解来定义一个实体模型。displayName属性最终会作为label展现在前端界面上。

更多Model的详细元数据描述介绍参见4.1.6【模型元数据详解】一文

模型命名规范

模型属性 默认取值规范 命名规则规范
name 默认取model.model的点分割最后一位 1仅支持数字、字母2必须以字母开头3长度必须小于等于128个字符
module 无默认值开发人员定义规范示例：{项目名称}_{模块功能示意名称} 1仅支持数字、大写或小写字母、下划线2必须以字母开头3不能以下划线结尾4长度必须小于等于128个字符
model 默认使用全类名，取lname的值开发人员定义规范示例：{项目名称}.{模块功能示意名称}.{简单类名} 1仅支持数字、字母、点2必须以字母开头3不能以点结尾4长度必须小于等于128个字符
display_name 空字符串 1长度必须小于等于128个字符
lname 符合java命名规范，真实的java全类名，无法指定，要符合model的约束，即为包名+类名 lname是不能定义的，为全类名：包名+类名，和model一样的校验规则：包名和类名的校验
summary 默认使用displayName属性 1不能使用分号2长度必须小于等于128个字符
descripition NULL，注解无法定义 1长度必须小于等于65535个字符
table 默认使用name字段生成表名时，table字段的命名规则约束同样生效（大小驼峰命名转为下划线分割的表名称） 1仅支持数字、字母、下划线2长度必须小于等于128个字符（此限制为系统存储约束，与数据库本身无关）
type java属性类型与数据库存储类型可执行转换即可 ModelTypeEnum枚举值

表3-3-1-1 模型命名规范

字段命名规范

字段属性 默认取值规范 命名规则规范
name 默认使用java属性名 1仅支持数字、字母2必须以小写字母开头3长度必须小于等于128个字符
field 默认使用java属性名 与name使用相同命名规则约束
display_name 默认使用name属性 1长度必须小于等于128个字符
lname 使用java属性名，符合java命名规范，真实的属性名称，无法指定 与name使用相同命名规则约束
column 列名为属性名的小驼峰转下划线格式 1仅支持数字、字母、下划线2长度必须小于等于128个字符（此限制为系统存储约束，与数据库本身无关）
summary 默认使用displayName属性 1不能使用分号2长度必须小于等于500个字符

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

我们重启Demo应用以后，打开Insomnia刷新GraphQL的schema，就可以看到PetShop默认对应的读写服务了

3.3.1 构建第一个Model

图3-3-1-2 PetShopQuery默认读写服务

3.3.1 构建第一个Model

图3-3-1-3 PetShopMutatiom默认读写服务

配置模块的主页为宠物商店的列表页

为了方便大家对模型有个更加直观的了解，接下来我们通过前端交互来感受下。

在3.2.2【启动前端工程】一文中，在模块下拉列表中“oinoneDemo工程”还是不能点击的。是因为该模块没有配置主页，我们现在把主页设置为宠物商店的列表页，只需要在DemoModule这个类上增加一个注解@UxHomepage(@UxRoute(PetShop.MODEL_MODEL))，关于该注解的更多说明请查看4.1.4一文中的【UxHomepage注解详解】部分

package pro.shushi.pamirs.demo.api;

import org.springframework.stereotype.Component;
import pro.shushi.pamirs.boot.base.ux.annotation.action.UxRoute;
import pro.shushi.pamirs.boot.base.ux.annotation.navigator.UxHomepage;
import pro.shushi.pamirs.demo.api.model.PetShop;
import pro.shushi.pamirs.meta.annotation.Module;
import pro.shushi.pamirs.meta.base.PamirsModule;
import pro.shushi.pamirs.meta.common.constants.ModuleConstants;

@Component
@Module(
        name = DemoModule.MODULE_NAME,
        displayName = "oinoneDemo工程",
        version = "1.0.0",
        dependencies = {ModuleConstants.MODULE_BASE}
)
@Module.module(DemoModule.MODULE_MODULE)
@Module.Advanced(selfBuilt = true, application = true)
@UxHomepage(@UxRoute(PetShop.MODEL_MODEL))
public class DemoModule implements PamirsModule {
    public static final String MODULE_MODULE = "demo_core";
    public static final String MODULE_NAME = "DemoCore";

    @Override
    public String[] packagePrefix() {
        return new String[]{"pro.shushi.pamirs.demo"};
    }
}

图3-3-1-4 “OinoneDemo工程”主页配置

重启demo应用，打开前端页面登陆后并通过App Finder切换至“oinoneDemo工程”，我们跟着下面操作一步一步来体验下。

  1. 在App Finder 的应用列表选中【oinoneDemo工程】，我们会看到系统进入了【宠物商店列表】

3.3.1 构建第一个Model

图3-3-1-5 切换应用“OinoneDemo工程”

3.3.1 构建第一个Model

图3-3-1-6 进入了宠物商店列表

  1. 点击【宠物商店列表】页面中【新增】按钮进入【宠物商店的新增页面】

3.3.1 构建第一个Model

图3-3-1-7 进入宠物商店的新增页面

  1. 点击【宠物商店的新增页面】的确定按钮，回到【宠物商店列表】，并能看到刚刚新增的记录

3.3.1 构建第一个Model

图3-3-1-8 新增记录产生

  1. 对【宠物商店列表】的数据记录可以进行【编辑】、【详情】操作。如点击【编辑】则进入数据记录的【宠物商店数据记录的编辑页】

3.3.1 构建第一个Model

图3-3-1-9 宠物商店数据记录的编辑页

查看数据库

大家可能会问我们的数据存储哪里去了？

我们这个demo应用一共生成了两个库包括demo和demo_base,分别对应yml文件两个数据源pamirs和base，base库存放系统元数据，pamirs库存放了demo模块以及其他安装模块的数据

3.3.1 构建第一个Model

图3-3-1-10 在demo库中查看数据表

那我们来找到demo库，就可以看到有一个demo_core_pet_shop表以及我们新增的数据

3.3.1 构建第一个Model

图3-3-1-11 在demo库中查看数据表

库、表的规则是boot工程里的yml文件配置的，如何配置可以参考4.1.1【模块之yml文件结构详解】一文

定义模型，并配上相应的菜单或配置模块的homepage为该模型，模块就具备了可访问的该模型对应的列表页、新增页、修改页、删除记录和导入导出功能。是不是上手还是比较容易的，本节学习就先到这里。

注：本节中的所有页面都是系统默认的，更多有关前端交互包括菜单、页面、行为知识可以在3.5【oinone以交互为外在】一章中详细学习。

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

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

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

相关推荐

  • 产品使用手册（改）

    史, 昂的头像 史, 昂
    Oinone 7天入门到精通 2024年5月23日
    1.2K00
  • 1.2 Oinone的致敬 Oinone 7天入门到精通

    1.2 Oinone的致敬

    占在巨人的肩膀上，天地孤影任我行 1.2.1 数字化时代Oinone接棒Odoo 在数字化时代，中国在互联网化的应用、技术的领先毋庸置疑，但在软件的工程化、产品化输出方面仍有许多改进的空间。这时，我了解到了Odoo——一个国外非常优秀的开源ERP厂商，全球ERP用户数量排名第一，百级别员工服务全球客户。Odoo的工程化能力和商业模式深深吸引了我，它是软件行业典型的产品制胜和长期主义者的胜利之一。 在2019年，也就是数式刚成立的时候，我们跟很多投资人聊起公司的对标是谁，我不是要成为数字化时代的SAP，而是要成为Odoo。然而，当时大部分国内投资人并不了解Odoo，尽管它已经是全球最大的ERP厂商之一，因为当时Odoo还没有明确的估值。直到2021年7月份获得Summit Partners的2.15亿美元投资后，Odoo才正式成为IT独角兽企业。 Odoo对我们提供了极大的启示，因此我们致敬Odoo，同样选择开源，每年对产品进行升级发布。如今，Odoo15已经发布，而Oinone也已推出第三版，恰好相隔12年，这是一个时代的接棒，从信息化升迁至数字化。 1.2.2Oinone与Odoo的不同之处 技术方面的不同 在技术上，Oinone和Odoo有相同之处，也有不同之处。它们都基于元数据驱动的软件系统，但是它们在如何让元数据运作的机制上存在巨大差异。Odoo是企业管理场景的单体应用，而Oinone则致力于企业商业场景的云原生应用。因此，它们在技术栈的选择、前后端协议设计、架构设计等方面存在差异。 场景方面的不同 在场景上，Oinone和Odoo呈现许多差异。相对于SAP这些老牌ERP厂商，Odoo算是西方在企业级软件领域的后起之秀，其软件构建方式、开源模式和管理理念在国外取得了非凡的成就。然而，在国内，Odoo并没有那么成功或者并没有那么知名。国内做Odoo的伙伴普遍认为，Odoo与中国用户的交互风格不符，收费模式设计以及外汇管制使商业活动受到限制，本地化服务不到位，国内生态没有形成合力，伙伴们交流合作都非常少。另外，Odoo在场景方面主要围绕内部流程管理，与国内老牌ERP如用友、金蝶重叠，市场竞争激烈。相比之下，Oinone看准了企业视角由内部管理转向业务在线、生态在线（协同）带来的新变化，聚焦新场景，利用云、端等新技术的发展，从企业内外部协同入手，以业务在线驱动企业管理流程升级。它先立足于国内，做好国内生态服务，再着眼未来的国际化。 无代码设计器的定位 在无代码设计器的定位上，Odoo的无代码设计器是一个非常轻量的辅助工具，因为ERP场景下，一个企业实施完以后基本几年不会变，流程稳定度非常高。相反，Oinone为适应"企业业务在线化后，所有的业务变化与创新都需要通过系统来触达上下游，从而敏捷响应快速创新"的时代背景，重点打造出五大设计器。（如下图1-2所示）。 图1-2 Oinone五大设计器 在数字化时代中国软件将接棒世界，而Oinone也要接棒Odoo，把数字化业务与技术的最佳实践赋能给企业，帮助企业数字化转型不走弯路！

    史, 昂的头像 史, 昂
    2024年5月23日
    1.6K00

  • 梅丛银

    认识陈鹏程及数式核心团队同学已经有一段时间了，在我们多次的交流讨论中时常会谈及：未来中国哪家软件企业能在互联网云原生时代走出来超越传统软件企业？史昂说这是他的梦想，也是他们团队这么多年坚持技术和产品研发与应用优先思考之路。史昂及数式核心团队面向企业应用市场历经三年的潜心研发和实战交付，推出Oinone产品及配套的低代码平台工具：对比国内外应用软件平台在开放生态和云原生均有它的继承性和独特性，特别是将技术平台赋予企业各种业务领域属性，便于企业客户和开发伙伴的二次开发并能快速搭建各类企业核心应用场景是Oinone的最大亮点。Oinone的内在特点之一是参考了全球最大开源ERP Odoo的元数据模型设计，同时基于业务中台架构和云原生技术，形成了自己一套国际化的快速开发平台、建模规范和应用产品，通过自己进场落地很多品牌企业的应用中台化不断迭代升级，走出了一条具有显著特色的新应用软件之路。史昂及团队特点谦卑、善于思考，善于吸收他山之精华，这是创业团队难能可贵之点，由此能善于与生态伙伴合作也是能够走的更远更长的基础基因。最后希望和祝愿Oinone能为中国企业在云时代数字化实践做出更多的贡献，为软件产业构建强大的应用生态和开发社区，真正树立起Oinone自己的软件品牌形象。 资深IT咨询专家&浩鲸云智能专家学院院长：梅丛银

    史, 昂的头像 史, 昂
    Oinone 7天入门到精通 2024年5月23日
    1.3K00
  • 4.2.4 框架之网络请求-HttpClient Oinone 7天入门到精通

    4.2.4 框架之网络请求-HttpClient

    oinone提供统一的网络请求底座，基于graphql二次封装 一、初始化 import { HttpClient } from '@kunlun/dependencies'; const http = HttpClient.getInstance(); http.setMiddleware() // 必须设置，请求回调。具体查看文章https://shushi.yuque.com/yqitvf/oinone/vwo80g http.setBaseURL() // 必须设置，后端请求的路径 图4-2-4-1 初始化代码示例 二、HttpClient详细介绍 获取实例 import { HttpClient } from '@kunlun/dependencies'; const http = HttpClient.getInstance(); 图4-2-4-2 获取实例 接口地址 import { HttpClient } from '@kunlun/dependencies'; const http = HttpClient.getInstance(); http.setBaseURL('接口地址'); http.getBaseURL(); // 获取接口地址 图4-2-4-3 接口地址 请求头 import { HttpClient } from '@kunlun/dependencies'; const http = HttpClient.getInstance(); http.setHeader({key: value}); 图4-2-4-4 请求头 variables import { HttpClient } from '@kunlun/dependencies'; const http = HttpClient.getInstance(); http.setExtendVariables((moduleName: string) => { return customFuntion(); }); 图4-2-4-5 variables 回调 import { HttpClient } from '@kunlun/dependencies'; const http = HttpClient.getInstance(); http.setMiddleware([middleware]); 图4-2-4-6 回调 业务使用-query private http = HttpClient.getInstance(); private getTestQuery = async () => { const query = `gql str`; const result = await this.http.query('module name', query); console.log(result) return result.data[`xx`]['xx']; // 返回的接口，打印出result对象层次返回 }; 图4-2-4-7 业务使用-query 业务使用-mutate private http = HttpClient.getInstance(); private getTestMutate = async () => { const mutation = `gql str`; const result = await this.http.mutate('module name', mutation); console.log(result) return result.data[`xx`]['xx']; // 返回的接口，打印出result对象层次返回 }; 图4-2-4-8 业务使用-mutate 三、如何使用HttpClient 初始化 在项目目录src/main.ts下初始化httpClient 初始化必须要做的事: 设置服务接口链接 设置接口请求回调 业务实战 前文说到自定义新增宠物表单，让我们在这个基础上加入我们的httpClient; 第一步新增service.ts 图4-2-4-8 新增service.ts service.ts import { HttpClient }…

    史, 昂的头像 史, 昂
    2024年5月23日
    1.4K00
  • 4.1.18 框架之网关协议-Variables变量 Oinone 7天入门到精通

    4.1.18 框架之网关协议-Variables变量

    我们在应用开发过程有一种特殊情况在后端逻辑编写的时候需要知道请求的发起入口，平台利用GQL协议中的Variables属性来传递信息，本文就介绍如何获取。 一、前端附带额外变量 属性名 类型 说明 scene String 菜单入口 表4-1-18-1 前端附带额外变量 图4-1-18-1 variables信息中的scene 二、后端如何接收variables信息 通过PamirsSession.getRequestVariables()可以得到PamirsRequestVariables对象。 三、第一个variable（举例） Step1 修改PetTalentAction，获取得到前端传递的Variables package pro.shushi.pamirs.demo.core.action; ……类引用 @Model.model(PetTalent.MODEL_MODEL) @Component public class PetTalentAction { ……其他代码 @Function.Advanced(type= FunctionTypeEnum.QUERY) @Function.fun(FunctionConstants.queryPage) @Function(openLevel = {FunctionOpenEnum.API}) public Pagination<PetTalent> queryPage(Pagination<PetTalent> page, IWrapper<PetTalent> queryWrapper){ String scene = (String)PamirsSession.getRequestVariables().getVariables().get("scene"); System.out.println("scene: "+ scene); ……其他代码 } ……其他代码 } 图4-1-18-2 修改PetTalentAction Step2 重启验证 点击宠物达人不同菜单入口，查看效果 图4-1-18-3 示例效果（一） 图4-1-18-4 示例效果（二）

    史, 昂的头像 史, 昂
    2024年5月23日
    1.1K00

Leave a Reply

登录后才能评论