总结系列-Android10适配-分区存储

Posted 2022-11-13 ZhangQiang-

上篇介绍了android10的部分适配总结,其中存储适配采用的为兼容模式,本篇单独介绍正常分区存储适配.

Google于 2019年9月3日发布了Android10 release版本，为了更好的保护用户数据并限制设备冗余文件增加，Android 10版本变更了设备外部存储访问方式，外部存储新特性称为分区存储（Scoped Storage), 分区存储遵循以下三个原则对外部存储文件访问方式重新设计，便于用户更好的管理外部存储文件.

(本篇主要总结,具体样例代码较多,参见末尾链接)

文件归属	系统记录文件由哪个应用创建，应用不需要存储权限即可以访问应用自己创建文件
应用数据保护	添加外部存储应用私有目录文件访问限制， 应用即使申请了存储权限也不能访问其他应用外部存储私有目录文件
用户数据保护	添加pdf、office、doc等文件的访问限制，用户即使申请了存储权限也不能访问其他应用创建的pdf、office、doc等文件

相关目录:
应用兼容模式
        1兼容模式设置
        2 判断兼容模式接口
分区存储新特性
    分区存储概览
        1 分区存储
        2 应用私有目录文件访问
        3 共享目录文件访问
        4 其他受影响变更
    存储特性Android版本差异概览
分区适配方案
    分区存储适配方案概览
        1文件迁移
        2 文件访问兼容性适配
    分区存储适配指导
        1 MediaStore API
        2 Storage Access Framework
        3 分享场景适配
百度APP分区存储适配经验样例

应用兼容模式

分区存储存在一定的适配成本，Google为Android10版本提供了过渡方案，设置应用以兼容模式运行，Android11将不再支持该行为，各应用需要在Android11发版之前完成分区存储适配工作

1 兼容模式设置

应用未完成外部存储适配工作，可以临时以兼容模式运行， 兼容模式下应用申请存储权限，即可拥有外部存储完整目录访问权限，通过Android10之前文件访问方式运行，以下两种方法设置应用以兼容模式运行
（1）Target 小于等于Android 9 (API level 28)
（2）Tagret 大于等于Android 10（API level 29）， 在manifest中设置requestLegacyExternalStorage属性为true

android10的时候在targetSdkVersion = 29应用中，设置android:requestLegacyExternalStorage="true"，就可以不启动分区存储，让以前的文件读取正常使用。但是targetSdkVersion = 30中不行了，强制开启分区存储。
当然，如果是覆盖安装呢，可以增加android:preserveLegacyExternalStorage="true"，暂时关闭分区存储，好让开发者完成数据迁移的工作。为什么是暂时呢？因为只要卸载重装，就会失效了。
以下是关于分区存储会遇到的所有情况，
分情况运行：
1） targetSdkVersion = 28，运行后正常读写。
2） targetSdkVersion = 29，不删除应用，targetSdkVersion 由28修改到29，覆盖安装，运行后正常读写。
3） targetSdkVersion = 29，删除应用，重新运行，读写报错，程序崩溃（open failed: EACCES (Permission denied)）
4） targetSdkVersion = 29，添加android:requestLegacyExternalStorage="true"（不启用分区存储），读写正常不报错
5） targetSdkVersion = 30，不删除应用，targetSdkVersion 由29修改到30，读写报错，程序崩溃（open failed: EACCES (Permission denied)）
6） targetSdkVersion = 30，不删除应用，targetSdkVersion 由29修改到30，增加android:preserveLegacyExternalStorage="true"，读写正常不报错
7） targetSdkVersion = 30，删除应用，重新运行，读写报错，程序崩溃（open failed: EACCES (Permission denied)）

2 判断兼容模式接口

Environment.isExternalStorageLegacy()
返回值  true : 应用以兼容模式运行     false：应用以分区存储特性运行

(备注：应用已完成存储适配工作且已打开分区存储开关，如果当前应用以兼容模式运行，覆盖安装后应用仍然会以兼容模式运行，卸载重新安装应用才会以分区存储模式运行)

在适配时，我们的判断代码如下：
    // 使用Environment.isExternalStorageLegacy()来检查APP的运行模式
    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q &&!Environment.isExternalStorageLegacy())
    

这样的好处是你可以在用户升级后，能方便的将用户的数据移动至应用的特定目录。否则你只能通过SAF去移动，这样会非常麻烦。如果你要移动数据注意只适用于Android 10下，所以现在适配反而是一个好时机。当然如果你不需要迁移数据，那适配会更省事。

