您当前正在浏览HarmonyOS最新文档，覆盖已发布的所有API版本，可在API参考中筛选您使用的API版本。详细的版本配套关系请参考版本说明。

readerCore（阅读核心能力）

Phone5.0.4(16)+PC/2in15.0.4(16)+Tablet5.0.4(16)+

更新时间: 2026-10-14 04:02

复制页面

本文导读

ReaderComponentController

on('resourceRequest')

off('resourceRequest')

展开章节

本模块为Reader Kit核心能力。提供阅读页面数据基础类、页面状态、内容分页信息、页面排版属性、组件控制器等能力。

起始版本： 5.0.4(16)

导入模块

收起
自动换行
深色代码主题
复制
import { readerCore } from '@kit.ReaderKit';

PageDatabaseBean

Phone5.0.4(16)+PC/2in15.0.4(16)+Tablet5.0.4(16)+

页面数据基础类。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从版本5.0.4(16)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Reader.ReaderService.ReaderCore

起始版本： 5.0.4(16)

展开

名称	类型	只读	可选	说明
nodeType	string	否	否	节点类型，固定值为“ReaderCoreIdentity”，表示阅读器节点。
dataId	string	否	否	节点标识，根据资源索引、页面偏移量自动生成。

constructor

Phone5.0.4(16)+PC/2in15.0.4(16)+Tablet5.0.4(16)+

constructor(nodeType: string, nodeDataId: string)

页面数据构造函数。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从版本5.0.4(16)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Reader.ReaderService.ReaderCore

起始版本： 5.0.4(16)

参数：

展开

参数名	类型	必填	说明
nodeType	string	是	节点类型，固定值为“ReaderCoreIdentity”，表示阅读器节点。
nodeDataId	string	是	节点标识，根据子类PageDataInfo.resourceIndex、PageDataInfo.pageOffset字段自动生成。

PageState

Phone5.0.4(16)+PC/2in15.0.4(16)+Tablet5.0.4(16)+

页面状态。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从版本5.0.4(16)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Reader.ReaderService.ReaderCore

起始版本： 5.0.4(16)

展开

名称	值	说明
PAGE_WAITING	1	初始化成功，正在等待排版引擎通知。
PAGE_LOADING	2	初始化成功，等待排版结果。
PAGE_ON_SHOW	3	排版成功并显示阅读页面。
OPEN_BOOK_FAIL	4	排版失败，未成功加载页面。

PageDataInfo

Phone5.0.4(16)+PC/2in15.0.4(16)+Tablet5.0.4(16)+

内容分页信息，继承PageDatabaseBean。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从版本5.0.4(16)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Reader.ReaderService.ReaderCore

起始版本： 5.0.4(16)

展开

名称	类型	只读	可选	说明
nodeType	string	否	否	节点类型，固定值为"ReaderCoreIdentity"，表示阅读器节点。
dataId	string	否	否	节点标识，根据“resourceIndex”、“pageOffset”字段自动生成。
pageHeaderContent	string	否	否	页眉文本。（预留字段，暂不支持。）
pageFooterContent	string	否	否	页脚文本。（预留字段，暂不支持。）
startDomPos	string	否	否	当前页的起始位置信息。
endDomPos	string	否	否	当前页的结束位置信息。
state	PageState	否	否	页面状态。
resourceIndex	number	否	否	书脊内容节点索引SpineItem.index。
pageOffset	number	否	否	页数偏移值，从0开始取值。例如：一个内容资源文件有50页，这个值的取值范围则为0-49。

constructor

Phone5.0.4(16)+PC/2in15.0.4(16)+Tablet5.0.4(16)+

constructor(nodeType: string, nodeId: string)

内容分页信息构造函数。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从版本5.0.4(16)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Reader.ReaderService.ReaderCore

起始版本： 5.0.4(16)

展开

参数名	类型	必填	说明
nodeType	string	是	节点类型，固定值为“ReaderCoreIdentity”。
nodeId	string	是	节点标识，根据子类PageDataInfo.resourceIndex、PageDataInfo.pageOffset字段自动生成。

