[Android & Kotlin] 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では名前を設定する時のデフォルト候補。
　

val intent = Intent(Intent.ACTION_CREATE_DOCUMENT)
intent.addCategory(Intent.CATEGORY_OPENABLE)
intent.type = "text/plain"
intent.putExtra(Intent.EXTRA_TITLE, "text_file.txt")

resultLauncher.launch(intent)

val intent = Intent(Intent.ACTION_CREATE_DOCUMENT)

intent.addCategory(Intent.CATEGORY_OPENABLE)

intent.type = "text/plain"

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

resultLauncher.launch(intent)

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

private var resultLauncher = registerForActivityResult(
    StartActivityForResult()
) { result: ActivityResult ->
    if (result.resultCode == AppCompatActivity.RESULT_OK) {
        val resultData = result.data
        if (resultData != null) {
            val uri = resultData.data

            // 書き込む文字列
            val str = "Storage Access Framework\n"
            try {
                contentResolver.openOutputStream(uri!!).use { outputStream ->
                    outputStream?.write(str.toByteArray())
                }
            } catch (e: Exception) {
                e.printStackTrace()
            }
        }
    }
}

private var resultLauncher = registerForActivityResult(

StartActivityForResult()

) { result: ActivityResult ->

if (result.resultCode == AppCompatActivity.RESULT_OK) {

val resultData = result.data

if (resultData != null) {

val uri = resultData.data

// 書き込む文字列

val str = "Storage Access Framework\n"

try {

contentResolver.openOutputStream(uri!!).use { outputStream ->

outputStream?.write(str.toByteArray())

}

} catch (e: Exception) {

e.printStackTrace()

}

サンプルコード

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

MainActivity.kt

//package your.package.name

import android.content.Intent
import android.os.Bundle
import android.widget.Button
import android.widget.TextView
import androidx.activity.result.ActivityResult
import androidx.activity.result.contract.ActivityResultContracts.StartActivityForResult
import androidx.appcompat.app.AppCompatActivity
import java.util.*


class MainActivity : AppCompatActivity() {

    private var resultLauncher = registerForActivityResult(
        StartActivityForResult()
    ) { result: ActivityResult ->
        if (result.resultCode == RESULT_OK) {
            val resultData = result.data
            if (resultData != null) {
                val uri = resultData.data

                // Uriを表示
                val textView = findViewById<TextView>(R.id.text_view)
                textView.text = String.format(Locale.US, "Uri:　%s",uri.toString())

                val str = "Storage Access Framework\n"
                try {
                    contentResolver.openOutputStream(uri!!).use { outputStream ->
                        outputStream?.write(str.toByteArray())
                    }
                } catch (e: Exception) {
                    e.printStackTrace()
                }
            }
        }
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        val button = findViewById<Button>(R.id.button)
        button.setOnClickListener { createFile() }
    }

    private fun createFile() {
        val fileName = "text_file.txt"
        val intent = Intent(Intent.ACTION_CREATE_DOCUMENT)
        intent.addCategory(Intent.CATEGORY_OPENABLE)
        intent.type = "text/plain"
        intent.putExtra(Intent.EXTRA_TITLE, fileName)
        resultLauncher.launch(intent)
    }
}

//package your.package.name

import android.content.Intent

import android.os.Bundle

import android.widget.Button

import android.widget.TextView

import androidx.activity.result.ActivityResult

import androidx.activity.result.contract.ActivityResultContracts.StartActivityForResult

import androidx.appcompat.app.AppCompatActivity

import java.util.*

class MainActivity : AppCompatActivity() {

private var resultLauncher = registerForActivityResult(

StartActivityForResult()

) { result: ActivityResult ->

if (result.resultCode == RESULT_OK) {

val resultData = result.data

if (resultData != null) {

val uri = resultData.data

// Uriを表示

val textView = findViewById<TextView>(R.id.text_view)

textView.text = String.format(Locale.US, "Uri:　%s",uri.toString())

val str = "Storage Access Framework\n"

try {

contentResolver.openOutputStream(uri!!).use { outputStream ->

outputStream?.write(str.toByteArray())

}

} catch (e: Exception) {

e.printStackTrace()

}

override fun onCreate(savedInstanceState: Bundle?) {

super.onCreate(savedInstanceState)

setContentView(R.layout.activity_main)

val button = findViewById<Button>(R.id.button)

button.setOnClickListener { createFile() }

}

private fun createFile() {

val fileName = "text_file.txt"

val intent = Intent(Intent.ACTION_CREATE_DOCUMENT)

intent.addCategory(Intent.CATEGORY_OPENABLE)

intent.type = "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」ディレクトリにテキストファイルを保存しましたが、同じように画像を保存することも可能です。
　

class MainActivity : AppCompatActivity() {

    private var resultLauncher = registerForActivityResult(
        StartActivityForResult()
    ) { result: ActivityResult ->
        if (result.resultCode == RESULT_OK) {
            val resultData = result.data
            if (resultData != null) {
                val uri = resultData.data

                val bmp = BitmapFactory.decodeResource(resources, R.drawable.img)
                try {contentResolver.openOutputStream(uri!!).use { outputStream ->
                        val compress = bmp.compress(
                            Bitmap.CompressFormat.PNG,
                            100,
                            outputStream
                        )
                        compress
                    }
                } catch (e: Exception) {
                    e.printStackTrace()
                }

            }
        }
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        val button = findViewById<Button>(R.id.button)
        button.setOnClickListener { createFile() }
    }

    private fun createFile() {
        val intent = Intent(Intent.ACTION_CREATE_DOCUMENT)
        intent.addCategory(Intent.CATEGORY_OPENABLE)
        intent.type = "image/*"
        intent.putExtra(Intent.EXTRA_TITLE, "img.jpg")
        resultLauncher.launch(intent)
    }
}

class MainActivity : AppCompatActivity() {

private var resultLauncher = registerForActivityResult(

StartActivityForResult()

) { result: ActivityResult ->

if (result.resultCode == RESULT_OK) {

val resultData = result.data

if (resultData != null) {

val uri = resultData.data

val bmp = BitmapFactory.decodeResource(resources, R.drawable.img)

try {contentResolver.openOutputStream(uri!!).use { outputStream ->

val compress = bmp.compress(

Bitmap.CompressFormat.PNG,

100,

outputStream

)

compress

}

} catch (e: Exception) {

e.printStackTrace()

}

override fun onCreate(savedInstanceState: Bundle?) {

super.onCreate(savedInstanceState)

setContentView(R.layout.activity_main)

val button = findViewById<Button>(R.id.button)

button.setOnClickListener { createFile() }

}

private fun createFile() {

val intent = Intent(Intent.ACTION_CREATE_DOCUMENT)

intent.addCategory(Intent.CATEGORY_OPENABLE)

intent.type = "image/*"

intent.putExtra(Intent.EXTRA_TITLE, "img.jpg")

resultLauncher.launch(intent)

}

　
　
関連ページ：
　

asynctask 00b 100x100 - [Android & Kotlin] Storage Access Framework でドキュメントの保存

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

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

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