[Android] Storage Access Framework でドキュメントを保存する

共有メモリにファイルを保存するためにSAF(Storage Access Framework)を利用します。ファイル保存に使うのは ACTION_CREATE_DOCUMENTです。取り出したい場合は ACTION_OPEN_DOCUMENT を使います。

Android Studio
2021.1.1

SAF, Storage Access Framework

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

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

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

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

Intent ACTION_CREATE

テキストファイルをSAFを使って保存します。

IntentはACTION_CREATE_DOCUMENT
setTypeでMIMEの設定
EXTRA_TITLEでは名前を設定する時のデフォルト候補。
　

Intent intent = new Intent(Intent.ACTION_CREATE_DOCUMENT);
intent.addCategory(Intent.CATEGORY_OPENABLE);
intent.setType("text/plain");
intent.putExtra(Intent.EXTRA_TITLE, "text_file.txt");

resultLauncher.launch(intent);

Intent intent = new Intent(Intent.ACTION_CREATE_DOCUMENT);

intent.addCategory(Intent.CATEGORY_OPENABLE);

intent.setType("text/plain");

intent.putExtra(Intent.EXTRA_TITLE, "text_file.txt");

resultLauncher.launch(intent);

　
registerForActivityResultを使ってUriを受け取り、そのUriに出力していきます。

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

                // 書き込む文字列
                String str = "Storage Access Framework\n";
                
                try(OutputStream outputStream =
                            getContentResolver().openOutputStream(uri)) {
                    if(outputStream != null){
                        outputStream.write(str.getBytes());
                    }

                } catch(Exception e){
                    e.printStackTrace();
                }
            }
        }
    });

ActivityResultLauncher<Intent> resultLauncher = registerForActivityResult(

new ActivityResultContracts.StartActivityForResult(),

result -> {

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

Intent resultData = result.getData();

if (resultData != null) {

Uri uri = resultData.getData();

// 書き込む文字列

String str = "Storage Access Framework\n";

try(OutputStream outputStream =

getContentResolver().openOutputStream(uri)) {

if(outputStream != null){

outputStream.write(str.getBytes());

}

} catch(Exception e){

e.printStackTrace();

}

});

サンプルコード

テキストファイルに「Storage Access Framework」の文字列を入れてそれを保存してみます。

MainActivity.java

//package your.package.name;

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.net.Uri;
import android.widget.Button;
import android.widget.TextView;

import java.io.OutputStream;
import java.util.Locale;

public class MainActivity extends AppCompatActivity {

    private TextView textView;

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

                        // Uriを表示
                        textView.setText(
                                String.format(Locale.US, "Uri:　%s",uri.toString()));

                        String str = "Storage Access Framework\n";
                        try(OutputStream outputStream =
                                    getContentResolver().openOutputStream(uri)) {
                            if(outputStream != null){
                                outputStream.write(str.getBytes());
                            }

                        } catch(Exception e){
                            e.printStackTrace();
                        }

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

        textView = findViewById(R.id.text_view);

        Button button = findViewById(R.id.button);
        button.setOnClickListener( v -> createFile());
    }

    private void createFile() {
        String fileName = "text_file.txt";

        Intent intent = new Intent(Intent.ACTION_CREATE_DOCUMENT);
        intent.addCategory(Intent.CATEGORY_OPENABLE);
        intent.setType("text/plain");
        intent.putExtra(Intent.EXTRA_TITLE, fileName);

        resultLauncher.launch(intent);
    }
}

//package your.package.name;

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.net.Uri;

import android.widget.Button;

import android.widget.TextView;

import java.io.OutputStream;

import java.util.Locale;

