Android 获取手机本地所有PDF文件的实现

在现代应用程序中，从设备存储中获取特定文件类型（如PDF文件）的能力是非常常见的需求。接下来，我们将一步步教会你如何在Android上实现这一功能。

整体流程

在开始之前，我们可以先明确一下整个过程的步骤，具体如下表所示：

步骤描述
1添加必要的权限
2创建文件查找器并定义文件类型
3查询设备存储中的PDF文件
4显示结果

下面我们将逐步展开每个步骤。

步骤一：添加必要的权限

在 Android 中，访问设备存储需要相关权限。我们需要在 AndroidManifest.xml 中添加以下权限：

<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
  • 1.

这段代码的意思是允许应用程序读取外部存储的数据。

步骤二：创建文件查找器并定义文件类型

为了查找 PDF 文件，我们需要使用 ContentResolver 和 Uri。在我们的 Kotlin 代码中，我们可以先定义一个常量，指明我们要查找的文件类型：

val pdfMimeType = "application/pdf"
  • 1.

步骤三：查询设备存储中的PDF文件

1. 使用 Cursor 查询文件

接下来，我们将使用 ContentResolver 查询设备中所有 PDF 文件。以下是一个完整的例子，展示了如何实现这一过程：

fun getAllPdfFiles(context: Context): List<String> {
    val pdfFiles = mutableListOf<String>()

    // 定义要查询的 Uri
    val uri = MediaStore.Files.getContentUri("external")
    
    // 定义查询条件
    val projection = arrayOf(MediaStore.Files.FileColumns.DISPLAY_NAME, MediaStore.Files.FileColumns.DATA)
    val selection = "${MediaStore.Files.FileColumns.MIME_TYPE} = ?"
    val selectionArgs = arrayOf(pdfMimeType)

    // 使用 ContentResolver 查询文件
    val cursor = context.contentResolver.query(
        uri,
        projection,
        selection,
        selectionArgs,
        null
    )

    // 如果查询结果不为空，遍历获取文件路径
    cursor?.use {
        val nameIndex = it.getColumnIndexOrThrow(MediaStore.Files.FileColumns.DISPLAY_NAME)
        val pathIndex = it.getColumnIndexOrThrow(MediaStore.Files.FileColumns.DATA)

        while (it.moveToNext()) {
            val name = it.getString(nameIndex)  // 获取文件名
            val path = it.getString(pathIndex)  // 获取文件路径
            
            pdfFiles.add(path)  // 将路径添加到列表
        }
    }

    return pdfFiles  // 返回文件路径列表
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.
  • 19.
  • 20.
  • 21.
  • 22.
  • 23.
  • 24.
  • 25.
  • 26.
  • 27.
  • 28.
  • 29.
  • 30.
  • 31.
  • 32.
  • 33.
  • 34.
  • 35.
2. 代码说明
  • val uri = MediaStore.Files.getContentUri("external")：获取外部存储的文件 URI。
  • val projection：定义希望查询的列，文件名称和文件路径。
  • val selection：定义筛选条件，这里筛选出 MIME 类型为 pdf 的文件。
  • val cursor：使用 context.contentResolver.query 方法来执行查询。
  • cursor?.use {...}：确保使用完Cursor后自动关闭。并在循环中读取文件信息。

步骤四：显示结果

此时我们已经获取到了所有 PDF 文件的路径，接下来可以将这些路径输出或者显示在 UI 上。我们可以使用一个简单的 Toast 来显示文件数量：

val pdfFiles = getAllPdfFiles(context)
Toast.makeText(context, "找到 ${pdfFiles.size} 个 PDF 文件", Toast.LENGTH_SHORT).show()
  • 1.
  • 2.

序列图示例

为了更清晰地理解这个流程，下面是一个简单的序列图。使用 mermaid 语法表示：

Storage App User Storage App User 请求获取 PDF 文件 查询所有 PDF 文件 返回文件列表 显示 PDF 文件数量

总结

通过上述步骤，我们实现了在 Android 中获取手机本地所有 PDF 文件的功能。从添加权限到实现逻辑，整个过程比较直观易懂。你可以将获取到的 PDF 文件列表用于后续的操作，如文件浏览、分享等。

随着开发经验的积累，你会发现，操作文件系统是理解 Android 系统的一个重要部分。希望这篇教程能对你有所帮助，使你在探索 Android 开发的道路上走得更远。继续努力，祝你在开发旅程中一切顺利！