如何在Jetpack Compose中显示PDF _jetpack compose如何展示pdf文件

2401_83739434

已于 2024-04-10 22:57:23 修改

阅读量359

点赞数 4

分类专栏： 2024年程序员学习文章标签： pdf android

于 2024-04-10 22:57:21 首次发布

本文链接：https://blog.csdn.net/2401_83739434/article/details/137614862

版权

2024年程序员学习专栏收录该内容

284 篇文章 0 订阅

订阅专栏

目标 Bitmap, 该方法将在此实例上加载页面渲染.
destClip: 一个Rect类的实例, 是一个可选参数, 如果你只想在目标Bitmap的一部分上渲染页面, 它可能会很有用.
transform: 是Matrix类的一个实例, 是一个可选参数, 用于实现以点表示的页面坐标和以像素表示的Bitmap坐标之间的转换.
renderMode是一个整数, 表示渲染模式, 有两种模式, 它们是Page类中定义的两个常量值: RENDER_MODE_FOR_DISPLAY和RENDER_MODE_FOR_PRINT. 在本例中, 我们将只使用第一种模式.

要知道的一个重要细节是, 如果没有传递destClip和transform参数, 页面将被渲染以占据整个目标Bitmap, 这就清楚地表明, 如果我们想避免页面变形, 目标Bitmap的宽度和高度之间的比例必须与要渲染的页面相匹配.
正如我们稍后将看到的, getWidth() 和 getHeight()方法在这方面将非常有用.

第一个实现

让我们尝试制定第一个实现方案, 其背后的想法是创建一个类, 该类能够在给定ParcelFileDescriptor作为输入的情况下, 提供Bitmap作为输出的列表.
然后, 我们将使用LazyColumn和Composable的Image在垂直列表中显示每个Bitmap.

为了清楚起见, 我们将把这个类称为PdfRender, 其使用方法如下:

@Composable
fun PDFReader(file: File) {
Box(
modifier = Modifier.fillMaxSize()
) {
val pdfReader = PdfRender(
fileDescriptor = ParcelFileDescriptor.open(
file,
ParcelFileDescriptor.MODE_READ_ONLY
)
)
LazyColumn {
items(count = pdfRender.pageCount) {
Image(
bitmap = pdfRender.pageLists[index].pageContent.asImageBitmap(),
contentDescription = “Psd page number: $index”
)
}
}
}
}

代码是自解释的, 但总结一下, 我们可以看到首先创建了一个 ParcelFileDescriptor 实例, 然后将其传递给 PdfRender 类, 该类将显示 pdf 中包含的页数和 Bitmap 列表.
此时, 如前所述, 会创建一个LazyColumn, 并在其中遍历Bitmap列表, 调用每个元素的可合成图像.

现在让我们看看PdfRender类的实现:

internal class PdfRender(
private val fileDescriptor: ParcelFileDescriptor
) {
private val pdfRenderer = PdfRenderer(fileDescriptor)
val pageCount get() = pdfRenderer.pageCount

val pageLists: List = List(pdfRenderer.pageCount) {
Page(
index = it,
pdfRenderer = pdfRender
)
}

fun close() {
pageLists.forEach {
it.recycle()
}
pdfRenderer.close()
fileDescriptor.close()
}

class Page(
val index: Int,
val pdfRenderer: PdfRenderer
) {
val pageContent = createBitmap()

private fun createBitmap(): Bitmap {
val newBitmap: Bitmap
pdfRenderer.openPage(index).use {
newBitmap = createBlankBitmap(
width = currentPage.width,
height = currentPage.height
)
currentPage.render(
newBitmap,
null,
null,
PdfRenderer.Page.RENDER_MODE_FOR_DISPLAY
)
}
return newBitmap
}

fun recycle() {
pageContent.recycle()
}

private fun createBlankBitmap(
width: Int,
height: Int
): Bitmap {
return createBitmap(
width,
height,
Bitmap.Config.ARGB_8888
).apply {
val canvas = Canvas(this)
canvas.drawBitmap(this, 0f, 0f, null)
}
}
}
}

首先, 创建一个PdfRenderer类的实例, 并通过pageCount字段显示PDF的页数, 该字段直接引用PdfRenderer类的pageCount字段.
随后, 创建了Page类的实例列表和close()函数, 该函数可用于释放已使用的内存并关闭PdfRenderer和ParcelFileDescriptor.

