เข้าถึงเอกสารและไฟล์อื่นๆ จากพื้นที่เก็บข้อมูลที่ใช้ร่วมกัน

ในอุปกรณ์ที่ใช้ Android 4.4 (API ระดับ 19) ขึ้นไป แอปของคุณจะโต้ตอบกับผู้ให้บริการเอกสารได้ ซึ่งรวมถึงวอลุ่มพื้นที่เก็บข้อมูลภายนอกและพื้นที่เก็บข้อมูลระบบคลาวด์ โดยใช้ Storage Access Framework เฟรมเวิร์กนี้ช่วยให้ผู้ใช้โต้ตอบกับเครื่องมือเลือกของระบบเพื่อเลือกผู้ให้บริการเอกสาร รวมถึงเลือกเอกสารและไฟล์อื่นๆ ที่เฉพาะเจาะจงเพื่อให้แอปของคุณสร้าง เปิด หรือแก้ไข

เนื่องจากผู้ใช้มีส่วนร่วมในการเลือกไฟล์หรือไดเรกทอรีที่แอปของคุณเข้าถึงได้ กลไกนี้จึงไม่จำเป็นต้องมีสิทธิ์ของระบบ และการควบคุมของผู้ใช้และความเป็นส่วนตัวจะได้รับการปรับปรุง นอกจากนี้ ไฟล์เหล่านี้ซึ่งจัดเก็บไว้นอกไดเรกทอรีเฉพาะแอปและนอกที่เก็บสื่อจะยังคงอยู่ในอุปกรณ์หลังจากถอนการติดตั้งแอปแล้ว

การใช้เฟรมเวิร์กมีขั้นตอนดังนี้

1. แอปเรียกใช้ Intent ที่มีการดำเนินการที่เกี่ยวข้องกับพื้นที่เก็บข้อมูล การดําเนินการนี้สอดคล้องกับกรณีการใช้งานที่เฉพาะเจาะจงซึ่งเฟรมเวิร์กมีให้บริการ
2. ผู้ใช้จะเห็นเครื่องมือเลือกของระบบ ซึ่งช่วยให้เรียกดูผู้ให้บริการเอกสารและเลือกตำแหน่งหรือเอกสารที่จะดำเนินการที่เกี่ยวข้องกับพื้นที่เก็บข้อมูลได้
3. แอปจะได้รับสิทธิ์อ่านและเขียน URI ที่แสดงถึงสถานที่หรือเอกสารที่ผู้ใช้เลือก เมื่อใช้ URI นี้ แอปจะดำเนินการกับตำแหน่งที่เลือกได้

หากต้องการรองรับการเข้าถึงไฟล์สื่อในอุปกรณ์ที่ใช้ Android 9 (API ระดับ 28) หรือต่ำกว่า ให้ประกาศสิทธิ์ READ_EXTERNAL_STORAGE และตั้งค่า maxSdkVersion เป็น 28

คู่มือนี้จะอธิบายกรณีการใช้งานต่างๆ ที่เฟรมเวิร์กรองรับสําหรับการทํางานกับไฟล์และเอกสารอื่นๆ รวมถึงอธิบายวิธีดำเนินการในตำแหน่งที่ผู้ใช้เลือก

Use Case สำหรับการเข้าถึงเอกสารและไฟล์อื่นๆ

เฟรมเวิร์กการเข้าถึงพื้นที่เก็บข้อมูลรองรับกรณีการใช้งานต่อไปนี้สำหรับการเข้าถึงไฟล์และเอกสารอื่นๆ

สร้างไฟล์ใหม่

การดำเนินการตามเจตนา ACTION_CREATE_DOCUMENT ช่วยให้คุณบันทึกไฟล์ในตำแหน่งที่ต้องการได้

เปิดเอกสารหรือไฟล์

การดำเนินการตามเจตนา ACTION_OPEN_DOCUMENT ช่วยให้ผู้ใช้เลือกเอกสารหรือไฟล์ที่ต้องการเปิดได้