分区存储新特性介绍

分区存储概览

1 分区存储新特性对外部存储进行了重新设计，外部存储被分为应用私有目录以及共享目录两个部分

（1）应用私有目录：存储应用私有数据，外部存储应用私有目录对应Android/data/packagename，内部存储应用私有目录对应data/data/packagename； 
        * 内部存储空间目录：系统会阻止其他应用访问这些位置，并且在 Android 10（API 级别 29）及更高版本中，系统会对这些位置进行加密。这些特征使得这些位置非常适合存储只有应用本身才能访问的敏感数据。
        * 外部存储空间目录：其他应用可以在具有适当权限的情况下访问这些目录，但存储在这些目录中的文件仅供您的应用使用。如果您明确打算创建其他应用能够访问的文件，您的应用应改为将这些文件存储在外部存储空间的共享存储空间部分。
（2)  共享目录：存储其他应用可访问文件， 包含媒体文件、文档文件以及其他文件，对应设备DCIM、Pictures、Alarms, Music, Notifications,Podcasts, Ringtones、Movies、Download等目录

2 应用私有目录文件访问

 应用私有目录文件访问方式与之前Android版本一致，可以通过file path获取资源
(如需允许其他应用访问存储在内部存储空间内此目录中的文件(如内部存储分享文件)，请使用具有 FLAG_GRANT_READ_URI_PERMISSION 属性的 FileProvider。)

3 共享目录文件访问

权限变更：应用读写自己沙箱和共享集合目录中应用自己的文件是不需要申请任何权限的，但是如果应用需要读取其他应用生成的多媒体文件就需要申请权限
共享目录文件需要通过MediaStore API或者Storage Access Framework方式访问
（1）MediaStore API在共享目录指定目录下创建文件或者访问应用自己创建文件，不需要申请存储权限
        注:媒体文件的应用归因:
        当以 Android 10 或更高版本为目标平台的应用启用了分区存储时，系统会将每个媒体文件归因于一个应用，这决定了应用在未请求任何存储权限时可以访问的文件。每个文件只能归因于一个应用。因此，如果您的应用创建的媒体文件存储在照片、视频或音频文件媒体集合中，应用便可以访 问该文件。
        但是，如果用户卸载并重新安装您的应用，您必须请求 READ_EXTERNAL_STORAGE 才能访问应用最初创建的文件。此权限请求是必需的，因为系统认为文件归因于以前安装的应用版本，而不是新安装的版本。
（2）MediaStore API访问其他应用在共享目录创建的媒体文件(图片、音频、视频)， 需要申请存储权限，未申请存储权限，通过ContentResolver查询不到文件Uri，即使通过其他方式获取到文件Uri，读取或创建文件会抛出异常；
        读取其他应用生成的多媒体文件，需要通过MediaProvider的接口读取，无法直接通过文件路径读取；读取其他应用存放在共享集合的图片和视频文件，就需要分别申请READ_MEDIA_IMAGES和READ_MEDIA_VIDEO权限，音乐类型文件，就需要申请READ_MEDIA_AUDIO权限,具体要申请哪个权限取决于应用需要访问的文件类型；
        系统只提供了多媒体文件的读权限，没有提供写权限，应用无法通过申请写权限修改其他应用生成的文件；
（3）MediaStore API不能够访问其他应用创建的非媒体文件(pdf、office、doc、txt等)， 只能够通过Storage Access Framework方式访问；
    下载目录的文件没有增加对应的权限，读取下载目录的文件需要通过SAF的方式读取。

其他:
写其他应用的多媒体文件，需要通过申请成为默认系统图库和音乐应用，或者让用户主动授权的方式实现。
需要读写指定的任意目录的文件只能通过SAF的方式实现。

4 其他受影响变更

(1) 图片位置信息 一些图片会包含位置信息，因为位置对于用户属于敏感信息， Android 10应用在分区存储模式下图片位置信息默认获取不到，应用通过以下两项设置可以获取图片位置信息：
        1.在manifest中申请ACCESS_MEDIA_LOCATION
        2.调用MediaStore  setRequireOriginal(Uri uri)接口更新图片Uri
(2) MediaStore.Files应用分区存储模式下，MediaStore.Files 集合只能够获取媒体文件信息(图片、音频、视频)， 获取不到非media(pdf、office、doc、txt等)文件
(3) File Path路径访问受影响接口
开启分区存储新特性， Andrioid 10不能够通过File Path路径直接访问共享目录下资源，以下接口通过File 路径操作文件资源，功能会受到影响，应用需要使用MediaStore或者SAF方式访问

 

