支持 Android 12，全版本保存图片到相册方案

作者:de得得de
来源:https://juejin.cn/post/7042218651482587172

背景

wallhaven-rdyyjm_1920x1080.jpg

由于Google对用户隐私和系统安全做的越来越完善，应用对一些敏感信息的操作越来越难。比如最常见的共享存储空间的访问，像保存图片到相册这种常见的需求。

• Android 6.0 以前，应用要想保存图片到相册，只需要通过File对象打开IO流就可以保存；

• Android 6.0 添加了运行时权限，需要先申请存储权限才可以保存图片；

• Android 10 引入了分区存储，但不是强制的，可以通过清单配置android:requestLegacyExternalStorage="true"关闭分区存储；

• Android 11 强制开启分区存储，应用以 Android 11 为目标版本，系统会忽略 requestLegacyExternalStorage标记，访问共享存储空间都需要使用MediaStore进行访问。

我们通过上面的时间线可以看出，Google对系统公共存储的访问的门槛逐渐升高，摒弃传统的Java
File对象直接访问文件的方式，想将Android的共享空间访问方式统一成一套API。这是我们的主角MediaStore

MediaStore
是Android诞生之初就存在的一套媒体库框架，通过[文档](https://link.juejin.cn?target=https%3A%2F%2Fdeveloper.android.google.cn%2Freference%2Fandroid%2Fprovider%2FMediaStore
"https://developer.android.google.cn/reference/android/provider/MediaStore")可以看到Added in API level 1。但是由于最初系统比较开放，我们对它的使用并不多，但是随着分区存储的开启，它的舞台会越来越多。

所以怎么才是正确的保存图片的方案呢？话不多说，步入正题

大致流程

我们访问MediaStore有点像访问数据库，实际上就是数据库，只是多了一些IO流的操作。将图片想象成数据库中的一条数据，我们怎么插入数据库呢，回想sqlite怎么操作的。

实际上Mediastore也是这样的：

1. 先将图片记录插入媒体库，获得插入的Uri；

2. 然后通过插入Uri打开输出流将文件写入；

大致流程就是这样子，只是不同的系统版本有一些细微的差距；

• Android 10 之前的版本需要申请存储权限， Android 10及以后版本是不需要读写权限的

• Android 10 之前是通过File路径打开流的，所以需要判断文件是否已经存在，否者的话会将以存在的图片给覆盖

• Android 10 及以后版本添加了IS_PENDING状态标识，为0时其他应用才可见，所以在图片保存过后需要更新这个标识。

相信说了这么多，大家已经不耐烦了，不慌代码马上就来。

编码时间

这里用保存Bitmap到图库为例，保存文件 和 权限申请的逻辑，这里就不贴代码了，详见
[Demo](https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Fhushenghao%2FMediaStoreDemo.git
"https://github.com/hushenghao/MediaStoreDemo.git")

检查清单文件，如果应用里没有其他需要存储权限的需求可以加上android:maxSdkVersion="28"，这样Android
10的设备的应用详情就看不到这个权限了。

1<!--Android Q之后不需要存储权限，完全使用MediaStore API来实现-->
2<uses-permission
3    android:name="android.permission.READ_EXTERNAL_STORAGE"
4    android:maxSdkVersion="28" />
5<uses-permission
6    android:name="android.permission.WRITE_EXTERNAL_STORAGE"
7    android:maxSdkVersion="28" />

保存图片到相册。这里为了演示方便，生产环境记得在IO线程处理，ANR了可不怪我。

1private fun saveImageInternal() {
2    val uri = assets.open("wallhaven_rdyyjm.jpg").use {
3        it.saveToAlbum(this, fileName = "save_wallhaven_rdyyjm.jpg", null)
4    } ?: return
5
6    Toast.makeText(this, uri.toString(), Toast.LENGTH_SHORT).show()
7}

是不是很简单，详细实现是怎么弄的，接着往下看。这是一个保存Bitmap的扩展方法

 1/**
 2 * 保存Bitmap到相册的Pictures文件夹
 3 *
 4 * @param context 上下文
 5 * @param fileName 文件名。 需要携带后缀
 6 * @param relativePath 相对于Pictures的路径
 7 * @param quality 质量
 8 */
 9fun Bitmap.saveToAlbum(
10    context: Context,
11    fileName: String,
12    relativePath: String? = null,
13    quality: Int = 75
14): Uri? {    
15    val resolver = context.contentResolver
16    val outputFile = OutputFileTaker()
17    // 插入图片信息
18    val imageUri = resolver.insertMediaImage(fileName, relativePath, outputFile)
19    if (imageUri == null) {
20        Log.w(TAG, "insert: error: uri == null")
21        return null
22    }
23
24    // 通过Uri打开输出流
25    (imageUri.outputStream(resolver) ?: return null).use {
26        val format = fileName.getBitmapFormat()
27        // 保存图片
28        [e-mail](format, quality, it)
29        // 更新 IS_PENDING 状态
30        imageUri.finishPending(context, resolver, outputFile.file)
31    }
32    return imageUri
33}