ให้สิทธิ์เข้าถึงเนื้อหาของไดเรกทอรี

การดำเนินการตาม Intent ACTION_OPEN_DOCUMENT_TREE ที่พร้อมใช้งานใน Android 5.0 (API ระดับ 21) ขึ้นไปช่วยให้ผู้ใช้เลือกไดเรกทอรีที่ต้องการได้ ซึ่งจะเป็นการให้สิทธิ์แอปเข้าถึงไฟล์และไดเรกทอรีย่อยทั้งหมดภายในไดเรกทอรีนั้น

ส่วนต่อไปนี้ให้คําแนะนําเกี่ยวกับวิธีกําหนดค่าแต่ละ Use Case

สร้างไฟล์ใหม่

ใช้การดำเนินการตาม Intent ของ ACTION_CREATE_DOCUMENT เพื่อโหลดเครื่องมือเลือกไฟล์ของระบบและอนุญาตให้ผู้ใช้เลือกตำแหน่งที่จะเขียนเนื้อหาของไฟล์ กระบวนการนี้คล้ายกับที่ใช้ในกล่องโต้ตอบ "บันทึกเป็น" ที่ระบบปฏิบัติการอื่นๆ ใช้

เมื่อกำหนดค่า Intent ให้ระบุชื่อและประเภท MIME ของไฟล์ และระบุ URI ของไฟล์หรือไดเรกทอรีที่เครื่องมือเลือกไฟล์ควรแสดงเมื่อโหลดครั้งแรก (ไม่บังคับ) โดยใช้ Intent Extra EXTRA_INITIAL_URI

ข้อมูลโค้ดต่อไปนี้แสดงวิธีสร้างและเรียกใช้ Intent สำหรับการสร้างไฟล์

// Request code for creating a PDF document.
const val CREATE_FILE = 1

private fun createFile(pickerInitialUri: Uri) {
    val intent = Intent(Intent.ACTION_CREATE_DOCUMENT).apply {
        addCategory(Intent.CATEGORY_OPENABLE)
        type = "application/pdf"
        putExtra(Intent.EXTRA_TITLE, "invoice.pdf")

        // Optionally, specify a URI for the directory that should be opened in
        // the system file picker before your app creates the document.
        putExtra(DocumentsContract.EXTRA_INITIAL_URI, pickerInitialUri)
    }
    startActivityForResult(intent, CREATE_FILE)
}

// Request code for creating a PDF document.
private static final int CREATE_FILE = 1;

private void createFile(Uri pickerInitialUri) {
    Intent intent = new Intent(Intent.ACTION_CREATE_DOCUMENT);
    intent.addCategory(Intent.CATEGORY_OPENABLE);
    intent.setType("application/pdf");
    intent.putExtra(Intent.EXTRA_TITLE, "invoice.pdf");

    // Optionally, specify a URI for the directory that should be opened in
    // the system file picker when your app creates the document.
    intent.putExtra(DocumentsContract.EXTRA_INITIAL_URI, pickerInitialUri);

    startActivityForResult(intent, CREATE_FILE);
}

เปิดไฟล์

แอปของคุณอาจใช้เอกสารเป็นหน่วยพื้นที่เก็บข้อมูลซึ่งผู้ใช้ป้อนข้อมูลที่ต้องการแชร์กับเพื่อนร่วมงานหรือนําเข้าไปยังเอกสารอื่นๆ ตัวอย่างที่เห็นได้ชัด เช่น ผู้ใช้เปิดเอกสารเพื่อการทำงานหรือเปิดหนังสือที่บันทึกเป็นไฟล์ EPUB