存储特性Android版本差异概览

 

分区适配方案

分区存储适配方案概览

分区存储适配包含文件迁移以及文件访问兼容性适配两个部分；

1 文件迁移

文件迁移是将应用共享目录文件迁移到应用私有目录或者Android10要求的media集合目录
（1）针对只有应用自己访问并且应用卸载后允许删除的文件，需要迁移文件到应用私有目录文件，可以通过File path方式访问文件资源，降低适配成本

（2）允许其他应用访问，并且应用卸载后不允许删除的文件，文件需要存储在共享目录，应用可以选择是否进行目录整改，将文件迁移到Android10要求的media集合目录

 

2 文件访问兼容性适配

共享目录文件不能够通过File path方式读取，需要使用MediaStore API或者Storage Access Framework框架进行访问

 

 

分区存储适配指导

MediaStore API

1 MediaStore API简述

系统会自动扫描外部存储，添加文件到系统已定义的Images、Videos、Audio files、Downloaded files集合中，Android 10通过MediaStore.Images、MediaStore.Video、MediaStore.Audio、MediaStore.Downloads 访问共享目录文件资源

 

2 MediaStore API创建文件

Android 10版本 MeidaStore API只允许在共享目录指定目录创建文件， 非指定目录创建文件会抛出IllegalArgumentException， 创建文件目录汇总如下：

 

备注：MediaStore.Downloads.EXTERNAL_CONTENT_URI是Android10版本新增API，用于创建、访问非媒体文件；

3 不同存储权限MediaStore API可访问文件区域

 

4 MediaStore API 文件访问

 

Storage Access Framework (google使用存储访问框架打开文件)

 Android 4.4引入了Storage Access Framework框架，应用通过系统选择器访问 DocumentsProvider 提供文件(包含外部存储以及云端存储， 外部存储包含应用私有目录以及共享目录)， SAF机制不需要申请任何存储权限, 包含Document provider、Client app、Picker三部分       
(1)Document provider：文档提供者是 DocumentsProvider 子类，数据模型是基于文件层级进行设计的，文档提供者通过存储服务（例如Google Drive）管理文件
(2)Client app：通过调用  ACTION_CREATE_DOCUMENT ,  ACTION_OPEN_DOCUMENT , and ACTION_OPEN_DOCUMENT_TREE  Intent获取Document provider提供的文件， 应用可以设置MIME type或者EXTRA_INITIAL_URI选择需要获取的文件，onActivityResult接口会返回选择文件Uri
(3)Picker：系统UI，应用通过调起系统选择器获取Document provider提供的文件信息

 

分享场景适配

(1) APP主动分享文件给其他应用，可以使用FileProvider方式赋予其他应用文件读取权限， FileProvider 应用基于XML配置生成文件Uri，其他应用不需要申请存储权限就可以通过接收Uri获取文件资源；
(2) Android 10 应用开启分区存储，通过File协议Uri或者MediaStore Uri分享文件给其他应用， 功能会受到影响, 具体如下表格：  

 

适配样例经验: 百度APP分区存储适配

百度APP适配简述

排查外部存储共享目录通过File方式访问的资源，针对历史遗留文件， 业务方根据具体场景选择是否进行文件迁移；
针对只有应用自己访问并且应用卸载后允许删除的文件，通过文件迁移到外部存储私有目录方式进行适配； 
针对允许其他应用访问，并且应用卸载后不允许删除的文件， 通过使用MediaStore API或者SAF方式进行适配

 

补充

应用在卸载后，会将App-specific目录下的数据删除，如果在AndroidManifest.xml中声明：android:hasFragileUserData="true"用户可以选择是否保留。

代码样例

相关代码较多,具体代码样例可参考 华为文档-存储空间的限制 较为详细 

 

---

相关参考链接:
Google 保存到专属存储空间    /   保存到共享存储文件
Google 文档 Android10行为变更  /  迁移指南
SAF（Storage Access Framework）使用攻略
Android10 文件存储相关(图片示例代码)
Android11(30)/Android10(29)分区存储-适配方案(MANAGE_EXTERNAL_STORAGE)
Android 10分区存储介绍及百度适配实践
携程Android 10适配踩坑指南  /  华为文档
android 10 [API 29] 适配指南