bookParser（书籍解析能力）

导入模块

import { bookParser } from '@kit.ReaderKit';

BookInfo

书籍基本信息。

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

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

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

起始版本： 5.0.4(16)

SpineItem

书脊（spine）内容节点，标识着可阅读的一个内容资源（例如：chapter1.xhtml)。

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

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

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

起始版本： 5.0.4(16)

CatalogItem

书籍目录节点，可用于目录列表的展示。

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

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

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

起始版本： 5.0.4(16)

CallbackRes

type CallbackRes<T, V> = (data: T) => V

书籍资源请求回调接口，在排版引擎渲染界面时调用，需配合ReaderComponentController的注册接口on('resourceRequest')使用。如果有自定义背景及字体资源，需要在此返回对应资源。

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

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

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

起始版本： 5.0.4(16)

参数：

返回值：

示例：

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);
    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%')
  }
}

getDefaultHandler

getDefaultHandler(path: string): Promise<BookParserHandler>

获取书籍默认解析器。使用Promise异步回调。

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

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

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

起始版本： 5.0.4(16)

参数：

返回值：

错误码：

示例：

import { bookParser } from '@kit.ReaderKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { common } from '@kit.AbilityKit';

@Entry
@Component
struct Reader {
  aboutToAppear(): void {
    this.initBookParser();
  }

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

  build() {
    // 业务自行实现页面布局
  }
}

BookParserHandler

书籍解析接口类。

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

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

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

起始版本： 5.0.4(16)

[h2]getBookInfo

getBookInfo(): BookInfo

获取书籍信息。

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

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

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

起始版本： 5.0.4(16)

返回值：

错误码：

示例：

import { bookParser } from '@kit.ReaderKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { common } from '@kit.AbilityKit';

@Entry
@Component
struct Reader {
  aboutToAppear(): void {
    this.getBookInfo();
  }

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

  build() {
    // 业务自行实现页面布局
  }
}

[h2]getCatalogList

getCatalogList(): CatalogItem[]

获取书籍目录列表。

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

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

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

起始版本： 5.0.4(16)

返回值：

错误码：

示例：

import { bookParser } from '@kit.ReaderKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { common } from '@kit.AbilityKit';

@Entry
@Component
struct Reader {
  aboutToAppear(): void {
    this.getCatalogList();
  }

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

  build() {
    // 业务自行实现页面布局
  }
}

[h2]getSpineList

getSpineList(): SpineItem[]

获取书脊内容列表。

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

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

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

起始版本： 5.0.4(16)

返回值：

错误码：

示例：

import { bookParser } from '@kit.ReaderKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { common } from '@kit.AbilityKit';

@Entry
@Component
struct Reader {
  aboutToAppear(): void {
    this.getSpineList();
  }

  private async getSpineList() {
    // 通过提前导入到应用沙箱目录中的书籍文件，初始化书籍解析器
    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();
    hilog.info(0x0000, 'ReaderLog', `getSpineList succeeded, spineList:` + JSON.stringify(spineList));
  }

  build() {
    // 业务自行实现页面布局
  }
}

[h2]getSpineItemContent

getSpineItemContent(spineIndex: number): Promise<string>

获取单个书脊资源里的内容，当排版引擎获取资源文件对应内容时会调用。如果不需要自定义排版引擎，开发者不需要关注。使用Promise异步回调。

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

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

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

起始版本： 5.0.4(16)

参数：

返回值：

错误码：

示例：

import { bookParser } from '@kit.ReaderKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { common } from '@kit.AbilityKit';

@Entry
@Component
struct Reader {
  aboutToAppear(): void {
    this.getSpineItemContent();
  }

  private async getSpineItemContent() {
    // 通过提前导入到应用沙箱目录中的书籍文件，初始化书籍解析器
    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 spineItemContent: string = await bookParserHandler.getSpineItemContent(spineList[0].index);
    hilog.info(0x0000, 'ReaderLog', `getSpineItemContent succeeded, spineItemContent:` + JSON.stringify(spineItemContent));
  }

  build() {
    // 业务自行实现页面布局
  }
}

[h2]getResourceContent

getResourceContent(spineIndex: number, filePath: string): ArrayBuffer

获取书籍内容资源。

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

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

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

起始版本： 5.0.4(16)

参数：

返回值：

错误码：

示例：

import { bookParser } from '@kit.ReaderKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { common } from '@kit.AbilityKit';

@Entry
@Component
struct Reader {
  aboutToAppear(): void {
    this.getResourceContent();
  }

  private async getResourceContent() {
    // 通过提前导入到应用沙箱目录中的书籍文件，初始化书籍解析器
    let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
    let filePath: string = `${context.filesDir}/abc.epub`;
    let bookParserHandler: bookParser.BookParserHandler = await bookParser.getDefaultHandler(filePath);
    // 需要替换成实际书籍文件中存在的图片名称
    let imagePath = './2188093923226426261_image001.jpg'
    let spineList: bookParser.SpineItem[] = bookParserHandler.getSpineList();
    let resourceContent: ArrayBuffer = bookParserHandler.getResourceContent(spineList[0].index, imagePath);
    hilog.info(0x0000, 'ReaderLog', `getResourceContent succeeded, resourceContentByteLength:` + resourceContent.byteLength);
  }

  build() {
    // 业务自行实现页面布局
  }
}

[h2]getDomPosByCatalogHref

getDomPosByCatalogHref(href: string): string

获取阅读起始位置domPos，可用于阅读进度标识（例如：跳转到指定阅读位置）。

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

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

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

起始版本： 5.0.4(16)

参数：

返回值：

错误码：

示例：

import { bookParser } from '@kit.ReaderKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { common } from '@kit.AbilityKit';

@Entry
@Component
struct Reader {
  aboutToAppear(): void {
    this.getDomPosByCatalogHref();
  }

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

  build() {
    // 业务自行实现页面布局
  }
}

[h2]getAbsoluteResourcePath

getAbsoluteResourcePath(spineIndex: number): string

获取资源的完整文件路径。

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

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

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

起始版本： 5.0.4(16)

参数：

返回值：

错误码：

示例：

import { bookParser } from '@kit.ReaderKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { common } from '@kit.AbilityKit';

@Entry
@Component
struct Reader {
  aboutToAppear(): void {
    this.getAbsoluteResourcePath();
  }

  private async getAbsoluteResourcePath() {
    // 通过提前导入到应用沙箱目录中的书籍文件，初始化书籍解析器
    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 resourcePath: string = bookParserHandler.getAbsoluteResourcePath(spineList[0].index);
    hilog.info(0x0000, 'ReaderLog', `getAbsoluteResourcePath succeeded, resourcePath:` + resourcePath);
  }

  build() {
    // 业务自行实现页面布局
  }
}