[Android] Storage Access Framework でフォトアプリから画像を取り出す

デフォルトでAndroidにインストールされているギャラリーあるいはフォトから画像を取得するにはSAF(Storage Access Framework)を使うと可能です。
画像ファイルを読み出したい場合などは、ACTION_OPEN_DOCUMENT を使い、また保存したい場合はACTION_CREATE_DOCUMENTアクションを使います。

Android Studio
2021.1.1

SAF, Storage Access Framework

SAFを使うことによりコンテンツを容易に参照できます。

ドキュメントストレージプロバイダ全体から簡単にドキュメント、画像、その他のファイルを参照して開くことができる
標準の Picker UI により、アプリやプロバイダを通じて一貫性のある方法でファイルにアクセスできる

図 2. ストレージアクセスフレームワークのフロー
Ref:ストレージアクセスフレームワーク

目次
1. Intent ACTION_OPEN
2. サンプルコード
3. サンプル動画

Intent ACTION_OPEN

画像ファイルを取り出してみましょう。

Intent.ACTION_OPEN_DOCUMENT：
- ピッカーを使用してファイルを選択するためのIntent
Intent.CATEGORY_OPENABLE:
- openFileDescriptor() によるファイルストリームとして利用可能な「開くことができる」ファイルのカテゴリーを選択
setType:
- MIME タイプを指定、取得するファイルの形式をフィルターする

// ACTION_OPEN_DOCUMENT is the intent to choose a file via the system's file browser.
Intent intent = new Intent(Intent.ACTION_OPEN_DOCUMENT);

// Filter to only show results that can be "opened", such as a
// file (as opposed to a list of contacts or timezones)
intent.addCategory(Intent.CATEGORY_OPENABLE);

// Filter to show only images, using the image MIME data type.
intent.setType("image/*");

resultLauncher.launch(intent);

// ACTION_OPEN_DOCUMENT is the intent to choose a file via the system's file browser.

Intent intent = new Intent(Intent.ACTION_OPEN_DOCUMENT);

// Filter to only show results that can be "opened", such as a

// file (as opposed to a list of contacts or timezones)

intent.addCategory(Intent.CATEGORY_OPENABLE);

// Filter to show only images, using the image MIME data type.

intent.setType("image/*");

resultLauncher.launch(intent);

　
ピッカーから画像を選択すると、registerForActivityResult()を使って結果のコールバックを登録しそこからデータを取り出します
　

ActivityResultLauncher<Intent> resultLauncher = registerForActivityResult(
    new ActivityResultContracts.StartActivityForResult(),
    new ActivityResultCallback<ActivityResult>() {
        @Override
        public void onActivityResult(ActivityResult result) {
            if (result.getResultCode() == Activity.RESULT_OK) {
                Intent resultData  = result.getData();
                if (resultData  != null) {
                    ...
                }
            }
        }
    });