ในกรณีเหล่านี้ ให้อนุญาตให้ผู้ใช้เลือกไฟล์ที่จะเปิดโดยเรียกใช้ Intent ACTION_OPEN_DOCUMENT ซึ่งจะเปิดแอปเครื่องมือเลือกไฟล์ของระบบ หากต้องการแสดงเฉพาะประเภทไฟล์ที่แอปรองรับ ให้ระบุประเภท MIME นอกจากนี้ คุณยังระบุ URI ของไฟล์ที่เครื่องมือเลือกไฟล์ควรแสดงเมื่อโหลดเป็นครั้งแรกได้ด้วยโดยใช้ส่วนเพิ่มเติมของ Intent EXTRA_INITIAL_URI

ข้อมูลโค้ดต่อไปนี้แสดงวิธีสร้างและเรียกใช้ Intent สําหรับการเปิดเอกสาร PDF

// Request code for selecting a PDF document.
const val PICK_PDF_FILE = 2

fun openFile(pickerInitialUri: Uri) {
    val intent = Intent(Intent.ACTION_OPEN_DOCUMENT).apply {
        addCategory(Intent.CATEGORY_OPENABLE)
        type = "application/pdf"

        // Optionally, specify a URI for the file that should appear in the
        // system file picker when it loads.
        putExtra(DocumentsContract.EXTRA_INITIAL_URI, pickerInitialUri)
    }

    startActivityForResult(intent, PICK_PDF_FILE)
}

// Request code for selecting a PDF document.
private static final int PICK_PDF_FILE = 2;

private void openFile(Uri pickerInitialUri) {
    Intent intent = new Intent(Intent.ACTION_OPEN_DOCUMENT);
    intent.addCategory(Intent.CATEGORY_OPENABLE);
    intent.setType("application/pdf");

    // Optionally, specify a URI for the file that should appear in the
    // system file picker when it loads.
    intent.putExtra(DocumentsContract.EXTRA_INITIAL_URI, pickerInitialUri);

    startActivityForResult(intent, PICK_PDF_FILE);
}

การจำกัดการเข้าถึง

ใน Android 11 (API ระดับ 30) ขึ้นไป คุณจะใช้ACTION_OPEN_DOCUMENTการดำเนินการของ Intent เพื่อขอให้ผู้ใช้เลือกไฟล์แต่ละไฟล์จากไดเรกทอรีต่อไปนี้ไม่ได้

• ไดเรกทอรี Android/data/ และไดเรกทอรีย่อยทั้งหมด
• ไดเรกทอรี Android/obb/ และไดเรกทอรีย่อยทั้งหมด

ให้สิทธิ์เข้าถึงเนื้อหาของไดเรกทอรี

แอปการจัดการไฟล์และการสร้างสื่อมักจะจัดการกลุ่มไฟล์ในลําดับชั้นไดเรกทอรี หากต้องการให้แอปมีความสามารถนี้ ให้ใช้การดำเนินการของ Intent ACTION_OPEN_DOCUMENT_TREE ซึ่งช่วยให้ผู้ใช้ให้สิทธิ์เข้าถึงทั้งโครงสร้างไดเรกทอรีได้ โดยมีข้อยกเว้นบางประการที่เริ่มตั้งแต่ Android 11 (API ระดับ 30) จากนั้นแอปจะเข้าถึงไฟล์ใดก็ได้ในไดเรกทอรีที่เลือกและไดเรกทอรีย่อยของไดเรกทอรีนั้น

เมื่อใช้ ACTION_OPEN_DOCUMENT_TREE แอปของคุณจะได้รับสิทธิ์เข้าถึงเฉพาะไฟล์ในไดเรกทอรีที่ผู้ใช้เลือกเท่านั้น คุณไม่มีสิทธิ์เข้าถึงไฟล์ของแอปอื่นๆ ที่อยู่นอกไดเรกทอรีที่ผู้ใช้เลือกนี้ การเข้าถึงที่ผู้ใช้ควบคุมนี้ช่วยให้ผู้ใช้เลือกเนื้อหาที่ตนต้องการแชร์กับแอปของคุณได้

คุณระบุ URI ของไดเรกทอรีที่เครื่องมือเลือกไฟล์ควรแสดงเมื่อโหลดครั้งแรกได้ (ไม่บังคับ) โดยใช้ Intent Extra EXTRA_INITIAL_URI

