java - 为什么 DocumentFile 这么慢，我应该用什么来代替？

Question

我想创建类似“PDF 查看器应用程序”的东西。应用程序将在用户选择的位置搜索所有 *.pdf 文件。用户可以通过这个函数选择这个文件夹:

Intent intent = new Intent(Intent.ACTION_OPEN_DOCUMENT_TREE);
startActivityForResult(intent, REQUEST_CODE);

然后我得到 DocumentFile(文件夹):

@Override
public void onActivityResult(int requestCode, int resultCode, Intent data) {
    if (resultCode == getActivity().RESULT_OK && requestCode == REQUEST_CODE) {
        Uri uriTree = data.getData();
        DocumentFile documentFile = DocumentFile.fromTreeUri(getActivity(), uriTree);
        //rest of code here
    }
}

为什么我选择这种选择文件夹的方式？因为我想让选择辅助存储成为可能(你知道，在 Android >= 5.0 中，你不能使用 Java.io.file 访问辅助存储)。

好的，所以我得到了所有 *.pdf 作为文档文件的文件夹。然后我打电话:

for(DocumentFile file: documentFile.listFiles()){
    String fileNameToDisplay = file.getName();
}

这非常慢。当所选文件夹中有约 600 个文件时，大约需要 30 秒。为了证明这一点，我选择了外部存储(不是二级存储)中的目录，然后我尝试了两种解决方案:DocumentFile 和 File。文件版本如下所示:

File f = new File(Environment.getExternalStorageDirectory()+"/pdffiles");
    for(File file: f.listFiles()){
        String fileNameToDisplay = file.getName();
    }
}

第二个版本的运行速度提高了大约 500 倍。几乎没有时间在 ListView 中显示所有文件。

为什么 DocumentFile 这么慢？

Answer 1

如果您阅读 source code TreeDocumentFile，您会发现每次调用 listFiles() 和 getName() 都会调用 ContentResolver#query() 在引擎盖下。正如 CommonsWare 所说，这将执行数百个查询，效率非常低。

这里是listFiles()的源代码:

@Override
public DocumentFile[] listFiles() {
    final ContentResolver resolver = mContext.getContentResolver();
    final Uri childrenUri = DocumentsContract.buildChildDocumentsUriUsingTree(mUri,
            DocumentsContract.getDocumentId(mUri));
    final ArrayList<Uri> results = new ArrayList<>();
    Cursor c = null;
    try {
        c = resolver.query(childrenUri, new String[] {
                DocumentsContract.Document.COLUMN_DOCUMENT_ID }, null, null, null);
        while (c.moveToNext()) {
            final String documentId = c.getString(0);
            final Uri documentUri = DocumentsContract.buildDocumentUriUsingTree(mUri,
                    documentId);
            results.add(documentUri);
        }
    } catch (Exception e) {
        Log.w(TAG, "Failed query: " + e);
    } finally {
        closeQuietly(c);
    }
    final Uri[] result = results.toArray(new Uri[results.size()]);
    final DocumentFile[] resultFiles = new DocumentFile[result.length];
    for (int i = 0; i < result.length; i++) {
        resultFiles[i] = new TreeDocumentFile(this, mContext, result[i]);
    }
    return resultFiles;
}

在此函数调用中，listFiles() 进行了仅选择文档 ID 列的查询。但是，在您的情况下，您还需要每个文件的文件名。因此，您可以将列 COLUMN_DISPLAY_NAME 添加到查询中。这将在单个查询中检索文件名和文档 ID(稍后您会将其转换为 Uri)并且效率更高。还有许多其他可用的列，例如文件类型、文件大小和上次修改时间，您可能还想检索它们。

c = resolver.query(mUri, new String[] {
        DocumentsContract.Document.COLUMN_DOCUMENT_ID,
        DocumentsContract.Document.COLUMN_DISPLAY_NAME
    }, null, null, null);

在 while 循环中，通过以下方式检索文件名

final String filename = c.getString(1);

上述修改后的代码能够立即检索包含 1000 多个文件的目录的 Uri 和文件名。

总而言之，如果您处理的文件不止几个，我的建议是避免使用 DocumentFile。而是使用 ContentResolver#query() 通过在查询中选择多个列来检索 Uri 和其他信息。对于文件操作，通过传递适当的 Uri，使用 DocumentsContract 类中的静态方法。

顺便说一下，在 Android 11 和 Android 9 上测试时，ContentResolver#query() 的 sortOrder 参数似乎在上面的代码 fragment 中被完全忽略了。我会手动对结果进行排序，而不是依赖查询顺序。