public class MainActivity extends AppCompatActivity {

private TextView textView;

ActivityResultLauncher<Intent> resultLauncher = registerForActivityResult(

new ActivityResultContracts.StartActivityForResult(),

result -> {

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

Intent resultData = result.getData();

if (resultData != null) {

Uri uri = resultData.getData();

// Uriを表示

textView.setText(

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

String str = "Storage Access Framework\n";

try(OutputStream outputStream =

getContentResolver().openOutputStream(uri)) {

if(outputStream != null){

outputStream.write(str.getBytes());

}

} catch(Exception e){

e.printStackTrace();

}

});

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

textView = findViewById(R.id.text_view);

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

button.setOnClickListener( v -> createFile());

}

private void createFile() {

String fileName = "text_file.txt";

Intent intent = new Intent(Intent.ACTION_CREATE_DOCUMENT);

intent.addCategory(Intent.CATEGORY_OPENABLE);

intent.setType("text/plain");

intent.putExtra(Intent.EXTRA_TITLE, fileName);

resultLauncher.launch(intent);

}

その他ファイル

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">YourApp Name</string>
    <string name="button">Save File</string>
    <string name="description">a picture</string>
</resources>

<string name="app_name">YourApp Name</string>

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

</resources>

　
実行してボタンをタップすると共有ストレージの「Downloads」に移行して、そこに保存できます。

adb を使ってストレージを覗いてみると、text_file.txt が存在します。
また、ファイル内容も想定したものです。

hoge>adb shell
$ ls
acct  bugreports  d            debug_ramdisk  etc              linkerconfig  mnt  proc     sdcard   system
apex  cache       data         default.prop   init             lost+found    odm  product  storage  system_ext
bin   config      data_mirror  dev            init.environ.rc  metadata      oem  res      sys      vendor
$ cd sdcard/Download/
$ ls -la
total 16
-rw------- 1 u0_a151 u0_a151 24 2020-11-02 23:00 data-storage.pdf
-rw------- 1 u0_a151 u0_a151 25 2020-11-02 23:17 text_file.txt
$ cat text_file.txt
Storage Access Framework
$

hoge>adb shell

$ ls

acct bugreports d debug_ramdisk etc linkerconfig mnt proc sdcard system

apex cache data default.prop init lost+found odm product storage system_ext

bin config data_mirror dev init.environ.rc metadata oem res sys vendor

$ cd sdcard/Download/

$ ls -la

total 16

-rw------- 1 u0_a151 u0_a151 24 2020-11-02 23:00 data-storage.pdf

-rw------- 1 u0_a151 u0_a151 25 2020-11-02 23:17 text_file.txt

$ cat text_file.txt

Storage Access Framework

画像ファイルの保存

SAFを使って「Download」ディレクトリにテキストファイルを保存しましたが、同じように画像を保存することも可能です。
　

public class MainActivity extends AppCompatActivity {

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

                        Bitmap bmp = BitmapFactory.decodeResource(getResources(), R.drawable.sample_image);
                        try(OutputStream outputStream =
                                    getContentResolver().openOutputStream(uri)) {
                            bmp.compress(Bitmap.CompressFormat.PNG, 100, outputStream);

                        } catch(Exception e){
                            e.printStackTrace();
                        }

                    }
                }
            });

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

        Button button = findViewById(R.id.button);
        button.setOnClickListener( v -> createFile());
    }

    private void createFile() {
        Intent intent = new Intent(Intent.ACTION_CREATE_DOCUMENT);
        intent.setType("image/*");
        intent.putExtra(Intent.EXTRA_TITLE, "sample_image.png");

        resultLauncher.launch(intent);
    }
}

public class MainActivity extends AppCompatActivity {

ActivityResultLauncher<Intent> resultLauncher = registerForActivityResult(

new ActivityResultContracts.StartActivityForResult(),

result -> {

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

Intent resultData = result.getData();

if (resultData != null) {

Uri uri = resultData.getData();

Bitmap bmp = BitmapFactory.decodeResource(getResources(), R.drawable.sample_image);

try(OutputStream outputStream =

getContentResolver().openOutputStream(uri)) {

bmp.compress(Bitmap.CompressFormat.PNG, 100, outputStream);

} catch(Exception e){

e.printStackTrace();

}

});

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

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

button.setOnClickListener( v -> createFile());

}

private void createFile() {

Intent intent = new Intent(Intent.ACTION_CREATE_DOCUMENT);

intent.setType("image/*");

intent.putExtra(Intent.EXTRA_TITLE, "sample_image.png");

resultLauncher.launch(intent);

}