# 自定义 StorageDriver

本节将介绍如何自定义 StorageDriver，以及相关的 API 信息和示例代码。

# 概述

StorageDriver 是一个用于存储和管理数据的接口，主要关注数据的存储、删除和管理分区方式。通过自定义 StorageDriver，您可以实现数据的读取、写入、删除等操作，并监控数据的变化。

# API Reference

# `StorageContext` 类

class StorageContext {
    public id: string;
    public feature: string;
}

StorageContext 类表示存储上下文，用于标识存储的数据和特性。

# `PDFViewerStorageContext` 类

class PDFViewerStorageContext extends StorageContext {
    public pdfViewer: PDFViewer;
}

PDFViewerStorageContext 类继承自 StorageContext 类，表示 PDFViewer 的存储上下文。它包含了一个 PDFViewer 实例，通过该实例，可以获得当前文档和当前页等信息。通过合理地组合这些信息，可以对数据进行分区存储。

# `PDFViewer` 接口

interface PDFViewer {
    getInstanceId(): string;
}

从 9.1.0 版本开始，PDFViewer 接口新增了一个方法 getInstanceId()，该方法用于获取 PDFViewer 的实例 ID。当存在多个 PDFViewer 实例时，请确保它们的 ID 是唯一的，以便对不同 PDFViewer 实例的数据进行分区存储。

# `PDFViewerConstructor` 接口

interface PDFViewerConstructor {
    new(options: {
        instanceId: string,
        customs: {
            storageDriver: StorageDriver;
        }
    }): PDFViewer;
}

PDFViewerConstructor 接口用于描述创建 PDFViewer 实例的构造函数信息。从 9.1.0 版本开始，该构造函数增加了一个包含 instanceId 和 customs 属性的 options 对象作为参数。其中 customs 属性包含了一个 StorageDriver 实例，用于存储和管理数据。为了实现自定义存储功能，应用层可以通过 custom.storageDriver 将自定义的 StorageDriver 实例传递给 PDFViewer。

# `StorageDriver` 接口

interface StorageDriver {
    public getAll(context: StorageContext): Promise<Record<string, any>>;
    public get<T>(context: StorageContext, key: string): Promise<T | null>;
    public set<T>(context: StorageContext, key: string, value: T): Promise<void>;
    public removeAll(context: StorageContext): Promise<void>;
    public remove(context: StorageContext, key: string): Promise<void>;
    public onChange<T>(callback: (event: StorageDriverChangeEvent<T>) => void): Function;
    public onRemove(callback: (event: StorageDriverRemoveEvent) => void): Function;
}

StorageDriver 是一个定义了一组用于存储和管理数据方法的接口。您可以通过实现这些方法来实现自定义的 StorageDriver。

getAll(context: StorageContext): Promise<Record<string, any>>: 获取指定上下文中的所有数据。
get<T>(context: StorageContext, key: string): Promise<T | null>: 获取指定上下文中指定键的数据。
set<T>(context: StorageContext, key: string, value: T): Promise<void>: 设置指定上下文中指定键的数据。
removeAll(context: StorageContext): Promise<void>: 移除指定上下文中的所有数据。
remove(context: StorageContext, key: string): Promise<void>: 移除指定上下文中指定键的数据。
onChange<T>(callback: (event: StorageDriverChangeEvent<T>) => void): Function: 注册监听数据变化的回调函数。
onRemove(callback: (event: StorageDriverRemoveEvent) => void): Function: 注册监听数据移除的回调函数。

# `StorageDriverChangeEvent` 接口

interface StorageDriverChangeEvent<T> {
    public context: StorageContext;
    public key: string;
    public oldValue: T;
    public newValue: T;
}

StorageDriverChangeEvent 接口表示数据变化的事件对象。它包含了上下文、键、旧值和新值等信息，在数据变化发生后，回调函数可以接收到该对象。

# `StorageDriverRemoveEvent` 接口

interface StorageDriverRemoveEvent {
    public context: StorageContext;
    public key: string;
}

StorageDriverRemoveEvent 接口表示数据移除的事件对象。它包含了上下文和键等信息，在数据移除事件发生后，回调函数可以接收到该对象。