ActivityResultLauncher<Intent> resultLauncher = registerForActivityResult(

new ActivityResultContracts.StartActivityForResult(),

new ActivityResultCallback<ActivityResult>() {

@Override

public void onActivityResult(ActivityResult result) {

if (result.getResultCode() == Activity.RESULT_OK) {

Intent resultData = result.getData();

if (resultData != null) {

...

}

});

このケースでは、パーミッションなど必要ありません(これがありがたいですね)

サンプルコード

フォトにある画像を読みだして表示させてみましょう。
　

　
MainActivity.java

//package your.package.name;

import androidx.activity.result.ActivityResult;
import androidx.activity.result.ActivityResultCallback;
import androidx.activity.result.ActivityResultLauncher;
import androidx.activity.result.contract.ActivityResultContracts;
import androidx.appcompat.app.AppCompatActivity;
import android.os.Bundle;
import android.app.Activity;
import android.content.Intent;
import android.graphics.Bitmap;
import android.graphics.BitmapFactory;
import android.net.Uri;
import android.os.ParcelFileDescriptor;
import android.widget.Button;
import android.widget.ImageView;
import android.widget.TextView;
import java.io.FileDescriptor;
import java.io.IOException;
import java.util.Locale;

public class MainActivity extends AppCompatActivity {

    private TextView textView;
    private ImageView imageView;

    ActivityResultLauncher<Intent> resultLauncher = registerForActivityResult(
            new ActivityResultContracts.StartActivityForResult(),
            result -> {
                if (result.getResultCode() == Activity.RESULT_OK) {
                    Intent resultData  = result.getData();
                    if (resultData  != null) {
                        openImage(resultData);
                    }
                }
            });

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        textView = findViewById(R.id.text_view);
        imageView = findViewById(R.id.image_view);

        Button button = findViewById(R.id.button);
        button.setOnClickListener( v -> {
            Intent intent = new Intent(Intent.ACTION_OPEN_DOCUMENT);
            intent.addCategory(Intent.CATEGORY_OPENABLE);
            intent.setType("image/*");

            resultLauncher.launch(intent);
        });
    }

    void openImage(Intent resultData){
        ParcelFileDescriptor pfDescriptor = null;
        try{
            Uri uri = resultData.getData();
            // Uriを表示
            textView.setText(
                    String.format(Locale.US, "Uri:　%s",uri.toString()));

            pfDescriptor = getContentResolver().openFileDescriptor(uri, "r");
            if(pfDescriptor != null){
                FileDescriptor fileDescriptor = pfDescriptor.getFileDescriptor();
                Bitmap bmp = BitmapFactory.decodeFileDescriptor(fileDescriptor);
                pfDescriptor.close();
                imageView.setImageBitmap(bmp);
            }
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            try{
                if(pfDescriptor != null){
                    pfDescriptor.close();
                }
            }catch (Exception e){
                e.printStackTrace();
            }
        }
    }

}

//package your.package.name;

import androidx.activity.result.ActivityResult;

import androidx.activity.result.ActivityResultCallback;

import androidx.activity.result.ActivityResultLauncher;

import androidx.activity.result.contract.ActivityResultContracts;

import androidx.appcompat.app.AppCompatActivity;

import android.os.Bundle;

import android.app.Activity;

import android.content.Intent;

import android.graphics.Bitmap;

import android.graphics.BitmapFactory;

import android.net.Uri;

import android.os.ParcelFileDescriptor;

import android.widget.Button;

import android.widget.ImageView;

import android.widget.TextView;

import java.io.FileDescriptor;

import java.io.IOException;

import java.util.Locale;

public class MainActivity extends AppCompatActivity {

private TextView textView;

private ImageView imageView;

ActivityResultLauncher<Intent> resultLauncher = registerForActivityResult(

new ActivityResultContracts.StartActivityForResult(),

result -> {

if (result.getResultCode() == Activity.RESULT_OK) {

Intent resultData = result.getData();

if (resultData != null) {

openImage(resultData);

}

});

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

textView = findViewById(R.id.text_view);

imageView = findViewById(R.id.image_view);

Button button = findViewById(R.id.button);

button.setOnClickListener( v -> {

Intent intent = new Intent(Intent.ACTION_OPEN_DOCUMENT);

intent.addCategory(Intent.CATEGORY_OPENABLE);

intent.setType("image/*");

resultLauncher.launch(intent);

});

}

void openImage(Intent resultData){

ParcelFileDescriptor pfDescriptor = null;

try{

Uri uri = resultData.getData();

// Uriを表示

textView.setText(

String.format(Locale.US, "Uri:　%s",uri.toString()));

pfDescriptor = getContentResolver().openFileDescriptor(uri, "r");

if(pfDescriptor != null){

FileDescriptor fileDescriptor = pfDescriptor.getFileDescriptor();

Bitmap bmp = BitmapFactory.decodeFileDescriptor(fileDescriptor);

pfDescriptor.close();

imageView.setImageBitmap(bmp);

}

} catch (IOException e) {

e.printStackTrace();

} finally {

try{

if(pfDescriptor != null){

pfDescriptor.close();

}

}catch (Exception e){

e.printStackTrace();

}

その他ファイル

activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical"
    android:background="#fee"
    android:gravity="center_horizontal"
    tools:context=".MainActivity">

    <TextView
        android:id="@+id/text_view"
        android:textColor="#000"
        android:layout_margin="10dp"
        android:layout_width="match_parent"
        android:layout_height="wrap_content" />
    <Button
        android:id="@+id/button"
        android:text="@string/button"
        android:layout_margin="10dp"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content" />

    <ImageView
        android:id="@+id/image_view"
        android:scaleType="centerInside"
        android:contentDescription="@string/description"
        android:layout_margin="10dp"
        android:layout_width="match_parent"
        android:layout_height="wrap_content" />

</LinearLayout>

<?xml version="1.0" encoding="utf-8"?>

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"

xmlns:tools="http://schemas.android.com/tools"

android:layout_width="match_parent"

android:layout_height="match_parent"

android:orientation="vertical"

android:background="#fee"

android:gravity="center_horizontal"

tools:context=".MainActivity">

<TextView

android:id="@+id/text_view"

android:textColor="#000"

android:layout_margin="10dp"

android:layout_width="match_parent"

android:layout_height="wrap_content" />

<Button

android:id="@+id/button"

android:text="@string/button"

android:layout_margin="10dp"

android:layout_width="wrap_content"

android:layout_height="wrap_content" />

<ImageView

android:id="@+id/image_view"

android:scaleType="centerInside"

android:contentDescription="@string/description"

android:layout_margin="10dp"

android:layout_width="match_parent"

android:layout_height="wrap_content" />

</LinearLayout>

　
リソースです
strings.xml

<resources>
    <string name="app_name">YourAppName</string>
    <string name="button">Get Image</string>
    <string name="description">a picture</string>
</resources>

<string name="app_name">YourAppName</string>

<string name="button">Get Image</string>

<string name="description">a picture</string>

</resources>

サンプル動画

本来は非同期で画像を取り込む事が望ましいとされています。（この例では簡略化させていただきました…）
　
　
関連ページ：
　

asynctask 00b 100x100 - [Android] Storage Access Framework でフォトアプリから画像を取り出す

[Android] データ保存、対象範囲別外部ストレージ

データを保存するストレージ領域が目的・用途によって区分されてセキュリティー的に厳しくなりました。対象範囲別外部ストレージ　 S...

　
　
References:
Storage Access Framework
インテント
ACTION_OPEN_DOCUMENT
ACTION_GET_CONTENT