插入图片到媒体库

需要注意Android 10以下需要图片查重，防止文件被覆盖的问题。

  1// 保存位置，这里使用Picures，也可以改为 DCIM
  2private val ALBUM_DIR = Environment.DIRECTORY_PICTURES
  3
  4/**
  5 * 用于Q以下系统获取图片文件大小来更新[MediaStore.Images.Media.SIZE]
  6 */
  7private class OutputFileTaker(var file: File? = null)
  8
  9/**
 10 * 插入图片到媒体库
 11 */
 12private fun ContentResolver.insertMediaImage(
 13    fileName: String,
 14    relativePath: String?,
 15    outputFileTaker: OutputFileTaker? = null
 16): Uri? {
 17    // 图片信息
 18    val imageValues = ContentValues().apply {
 19        val mimeType = fileName.getMimeType()
 20        if (mimeType != null) {
 21            put(MediaStore.Images.Media.MIME_TYPE, mimeType)
 22        }
 23        // 插入时间
 24        val date = System.currentTimeMillis() / 1000
 25        put(MediaStore.Images.Media.DATE_ADDED, date)
 26        put(MediaStore.Images.Media.DATE_MODIFIED, date)
 27    }
 28    // 保存的位置
 29    val collection: Uri
 30    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
 31        val path = if (relativePath != null) "${ALBUM_DIR}/${relativePath}" else ALBUM_DIR
 32        imageValues.apply {
 33            put(MediaStore.Images.Media.DISPLAY_NAME, fileName)
 34            put(MediaStore.Images.Media.RELATIVE_PATH, path)
 35            put(MediaStore.Images.Media.IS_PENDING, 1)
 36        }
 37        collection = MediaStore.Images.Media.getContentUri(MediaStore.VOLUME_EXTERNAL_PRIMARY)
 38        // 高版本不用查重直接插入，会自动重命名
 39    } else {
 40        // 老版本
 41        val pictures = Environment.getExternalStoragePublicDirectory(ALBUM_DIR)
 42        val saveDir = if (relativePath != null) File(pictures, relativePath) else pictures
 43
 44        if (!saveDir.exists() && !saveDir.mkdirs()) {
 45            Log.e(TAG, "save: error: can't create Pictures directory")
 46            return null
 47        }
 48
 49        // 文件路径查重，重复的话在文件名后拼接数字
 50        var imageFile = File(saveDir, fileName)
 51        val fileNameWithoutExtension = imageFile.nameWithoutExtension
 52        val fileExtension = imageFile.extension
 53
 54        // 查询文件是否已经存在
 55        var queryUri = this.queryMediaImage28(imageFile.absolutePath)
 56        var suffix = 1
 57        while (queryUri != null) {
 58            // 存在的话重命名，路径后面拼接 fileNameWithoutExtension(数字).png
 59            val newName = fileNameWithoutExtension + "(${suffix++})." + fileExtension
 60            imageFile = File(saveDir, newName)
 61            queryUri = this.queryMediaImage28(imageFile.absolutePath)
 62        }
 63
 64        imageValues.apply {
 65            put(MediaStore.Images.Media.DISPLAY_NAME, imageFile.name)
 66            // 保存路径
 67            val imagePath = imageFile.absolutePath
 68            Log.v(TAG, "save file: $imagePath")
 69            put(MediaStore.Images.Media.DATA, imagePath)
 70        }
 71        outputFileTaker?.file = imageFile// 回传文件路径，用于设置文件大小
 72        collection = MediaStore.Images.Media.EXTERNAL_CONTENT_URI
 73    }
 74    // 插入图片信息
 75    return this.insert(collection, imageValues)
 76}
 77
 78/**
 79 * Android Q以下版本，查询媒体库中当前路径是否存在
 80 * @return Uri 返回null时说明不存在，可以进行图片插入逻辑
 81 */
 82private fun ContentResolver.queryMediaImage28(imagePath: String): Uri? {
 83    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) return null
 84
 85    val imageFile = File(imagePath)
 86    if (imageFile.canRead() && imageFile.exists()) {
 87        Log.v(TAG, "query: path: $imagePath exists")
 88        // 文件已存在，返回一个file://xxx的uri
 89        // 这个逻辑也可以不要，但是为了减少媒体库查询次数，可以直接判断文件是否存在
 90        return Uri.fromFile(imageFile)
 91    }
 92    // 保存的位置
 93    val collection = MediaStore.Images.Media.EXTERNAL_CONTENT_URI
 94
 95    // 查询是否已经存在相同图片
 96    val query = this.query(
 97        collection,
 98        arrayOf(MediaStore.Images.Media._ID, MediaStore.Images.Media.DATA),
 99        "${MediaStore.Images.Media.DATA} == ?",
100        arrayOf(imagePath), null
101    )
102    query?.use {
103        while (it.moveToNext()) {
104            val idColumn = it.getColumnIndexOrThrow(MediaStore.Images.Media._ID)
105            val id = it.getLong(idColumn)
106            val existsUri = ContentUris.withAppendedId(collection, id)
107            Log.v(TAG, "query: path: $imagePath exists uri: $existsUri")
108            return existsUri
109        }
110    }
111    return null
112}