名称	类型	只读	可选	说明
fontName	string	否	否	字体名称。
fontSize	number	否	否	字号大小，单位：px。
fontWeight	number	否	否	文本的字体粗细，依赖所引用的字体文件是否支持设置文本的粗细。（预留字段，暂不支持。）
fontColor	string	否	否	字体颜色。例如'#ffffff'、'rgba(248, 249, 250, 1)'。字体颜色值的限制如下： - 对于16进制颜色值，只支持6位颜色值，不支持透明度。 - 对于rgba颜色值，透明度的值只支持1。
fontPath	string	否	否	字体文件本地路径。支持两种存放路径： - 工程目录resources/rawfile文件夹。适合预置字体场景。 - 应用沙箱目录。适合在线下载字体场景。
lineHeight	number	否	否	行高系数。一行文本实际显示高度为fontSize * lineHeight。
nightMode	boolean	否	否	是否深色模式，需要开发者在监听到深、浅模式变化时手动设置。用于仿真翻页时背面主题色的绘制。 - true：深色模式。 - false：浅色模式，默认是false。
themeColor	string	否	否	主题背景色。示例：'#ffffff'、'rgba(248, 249, 250, 1)'。如果有设置背景图片的情况下，通常用于仿真翻页时背面主题色的绘制。如果没有设置背景图片，还会用于渲染阅读页的背景色。背景色的值限制如下： - 对于16进制颜色值，只支持6位颜色值，不支持透明度。 - 对于rgba颜色值，透明度的值只支持1。
themeBgImg	string	否	否	主题背景图路径，用于阅读页背景的绘制。支持两种存放路径： - 工程目录resources/rawfile文件夹。适合预置背景图场景。 - 应用沙箱目录。适合在线下载背景图场景。
flipMode	string	否	否	翻页方式。 - '0'：仿真。 - '1'：横滑。默认值为0。
scaledDensity	number	否	否	系统显示文本的缩放因子，该值通过display.getDefaultDisplaySync().scaledDensity字段获取。在智慧多窗等场景，文本缩放因子发生变化时，开发者需要调用ReaderComponentController组件控制器的setPageConfig接口更新该属性。
viewPortWidth	number	否	否	排版视口宽度，单位：px。
viewPortHeight	number	否	否	排版视口高度，单位：px。

ReaderComponentController

Phone5.0.4(16)+PC/2in15.0.4(16)+Tablet5.0.4(16)+

ReadPageComponent组件控制器，需要配合ReadPageComponent组件一起使用。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从版本5.0.4(16)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Reader.ReaderService.ReaderCore

起始版本： 5.0.4(16)

init

Phone5.0.4(16)+PC/2in15.0.4(16)+Tablet5.0.4(16)+

init(context: common.UIAbilityContext): Promise<void>

初始化ReaderComponentController，使用Promise异步回调。

说明

在集成ReaderComponentController时，初始化接口一定要优先于controller的其他接口之前执行。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从版本5.0.4(16)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Reader.ReaderService.ReaderCore

起始版本： 5.0.4(16)

参数：

展开

参数名	类型	必填	说明
context	common.UIAbilityContext	是	当前应用上下文。

返回值：

展开

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

展开

错误码ID	错误信息
401	Parameter error.
1016910004	Invalid caller.

示例：

收起
自动换行
深色代码主题
复制
import { readerCore, ReadPageComponent } from '@kit.ReaderKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { common } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Reader {
  private readerComponentController: readerCore.ReaderComponentController = new readerCore.ReaderComponentController();

  aboutToAppear(): void {
    this.init();
  }

  private async init() {
    let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
    await this.readerComponentController.init(context);
    hilog.info(0x0000, 'ReaderLog', `init succeeded`);
  }

  build() {
    Stack() {
      ReadPageComponent({
        controller: this.readerComponentController,
        readerCallback: (err: BusinessError, data: readerCore.ReaderComponentController) => {
          this.readerComponentController = data;
        }
      })
    }.width('100%').height('100%')
  }
}

registerBookParser

Phone5.0.4(16)+PC/2in15.0.4(16)+Tablet5.0.4(16)+

registerBookParser(bookParserHandler: bookParser.BookParserHandler): void