分析Page类, 我们可以看到它是如何将两个参数作为输入的, 即PdfRenderer实例和页面索引.
在创建每个实例时, pageContent 字段通过调用createBitmap()函数来填充.

在该函数的执行过程中, 第一步是通过openPage方法打开当前页面, 通过该方法提供的实例, 我们可以获取当前页面的大小, 然后创建一个与页面大小相同的空Bitmap, 并将其传递给当前页面实例的 render 方法.

该方法会渲染页面, 并将渲染结果填充到传入的Bitmap中.

让我们看看最终结果

在这个测试中, 我使用了一个超过 200MB 的超大 PDF 文件来说明渲染时间是如何过长的. 显然, 我们无法忍受这种性能水平. 此外, 在使用 Android Studio 剖析器分析应用程序时, 我们发现内存消耗也过大.

对于一个只打开 PDF 的应用程序来说, 近 6GB 的内存消耗是相当大的. 性能不佳的原因很简单: 所有页面都是在打开时渲染的, 所有创建的Bitmap即使在不显示时也会保留在内存中.

然而, 要找到解决这个问题的办法比想象的要复杂得多. 事实上, 我们不可能并行渲染每个页面以减少加载时间, 因为如前所述, PdfRenderer类不允许我们同时打开多个页面.

此外, 我们还需要设计一种方法, 只渲染当前显示的页面, 最多也只渲染紧随其后的页面, 并将其保留在内存中.

另一个可能不会立即显现的问题是用户界面冻结; 事实上, 在当前的实现中, 用户界面一直冻结到所有页面加载和渲染完毕.

协程前来拯救

要解决用户界面冻结和加载时间的问题, 一种实用的方法是使用例程将渲染过程转移到异步线程中. 不过, 虽然转移到并行线程可以解决前两个问题, 但却会带来新的挑战:

调用Composable Image时, Bitmap可能尚未渲染.
然而, 渲染图像必须按顺序进行, 因为一次只能打开一个页面. 尽管如此, 如果一个页面已渲染完成, 我们希望立即显示它, 而无需等待其他页面的渲染.

为了解决Compose中文件的创建与页面渲染之间的异步性问题, 我们可以使用 StateFlow. 它允许我们在Compose应用中使用 collectAsState 方法, 因此当一个新值发布时, Composable应用也会随之更新.

因此, 我们的想法是将Page类的pageContent字段从一个简单的Bitmap转化为一个MutableStateFlow<Bitmap?>. 因此, 在Compose应用中, 只有当状态流中填充了Bitmap时, 我们才会调用Image函数.

让我们看看示例代码:

page.pageContent.collectAsState().value?.asImageBitmap()?.let {
Image(
bitmap = it,
contentDescription = “Pdf page number: $index”
)
}

至于渲染的顺序问题, 由于我们将其执行转移到了一个协程中, 最直接的解决方案就是使用Mutex来确保同一时间只有一个页面被渲染.

