如何在Espresso测试中处理DocumentsProvider返回的Intent结果权限问题

这个问题我之前帮开发者排查过不少次——核心原因是你在测试里模拟的Intent结果没有附带DocumentsProvider正常返回时会自动授予的持久化权限，导致takePersistableUriPermission找不到对应的授权记录。下面是具体的解决步骤和示例代码：

关键原理 #

真实场景中，当用户通过DocumentsPicker选择文件后，系统会自动为你的App授予该URI的临时权限，并且允许你调用takePersistableUriPermission将权限持久化。但在测试中，我们手动构造的Intent并没有经过这个系统授权流程，所以需要手动为目标URI授予持久化权限，同时在返回的Intent中带上权限标记。

具体实现步骤 #

1. 在测试中为URI授予持久化权限 #

通过测试的Instrumentation获取目标App的上下文，调用grantUriPermission方法，为你的App包名授予目标URI的读写权限，并指定FLAG_GRANT_PERSISTABLE_URI_PERMISSION标记。

2. 构造带权限标记的返回Intent #

在返回的Intent中，除了设置URI，还要添加FLAG_GRANT_READ_URI_PERMISSION、FLAG_GRANT_WRITE_URI_PERMISSION以及FLAG_GRANT_PERSISTABLE_URI_PERMISSION标记，确保App的getContentResolver能识别到权限。

示例代码 #

你的Activity中onActivityResult代码（参考） #

private static final int REQUEST_CODE_PICK_DOCUMENT = 1001;

@Override
protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
    super.onActivityResult(requestCode, resultCode, data);
    if (requestCode == REQUEST_CODE_PICK_DOCUMENT && resultCode == RESULT_OK && data != null) {
        Uri documentUri = data.getData();
        if (documentUri != null) {
            try {
                // 尝试持久化权限
                getContentResolver().takePersistableUriPermission(
                        documentUri,
                        Intent.FLAG_GRANT_READ_URI_PERMISSION | Intent.FLAG_GRANT_WRITE_URI_PERMISSION
                );
                // 后续处理URI逻辑
            } catch (SecurityException e) {
                // 权限异常处理
                Log.e(TAG, "Failed to take persistable permission", e);
            }
        }
    }
}

Espresso测试代码（使用ActivityResultRule） #

@RunWith(AndroidJUnit4.class)
public class DocumentPickerTest {
    private static final int REQUEST_CODE_PICK_DOCUMENT = 1001;

    @Rule
    public ActivityResultRule<MainActivity> activityResultRule = new ActivityResultRule<>(MainActivity.class);

    @Test
    public void testDocumentPickerFlowWithPersistablePermission() {
        // 1. 构造模拟的DocumentsProvider格式URI
        Uri testDocumentUri = Uri.parse("content://com.android.providers.downloads.documents/document/123");

        // 2. 获取测试工具类和目标App包名
        Instrumentation instrumentation = InstrumentationRegistry.getInstrumentation();
        String targetPackage = instrumentation.getTargetContext().getPackageName();

        // 3. 为目标URI授予持久化权限
        instrumentation.getTargetContext().getContentResolver().grantUriPermission(
                targetPackage,
                testDocumentUri,
                Intent.FLAG_GRANT_READ_URI_PERMISSION |
                Intent.FLAG_GRANT_WRITE_URI_PERMISSION |
                Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION
        );

        // 4. 构造带权限标记的返回Intent
        Intent resultIntent = new Intent();
        resultIntent.setData(testDocumentUri);
        resultIntent.addFlags(
                Intent.FLAG_GRANT_READ_URI_PERMISSION |
                Intent.FLAG_GRANT_WRITE_URI_PERMISSION |
                Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION
        );

        // 5. 设置模拟的ActivityResult
        activityResultRule.setActivityResult(REQUEST_CODE_PICK_DOCUMENT, Activity.RESULT_OK, resultIntent);

        // 6. 触发打开文档选择器的操作
        onView(withId(R.id.btn_open_document_picker)).perform(click());

        // 7. 验证流程是否正常（比如检查URI是否被正确显示）
        onView(withId(R.id.tv_selected_document_uri)).check(matches(withText(testDocumentUri.toString())));
    }
}

如果你使用ActivityScenario（AndroidX测试） #

@Test
public void testDocumentPickerWithActivityScenario() {
    Uri testDocumentUri = Uri.parse("content://com.android.providers.downloads.documents/document/456");
    Instrumentation instrumentation = InstrumentationRegistry.getInstrumentation();
    String targetPackage = instrumentation.getTargetContext().getPackageName();

    // 授予持久化权限
    instrumentation.getTargetContext().getContentResolver().grantUriPermission(
            targetPackage,
            testDocumentUri,
            Intent.FLAG_GRANT_READ_URI_PERMISSION | Intent.FLAG_GRANT_WRITE_URI_PERMISSION | Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION
    );

    try (ActivityScenario<MainActivity> scenario = ActivityScenario.launch(MainActivity.class)) {
        scenario.onActivity(activity -> {
            // 模拟ActivityResult分发
            ActivityResultRegistry registry = activity.getActivityResultRegistry();
            registry.dispatchResult(
                    REQUEST_CODE_PICK_DOCUMENT,
                    Activity.RESULT_OK,
                    new Intent().setData(testDocumentUri).addFlags(
                            Intent.FLAG_GRANT_READ_URI_PERMISSION |
                            Intent.FLAG_GRANT_WRITE_URI_PERMISSION |
                            Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION
                    )
            );
        });

        // 触发选择操作
        onView(withId(R.id.btn_open_document_picker)).perform(click());

        // 验证结果
        onView(withId(R.id.tv_selected_document_uri)).check(matches(withText(testDocumentUri.toString())));
    }
}

注意事项 #

• 确保模拟的URI格式符合DocumentsProvider的规范（比如content://com.android.providers.downloads.documents/document/[ID]），否则系统可能认为是无效URI而拒绝授权。
• 权限标记要保持一致：grantUriPermission、返回Intent的flags以及takePersistableUriPermission中使用的权限标记要完全匹配（比如只需要读权限的话，就不要加写权限标记）。
• 如果测试中使用自定义DocumentsProvider，要确保该Provider在测试环境中已正确注册和启用。

内容的提问来源于stack exchange，提问作者friedger