4.4 Oinone的分布式体验进阶

史, 昂 • 2024年5月23日 am8:28 • Oinone 7天入门到精通 • 阅读 999

在分布式开发中，每个人基本只负责自己相关的模块开发。所以每个研发就都需要一个环境，比如一般公司会有（N个）项目环境、1个日常环境、1个预发环境、1个线上环境。在整项目环境的时候就特别麻烦，oinone的好处是在于每个研发可以通过boot工程把需要涉及的模块都启动在一个jvm中进行开发，并不依赖任何环境，在项目开发中，特别方便。但当公司系统膨胀到一定规模，大到很多人都不知道有哪些模块，或者公司出于安全策略考虑，或者因为启动速度的原因（毕竟模块多了启动的速度也会降下来）。本文就给大家介绍oinone与经典分布式组织模式的兼容性

一、模块启动的最小集

我们来改造SecondModule模块，让该模块的用户权限相关都远程走DemoModule

Step1 修改SecondModule的启动工程application-dev.yml文件

除了base、second_core两个模块保留，其他模块都去除了。

pamirs:
    boot:
    init: true
    sync: true
    modules:
      - base
      - second_core

图4-4-1 SecondModule的application-dev.yml仅配置两个模块

Step2 去除boot工程的依赖

去除SecondModule启动工程的pom依赖

<!-- <dependency>
  <groupId>pro.shushi.pamirs.core</groupId>
  <artifactId>pamirs-resource-core</artifactId>
</dependency>
<dependency>
  <groupId>pro.shushi.pamirs.core</groupId>
  <artifactId>pamirs-user-core</artifactId>
</dependency>
<dependency>
  <groupId>pro.shushi.pamirs.core</groupId>
  <artifactId>pamirs-auth-core</artifactId>
</dependency>
<dependency>
  <groupId>pro.shushi.pamirs.core</groupId>
  <artifactId>pamirs-message-core</artifactId>
</dependency>
<dependency>
  <groupId>pro.shushi.pamirs.core</groupId>
  <artifactId>pamirs-international</artifactId>
</dependency>
<dependency>
  <groupId>pro.shushi.pamirs.core</groupId>
  <artifactId>pamirs-business-core</artifactId>
</dependency>
<dependency>
  <groupId>pro.shushi.pamirs.core</groupId>
  <artifactId>pamirs-apps-core</artifactId>
</dependency> -->

图4-4-2 去除boot工程多余的依赖

Step3 重启SecondModule

这【远程模型】和【远程代理】均能访问正常

图4-4-3 远程模型和远程代理菜单均能访问正常

Step4 SecondModule增加对模块依赖

我们让SecondModule增加用户和权限模块的依赖，期待效果是：SecondModule会对用户和权限的访问都会走Dome应用，因为Demo模块的启动工程中包含了user、auth模块。

修改pamirs-second-api的pom文件增加对user和auth的api包依赖

<dependency>
  <groupId>pro.shushi.pamirs.core</groupId>
  <artifactId>pamirs-user-api</artifactId>
</dependency>
<dependency>
  <groupId>pro.shushi.pamirs.core</groupId>
  <artifactId>pamirs-auth-api</artifactId>
</dependency>

图4-4-4 修改pamirs-second-api的pom文件

修改SecondModule类，增加依赖定义

@Module(
    dependencies = {ModuleConstants.MODULE_BASE, AuthModule.MODULE_MODULE, UserModule.MODULE_MODULE}
)

图4-4-5 配置SecondModule的依赖

Step5 修改RemoteTestModel模型

为RemoteTestModel模型增加user字段

@Field.many2one
@Field(displayName = "用户")
private PamirsUser user;

图4-4-6 为RemoteTestModel模型增加user字段

Step6 重启系统看效果

mvn install pamirs-second工程，因为需要让pamirs-demo工程能依赖到最新的pamirs-second-api包
重启pamirs-second和pamirs-demo
两个页面都正常

图4-4-7 示例效果一

图4-4-8 示例效果二

二、PmetaOnline的NEVER指令（开发时环境共享）

我们在4.1.2【模块之启动指令】一文中介绍过 “-PmetaOnline指令”，该参数用于设置元数据在线的方式，如果不使用该参数，则profile属性的默认值请参考服务启动可选项。-PmetaOnline参数可选项为：

NEVER - 不持久化元数据，会将pamirs.boot.options中的updateModule、reloadMeta和updateMeta属性设置为false
MODULE - 只注册模块信息，会将pamirs.boot.options中的updateModule属性设置为true，reloadMeta和updateMeta属性设置为false
ALL - 注册持久化所有元数据，会将pamirs.boot.options中的updateModule、reloadMeta和updateMeta属性设置为true