class Page(
val mutex: Mutex,
val index: Int,
val pdfRenderer: PdfRenderer,
val coroutineScope: CoroutineScope
) {
var isLoaded = false

var job: Job? = null

val pageContent = MutableStateFlow<Bitmap?>(null)

fun load() {
if (!isLoaded) {
job = coroutineScope.launch {
mutex.withLock {
val newBitmap: Bitmap
pdfRenderer.openPage(index).use { currentPage ->
newBitmap = createBlankBitmap(
width = currentPage.width,
height = currentPage.height
)
currentPage.render(
newBitmap,
null,
null,
PdfRenderer.Page.RENDER_MODE_FOR_DISPLAY
)
}
isLoaded = true
pageContent.emit(newBitmap)
}
}
}
}

fun recycle() {
isLoaded = false
val oldBitmap = pageContent.value
pageContent.tryEmit(null)
oldBitmap?.recycle()
}

从这个代码片段中, 我们可以看到我们是如何将页面渲染转移到一个名为load()的函数中的, 在这个函数中, 我们在一个CoroutineScope上启动了一个协程, 这个CoroutineScope是由PdfRender类提供的, 因此它对于所有Page实例来说都是唯一的.

然后, 在whitLock方法的回调中执行渲染, 确保一次只打开, 渲染一个页面, 然后在MutableStateFlow pageContent上输出.

此时, 我们已经解决了异步问题, 但性能问题依然存在. 事实上, 即使我们现在可以将渲染转移到一个协程中, 但事实依然是, 在打开时渲染所有页面会浪费计算资源和内存.

不过, 在这一点上, 只要每个 Page 实例的 load() 方法只在该页面必须出现在屏幕上时才被调用, 解决方案就会立竿见影.

为此, 我们可以使用Compose提供的组件或SideEffect.

@Composable
fun PDFReader(file: File) {
Box(
modifier = Modifier.fillMaxSize()
) {
val pdfRender = PdfRender(
fileDescriptor = ParcelFileDescriptor.open(
file,
ParcelFileDescriptor.MODE_READ_ONLY
)
)
LazyColumn {
items(count = pdfRender.pageCount) { index ->
val page = pdfRender.pageLists[index]
LaunchedEffect(key1 = Unit) {
page.load()
}
page.pageContent.collectAsState().value?.asImageBitmap()?.let {
Image(
bitmap = it,
contentDescription = “Pdf page number: $index”
)
}
}
}
}
}

从代码片段中可以看到, 我们添加了一个LaunchedEffect, 并将key1参数设置为Unit.

当一个页面从屏幕上消失时, 它的Composable元素将离开组合, 然后在它回来时被重新创建, 然后LaunchedEffect将再次被执行.

然而, 如果用户反复滚动列表并交替滚动方向, 这可能会导致无用的重复页面渲染.

在前面展示的Page类的实现中已经有了解决方案, 事实上, isLoaded变量在渲染完成后被设置为true, 并在load()函数启动时进行检查, 如果变量结果为true, 则不会再次渲染.

在Page的实现中, 我们已经可以看到变量isLoaded是如何在recycle()方法中设置为false的. 我们将在下一章看到它, 与此同时, 让我们看看PdfRender类的当前实现和我们得到的结果.

internal class PdfRender(
private val fileDescriptor: ParcelFileDescriptor
) {
private val pdfRenderer = PdfRenderer(fileDescriptor)
val pageCount get() = pdfRenderer.pageCount
private val mutex: Mutex = Mutex()
private val coroutineScope = CoroutineScope(Dispatchers.Default + SupervisorJob())

val pageLists: List = List(pdfRenderer.pageCount) {
Page(
index = it,
pdfRenderer = pdfRender,
coroutineScope = coroutineScope,
mutex = mutex
)
}

fun close() {
pageLists.forEach {
it.recycle()
}
pdfRenderer.close()
fileDescriptor.close()
}

class Page(
val mutex: Mutex,
val index: Int,
val pdfRenderer: PdfRenderer,
val coroutineScope: CoroutineScope
) {
var isLoaded = false

var job: Job? = null

val pageContent = MutableStateFlow<Bitmap?>(null)

fun recycle() {
isLoaded = false
val oldBitmap = pageContent.value

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数HarmonyOS鸿蒙开发工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年HarmonyOS鸿蒙开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上HarmonyOS鸿蒙开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录大纲截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新

如果你觉得这些内容对你有帮助，可以添加VX：vip204888 （备注鸿蒙获取）

一个人可以走的很快，但一群人才能走的更远。不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎扫码加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

25827)]
[外链图片转存中…(img-A0WGxpEJ-1712761025827)]

由于文件比较大，这里只是将部分目录大纲截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新

如果你觉得这些内容对你有帮助，可以添加VX：vip204888 （备注鸿蒙获取）
[外链图片转存中…(img-ArwdbYaX-1712761025828)]

2401_83739434

关注

4
点赞
踩
6

收藏

觉得还不错? 一键收藏
0
评论
如何在Jetpack Compose中显示PDF _jetpack compose如何展示pdf文件

在这个测试中, 我使用了一个超过 200MB 的超大 PDF 文件来说明渲染时间是如何过长的. 显然, 我们无法忍受这种性能水平. 此外, 在使用 Android Studio 剖析器分析应用程序时, 我们发现内存消耗也过大.此时, 我们已经解决了异步问题, 但性能问题依然存在. 事实上, 即使我们现在可以将渲染转移到一个协程中, 但事实依然是, 在打开时渲染所有页面会浪费计算资源和内存.此外, 我们还需要设计一种方法, 只渲染当前显示的页面, 最多也只渲染紧随其后的页面, 并将其保留在内存中.
复制链接

扫一扫

专栏目录