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

3.3.1 构建第一个Model

史, 昂 • • Oinone 7天入门到精通 • 1956 views

定义模型，并配上相应的菜单或配置模块的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低代码应用平台体验

Like (1)
史, 昂's avatar史, 昂数式管理员
0 0
Previous 2024年5月23日 am9:50
Next 2024年5月23日

相关推荐

  • 第3章 Oinone的基础入门

    本章主要介绍如何快速入门，了解如何在Oinone上进行开发。我们将通过准备环境、构建自己的第一个Oinone模块、完成一些小功能等方式来全面了解Oinone，这将是一个很好的开始。 具体来说，本章包括以下几个方面： 环境搭建：准备Windows或Mac版环境。 Oinone以模块为组织：了解Oinone模块的概念和如何创建和使用模块。 Oinone以模型为驱动：了解Oinone模型的概念和如何使用模型来构建应用。 Oinone以函数为内在：了解Oinone函数的概念和如何使用函数来实现应用逻辑。 Oinone以交互为外在：了解Oinone交互的概念和如何使用交互来设计和实现应用界面。

    史, 昂's avatar 史, 昂
    Oinone 7天入门到精通 2024年5月23日
    2.8K00
  • 业务域 Oinone 7天入门到精通

    业务域

    1. 业务域介绍 业务域是根据业务域对集成应用、开放接口进行归类管理。在创建集成应用、开发接口时，可选择归属的业务域。 操作入口：集成设计器——业务域。 2. 业务域管理 业务域管理提供新增、删除、搜索操作。 2.1 业务域列表 支持按照编码、名称、描述搜索业务域。 2.2 新增业务域 新增业务域：输入业务域名称、描述新增。 2.3 删除业务域 当前业务域未被其他数据记录引用时，可删除成功，反之如果被引用了，不允许删除。

    史, 昂's avatar 史, 昂
    2024年6月20日
    2.4K00
  • 4.1.6 模型之元数据详解 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 字段是否大小写映射…

    史, 昂's avatar 史, 昂
    2024年5月23日
    1.7K00
  • 4.2.5 框架之网络请求-Request Oinone 7天入门到精通

    4.2.5 框架之网络请求-Request

    在中后台业务场景中，大部分的请求时候是可以被枚举的，比如创建、删除、更新、查询。在上文中，我们讲了httpClient如何自定义请求，来实现自己的业务诉求。本文中讲到的Request是离业务更近一步的封装，他提供了开箱即用的API，比如insertOne、updateOne，它是基于HttpClient做的二次封装，当你熟悉Request时，在中后台的业务场景中，所有的业务接口自定义将事半功倍。 一、Request详细介绍 元数据-model 获取模型实例 import { getModel } from '@kunlun/dependencies' getModel('modelName'); 图4-2-5-1 获取模型实例 清除所有缓存的模型 import { cleanModelCache } from '@kunlun/dependencies' cleanModelCache(); 图4-2-5-2 清除所有缓存的模型 元数据-module 获取应用实例，包含应用入口和菜单 import { queryModuleByName } from '@kunlun/dependencies' queryModuleByName('moduleName') 图4-2-5-3 获取应用实例 查询当前用户所有的应用 import { loadModules } from '@kunlun/dependencies' loadModules() 图4-2-5-4 查询当前用户所有的应用 query 分页查询 import { queryPage } from '@kunlun/dependencies' queryPage(modelName, { pageSize: 15, // 一次查询几条 currentPage, 1, // 当前页码 condition?: '' // 查询条件 maxDepth?: 1, // 查几层模型出来，如果有2，会把所有查询字段的关系字段都查出来 sort?: []; // 排序规则 }, fields, variables, context) 图4-2-5-5 分页查询 自定义分页查询-可自定义后端接口查询数据 import { customQueryPage } from '@kunlun/dependencies' customQueryPage(modelName, methodName, { pageSize: 15, // 一次查询几条 currentPage, 1, // 当前页码 condition?: '' // 查询条件 maxDepth?: 1, // 查几层模型出来，如果有2，会把所有查询字段的关系字段都查出来 sort?: []; // 排序规则 }, fields, variables, context) 图4-2-5-6 自定义分页查询 查询一条-根据params匹配出一条数据 import { queryOne } from '@kunlun/dependencies' customQueryPage(modelName, params, fields, variables, context) 图4-2-5-7 根据params匹配出一条数据 自定义查询 import { customQuery } from '@kunlun/dependencies' customQuery(methodName, modelName, record, fields, variables, context) 图4-2-5-8 自定义查询 update import { updateOne } from '@kunlun/dependencies' updateOne(modelName, record, fields, variables, context) 图4-2-5-9 update insert import { insertOne } from '@kunlun/dependencies' insertOne(modelName, record, fields, variables, context) 图4-2-5-10 insert delete import { deleteOne } from '@kunlun/dependencies'…

    史, 昂's avatar 史, 昂
    2024年5月23日
    1.8K00
  • 3.2.3 应用中心 Oinone 7天入门到精通

    3.2.3 应用中心

    在App Finder 中点击应用中心可以进入oinone的应用中心，可以看到oinone平台所有应用列表、应用大屏、以及技术可视化。 一、应用列表 标准版本不支持在线安装，只能通过boot工程的yml文件来配置安装模块。在 www.oinone.top 官方SaaS平台客户可以在线管理应用生命周期如：安装、升级、卸载。同时针对已安装应用可以进行无代码设计（前提安装了设计器），针对应用类的模块则可进行收藏，收藏后会在App Finder中的我收藏的应用中出现。在应用列表中可以看到我们已经安装的应用以及模块，我们oinoneDemo工程也在其中。 图3-2-35 Oinone的应用列表 图3-2-36 应用收藏后会在App Finder的【我收藏的应用】中出现 二、应用大屏 但我们的测试应用没有设置应用类目，则无法在应用大屏中呈现。 图3-2-37 未设置应用类目则无法在应用大屏中呈现 三、技术可视化 在技术可视化页面，出展示已经安装模块的元数据，并进行分类呈现 图3-2-38 云数据分类呈现

    史, 昂's avatar 史, 昂
    2024年5月23日
    2.6K00

Leave a Reply

Please Login to Comment