注册书籍解析器。

说明

registerBookParser接口需要在startPlay接口之前调用。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从版本5.0.4(16)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Reader.ReaderService.ReaderCore

起始版本： 5.0.4(16)

参数：

展开

参数名	类型	必填	说明
bookParserHandler	bookParser.BookParserHandler	是	书籍解析器。

错误码：

展开

错误码ID	错误信息
401	Parameter error.
1016900002	Read Page Component is not initialized.
1016900003	Invalid request.
1016900999	Other error.

示例：

收起
自动换行
深色代码主题
复制
import { bookParser, readerCore, ReadPageComponent } from '@kit.ReaderKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { common } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Reader {
  private readerComponentController: readerCore.ReaderComponentController = new readerCore.ReaderComponentController();

  aboutToAppear(): void {
    this.registerBookParser();
  }

  private async registerBookParser() {
    // 通过提前导入到应用沙箱目录中的书籍文件，初始化书籍解析器
    let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
    let filePath: string = `${context.filesDir}/abc.epub`;
    let bookParserHandler: bookParser.BookParserHandler = await bookParser.getDefaultHandler(filePath);
    await this.readerComponentController.init(context);
    this.readerComponentController.registerBookParser(bookParserHandler);
    hilog.info(0x0000, 'ReaderLog', `registerBookParser succeeded`);
  }

  build() {
    Stack() {
      ReadPageComponent({
        controller: this.readerComponentController,
        readerCallback: (err: BusinessError, data: readerCore.ReaderComponentController) => {
          this.readerComponentController = data;
        }
      })
    }.width('100%').height('100%')
  }
}

setPageConfig

Phone5.0.4(16)+PC/2in15.0.4(16)+Tablet5.0.4(16)+

setPageConfig(pageConfig: ReaderSetting): void

设置或者修改页面排版属性。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从版本5.0.4(16)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Reader.ReaderService.ReaderCore

起始版本： 5.0.4(16)

参数：

展开

参数名	类型	必填	说明
pageConfig	ReaderSetting	是	页面排版属性。

错误码：

展开

错误码ID	错误信息
401	Parameter error.
1016900002	Read Page Component is not initialized.
1016900003	Invalid request.
1016900999	Other error.

示例：

收起
自动换行
深色代码主题
复制
import { readerCore, ReadPageComponent } from '@kit.ReaderKit';
import { common } from '@kit.AbilityKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { display } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Reader {
  private readerComponentController: readerCore.ReaderComponentController = new readerCore.ReaderComponentController();

  aboutToAppear(): void {
    this.setPageConfig();
  }

  private async setPageConfig() {
    let readerSetting: readerCore.ReaderSetting = {
      fontName: '系统字体',
      fontPath: '',
      fontSize: 18,
      fontColor: '#000000',
      fontWeight: 400,
      lineHeight: 1.9,
      nightMode: false,
      themeColor: 'rgba(248, 249, 250, 1)',
      themeBgImg: '',
      flipMode: '0',
      scaledDensity: display.getDefaultDisplaySync().scaledDensity > 0 ? display.getDefaultDisplaySync().scaledDensity :
        1,
      viewPortWidth: 1260, // 视口宽度，需要根据设备实际情况获取，否则会导致阅读界面异常
      viewPortHeight: 2720 // 视口高度，需要根据设备实际情况获取，否则会导致阅读界面异常
    };

    let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
    await this.readerComponentController.init(context);
    this.readerComponentController.setPageConfig(readerSetting);
    hilog.info(0x0000, 'ReaderLog', `setPageConfig succeeded`);
  }

  build() {
    Stack() {
      ReadPageComponent({
        controller: this.readerComponentController,
        readerCallback: (err: BusinessError, data: readerCore.ReaderComponentController) => {
          this.readerComponentController = data;
        }
      })
    }.width('100%').height('100%')
  }
}

startPlay

Phone5.0.4(16)+PC/2in15.0.4(16)+Tablet5.0.4(16)+

startPlay(spineIndex: number, domPos: string): Promise<void>

以指定阅读进度打开书籍，使用Promise异步回调。

说明