oinone的默认模式下元数据都是注册持久化到DB的，但当我们在分布式场景下新开发模块或者对已有模块进行本地化开发时，做为开发阶段我们肯定是希望复用原有环境，但不对原有环境照成影响。那么-PmetaOnline就很有意义。让我们还没有经过开发自测的代码产生的元数据仅限于开发本地环境，而不是直接影响整个大的项目环境

PmetaOnline指令设置为NEVER（举例）

Step1 为DemoCore新增一个DevModel模型

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

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

@Model.model(DevModel.MODEL_MODEL)
@Model(displayName = "开发阶段模型",summary="开发阶段模型，当PmetaOnline指令设置为NEVER时，本地正常启动但元数据不落库",labelFields={"name"})
public class DevModel  extends AbstractDemoCodeModel{

    public static final String MODEL_MODEL="demo.DevModel";

    @Field(displayName = "名称")
    private String name;

}

图4-4-9 为DemoCore新增一个DevModel模型

Step2 为DevModel模型配置菜单

@UxMenu("开发模型")@UxRoute(DevModel.MODEL_MODEL) class DevModelProxyMenu{}

图4-4-10 为DevModel模型配置菜单

Step3 启动Demo应用时指定-PmetaOnline

图4-4-11 启动Demo应用时指定-PmetaOnline

Step4 重启系统看效果

查看元数据

图4-4-12 DB查看元数据变化

菜单与页面能正常操作

图4-4-13 开发模型菜单可正常操作

图4-4-14 开发模型详情页面可正常操作

Step5 Never模式需注意的事项

业务库需设定为本地开发库，这样才不会影响公共环境，因为对库表结构的修改还是会正常进行的
如果不小心影响了公共环境，需要对公共环境进行重启恢复
系统新产生的元数据（如：例子中的【开发模式】菜单）不受权限管控

三、分布式开发约定

设计约定

跨模块的存储模型间继承，在部署时需要跟依赖模块配置相同数据源。这个涉及模块规划问题，比如业务上的user扩展模块，需要跟user模块一起部署。
跨模块的多对多关系，配置中间表模型，在3.3.9【字段类型之关系与引用】一文中的“M2M字段”部分有详细介绍。
基础依赖：base。
canal相关参考：4.1.10【函数之触发与定时】中提到的修改topic方案。

编码约定

跨模块间用service来调用，避免直接调用模型的数据管理器（如new 非本模块Model().queryPage等）。结构性代码可以用oinone提供研发辅助工具进行提效率
在3.4.1【构建第一个Function】一文中有提到，需要在API包中声明注解了@Fun注解的函数接口，并在接口的方法上加上@Function注解。

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

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

Oinone 7天从入门到精通

史, 昂数式管理员

0 0

4.5 研发辅助

上一篇 2024年5月23日

4.3 Oinone的分布式体验

下一篇 2024年5月23日

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.1K000
3.4.2 函数的开放级别与类型

一、函数开放级别我们在日常开发中通常会因为安全性，为方法定义不同的开放层级，或者通过应用分层把需要对web开放的接口统一定义在一个独立的应用中。oinone也提供类似的策略，所有逻辑都通过Function来归口统一管理，所以在Function是可以定义其开放级别有API、REMOTE、LOCAL三种类型，配置可多选。四种自定义新增方式与开放级别的对应关系函数本地调用(LOCAL) 远程调用(REMOTE) 开放(API) 伴随模型新增函数支持支持【默认】支持独立新增函数绑定到模型支持支持【默认】支持独立新增函数只作公共逻辑单元支持支持【默认】伴随ServerAction新增函数必选表3-4-2-1 四种自定义新增方式与开放级别的对应关系远程调用（REMOTE）如果函数的开放级别为本地调用，则不会发布远程服务和注册远程服务消费者非数据管理器函数提供者：如果函数定义在当前部署包的启动应用中，则主动发布远程服务提供者。消费者：如果函数定义在部署依赖包中但未在当前部署包的启动应用中，则系统会默认注册远程消费者。发布注册的远程服务使用命名空间和函数编码进行路由。所以非数据管理器函数的消费者并不需要感知该服务是否是本地提供还是远程提供。而服务提供者也不需要手动注册远程服务。数据管理器类函数提供者：如果数据管理器函数所在模型定义在当前部署包的启动应用中，则系统会主动发布数据管理器的远程服务作为数据管理器的远程服务提供者；消费者：如果模型定义在部署依赖包中但未在当前部署包的启动应用中，则系统会主动注册数据管理器的远程服务消费者。所以数据管理器类函数的消费者与服务提供者并不需要感知函数的远程调用。二、函数类型函数的类型语义分为：增、删、改、查，在编程模式下目前用于Function为API级别，生成GraphQL的Schema时放在query还是mutation。查放在query，其余放mutation。三、函数分类 TBD 在无代码编辑器中，函数分类主要用函数选择的分类管理。

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