ข้อมูลโค้ดต่อไปนี้แสดงวิธีสร้างและเรียกใช้ Intent สําหรับการเปิดไดเรกทอรี

fun openDirectory(pickerInitialUri: Uri) {
    // Choose a directory using the system's file picker.
    val intent = Intent(Intent.ACTION_OPEN_DOCUMENT_TREE).apply {
        // Optionally, specify a URI for the directory that should be opened in
        // the system file picker when it loads.
        putExtra(DocumentsContract.EXTRA_INITIAL_URI, pickerInitialUri)
    }

    startActivityForResult(intent, your-request-code)
}

public void openDirectory(Uri uriToLoad) {
    // Choose a directory using the system's file picker.
    Intent intent = new Intent(Intent.ACTION_OPEN_DOCUMENT_TREE);

    // Optionally, specify a URI for the directory that should be opened in
    // the system file picker when it loads.
    intent.putExtra(DocumentsContract.EXTRA_INITIAL_URI, uriToLoad);

    startActivityForResult(intent, your-request-code);
}

การจำกัดการเข้าถึง

ใน Android 11 (API ระดับ 30) ขึ้นไป คุณจะใช้ACTION_OPEN_DOCUMENT_TREEการดำเนินการของ Intent เพื่อขอสิทธิ์เข้าถึงไดเรกทอรีต่อไปนี้ไม่ได้

• ไดเรกทอรีรูทของวอลุ่มที่จัดเก็บข้อมูลภายใน
• ไดเรกทอรีรูทของวอลุ่มการ์ด SD แต่ละรายการที่ผู้ผลิตอุปกรณ์พิจารณาว่าเชื่อถือได้ ไม่ว่าการ์ดจะเป็นแบบจำลองหรือแบบถอดออกได้ วอลุ่มที่เชื่อถือได้คือวอลุ่มที่แอปเข้าถึงได้สําเร็จเกือบทุกครั้ง
• ไดเรกทอรี Download

นอกจากนี้ ใน Android 11 (API ระดับ 30) ขึ้นไป คุณจะใช้ACTION_OPEN_DOCUMENT_TREEการดำเนินการของ Intent เพื่อขอให้ผู้ใช้เลือกไฟล์แต่ละไฟล์จากไดเรกทอรีต่อไปนี้ไม่ได้

• ไดเรกทอรี Android/data/ และไดเรกทอรีย่อยทั้งหมด
• ไดเรกทอรี Android/obb/ และไดเรกทอรีย่อยทั้งหมด

ดำเนินการกับสถานที่ที่เลือก

หลังจากผู้ใช้เลือกไฟล์หรือไดเรกทอรีโดยใช้เครื่องมือเลือกไฟล์ของระบบแล้ว คุณจะสามารถดึงข้อมูล URI ของรายการที่เลือกได้โดยใช้โค้ดต่อไปนี้ใน onActivityResult()

override fun onActivityResult(
        requestCode: Int, resultCode: Int, resultData: Intent?) {
    if (requestCode == your-request-code
            && resultCode == Activity.RESULT_OK) {
        // The result data contains a URI for the document or directory that
        // the user selected.
        resultData?.data?.also { uri ->
            // Perform operations on the document using its URI.
        }
    }
}

@Override
public void onActivityResult(int requestCode, int resultCode,
        Intent resultData) {
    if (requestCode == your-request-code
            && resultCode == Activity.RESULT_OK) {
        // The result data contains a URI for the document or directory that
        // the user selected.
        Uri uri = null;
        if (resultData != null) {
            uri = resultData.getData();
            // Perform operations on the document using its URI.
        }
    }
}

การอ้างอิง URI ของรายการที่เลือกจะช่วยให้แอปของคุณดําเนินการต่างๆ กับรายการนั้นได้ เช่น คุณสามารถเข้าถึงข้อมูลเมตาของรายการ แก้ไขรายการในตำแหน่งเดิม และลบรายการได้