startPlay接口需在registerBookParser事件成功触发后，才能调用。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从版本5.0.4(16)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Reader.ReaderService.ReaderCore

起始版本： 5.0.4(16)

参数：

展开

参数名	类型	必填	说明
spineIndex	number	是	内容资源索引SpineItem.index。
domPos	string	是	用户上次阅读进度。

返回值：

展开

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

展开

错误码ID	错误信息
401	Parameter error.
1016900002	Read Page Component is not initialized.
1016900003	Invalid request.
1016900999	Other error.
1016910001	Invalid spine item.
1016910002	Unexpected spine item resource data.
1016910003	Spine item resource data out of range.

示例：

收起
自动换行
深色代码主题
复制
import { bookParser, readerCore, ReadPageComponent } from '@kit.ReaderKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { common } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Reader {
  private readerComponentController: readerCore.ReaderComponentController = new readerCore.ReaderComponentController();

  aboutToAppear(): void {
    this.startPlay();
  }

  private async startPlay() {
    // 通过提前导入到应用沙箱目录中的书籍文件，初始化书籍解析器
    let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
    let filePath: string = `${context.filesDir}/abc.epub`;
    let bookParserHandler: bookParser.BookParserHandler = await bookParser.getDefaultHandler(filePath);
    let spineList: bookParser.SpineItem[] = bookParserHandler.getSpineList();
    let spineIndex: number = spineList[0].index;
    let domPos: string = '';

    await this.readerComponentController.init(context);
    this.readerComponentController.registerBookParser(bookParserHandler);
    // 调用startPlay接口初始化书籍内容显示
    await this.readerComponentController.startPlay(spineIndex || 0, domPos);
    hilog.info(0x0000, 'ReaderLog', `startPlay succeeded`);
  }

  build() {
    Stack() {
      ReadPageComponent({
        controller: this.readerComponentController,
        readerCallback: (err: BusinessError, data: readerCore.ReaderComponentController) => {
          this.readerComponentController = data;
        }
      })
    }.width('100%').height('100%')
  }
}

flipPage

Phone5.0.4(16)+PC/2in15.0.4(16)+Tablet5.0.4(16)+

flipPage(isNext: boolean): void

触发ReadPageComponent组件进行翻页。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从版本5.0.4(16)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Reader.ReaderService.ReaderCore

起始版本： 5.0.4(16)

参数：

展开

参数名	类型	必填	说明
isNext	boolean	是	是否翻到下一页。 - true：往下一页翻页。 - false：往上一页翻页。

参数名

类型

必填

说明

isNext

boolean

是

是否翻到下一页。

- true：往下一页翻页。

- false：往上一页翻页。

错误码：

展开

错误码ID	错误信息
401	Parameter error.
1016900002	Read Page Component is not initialized.
1016900003	Invalid request.
1016900999	Other error.

示例：

收起
自动换行
深色代码主题
复制
import { readerCore, ReadPageComponent } from '@kit.ReaderKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { common } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Reader {
  private readerComponentController: readerCore.ReaderComponentController = new readerCore.ReaderComponentController();

  aboutToAppear(): void {
    this.flipPage();
  }

  private async flipPage() {
    let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
    await this.readerComponentController.init(context);
    // 翻下一页
    this.readerComponentController.flipPage(true);
    hilog.info(0x0000, 'ReaderLog', `flipPage succeeded`);
  }

  build() {
    Stack() {
      ReadPageComponent({
        controller: this.readerComponentController,
        readerCallback: (err: BusinessError, data: readerCore.ReaderComponentController) => {
          this.readerComponentController = data;
        }
      })
    }.width('100%').height('100%')
  }
}

releaseBook

Phone5.0.4(16)+PC/2in15.0.4(16)+Tablet5.0.4(16)+

releaseBook(): void

释放书籍资源，在退出阅读器等释放资源场景时使用。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从版本5.0.4(16)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Reader.ReaderService.ReaderCore

起始版本： 5.0.4(16)

示例：

