איך מבקשים קובץ משותף

כשאפליקציה אחרת מבקשת לגשת לקובץ ששותף על ידי אפליקציה אחרת, האפליקציה שמבקשת גישה (הלקוח) בדרך כלל שולחת בקשה לאפליקציה שמשתפת את הקבצים (השרת). ברוב המקרים, הבקשה מפעיל Activity באפליקציית השרת שמציג את הקבצים שהוא יכול לשתף. המשתמש בוחר קובץ, ולאחר מכן אפליקציית השרת מחזירה את ה-URI של תוכן הקובץ אפליקציית לקוח.

בשיעור הזה תראו איך אפליקציית לקוח מבקשת קובץ מאפליקציית שרת, מקבלת את URI של תוכן מאפליקציית השרת ופותח את הקובץ באמצעות ה-URI של התוכן.

שליחת בקשה לקובץ

כדי לבקש קובץ מאפליקציית השרת, אפליקציית הלקוח קוראת startActivityForResult עם Intent שמכילות את הפעולה, כמו ACTION_PICK וסוג MIME שאפליקציית הלקוח לטפל בתופעה.

לדוגמה, קטע הקוד הבא מדגים איך לשלוח קישור Intent לאפליקציית שרת כדי להפעיל את Activity מתואר בשיתוף קובץ:

Kotlin

class MainActivity : Activity() {
    private lateinit var requestFileIntent: Intent
    private lateinit var inputPFD: ParcelFileDescriptor
    ...
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        requestFileIntent = Intent(Intent.ACTION_PICK).apply {
            type = "image/jpg"
        }
        ...
    }
    ...
    private fun requestFile() {
        /**
         * When the user requests a file, send an Intent to the
         * server app.
         * files.
         */
        startActivityForResult(requestFileIntent, 0)
        ...
    }
    ...
}

Java

public class MainActivity extends Activity {
    private Intent requestFileIntent;
    private ParcelFileDescriptor inputPFD;
    ...
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        requestFileIntent = new Intent(Intent.ACTION_PICK);
        requestFileIntent.setType("image/jpg");
        ...
    }
    ...
    protected void requestFile() {
        /**
         * When the user requests a file, send an Intent to the
         * server app.
         * files.
         */
            startActivityForResult(requestFileIntent, 0);
        ...
    }
    ...
}

גישה לקובץ המבוקש

אפליקציית השרת שולחת את ה-URI של תוכן הקובץ חזרה לאפליקציית הלקוח Intent השדה Intent מועבר ללקוח באפליקציה במקום onActivityResult(). פעם אחת לאפליקציית הלקוח יש את ה-URI של התוכן של הקובץ, היא יכולה לגשת לקובץ על ידי קבלת FileDescriptor

אבטחת הקבצים נשמרת בתהליך הזה רק כל עוד מנתחים בצורה נכונה את ה-URI של התוכן שאפליקציית הלקוח מקבלת. במהלך ניתוח תוכן, עליך לוודא שה-URI הזה לא מפנה לכל פריט שנמצא מחוץ לספרייה המיועד, ומבטיחה מתבצע ניסיון לניתוח נתיב. רק אפליקציית הלקוח צריכה לקבל גישה לקובץ, ורק להרשאות שהוענקו על ידי אפליקציית שרת. ההרשאות הן זמניות. לכן, ברגע שרשימת המשימות של אפליקציית הלקוח מסתיימת, כבר לא ניתן לגשת לקובץ מחוץ לאפליקציית השרת.

קטע הקוד הבא מראה איך אפליקציית הלקוח מטפלת נשלח Intent מאפליקציית השרת, ואיך אפליקציית הלקוח מקבלת את FileDescriptor באמצעות ה-URI של התוכן:

Kotlin

/*
 * When the Activity of the app that hosts files sets a result and calls
 * finish(), this method is invoked. The returned Intent contains the
 * content URI of a selected file. The result code indicates if the
 * selection worked or not.
 */
public override fun onActivityResult(requestCode: Int, resultCode: Int, returnIntent: Intent) {
    // If the selection didn't work
    if (resultCode != Activity.RESULT_OK) {
        // Exit without doing anything else
        return
    }
    // Get the file's content URI from the incoming Intent
    returnIntent.data?.also { returnUri ->
        /*
         * Try to open the file for "read" access using the
         * returned URI. If the file isn't found, write to the
         * error log and return.
         */
        inputPFD = try {
            /*
             * Get the content resolver instance for this context, and use it
             * to get a ParcelFileDescriptor for the file.
             */
            contentResolver.openFileDescriptor(returnUri, "r")
        } catch (e: FileNotFoundException) {
            e.printStackTrace()
            Log.e("MainActivity", "File not found.")
            return
        }

        // Get a regular file descriptor for the file
        val fd = inputPFD.fileDescriptor
        ...
    }
}

Java

    /*
     * When the Activity of the app that hosts files sets a result and calls
     * finish(), this method is invoked. The returned Intent contains the
     * content URI of a selected file. The result code indicates if the
     * selection worked or not.
     */
    @Override
    public void onActivityResult(int requestCode, int resultCode,
            Intent returnIntent) {
        // If the selection didn't work
        if (resultCode != RESULT_OK) {
            // Exit without doing anything else
            return;
        } else {
            // Get the file's content URI from the incoming Intent
            Uri returnUri = returnIntent.getData();
            /*
             * Try to open the file for "read" access using the
             * returned URI. If the file isn't found, write to the
             * error log and return.
             */
            try {
                /*
                 * Get the content resolver instance for this context, and use it
                 * to get a ParcelFileDescriptor for the file.
                 */
                inputPFD = getContentResolver().openFileDescriptor(returnUri, "r");
            } catch (FileNotFoundException e) {
                e.printStackTrace();
                Log.e("MainActivity", "File not found.");
                return;
            }
            // Get a regular file descriptor for the file
            FileDescriptor fd = inputPFD.getFileDescriptor();
            ...
        }
    }

השיטה openFileDescriptor() מחזירה ParcelFileDescriptor עבור הקובץ. מהאובייקט הזה, הלקוח האפליקציה מקבלת אובייקט FileDescriptor, שבעזרתו היא יכולה לקרוא את הקובץ.

מידע נוסף בנושא זמין במאמרים הבאים:

• מסננים של Intent וכוונות
• אחזור נתונים מהספק