ส่วนต่อไปนี้จะแสดงวิธีดำเนินการกับไฟล์ที่ผู้ใช้เลือก

ระบุการดำเนินการที่ผู้ให้บริการรองรับ

ผู้ให้บริการเนื้อหาแต่ละรายอนุญาตให้ดำเนินการต่างๆ กับเอกสารได้ เช่น การคัดลอกเอกสารหรือดูภาพขนาดย่อของเอกสาร หากต้องการดูว่าผู้ให้บริการรายใดรองรับการดำเนินการใดบ้าง ให้ตรวจสอบค่าของ Document.COLUMN_FLAGS จากนั้น UI ของแอปจะแสดงเฉพาะตัวเลือกที่ผู้ให้บริการรองรับ

เก็บสิทธิ์ไว้

เมื่อแอปเปิดไฟล์เพื่ออ่านหรือเขียน ระบบจะให้สิทธิ์ URI แก่แอปสำหรับไฟล์นั้น ซึ่งจะมีผลจนกว่าอุปกรณ์ของผู้ใช้จะรีสตาร์ท แต่สมมติว่าแอปของคุณเป็นแอปแต่งรูป และคุณต้องการให้ผู้ใช้เข้าถึงรูปภาพ 5 รูปที่แก้ไขล่าสุดจากแอปของคุณโดยตรง หากอุปกรณ์ของผู้ใช้รีสตาร์ท คุณจะต้องส่งผู้ใช้กลับไปที่เครื่องมือเลือกของระบบเพื่อค้นหาไฟล์

หากต้องการเก็บสิทธิ์เข้าถึงไฟล์ไว้เมื่ออุปกรณ์รีสตาร์ทและมอบประสบการณ์การใช้งานที่ดีขึ้นให้แก่ผู้ใช้ แอปของคุณสามารถ "รับ" การให้สิทธิ์ URI แบบถาวรที่ระบบมอบให้ ดังที่แสดงในตัวอย่างโค้ดต่อไปนี้

val contentResolver = applicationContext.contentResolver

val takeFlags: Int = Intent.FLAG_GRANT_READ_URI_PERMISSION or
        Intent.FLAG_GRANT_WRITE_URI_PERMISSION
// Check for the freshest data.
contentResolver.takePersistableUriPermission(uri, takeFlags)

