FC2ブログ

記事一覧

対象範囲別ストレージ (Scoped Strage) の対応方法 - Android11 - | Xamarin.Forms


今回は Google Play Console におきまして、「お客様のアプリで 1 件以上の App Bundle または APK のマニフェスト ファイルに requestLegacyExternalStorage フラグが含まれていることが検出されました。」と通知が来まして、更なるアプリ改修が必要と認識しましたので、その対応方法について覚え書きしてみました。
そもそも 2021年8月以降には Google Play で公開する為にターゲットフレームワークを Android 11.0 (R) へ変更する事が必要になっています。その対応方法のメイン改修となります「対象範囲別ストレージ (Scoped Strage)」 への対応が必要の様です。
※今回の記事は以前の記事「Android7 Nougat 以降のFileProviderの設定方法」を更新するものとなっていますので、その記事が前提となります。


xamarin_android_11_scoped_strage_02.png



前提条件
・Windows10 Pro 64Bit 1903
・Visual Studio 2019 Community v16.9.4
・Xamarin 16.9.000.273 (NuGet Xamarin.Forms 4.6.0.1141)


参考URL
https://developer.android.com/about/versions/11/privacy/storage?hl=ja



1.事前準備

Android11 の SDK やシミュレータをインストールするために、Visual Studio 2019 のバージョンを v16.9 以降に更新します。

更新したら、Android SDK マネージャで必要な環境をダウンロード & インストールします。

xamarin_android_11_scoped_strage_03.png


その上で、Android プロジェクトのプロパティからターゲットフレームワークを変更します。

xamarin_android_11_scoped_strage_01.png



2.注意点

ターゲットフレームワークを Android 11 (R) に変更した場合、以下の AndroidManifest.xml での設定ができなくなります。

・sharedUserId は設定するとエラーになります。アプリ間でファイルを共有してアクセスできる機能でした。
<manifest android:sharedUserId="任意のアプリID"

・requestLegacyExternalStorage フラグは無視されます。Android10 で対象範囲別ストレージ (Scoped Strage)をオプトアウトする方法でした。
<application android:requestLegacyExternalStorage="true" >


また、Android のネイティブコードにも Google により変更されていない不具合がある事が分かりました。

・BuildVersionCodes.R が 10000 のままとなっており、変更されておらず、以下の条件式に合致することはありません。
if (Build.VERSION.SdkInt >= BuildVersionCodes.R)
{
//絶対に通りません。
}
※以下のURLでも変更されていないまま記載されていましたが、2021/05/29時点では値が30に更新されています。
https://developer.android.com/reference/android/os/Build.VERSION_CODES#R



3.実装方法 その1

対象範囲別ストレージに準拠する場合は、ファイルの入出力方法を Storage Access Framework API、Media Store API などに置き換えてアプリを更新する方法があります。簡単な実装方法例を以下に記載します。


Storage Access Framework の例
private void SaveTextFile()
{
var intent = new Intent(Intent.ActionCreateDocument);
intent.AddCategory(Intent.CategoryOpenable);
intent.SetType("text/plain");
intent.PutExtra(Intent.ExtraTitle, "sample.txt");
StartActivityForResult(intent, 11111);
}

protected override void OnActivityResult(int requestCode, Result resultCode, global::Android.Content.Intent data)
{
base.OnActivityResult(requestCode, resultCode, data);

if (requestCode == 11111 &&
resultCode == Result.Ok &&
data != null &&
data.Data != null)
{
Android.Net.Uri uri = data.Data;
using (System.IO.Stream fos = this.ContentResolver.OpenOutputStream(uri))
{
fos.Write(System.Text.Encoding.UTF8.GetBytes("SAF Test"));
fos.Close();
}
}
}



4.実装方法 その2

(1)ファイルマネージャやバックアップ&復元機能を保持するアプリの場合は、AndroidManifest.xml に MANAGE_EXTERNAL_STORAGE を追加してアプリを更新する方法もあります。
※ MANAGE_EXTERNAL_STORAGE を含むアプリはGoogle Play Console で2021年5月5日以降にアップロードが可能です。(実際は2021年5月10日頃にアップロードが可能になっていました。)ただし、厳格な審査がありますので、アプリの主要な機能がファイルマネージャでない場合は、審査に通らない可能性が有ります。

AndroidManifest.xml
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
android:installLocation="internalOnly"
package="com.Company.AppName">
<uses-sdk android:targetSdkVersion="30" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.MANAGE_EXTERNAL_STORAGE" />
</manifest>


(2)また、ACTION_MANAGE_ALL_FILES_ACCESS_PERMISSION インテントを呼び出すことも必要ですが、一部の端末で呼び出しかたに違いがあるようですので、エラーがあった場合は少し変更してインテントを呼び出すようにしています。

