mupdf-android-viewer 设计与实现浅析

2024-04-20 20:58

本文主要是介绍mupdf-android-viewer 设计与实现浅析,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

目前在 Android 应用开发中,可用的 PDF 文档展示的开源项目好几个,最为方便的是 AndroidPdfViewer,它基于 PdfiumAndroid 开发而来,而后者则是由 AOSP 中的 pdfium 封转而来。另外一个 PDF 文档显示的开源项目 mupdf 也非常强大。本文简单分析 MuPDF 库的 Android 封装。

MuPDF 是一个用于查看和改变 PDF,XPS 和 E-book 文档的开源软件框架。它为多个不同的平台提供了查看器,命令行工具,以及软件库以用于构建工具和应用程序。

mupdf-android-viewer 是 MuPDF 为 Android 平台提供的查看器,它的代码可以通过 Git 下载得到:

$ git clone git://git.ghostscript.com/mupdf-android-viewer.git

mupdf-android-viewer 工程的目录结构很简单:

mupdf-android-viewer$ tree
.
├── app
│   ├── build.gradle
│   └── src
│       └── main
│           ├── AndroidManifest.xml
│           ├── java
│           │   └── com
│           │       └── artifex
│           │           └── mupdf
│           │               └── viewer
│           │                   └── app
│           │                       └── LibraryActivity.java
│           └── res
│               ├── drawable
│               │   └── ic_mupdf.xml
│               └── values
│                   └── strings.xml
├── build.gradle
├── COPYING
├── gradle
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── jni
├── lib
│   ├── build.gradle
│   └── src
│       └── main
│           ├── AndroidManifest.xml
│           ├── java
│           │   └── com
│           │       └── artifex
│           │           └── mupdf
│           │               └── viewer
│           │                   ├── CancellableAsyncTask.java
│           │                   ├── CancellableTaskDefinition.java
│           │                   ├── DocumentActivity.java
│           │                   ├── MuPDFCancellableTaskDefinition.java
│           │                   ├── MuPDFCore.java
│           │                   ├── OutlineActivity.java
│           │                   ├── PageAdapter.java
│           │                   ├── PageView.java
│           │                   ├── ReaderView.java
│           │                   ├── SearchTask.java
│           │                   ├── SearchTaskResult.java
│           │                   └── Stepper.java
│           └── res
│               ├── drawable
│               │   ├── button.xml
│               │   ├── ic_chevron_left_white_24dp.xml
│               │   ├── ic_chevron_right_white_24dp.xml
│               │   ├── ic_close_white_24dp.xml
│               │   ├── ic_link_white_24dp.xml
│               │   ├── ic_search_white_24dp.xml
│               │   ├── ic_toc_white_24dp.xml
│               │   ├── page_indicator.xml
│               │   ├── seek_line.xml
│               │   └── seek_thumb.xml
│               ├── layout
│               │   └── document_activity.xml
│               └── values
│                   ├── colors.xml
│                   └── strings.xml
├── Makefile
├── README
└── settings.gradle27 directories, 41 files

其中 settings.gradle 内容如下:

include ':jni'
include ':lib'
include ':app'

mupdf-android-viewer 主要由三个模块组成,分别为 app,lib 和 jni,app 是 Android MuPDF 查看器的应用程序主工程,jni 是 MuPDF 的核心库,lib 是基于 MuPDF 核心库封装出来的用于显示 PDF 文档的 UI 控件库。Android MuPDF 查看器应用程序基于 lib 库构建而成。

MuPDF 的 核心库可以有两个来源,一是远程 Maven 仓库,其中 Maven 仓库的地址为 http://maven.ghostscript.com/,Android 核心库的坐标为 com.artifex.mupdf:fitz:1.13.0,这可以从 mupdf-android-viewer/build.gradlemupdf-android-viewer/lib/build.gradle 文件中看出来;二是由源码编译而来,编译的方法如 为 Android 编译 MuPDF 查看器 一文所示,MuPDF 的 核心库的源码下载之后位于 mupdf-android-viewer/jni 目录下。