收起
自动换行
深色代码主题
复制
import { readerCore, ReadPageComponent } from '@kit.ReaderKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { common } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Reader {
  private readerComponentController: readerCore.ReaderComponentController = new readerCore.ReaderComponentController();

  aboutToAppear(): void {
    this.releaseBook();
  }

  private async releaseBook() {
    let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
    await this.readerComponentController.init(context);
    // 释放加载书籍时的资源
    this.readerComponentController.releaseBook();
    hilog.info(0x0000, 'ReaderLog', `releaseBook succeeded`);
  }

  build() {
    Stack() {
      ReadPageComponent({
        controller: this.readerComponentController,
        readerCallback: (err: BusinessError, data: readerCore.ReaderComponentController) => {
          this.readerComponentController = data;
        }
      })
    }.width('100%').height('100%')
  }
}

on('pageShow')

Phone5.0.4(16)+PC/2in15.0.4(16)+Tablet5.0.4(16)+

on(type: 'pageShow', callback: Callback<PageDataInfo>): void

注册页面展示的通知服务，该通知在页面排版成功展示后触发。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从版本5.0.4(16)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Reader.ReaderService.ReaderCore

起始版本： 5.0.4(16)

参数：

展开

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为“pageShow”。
callback	Callback<PageDataInfo>	是	回调函数，返回内容分页排版信息。

示例：

收起
自动换行
深色代码主题
复制
import { readerCore, ReadPageComponent } from '@kit.ReaderKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { common } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Reader {
  private readerComponentController: readerCore.ReaderComponentController = new readerCore.ReaderComponentController();

  aboutToAppear(): void {
    this.registerListener();
  }

  private async registerListener() {
    let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
    await this.readerComponentController.init(context)
    // 此处只演示方法调用，实际触发回调，需要配合startPlay接口使用
    this.readerComponentController.on('pageShow', (data: readerCore.PageDataInfo): void => {
      // 开发者可在此保存内容分布排版数据，利用data.resourceIndex及data.startDomPos数据调用startPlay接口继续阅读
      hilog.info(0x0000, 'ReaderLog', 'pageshow: data is: ' + JSON.stringify(data));
    });
  }

  build() {
    Stack() {
      ReadPageComponent({
        controller: this.readerComponentController,
        readerCallback: (err: BusinessError, data: readerCore.ReaderComponentController) => {
          this.readerComponentController = data;
        }
      })
    }.width('100%').height('100%')
  }
}

off('pageShow')

Phone5.0.4(16)+PC/2in15.0.4(16)+Tablet5.0.4(16)+

off(type: 'pageShow', callback?: Callback<PageDataInfo>): void

注销章节内容分页展示结果回调，可在页面销毁时调用。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从版本5.0.4(16)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Reader.ReaderService.ReaderCore

起始版本： 5.0.4(16)

参数：

展开

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为“pageShow”。
callback	Callback<PageDataInfo>	否	回调函数，需要传on('pageShow')注册时的回调函数，若不传则注销所有的回调函数。

示例：

收起
自动换行
深色代码主题
复制
import { readerCore, ReadPageComponent } from '@kit.ReaderKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { common } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Reader {
  private readerComponentController: readerCore.ReaderComponentController = new readerCore.ReaderComponentController();

  aboutToAppear(): void {
    this.unregisterListener();
  }

  private async unregisterListener() {
    let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
    let readerComponentController: readerCore.ReaderComponentController = new readerCore.ReaderComponentController();
    await readerComponentController.init(context);
    readerComponentController.off('pageShow');
    hilog.info(0x0000, 'ReaderLog', `offPageShow succeeded`);
  }

  build() {
    Stack() {
      ReadPageComponent({
        controller: this.readerComponentController,
        readerCallback: (err: BusinessError, data: readerCore.ReaderComponentController) => {
          this.readerComponentController = data;
        }
      })
    }.width('100%').height('100%')
  }
}

on('resourceRequest')

Phone5.0.4(16)+PC/2in15.0.4(16)+Tablet5.0.4(16)+

on(type: 'resourceRequest', callback: bookParser.CallbackRes<string, ArrayBuffer>): void

注册资源请求回调，如果设置了自定义背景，字体时，排版引擎会通过此接口获取对应的资源ArrayBuffer。

说明

