插件自定义模型
📊📝📽️ Univer General
Univer 允许用户将自定义插件中的数据跟随 snapshot
一起落盘或加载。
创建一个 CustomerService
在 @univerjs/core
中存在一个 ResourceManagerService
实例,你可以在自己新建的 plugin 中注册对应的 hook
,将数据绑定到 snapshot
上。
import { IResourceManagerService, Inject, OnLifecycle, LifecycleStages } from '@univerjs/core';
import { UniverType } from '@univerjs/protocol';
const YOUR_PLUGIN_NAME = 'YOUR_PLUGIN_NAME';
interface IResource { testResource: string }
@OnLifecycle(LifecycleStages.Starting, CustomerService)
class CustomerService {
private _model:IResource = { testResource: '' };
constructor(
@Inject(IResourceManagerService) private _resourceManagerService: IResourceManagerService
) {
this._resourceManagerService.registerPluginResource<IResource>({
toJson: (unitID) => this._toJson(unitID),
parseJson: (json) => this._parseJson(json),
pluginName: 'SHEET_CustomerService_PLUGIN',
businesses: [UniverType.UNIVER_SHEET, UniverType.UNIVER_DOC, UniverType.UNIVER_SLIDE],
onLoad: (_unitId, resource) => {
this._model = resource;
},
onUnLoad: (_unitId) => {
this._model = { testResource: '' };
},
});
}
private _toJson(_unitID: string) {
const model = this._model;
return JSON.stringify(model);
}
private _parseJson(json: string) {
return JSON.parse(json);
}
}
IResource
的类型可以自己随意定义,支持任何类型。toJson/parseJson
是一对针对 IResource 的序列化函数,通常使用 JSON 函数,这里你也可以可以加入压缩/混淆的特定逻辑。toJson
的函数参数为什么会有unitID
? 这是因为 一个Univer
实例可能会包含多个unit
实例(例如Sheet
/Doc
以及后续的Slider
),onLoad
/onUnLoad
同理。businesses
这个选项,是当什么业务加载的时候,才需要加载resources
,如果你是一个Sheet
模块的数据,在Doc
加载的时候,就没必要加载了。
注入 CustomerPlugin
当你的数据已经接入 ResourceManagerService
后,将你的 CustomerService
在你自己的 CustomerPlugin
中注入
import { Plugin, Inject, Injector } from '@univerjs/core';
export class UniverSheetsPlugin extends Plugin {
constructor(
@Inject(Injector) override readonly _injector: Injector
) {
super();
this._injector.add([CustomerService]);
}
}
将插件注册进 Univer
const univer = new Univer();
univer.registerPlugin(UniverSheetsPlugin);
// 执行其他的初始化逻辑
如何获得包含Resources
资源的快照
在 @univerjs/core
中存在一个 ResourceLoaderService
实例,你可以通过该 Service
的 saveWorkbook
或者 saveDoc
获得最新快照信息 Snapshot
,后续再通过 univer.createUnit
来回显数据。
其中 Resource
信息存储在 snapshot.resources
上,可根据对应的 pluginName
去获取。
import { IResourceLoaderService, IUniverInstanceService, Inject, LifecycleStages, OnLifecycle } from '@univerjs/core';
import { UniverType } from '@univerjs/protocol';
@OnLifecycle(LifecycleStages.Starting, CustomerService)
class CustomerService {
constructor(
@Inject(IResourceLoaderService) private _resourceLoaderService: IResourceLoaderService,
@Inject(IUniverInstanceService) private _univerInstanceService: IUniverInstanceService
) {
const workbook = this._univerInstanceService.getCurrentUnitForType(UniverType.UNIVER_SHEET)!
const snapshot = this._resourceLoaderService.saveUnit(workbook.getUnitId());
}
}