MuPDF 的 Android 核心库又由三个部分组成,分别为它所依赖的第三方库,MuPDF 本地层库和 MuPDF 本地层库的 JNI 封装。其中 MuPDF 本地层库的 JNI 封装位于 mupdf-android-viewer/jni/libmupdf/platform/java,MuPDF 本地层库位于 mupdf-android-viewer/jni/libmupdf/source,依赖的第三方库则位于 mupdf-android-viewer/jni/libmupdf/thirdparty

MuPDF Android 查看器的整体组件结构如下图所示:

截图_2018-06-07_17-18-34.png

MuPDF UI 控件库的代码位于 mupdf-android-viewer/lib,它连接了上层的 Android 应用程序和下层的 MuPDF 核心库,其中 MuPDFCore 类封装了 MuPDF 核心库用 JNI 封装的底层 MuPDF 库的 Java 接口;ReaderViewPageAdapterPageViewSearchTaskSearchTaskResult 基于 MuPDFCore 类实现 Android 应用程序的 UI 组件,以方便在 Android 应用中查看 PDF 文件;DocumentActivity 和 OutlineActivity 是两个 Activity,这两个页面分别用于显示 PDF 文档及 PDF 文档的目录。

MuPDFCore 类的定义如下:

package com.artifex.mupdf.viewer;import com.artifex.mupdf.fitz.Cookie;
import com.artifex.mupdf.fitz.Document;
import com.artifex.mupdf.fitz.Outline;
import com.artifex.mupdf.fitz.Page;
import com.artifex.mupdf.fitz.Link;
import com.artifex.mupdf.fitz.DisplayList;
import com.artifex.mupdf.fitz.Rect;
import com.artifex.mupdf.fitz.RectI;
import com.artifex.mupdf.fitz.Matrix;
import com.artifex.mupdf.fitz.android.AndroidDrawDevice;import android.content.Context;
import android.graphics.Bitmap;
import android.graphics.PointF;
import android.graphics.RectF;import java.util.ArrayList;public class MuPDFCore
{private int resolution;private Document doc;private Outline[] outline;private int pageCount = -1;private int currentPage;private Page page;private float pageWidth;private float pageHeight;private DisplayList displayList;public MuPDFCore(String filename) {doc = Document.openDocument(filename);pageCount = doc.countPages();resolution = 160;currentPage = -1;}public MuPDFCore(byte buffer[], String magic) {doc = Document.openDocument(buffer, magic);pageCount = doc.countPages();resolution = 160;currentPage = -1;}public String getTitle() {return doc.getMetaData(Document.META_INFO_TITLE);}public int countPages() {return pageCount;}private synchronized void gotoPage(int pageNum) {/* TODO: page cache */if (pageNum > pageCount-1)pageNum = pageCount-1;else if (pageNum < 0)pageNum = 0;if (pageNum != currentPage) {currentPage = pageNum;if (page != null)page.destroy();page = null;if (displayList != null)displayList.destroy();displayList = null;page = doc.loadPage(pageNum);Rect b = page.getBounds();pageWidth = b.x1 - b.x0;pageHeight = b.y1 - b.y0;}}public synchronized PointF getPageSize(int pageNum) {gotoPage(pageNum);return new PointF(pageWidth, pageHeight);}public synchronized void onDestroy() {if (displayList != null)displayList.destroy();displayList = null;if (page != null)page.destroy();page = null;if (doc != null)doc.destroy();doc = null;}public synchronized void drawPage(Bitmap bm, int pageNum,int pageW, int pageH,int patchX, int patchY,int patchW, int patchH,Cookie cookie) {gotoPage(pageNum);if (displayList == null)displayList = page.toDisplayList(false);float zoom = resolution / 72;Matrix ctm = new Matrix(zoom, zoom);RectI bbox = new RectI(page.getBounds().transform(ctm));float xscale = (float)pageW / (float)(bbox.x1-bbox.x0);float yscale = (float)pageH / (float)(bbox.y1-bbox.y0);ctm.scale(xscale, yscale);AndroidDrawDevice dev = new AndroidDrawDevice(bm, patchX, patchY);displayList.run(dev, ctm, cookie);dev.destroy();}public synchronized void updatePage(Bitmap bm, int pageNum,int pageW, int pageH,int patchX, int patchY,int patchW, int patchH,Cookie cookie) {drawPage(bm, pageNum, pageW, pageH, patchX, patchY, patchW, patchH, cookie);}public synchronized Link[] getPageLinks(int pageNum) {gotoPage(pageNum);return page.getLinks();}public synchronized RectF[] searchPage(int pageNum, String text) {gotoPage(pageNum);Rect[] rs = page.search(text);RectF[] rfs = new RectF[rs.length];for (int i=0; i < rs.length; ++i)rfs[i] = new RectF(rs[i].x0, rs[i].y0, rs[i].x1, rs[i].y1);return rfs;}public synchronized boolean hasOutline() {if (outline == null)outline = doc.loadOutline();return outline != null;}private void flattenOutlineNodes(ArrayList<OutlineActivity.Item> result, Outline list[], String indent) {for (Outline node : list) {if (node.title != null)result.add(new OutlineActivity.Item(indent + node.title, node.page));if (node.down != null)flattenOutlineNodes(result, node.down, indent + "    ");}}public synchronized ArrayList<OutlineActivity.Item> getOutline() {ArrayList<OutlineActivity.Item> result = new ArrayList<OutlineActivity.Item>();flattenOutlineNodes(result, outline, "");return result;}public synchronized boolean needsPassword() {return doc.needsPassword();}public synchronized boolean authenticatePassword(String password) {return doc.authenticatePassword(password);}
}