final int takeFlags = intent.getFlags()
            & (Intent.FLAG_GRANT_READ_URI_PERMISSION
            | Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
// Check for the freshest data.
getContentResolver().takePersistableUriPermission(uri, takeFlags);

ตรวจสอบข้อมูลเมตาของเอกสาร

เมื่อคุณมี URI ของเอกสาร คุณจะได้รับสิทธิ์เข้าถึงข้อมูลเมตาของเอกสาร ข้อมูลโค้ดนี้ดึงข้อมูลเมตาของเอกสารที่ระบุโดย URI และบันทึกไว้

val contentResolver = applicationContext.contentResolver

fun dumpImageMetaData(uri: Uri) {

    // The query, because it only applies to a single document, returns only
    // one row. There's no need to filter, sort, or select fields,
    // because we want all fields for one document.
    val cursor: Cursor? = contentResolver.query(
            uri, null, null, null, null, null)

    cursor?.use {
        // moveToFirst() returns false if the cursor has 0 rows. Very handy for
        // "if there's anything to look at, look at it" conditionals.
        if (it.moveToFirst()) {

            // Note it's called "Display Name". This is
            // provider-specific, and might not necessarily be the file name.
            val displayName: String =
                    it.getString(it.getColumnIndex(OpenableColumns.DISPLAY_NAME))
            Log.i(TAG, "Display Name: $displayName")

            val sizeIndex: Int = it.getColumnIndex(OpenableColumns.SIZE)
            // If the size is unknown, the value stored is null. But because an
            // int can't be null, the behavior is implementation-specific,
            // and unpredictable. So as
            // a rule, check if it's null before assigning to an int. This will
            // happen often: The storage API allows for remote files, whose
            // size might not be locally known.
            val size: String = if (!it.isNull(sizeIndex)) {
                // Technically the column stores an int, but cursor.getString()
                // will do the conversion automatically.
                it.getString(sizeIndex)
            } else {
                "Unknown"
            }
            Log.i(TAG, "Size: $size")
        }
    }
}

public void dumpImageMetaData(Uri uri) {

    // The query, because it only applies to a single document, returns only
    // one row. There's no need to filter, sort, or select fields,
    // because we want all fields for one document.
    Cursor cursor = getActivity().getContentResolver()
            .query(uri, null, null, null, null, null);

    try {
        // moveToFirst() returns false if the cursor has 0 rows. Very handy for
        // "if there's anything to look at, look at it" conditionals.
        if (cursor != null && cursor.moveToFirst()) {

            // Note it's called "Display Name". This is
            // provider-specific, and might not necessarily be the file name.
            String displayName = cursor.getString(
                    cursor.getColumnIndex(OpenableColumns.DISPLAY_NAME));
            Log.i(TAG, "Display Name: " + displayName);

            int sizeIndex = cursor.getColumnIndex(OpenableColumns.SIZE);
            // If the size is unknown, the value stored is null. But because an
            // int can't be null, the behavior is implementation-specific,
            // and unpredictable. So as
            // a rule, check if it's null before assigning to an int. This will
            // happen often: The storage API allows for remote files, whose
            // size might not be locally known.
            String size = null;
            if (!cursor.isNull(sizeIndex)) {
                // Technically the column stores an int, but cursor.getString()
                // will do the conversion automatically.
                size = cursor.getString(sizeIndex);
            } else {
                size = "Unknown";
            }
            Log.i(TAG, "Size: " + size);
        }
    } finally {
        cursor.close();
    }
}

เปิดเอกสาร

การอ้างอิง URI ของเอกสารจะช่วยให้คุณเปิดเอกสารเพื่อประมวลผลเพิ่มเติมได้ ส่วนนี้จะแสดงตัวอย่างการเปิดบิตแมปและอินพุตสตรีม

บิตแมป

ข้อมูลโค้ดต่อไปนี้แสดงวิธีเปิดไฟล์ Bitmap โดยระบุ URI

val contentResolver = applicationContext.contentResolver

@Throws(IOException::class)
private fun getBitmapFromUri(uri: Uri): Bitmap {
    val parcelFileDescriptor: ParcelFileDescriptor =
            contentResolver.openFileDescriptor(uri, "r")
    val fileDescriptor: FileDescriptor = parcelFileDescriptor.fileDescriptor
    val image: Bitmap = BitmapFactory.decodeFileDescriptor(fileDescriptor)
    parcelFileDescriptor.close()
    return image
}

private Bitmap getBitmapFromUri(Uri uri) throws IOException {
    ParcelFileDescriptor parcelFileDescriptor =
            getContentResolver().openFileDescriptor(uri, "r");
    FileDescriptor fileDescriptor = parcelFileDescriptor.getFileDescriptor();
    Bitmap image = BitmapFactory.decodeFileDescriptor(fileDescriptor);
    parcelFileDescriptor.close();
    return image;
}

หลังจากเปิดบิตแมปแล้ว คุณสามารถแสดงบิตแมปในImageView

สตรีมอินพุต

ข้อมูลโค้ดต่อไปนี้แสดงวิธีเปิดออบเจ็กต์ InputStream โดยระบุ URI ข้อมูลโค้ดนี้อ่านบรรทัดของไฟล์เป็นสตริง

val contentResolver = applicationContext.contentResolver

@Throws(IOException::class)
private fun readTextFromUri(uri: Uri): String {
    val stringBuilder = StringBuilder()
    contentResolver.openInputStream(uri)?.use { inputStream ->
        BufferedReader(InputStreamReader(inputStream)).use { reader ->
            var line: String? = reader.readLine()
            while (line != null) {
                stringBuilder.append(line)
                line = reader.readLine()
            }
        }
    }
    return stringBuilder.toString()
}

private String readTextFromUri(Uri uri) throws IOException {
    StringBuilder stringBuilder = new StringBuilder();
    try (InputStream inputStream =
            getContentResolver().openInputStream(uri);
            BufferedReader reader = new BufferedReader(
            new InputStreamReader(Objects.requireNonNull(inputStream)))) {
        String line;
        while ((line = reader.readLine()) != null) {
            stringBuilder.append(line);
        }
    }
    return stringBuilder.toString();
}

แก้ไขเอกสาร

คุณสามารถใช้ Storage Access Framework เพื่อแก้ไขเอกสารข้อความในตำแหน่งเดิมได้

ข้อมูลโค้ดต่อไปนี้จะเขียนทับเนื้อหาของเอกสารที่แสดงโดย URI ที่ระบุ

val contentResolver = applicationContext.contentResolver

private fun alterDocument(uri: Uri) {
    try {
        contentResolver.openFileDescriptor(uri, "w")?.use {
            FileOutputStream(it.fileDescriptor).use {
                it.write(
                    ("Overwritten at ${System.currentTimeMillis()}\n")
                        .toByteArray()
                )
            }
        }
    } catch (e: FileNotFoundException) {
        e.printStackTrace()
    } catch (e: IOException) {
        e.printStackTrace()
    }
}

private void alterDocument(Uri uri) {
    try {
        ParcelFileDescriptor pfd = getActivity().getContentResolver().
                openFileDescriptor(uri, "w");
        FileOutputStream fileOutputStream =
                new FileOutputStream(pfd.getFileDescriptor());
        fileOutputStream.write(("Overwritten at " + System.currentTimeMillis() +
                "\n").getBytes());
        // Let the document provider know you're done by closing the stream.
        fileOutputStream.close();
        pfd.close();
    } catch (FileNotFoundException e) {
        e.printStackTrace();
    } catch (IOException e) {
        e.printStackTrace();
    }
}

ลบเอกสาร

หากมี URI ของเอกสารและ Document.COLUMN_FLAGS ของเอกสารมี SUPPORTS_DELETE อยู่ คุณจะลบเอกสารได้ เช่น

DocumentsContract.deleteDocument(applicationContext.contentResolver, uri)

DocumentsContract.deleteDocument(applicationContext.contentResolver, uri);

เรียกข้อมูล URI ของสื่อที่เทียบเท่า

วิธีการ getMediaUri() จะระบุ URI ของร้านค้าสื่อที่เทียบเท่า URI ของผู้ให้บริการเอกสารที่ระบุ URI 2 รายการนี้หมายถึงรายการพื้นฐานเดียวกัน การใช้ URI ของที่เก็บสื่อช่วยให้คุณเข้าถึงไฟล์สื่อจากพื้นที่เก็บข้อมูลที่ใช้ร่วมกันได้ง่ายขึ้น

เมธอด getMediaUri() รองรับ URI ExternalStorageProvider ใน Android 12 (API ระดับ 31) ขึ้นไป เมธอดนี้จะรองรับ MediaDocumentsProvider URI ด้วย

เปิดไฟล์เสมือน

ใน Android 7.0 (API ระดับ 25) ขึ้นไป แอปของคุณสามารถใช้ไฟล์เสมือนที่เฟรมเวิร์กการเข้าถึงพื้นที่เก็บข้อมูลมีให้ แม้ว่าไฟล์เสมือนจะไม่มีการแสดงผลแบบไบนารี แต่แอปของคุณก็สามารถเปิดเนื้อหาของไฟล์เหล่านั้นได้โดยการเปลี่ยนไฟล์เป็นประเภทอื่นหรือดูไฟล์เหล่านั้นโดยใช้การดำเนินการของ Intent ACTION_VIEW

หากต้องการเปิดไฟล์เสมือน แอปไคลเอ็นต์ต้องมีตรรกะพิเศษเพื่อจัดการไฟล์เหล่านั้น หากต้องการรับการนำเสนอไบต์ของไฟล์เพื่อดูตัวอย่างไฟล์ คุณต้องขอประเภท MIME อื่นจากผู้ให้บริการเอกสาร

หลังจากผู้ใช้เลือกแล้ว ให้ใช้ URI ในข้อมูลผลลัพธ์เพื่อระบุว่าไฟล์เป็นแบบเสมือนจริงหรือไม่ ตามที่แสดงในข้อมูลโค้ดต่อไปนี้

private fun isVirtualFile(uri: Uri): Boolean {
    if (!DocumentsContract.isDocumentUri(this, uri)) {
        return false
    }

    val cursor: Cursor? = contentResolver.query(
            uri,
            arrayOf(DocumentsContract.Document.COLUMN_FLAGS),
            null,
            null,
            null
    )

    val flags: Int = cursor?.use {
        if (cursor.moveToFirst()) {
            cursor.getInt(0)
        } else {
            0
        }
    } ?: 0

    return flags and DocumentsContract.Document.FLAG_VIRTUAL_DOCUMENT != 0
}

private boolean isVirtualFile(Uri uri) {
    if (!DocumentsContract.isDocumentUri(this, uri)) {
        return false;
    }

    Cursor cursor = getContentResolver().query(
        uri,
        new String[] { DocumentsContract.Document.COLUMN_FLAGS },
        null, null, null);

    int flags = 0;
    if (cursor.moveToFirst()) {
        flags = cursor.getInt(0);
    }
    cursor.close();

    return (flags & DocumentsContract.Document.FLAG_VIRTUAL_DOCUMENT) != 0;
}

หลังจากยืนยันว่าเอกสารเป็นไฟล์เสมือนแล้ว คุณสามารถบังคับให้ไฟล์เป็นประเภท MIME อื่นได้ เช่น "image/png" ข้อมูลโค้ดต่อไปนี้แสดงวิธีตรวจสอบว่าไฟล์เสมือนแสดงเป็นรูปภาพได้หรือไม่ และหากแสดงได้ ก็จะรับสตรีมอินพุตจากไฟล์เสมือน

@Throws(IOException::class)
private fun getInputStreamForVirtualFile(
        uri: Uri, mimeTypeFilter: String): InputStream {

    val openableMimeTypes: Array<String>? =
            contentResolver.getStreamTypes(uri, mimeTypeFilter)

    return if (openableMimeTypes?.isNotEmpty() == true) {
        contentResolver
                .openTypedAssetFileDescriptor(uri, openableMimeTypes[0], null)
                .createInputStream()
    } else {
        throw FileNotFoundException()
    }
}

private InputStream getInputStreamForVirtualFile(Uri uri, String mimeTypeFilter)
    throws IOException {

    ContentResolver resolver = getContentResolver();

    String[] openableMimeTypes = resolver.getStreamTypes(uri, mimeTypeFilter);

    if (openableMimeTypes == null ||
        openableMimeTypes.length < 1) {
        throw new FileNotFoundException();
    }

    return resolver
        .openTypedAssetFileDescriptor(uri, openableMimeTypes[0], null)
        .createInputStream();
}

แหล่งข้อมูลเพิ่มเติม

ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีจัดเก็บและเข้าถึงเอกสารและไฟล์อื่นๆ ได้ที่แหล่งข้อมูลต่อไปนี้

ตัวอย่าง

• ActionOpenDocument ซึ่งมีอยู่ใน GitHub
• ActionOpenDocumentTree ซึ่งมีอยู่ใน GitHub

วิดีโอ

• การเตรียมพร้อมสําหรับพื้นที่เก็บข้อมูลแบบมีขอบเขต (Android Dev Summit'19)