改变标志位，通知媒体库

到这里整个图片保存就结束了。怎么样是不是很简单，赶紧去系统图库里看看图片是不是已经在了。

 1private fun Uri.finishPending(
 2    context: Context,
 3    resolver: ContentResolver,
 4    outputFile: File?
 5) {
 6    val imageValues = ContentValues()
 7    if (Build.VERSION.SDK_INT < Build.VERSION_CODES.Q) {
 8        if (outputFile != null) {
 9            // Android 10 以下需要更新文件大小字段，否则部分设备的图库里照片大小显示为0
10            imageValues.put(MediaStore.Images.Media.SIZE, outputFile.length())
11        }
12        resolver.update(this, imageValues, null, null)
13        // 通知媒体库更新，部分设备不更新 图库看不到 ？？？
14        val intent = Intent(Intent.ACTION_MEDIA_SCANNER_SCAN_FILE, this)
15        context.sendBroadcast(intent)
16    } else {
17        // Android Q添加了IS_PENDING状态，为0时其他应用才可见
18        imageValues.put(MediaStore.Images.Media.IS_PENDING, 0)
19        resolver.update(this, imageValues, null, null)
20    }
21}

虽然代码有点多，但是相信 大家期盼已久了
[ImageExt.kt](https://link.juejin.cn?target=https%3A%2F%2Fraw.githubusercontent.com%2Fhushenghao%2FMediaStoreDemo%2Fmain%2Fapp%2Fsrc%2Fmain%2Fjava%2Fcom%2Fdede%2Fmediastoredemo%2FImageExt.kt
"https://raw.githubusercontent.com/hushenghao/MediaStoreDemo/main/app/src/main/java/com/dede/mediastoredemo/ImageExt.kt")

图片分享

有很多场景是保存图片之后，调用第三方分享进行图片分享，但是一些文章不管三七二十一说需要用FileProvider。实际上这是不准确的，部分情况是需要，还有一些场景是不需要的。

我们只需要记得 FileProvider是给其他应用分享应用私有文件的
就够了，只有在我们需要将应用沙盒内的文件共享出去的时候才需要配置FileProvider。例如：

• 应用内更新，系统包安装器需要读取系统沙盒内的apk文件（如果你下载了公共路径那另说）

• 应用内沙盒图片分享，微信已经要求一定要通过FileProvider才可以分享图片了（没有适配的赶紧看看分享还能用吗）

但是保存到系统图库并分享的场景明显就不符合这个场景，因为图库不是应用私有的空间。

1private fun shareImageInternal() {
2    val uri = assets.open("wallhaven_rdyyjm.jpg").use {
3        it.saveToAlbum(this, fileName = "save_wallhaven_rdyyjm.jpg", null)
4    } ?: return
5    val intent = Intent(Intent.ACTION_SEND)
6        .putExtra(Intent.EXTRA_STREAM, uri)
7        .setType("image/*")
8    startActivity(Intent.createChooser(intent, null))
9}

所以在使用FileProvider要区分一下场景，是不是可以不需要，因为FileProvider是一种特殊的ContentProvider，每一个内容提供者在应用启动的时候都要初始化，所以也会拖慢应用的启动速度。

参考资料

访问共享存储空间中的媒体文件

https://developer.android.google.cn/training/data-storage/shared/media

推荐阅读：