由 MuPDFCore 类的实现不难看出,MuPDF 核心库在查看 PDF 文件方面所提供的功能如下:

1. :解析 PDF 文档。这主要是在 MuPDFCore 类的构造函数里完成的,通过 com.artifex.mupdf.fitz.Document 类的 openDocument() 方法执行。PDF 文档解析完成之后,可以借助于 com.artifex.mupdf.fitz.Document 的对象获得 PDF 文档的标题,页数等信息。
2. :跳转到 PDF 文档的特定页上。这主要通过 gotoPage() 方法完成。这将为目标页创建 com.artifex.mupdf.fitz.Page 对象,并可以获得这一页绘制之后的尺寸。
3. :将 PDF 文档特定页的内容绘制到 Bitmap 上。绘制通过 com.artifex.mupdf.fitz.Page 对象创建的 com.artifex.mupdf.fitz.DisplayList 对象完成。在绘制的时候,还会根据 Bitmap 的尺寸和 PDF 目标文档的尺寸做一定的放缩。
4. :在 PDF 文档中搜索特定的字符串。在 PDF 文档的特定页执行的搜索操作以找到的文本在该页中占据的矩形框的数组的形式返回。
5. :获得 PDF 文档的目录信息。这主要是通过 hasOutline()getOutline() 方法实现的。其中目录项由 OutlineActivity.Item 描述:

public class OutlineActivity extends ListActivity
{public static class Item implements Serializable {public String title;public int page;public Item(String title, int page) {this.title = title;this.page = page;}public String toString() {return title;}}

OutlineActivity.Item 描述了特定目录项的标题及该目录项在 PDF 文档中的页码。
6. :判断查看 PDF 文档是否需要密码,以及配置认证密码。这主要是通过 needsPassword()authenticatePassword(String password) 方法实现的。

MuPDF 核心库提供的最主要的功能是解析 PDF 文档,跳转到特定页,并将该页的实际内容绘制到 Bitmap 上。基于 MuPDF 核心库实现 Android 应用程序的 UI 控件,最主要要做的即是创建、管理并展示 PDF 文档中各页的 Bitmap 图片。

这篇关于mupdf-android-viewer 设计与实现浅析的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/921309

相关文章

C++中unordered_set哈希集合的实现

《C++中unordered_set哈希集合的实现》std::unordered_set是C++标准库中的无序关联容器,基于哈希表实现,具有元素唯一性和无序性特点,本文就来详细的介绍一下unorder... 目录一、概述二、头文件与命名空间三、常用方法与示例1. 构造与析构2. 迭代器与遍历3. 容量相关4

C++中悬垂引用(Dangling Reference) 的实现

《C++中悬垂引用(DanglingReference)的实现》C++中的悬垂引用指引用绑定的对象被销毁后引用仍存在的情况,会导致访问无效内存,下面就来详细的介绍一下产生的原因以及如何避免,感兴趣... 目录悬垂引用的产生原因1. 引用绑定到局部变量,变量超出作用域后销毁2. 引用绑定到动态分配的对象,对象

SpringBoot基于注解实现数据库字段回填的完整方案

《SpringBoot基于注解实现数据库字段回填的完整方案》这篇文章主要为大家详细介绍了SpringBoot如何基于注解实现数据库字段回填的相关方法,文中的示例代码讲解详细,感兴趣的小伙伴可以了解... 目录数据库表pom.XMLRelationFieldRelationFieldMapping基础的一些代

Java HashMap的底层实现原理深度解析

《JavaHashMap的底层实现原理深度解析》HashMap基于数组+链表+红黑树结构,通过哈希算法和扩容机制优化性能,负载因子与树化阈值平衡效率,是Java开发必备的高效数据结构,本文给大家介绍... 目录一、概述:HashMap的宏观结构二、核心数据结构解析1. 数组(桶数组)2. 链表节点(Node

Java AOP面向切面编程的概念和实现方式

《JavaAOP面向切面编程的概念和实现方式》AOP是面向切面编程,通过动态代理将横切关注点(如日志、事务)与核心业务逻辑分离,提升代码复用性和可维护性,本文给大家介绍JavaAOP面向切面编程的概... 目录一、AOP 是什么?二、AOP 的核心概念与实现方式核心概念实现方式三、Spring AOP 的关

Python实现字典转字符串的五种方法

《Python实现字典转字符串的五种方法》本文介绍了在Python中如何将字典数据结构转换为字符串格式的多种方法,首先可以通过内置的str()函数进行简单转换;其次利用ison.dumps()函数能够... 目录1、使用json模块的dumps方法:2、使用str方法:3、使用循环和字符串拼接:4、使用字符

Linux下利用select实现串口数据读取过程

《Linux下利用select实现串口数据读取过程》文章介绍Linux中使用select、poll或epoll实现串口数据读取,通过I/O多路复用机制在数据到达时触发读取,避免持续轮询,示例代码展示设... 目录示例代码(使用select实现)代码解释总结在 linux 系统里,我们可以借助 select、

Linux挂载linux/Windows共享目录实现方式

《Linux挂载linux/Windows共享目录实现方式》:本文主要介绍Linux挂载linux/Windows共享目录实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地... 目录文件共享协议linux环境作为服务端(NFS)在服务器端安装 NFS创建要共享的目录修改 NFS 配

通过React实现页面的无限滚动效果

《通过React实现页面的无限滚动效果》今天我们来聊聊无限滚动这个现代Web开发中不可或缺的技术,无论你是刷微博、逛知乎还是看脚本,无限滚动都已经渗透到我们日常的浏览体验中,那么,如何优雅地实现它呢?... 目录1. 早期的解决方案2. 交叉观察者:IntersectionObserver2.1 Inter

Spring Gateway动态路由实现方案

《SpringGateway动态路由实现方案》本文主要介绍了SpringGateway动态路由实现方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随... 目录前沿何为路由RouteDefinitionRouteLocator工作流程动态路由实现尾巴前沿S