PermissionService.cs
/// <summary>
/// Scoped Strage 対策
/// </summary>
private void RequestAllFilesAccessPermission()
{
try
{ //Scoped Strage 対策 Activity activity = Forms.MainActivity; string packageName = activity.PackageManager.GetPackageInfo(activity.PackageName, 0).PackageName; //TODO:BuildVersionCodes.Rに置き換える //if (Build.VERSION.SdkInt >= BuildVersionCodes.R) if ((int)Build.VERSION.SdkInt >= 30) {
if (Android.OS.Environment.IsExternalStorageManager)
{
return;
}
try { Intent intent = new Intent(Android.Provider.Settings.ActionManageAllFilesAccessPermission); intent.AddCategory("android.intent.category.DEFAULT"); intent.SetData(Android.Net.Uri.Parse("package:" + packageName)); activity.StartActivityForResult(intent, RequestCode.AllFilePermission); } catch (Exception) { Intent intent = new Intent(); intent.SetAction(Android.Provider.Settings.ActionManageAllFilesAccessPermission); activity.StartActivityForResult(intent, RequestCode.AllFilePermission);
} } else { //below android 11 activity.RequestPermissions(new String[] { Android.Manifest.Permission.WriteExternalStorage }, RequestCode.Permission); }
}
catch (Exception ex)
{
System.Console.WriteLine(ex.Message);
}
}

※ 次の記事「MainActivityのインスタンスを取得する方法」でも紹介しておりますが、Forms.MainActivity は MainActivity.cs で取得した Activity のインスタンスをシングルトンで保持しているプロパティです。Forms.Context が廃止されたための対応を行っております。
※ RequestCode.AllFilePermission は定数です。任意の正の整数を設定します。

また、以下は一部端末で発生するエラーの内容です。インテントの作成方法に違いがあるようです。

android.content.ActivityNotFoundException: No Activity found to handle Intent { act=android.settings.MANAGE_ALL_FILES_ACCESS_PERMISSION dat=package:com.CompanyName.AppName }


ActionManageAllFilesAccessPermission インテントの実行画面は以下の通りです。

xamarin_android_11_scoped_strage_04.png


ActionManageAllFilesAccessPermission の実行結果を取得する方法については、Environment.IsExternalStorageManager で判別できましたが、以下の様に MainActivity.cs で取得することもできるようです。しかしながら、あまり正確なレスポンスが得られませんでしたのでお勧めしません。

MainActivity.cs
public class MainActivity : global::Xamarin.Forms.Platform.Android.FormsAppCompatActivity 
{
    protected override void OnActivityResult(int requestCode, Result resultCode, global::Android.Content.Intent data)
    {
        base.OnActivityResult(requestCode, resultCode, data);

        //ファイル管理パーミッションからの戻り
        if (requestCode == RequestCode.AllFilePermission)
        {
            System.Console.WriteLine("StartActivityForResult ActionManageAllFilesAccessPermission:" + resultCode.ToString());
            return;
        }
}
}


(3)Google Play Console で MANAGE_EXTERNAL_STORAGE パーミッションを保有するアプリを公開しようとすると、権限の申請フォームへの入力を求められますので、案内のまま進み、申請フォームを入力します。

xamarin_android_11_scoped_strage_05.png


以上で、MANAGE_EXTERNAL_STORAGE パーミッションを含むアプリの公開ができました。





最後までお読みいただきありがとうございます。
当ブログの内容をまとめた Xamarin逆引きメニュー は以下のURLからご覧になれます。
https://itblogdsi.blog.fc2.com/blog-entry-81.html


関連記事

コメント

コメントの投稿

※名前とタイトルが入力されていないコメントでは他のコメントとの区別ができません。

 入力されていないコメントには返信しませんのであらかじめご了承くださいませ。

※ニックネームでも良いので必ずご入力ください。

    

※必ずご入力ください。

    
    

※必ずご入力ください。

※技術的な質問には環境やエラーについて正確かつ詳細にお教えください。

・正確なエラーの内容

・Windowsのバージョン番号

・Visual Studioのバージョン

・機器の型番

・アプリやソフトのバージョン

    

カテゴリ別記事一覧

広告

プロフィール

石河 純


著者名 :石河 純
自己紹介:素人上がりのIT技術者。趣味は卓球・車・ボウリング

IT関連の知識はざっくりとこんな感じです。
【OS関連】
WindowsServer: 2012/2008R2/2003/2000/NT4
Windows: 10/8/7/XP/2000/me/NT4/98
Linux: CentOS RedHatLinux9
Mac: macOS Sierra 10.12 / OSX Lion 10.7.5 / OSX Snow Leopard 10.6.8
【言語・データベース】
VB.net ASP.NET C#.net Java VBA
Xamarin.Forms
Oracle10g SQLServer2008R2 SQLAnywhere8/11/16
ActiveReport CrystalReport ReportNet(IBM)
【ネットワーク関連】
CCNP シスコ技術者認定
Cisco Catalyst シリーズ
Yamaha RTXシリーズ
FireWall関連
【WEB関連】
SEO SEM CSS IIS6/7 apache2

休みの日は卓球をやっています。
現在、卓球用品通販ショップは休業中です。