注册多个资源请求回调时，只会生效最后一个。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从版本5.0.4(16)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Reader.ReaderService.ReaderCore

起始版本： 5.0.4(16)

参数：

展开

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为“resourceRequest”。
callback	bookParser.CallbackRes<string, ArrayBuffer>	是	回调函数，string：请求资源路径。ArrayBuffer：请求资源对应的二进制数据。

示例：

收起
自动换行
深色代码主题
复制
import { bookParser, readerCore, ReadPageComponent } from '@kit.ReaderKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { common } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Reader {
  private readerComponentController: readerCore.ReaderComponentController = new readerCore.ReaderComponentController();
  // 字体文件以实际文件名及路径为准
  private selectFontPath = 'fonts/SourceHanSerifCN-VF.ttf';

  aboutToAppear(): void {
    this.registerListener();
  }

  private async registerListener() {
    let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
    await this.readerComponentController.init(context);
    // 此处只演示方法调用，实际触发回调，需要配合startPlay接口使用
    this.readerComponentController.on('resourceRequest', this.resourceRequest);
  }

  private resourceRequest: bookParser.CallbackRes<string, ArrayBuffer> = (fileName: string): ArrayBuffer => {
    if (this.isFont(fileName)) {
      let res = $rawfile(this.selectFontPath);
      let context = this.getUIContext().getHostContext();
      if (res && context) {
        // 获取资源路径下的字体数据
        let value: Uint8Array = context.resourceManager.getRawFileContentSync(this.selectFontPath);
        hilog.info(0x0000, 'ReaderLog', 'resourceRequest : get success');
        return value.buffer as ArrayBuffer;
      }
    }
    return new ArrayBuffer(0);
  }

  private isFont(filePath: string): boolean {
    let options = ['.ttf', '.woff2', '.otf'];
    let path = filePath.toLowerCase();
    let result = path.indexOf(options[0]) != -1 || path.indexOf(options[1]) != -1 || path.indexOf(options[2]) != -1;
    hilog.info(0x0000, 'ReaderLog', 'isFont = ' + result);
    return result;
  }

  build() {
    Stack() {
      ReadPageComponent({
        controller: this.readerComponentController,
        readerCallback: (err: BusinessError, data: readerCore.ReaderComponentController) => {
          this.readerComponentController = data;
        }
      })
    }.width('100%').height('100%')
  }
}

off('resourceRequest')

Phone5.0.4(16)+PC/2in15.0.4(16)+Tablet5.0.4(16)+

off(type: 'resourceRequest', callback?: bookParser.CallbackRes<string, ArrayBuffer>): void

注销资源请求回调接口，可在页面销毁时调用。

模型约束： 此接口仅可在Stage模型下使用。

元服务API： 从版本5.0.4(16)开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Reader.ReaderService.ReaderCore

起始版本： 5.0.4(16)

参数：

展开

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为“resourceRequest”。
callback	bookParser.CallbackRes<string, ArrayBuffer>	否	回调函数，需要传on('resourceRequest')注册时的回调函数，若不传则注销所有的回调函数。

示例：

收起
自动换行
深色代码主题
复制
import { readerCore, ReadPageComponent } from '@kit.ReaderKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { common } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Reader {
  private readerComponentController: readerCore.ReaderComponentController = new readerCore.ReaderComponentController();

  aboutToAppear(): void {
    this.unregisterListener();
  }

  private async unregisterListener() {
    let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
    await this.readerComponentController.init(context);
    this.readerComponentController.off('resourceRequest');
    hilog.info(0x0000, 'ReaderLog', `offResourceRequest succeeded`);
  }

  build() {
    Stack() {
      ReadPageComponent({
        controller: this.readerComponentController,
        readerCallback: (err: BusinessError, data: readerCore.ReaderComponentController) => {
          this.readerComponentController = data;
        }
      })
    }.width('100%').height('100%')
  }
}

bookParser（书籍解析能力）

ArkTS组件

意见反馈

以上内容对您是否有帮助？

意见反馈

如果您有其他疑问，您也可以通过开发者社区问答频道来和我们联系探讨。

社区提问 AI 助手提问