6.4 国际化之多语言

多语言是国际化中大家最常面对的问题，我们需要对应用的页面结构元素进行翻译，也需要对系统内容进行翻译比如：菜单、数据字典等，甚至还会业务数据进行翻译。但不管什么翻译需求，我们在实现上基本可以归类为前端翻译和后端翻译。前端翻译顾名思义是在前端根据用户选择语言对内容进行翻译，反之就是后端翻译。本文会带着大家了解oinone的前端翻译与后端翻译准备工作 pamirs-demo-boot的pom文件中引入pamirs-translate包依赖 <dependency> <groupId>pro.shushi.pamirs.core</groupId> <artifactId>pamirs-translate</artifactId> </dependency> pamirs-demo-boot的application-dev.yml文件中增加配置pamirs.boot.modules增加translate，即在启动模块中增加translate模块 pamirs: boot: modules: – translate 后端翻译（使用）这里通过对菜单的翻译来带大家了解翻译模块 Step1 新增翻译记录切换应用到translate模块，点击新增翻译。选择新增翻译生效模块选择翻译的模型为：菜单模型源语言选择中文，目标选择English 添加翻译项目：源术语为：商店翻译值为：shop 状态为：激活 Step2 查看效果应用切换到Demo模块，在右上角切换语言至英语后端翻译（自定义模型的翻译）在前面菜单的翻译中，似乎我们什么都没做就可以正常通过翻译模块完成多语言的切换了。是不是真如我们想象的一样，当然不是。是因为Menu模型的displayName字段加上@Field(translate = true)注解。 Step1 为PetType模型的name字段增加翻译注解 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; @Model.MultiTable(typeField = "kind") @Model.model(PetType.MODEL_MODEL) @Model(displayName="品种",labelFields = {"name"}) public class PetType extends IdModel { public static final String MODEL_MODEL="demo.PetType"; @Field(displayName = "品种名" , translate = true) private String name; @Field(displayName = "宠物分类") private String kind; } Step2 重启应用查看效果切换应用到translate模块，点击新增翻译切换应用到Demo模块，切换中英文，查看效果前端翻译还记得我们前端第一个自定义动作吗？会弹出“oinone第一个自定义Action，啥也没干”，我们要对它进行翻译。 Step1 修改前端DoNothingActionWidget.ts import translateValueByKey 提示语用translateValueByKey加上翻译 const confirmRs = executeConfirm(translateValueByKey(\’oinone第一个自定义Action，啥也没干\’)||\’oinone第一个自定义Action，啥也没干\’); 前端更多翻译工具请见前端高级特性-框架之翻译工具 import { Action, ActionContextType, ActionWidget, executeConfirm, IClientAction, SPI, ViewType, Widget, translateValueByKey } from '@kunlun/dependencies'; @SPI.ClassFactory(ActionWidget.Token({ name: 'demo.doNothing' })) export class DoNothingActionWidget extends ActionWidget { @Widget.Method() public async clickAction() { const confirmRs = executeConfirm(translateValueByKey('oinone第一个自定义Action，啥也没干')||'oinone第一个自定义Action，啥也没干'); } } //定义动作元数据 Action.registerAction('*', { displayName: '啥也没干', name: 'demo.doNothing', id: 'demo.doNothing', contextType: ActionContextType.ContextFree, bindingType: [ViewType.Table] } as IClientAction); Step2 新增翻译记录前端翻译的翻译记录对应的模型可以随意找一个放。但要注意几点：不要找有字读配置translate = true的模型，因为会影响后端翻译性能。最好统一到一个模型中，便于后续管理。这里大家可以自定义一个无有业务访问且本身无需要翻译的模型来挂载，避免性能损失 Step3 刷新远程资源生成前端语言文件 Step4 新增或修改.env 前端在项目根目录下新增或修改.env，可以参考.env.example文件。通过.env文件为前端配置oss文件路径，针对I18N_OSS_URL配置项。真实前端访问翻译语言文件的路径规则为：http://bucket.downloadUrl/mainDir/租户/translate/模块/语言文件。 yaml文件中oss配置的文件路径：http://pamirs.oss-cn-hangzhou.aliyuncs.com/upload/demo/ 租户/translate/模块/语言文件前端会自动根据上下文组织 # 后端api配置 # API_BASE_URL=http://127.0.0.1:8090 # 下面是国际化语言的cdn配置，默认用当前请求链接下的路径: /pamirs/translate/${module}/i18n_${lang}.js I18N_OSS_URL=http://pamirs.oss-cn-hangzhou.aliyuncs.com/upload/demo Step5 重启前端应用看效果对语言进行中英文切换，进入宠狗达人页面，点击【第一个自定义Action】，查看前端翻译效果

