Android
 Computer >> コンピューター >  >> プログラミング >> Android

SDカードのフォルダ・ファイルにAndroidの書き込み権限を設定する方法【サンプルコード付き】


本記事では、AndroidアプリからSDカード(外部ストレージ)上のフォルダやファイルに対して書き込みを行うために必要なアクセス許可(パーミッション)の設定方法を、サンプルコード付きで解説します。「テキストを入力して外部ストレージに保存し、あとで読み出す」というシンプルなアプリを題材に、レイアウト・Javaコード・マニフェストの実装手順を順番に見ていきましょう。

実装の全体像

外部ストレージへの読み書きを実現するには、主に次の3つの要素が必要です。

  • マニフェストでの権限宣言:READ_EXTERNAL_STORAGE と WRITE_EXTERNAL_STORAGE を宣言する
  • ストレージ状態の確認:メディアがマウント済みか、読み取り専用になっていないかをチェックする
  • ファイル入出力処理:FileOutputStream / FileInputStream を使った保存と読み込みの実装

ステップ1:新規プロジェクトの作成

Android Studioを起動し、メニューから「File」→「New Project」を選択して新しいプロジェクトを作成します。必要な項目をすべて入力して、プロジェクトを完成させてください。

ステップ2:レイアウトファイル(activity_main.xml)の編集

res/layout/activity_main.xml に以下のコードを追加します。テキスト入力用のEditText、「SAVE」「READ」の2つのボタン、結果表示用のTextViewを縦方向に並べたシンプルな構成です。

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="https://schemas.android.com/apk/res/android"
xmlns:tools="https://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical"
    android:padding="12dp"
    tools:context=".MainActivity">
    <TextView
       android:textStyle="bold"
       android:textAlignment="center"
       android:layout_width="match_parent"
       android:layout_height="wrap_content"
       android:text="Reading and Writing to External Storage"
       android:textSize="24sp" />
    <EditText
       android:layout_marginTop="30dp"
       android:id="@+id/myInputText"
       android:layout_width="match_parent"
       android:layout_height="wrap_content"
       android:ems="10"
       android:gravity="top|start"
       android:lines="5"
       android:minLines="3">
    </EditText>
    <LinearLayout
       android:layout_width="match_parent"
       android:layout_height="wrap_content"
       android:layout_marginTop="20dp"
       android:orientation="horizontal"
       android:weightSum="1.0">
    <Button
       android:id="@+id/saveExternalStorage"
       android:layout_width="match_parent"
       android:layout_height="wrap_content"
       android:layout_weight="0.5"
       android:text="SAVE" />
    <Button
       android:id="@+id/getExternalStorage"
       android:layout_width="match_parent"
       android:layout_height="wrap_content"
       android:layout_weight="0.5"
       android:text="READ" />
    </LinearLayout>
    <TextView
       android:layout_marginTop="10dp"
       android:id="@+id/response"
       android:layout_width="wrap_content"
       android:layout_height="wrap_content"
       android:padding="5dp"
       android:text=""
       android:textAppearance="?android:attr/textAppearanceMedium" />
</LinearLayout>

ステップ3:MainActivity.java の実装

src/MainActivity.java に以下のコードを追加します。SAVEボタンでテキストファイルを書き出し、READボタンでその内容を読み戻す処理を実装しています。

import androidx.appcompat.app.AppCompatActivity;
import android.os.Bundle;
import android.os.Environment;
import android.view.View;
import android.widget.Button;
import android.widget.EditText;
import android.widget.TextView;
import java.io.BufferedReader;
import java.io.DataInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
public class MainActivity extends AppCompatActivity {
    EditText editText;
    TextView textView;
    Button saveButton, readButton;
    File myExternalFile;
    String myData = "";
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        editText = findViewById(R.id.myInputText);
        textView = findViewById(R.id.response);
        saveButton = findViewById(R.id.saveExternalStorage);
        saveButton.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                try {
                    FileOutputStream fos = new FileOutputStream(myExternalFile);
                    fos.write(editText.getText().toString().getBytes());
                    fos.close();
                }
                catch (IOException e) {
                    e.printStackTrace();
                }
                editText.setText("");
                textView.setText("SampleFile.txt saved to External Storage...");
            }
        });
        readButton = findViewById(R.id.getExternalStorage);
        readButton.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                try {
                    FileInputStream fis = new FileInputStream(myExternalFile);
                    DataInputStream in = new DataInputStream(fis);
                    BufferedReader br = new BufferedReader(new InputStreamReader(in));
                    String strLine;
                    while ((strLine = br.readLine()) != null) {
                        myData = myData + strLine;
                    }
                    in.close();
                }
                catch (IOException e) {
                    e.printStackTrace();
                }
                editText.setText(myData);
                textView.setText("SampleFile.txt data retrieved from Internal Storage...");
            }
        });
        if (!isExternalStorageAvailable() || isExternalStorageReadOnly()) {
            saveButton.setEnabled(false);
        }
        else {
            String fileName = "SampleFile.txt";
            String filePath = "MyFolder";
            myExternalFile = new File(getExternalFilesDir(filePath), fileName);
        }
    }
    private static boolean isExternalStorageReadOnly() {
        String extStorageState = Environment.getExternalStorageState();
        return Environment.MEDIA_MOUNTED_READ_ONLY.equals(extStorageState);
    }
    private static boolean isExternalStorageAvailable() {
        String extStorageState = Environment.getExternalStorageState();
        return Environment.MEDIA_MOUNTED.equals(extStorageState);
    }
}

