租户初始化客户端
组件编码
hzero-boot-tenant
一、简介
1.1 概述
租户初始化客户端的功能是主动向服务端注册租户初始化处理器，接收租户初始化服务端的租户初始化请求消息，并自动调用当前服务的初始化逻辑，完成调用后向租户初始化服务端发送初始化相关的日志消息。
1.2 组件坐标
<dependency>
<groupId>org.hzero.boot</groupId>
<artifactId>hzero-boot-tenant</artifactId>
<version>${hzero.boot.version}</version>
</dependency>
二、使用说明
租户初始化客户端的功能包含注册租户初始化处理器和执行注册租户初始化处理器。
- 配置是否自动注册租户初始化处理器和执行注册租户初始化处理器
# application.yml
hzero:
tenant:
init:
register:
enabled: true # 是否启用自动注册租户初始化处理器
process：
enabled: true # 是否启用执行注册租户初始化处理器
-
自行开发租户初始化处理器逻辑
-
新建类实现
TenantInitProcessor接口，实现对应方法。注意需要把当前处理器类注册到spring容器中。- 方法说明：
- process(TenantInitContext tenantInitContext)：入参为租户信息，通过它可以获取当前操作的租户的相关信息信息
- 方法说明：
-
类上添加
@TenantInit注解- 注解说明：
- processorName：处理器名称
- processorType：处理器类型，包含前置处理器和后置处理器，默认为后置处理器
- initType：初始化类型，包含新增和更新，默认为新增
- orderSeq：全局顺序号，顺序越小，优先级越高，默认为10
- 注解说明：
-
二、服务端简述
简要说明服务逻辑
概述
租户初始化服务端的功能是包含租户初始化处理器注册的持久化和对租户变更的拦截并分组按序调用对应的处理器。
处理器查看
查询已经注册的处理器信息
- 菜单路径：
系统管理>租户维护>租户初始化处理配置
列表方式查看
以列表的方式展示处理器信息。点击结果列表tab页
数据列名：
- 服务名称：处理器所在的服务名称
- 处理器代码：处理器对应的代码
- 处理器名称：处理器对应的名称
- 处理器类型：处理器类型，包含前置处理器和后置处理器
- 初始化类型：初始化类型，包含创建和更新
- 排序：处理器对应序号，代码执行的先后，序号越小，顺序越靠后
- 说明：其他说明
示意图方式方式查看
通过示意图的方式查看各个处理器之间的执行关系。点击租户创建或者租户更新tab页
处日志查看
查询处理器的执行日志信息
- 菜单路径：
系统管理>租户维护>租户初始化处理日志
列表方式查看
以列表的方式展示租户初始化处理日志信息。
数据列名：
- 实例编号：对应一次租户信息变更
- 租户编码：租户对应的编码
- 服务名称：处理器所在的服务名称
- 处理器代码：处理器对应的代码
- 处理器名称：处理器对应的名称
- 处理器类型：处理器类型，包含前置处理器和后置处理器
- 初始化类型：初始化类型，包含创建和更新
- 排序：处理器对应序号，代码执行的先后，序号越小，顺序越靠后
- 处理状态：处理执行结果
- 处理时间：处理器执行时间
- 说明：其他说明
示意图方式方式查看
通过示意图的方式查看各个处理器之间的执行结果。点击实例编号列对应的实例编号。
鼠标滑过对应的处理器，如果是执行成功的，会显示处理器的相关信息，如果是执行失败，会显示对应的异常堆栈。
三、版本更新日志
版本 0.10.0.RELEASE [2019-07-20]
- 初始发布
展望
- 支持处理器的自动失效