史, 昂
2024年5月23日
1.4K200
第3章 Oinone的基础入门

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

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

3.3.3 模型的数据管理器

数据管理器和数据构造器是Oinone为模型自动赋予的Function是内在数据管理能力，数据管理器针对存储模型是方便在大家编程模式下可以利用数据管理器Function快速达到相关数据操作的目的。数据构造器则主要用于模型进行初始化时字段默认值计算和页面交互数据管理器只有存储模型才有数据管理器。如果@Model.Advanced注解设置了dataManager属性为false，则表示在UI层不开放默认数据管理器。开放级别为API则表示UI层可以通过HTTP请求利用4.1.15【Pamirs标准网关协议】进行数据交互。模型默认数据读管理器函数编码描述开放级别 queryByPk 根据主键查询单条记录，会进行主键值检查 Local、Remote queryByEntity 根据实体查询单条记录 Local、Remote、Api queryByWrapper 根据查询类查询单条记录 Local、Remote queryListByEntity 根据实体查询返回记录列表 Local、Remote queryListByWrapper 根据查询类查询记录列表 Local、Remote queryListByPage 根据实体分页查询返回记录列表 Local、Remote queryListByPageAndWrapper 根据查询类分页查询记录列表 Local、Remote queryPage 分页查询返回分页对象，分页对象中包含记录列表 Local、Remote、Api countByEntity 按实体条件获取记录数量 Local、Remote countByWrapper 按查询类条件获取记录数量 Local、Remote 表3-3-3-1 模型默认数据读管理器模型默认数据写管理器函数编码描述开放级别 createOne 提交新增单条记录 Local、Remote createOrUpdate 新增或更新，需要为模型设置唯一索引，如果数据库检测到索引冲突，会更新数据，若未冲突则新增数据 Local、Remote updateByPk 根据主键更新单条记录，会进行主键值检查 Local、Remote updateByUniqueField 条件更新，条件中必须包含唯一索引字段 Local、Remote updateByEntity 按实体条件更新记录 Local、Remote、Api updateByWrapper 按查询类条件更新记录 Local、Remote createBatch 批量新增记录 Local、Remote createOrUpdateBatch 批量新增或更新记录 Local、Remote updateBatch 根据主键批量更新记录，会进行主键值检查 Local、Remote deleteByPk 根据主键删除单条记录，会进行主键值检查 Local、Remote deleteByPks 根据主键批量删除，会进行主键值检查 Local、Remote deleteByUniqueField 按条件删除记录，条件中必须包含唯一索引字段 Local、Remote deleteByEntity 根据实体条件删除 Local、Remote、Api deleteByWrapper 根据查询类条件删除 Local、Remote createWithField 新增实体记录并更新实体字段记录 Local、Remote、Api updateWithField 更新实体记录并更新实体字段记录 Local、Remote、Api deleteWithFieldBatch 批量删除实体记录并删除关联关系 Local、Remote、Api 表3-3-3-2 模型默认数据写管理器如果模型继承IdModel，模型会自动设置主键设置为id，则会继承queryById、updateById和deleteById函数。 queryById（详情，根据ID查询单条记录，开放级别为Remote） updateById（提交更新单条记录，根据ID更新单条记录，开放级别为Remote） deleteById（提交删除单条记录，根据ID删除单条记录，开放级别为Remote）如果模型继承CodeModel，模型也会继承IdModel的数据管理器，编码字段code为唯一索引字段。在新增数据时会根据编码生成规则自动设置编码字段code的值，继承queryByCode、updateByCode和deleteByCode函数。 queryByCode（详情，根据code查询单条记录，开放级别为Remote） updateByCode（提交更新单条记录，根据code更新单条记录，开放级别为Remote） deleteByCode（提交删除单条记录，根据code删除单条记录，开放级别为Remote）没有主键或唯一索引的模型，在UI层不会开放默认数据写管理器。 #### 使用场景图3-3-3-1 数据管理器使用场景数据构造器模型数据构造器 construct：供前端新开页面构造默认数据使用。所有模型都拥有construct构造器，默认会将字段上配置的默认值返回给前端，另外可以在子类中覆盖construct方法。数据构造器 construct函数的开放级别为API，函数类型为QUERY查询函数，系统将识别模型中的以construct命名的函数强制设置为API开放级别和QUERY查询类型。可以使用@Field的defaultValue属性配置字段的默认值。注意，枚举的默认值为枚举的name。

史, 昂
2024年5月23日
1.3K101

登录后才能评论