このコードのポイントは以下の通りです。

  • isExternalStorageAvailable() / isExternalStorageReadOnly() メソッドで、外部ストレージが「マウント済みかつ書き込み可能」な状態かどうかを確認しています。
  • ストレージが読み取り専用の場合はSAVEボタンを無効化し、書き込み失敗によるクラッシュを未然に防ぎます。
  • getExternalFilesDir() を使うことで、アプリ専用の外部ストレージディレクトリ内に「MyFolder/SampleFile.txt」としてファイルを作成します。

ステップ4:AndroidManifest.xml への権限追加

androidManifest.xml に以下のコードを追加します。<uses-permission> タグで外部ストレージへの読み取り・書き込み権限を宣言している点が重要です。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="https://schemas.android.com/apk/res/android"
    package="app.com.sample">
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>

アプリの実行と動作確認

それでは、作成したアプリを実行してみましょう。ここでは実機のAndroidスマートフォンをPCに接続している前提で説明します。Android Studioでプロジェクト内のアクティビティファイルを開き、ツールバーの「Run」アイコンをクリックしてください。デバイス選択ダイアログで接続したモバイル端末を選ぶと、端末側にアプリの初期画面が表示されます。

SDカードのフォルダ・ファイルにAndroidの書き込み権限を設定する方法【サンプルコード付き】

SDカードのフォルダ・ファイルにAndroidの書き込み権限を設定する方法【サンプルコード付き】

補足:ランタイムパーミッションとスコープストレージ

Android 6.0(API 23)以降では、マニフェストへの宣言に加えて、アプリの実行時に requestPermissions() などでユーザーに権限をリクエストし、許可を得てからファイル操作を行う必要があります。また、Android 10以降はスコープストレージの導入により、他アプリと共有されるストレージ領域への直接アクセスが制限されました。本記事のように getExternalFilesDir() で取得できるアプリ固有のディレクトリを使えば、OSバージョンに左右されにくい安全な実装になります。共有ストレージ全体を扱いたい場合は、Storage Access Framework(SAF)や MANAGE_EXTERNAL_STORAGE 権限の活用も検討してください。

  1. Androidのアセットフォルダからファイルを読み込む方法【サンプルコード付きで解説】

    このチュートリアルでは、Androidアプリでアセット(assets)フォルダ内のファイルを扱う方法を、実際に動作するサンプルコードとともに段階的に解説します。なお、アセットフォルダはAPKにパッケージ化される読み取り専用の領域であるため、実行時に新しいファイルを書き込むことはできません。そこで本記事では、アセットフォルダに配置したテキストファイルを読み込み、画面に表示するまでの一連の手順を紹介します。ステップ1:新規プロジェクトを作成するAndroid Studioを起動し、メニューから「File」→「New Project」を選択します。必要な項目をすべて入力して、新しいプロジェクトを作成

  2. 【Android開発】TextViewのSpan(文字列の一部)に色を設定する方法を解説

    この記事では、AndroidアプリでTextView内の特定の文字列(Span)に色を設定する方法を、実際のサンプルコードとともに解説します。SpannableStringとForegroundColorSpanを組み合わせれば、1つのTextViewの中でも部分的にテキストの色を変更できます。手順1:Android Studioで新規プロジェクトを作成Android Studioを起動し、メニューから「File」→「New Project」を選択します。必要な項目を入力して、新しいプロジェクトを作成してください。手順2:レイアウトファイル(activity_main.xml)を編集するres