一个Android下载网络图片显示并保存到系统相册的完整案例

文章目录

- 1. 案例简介
- - 1.1 效果演示
- 2. 工程配置
- 3. 网络层
- - 3.1 网络接口定义
  - 3.2 Retrofit工具类
- 4. 主界面及完整代码
- - 4.1 完整主界面代码 ImageDownloadActivity
  - 4.2 布局文件
- 5. 总结

1. 案例简介

在 Android开发中，下载图片保存到本地是常见的需求，看似简单但其中包含了一些比较关键的知识点，比如网络请求、文件下载、动态权限申请、文件保存、移动到系统相册等

1.1 效果演示

下载网络图片

2. 工程配置

本案例使用 Android Studio 开发，kotlin语言。 build.gradle 文件中的必要依赖有：

// Retrofit
implementation 'com.squareup.retrofit2:retrofit:2.9.0'
implementation 'com.squareup.retrofit2:converter-gson:2.9.0'// RxJava
implementation 'io.reactivex.rxjava2:rxjava:2.2.20'
implementation 'io.reactivex.rxjava2:rxandroid:2.1.1'// Retrofit RxJava Adapter
implementation 'com.squareup.retrofit2:adapter-rxjava2:2.9.0'// 使用 Gson
implementation 'com.google.code.gson:gson:2.8.9'

3. 网络层

使用 Retrofit 网络请求框架+RxJava 异步数据流处理库。

3.1 网络接口定义

接口层定义了下载文件的方法 downloadFile，接收参数是下载地址的相对路径。因为 Retrofit 在构建的时候会有一个 BaseUrl，拼接上这里的相对路径就是完整的下载地址。

import io.reactivex.Single
import okhttp3.ResponseBody
import retrofit2.http.GET
import retrofit2.http.Urlinterface INetApi {@GETfun downloadFile(@Url relativePath: String?): Single<ResponseBody>
}

3.2 Retrofit工具类

一般都会创建一个 RetrofitUtil 工具类来创建 Retrofit 实例对象供外界调用。这里的BaseUrl 也由外界传入，可以创建多个不同的实例。

import retrofit2.Retrofit
import retrofit2.adapter.rxjava2.RxJava2CallAdapterFactory
import retrofit2.converter.gson.GsonConverterFactoryobject RetrofitUtil {fun createRetrofit(baseUrl: String): INetApi {val retrofit = Retrofit.Builder().baseUrl(baseUrl).addCallAdapterFactory(RxJava2CallAdapterFactory.create()).addConverterFactory(GsonConverterFactory.create()).build()return retrofit.create(INetApi::class.java)}
}

4. 主界面及完整代码

这里我们搭建一个简单的下载图片的UI界面。图片的地址是网上随便找的一个网络图片地址：https://i2.hdslb.com/bfs/archive/961b6650675f97b297bb5ec764ce89b314134544.jpg
你也可以随便找一个，替换成你的地址。

界面中有一个按钮 Button 和一个图片 ImageView，点击按钮，触发 startDownload 方法，通过上面封装好的 RetrofitUtil 工具类，传入 BaseUrl 和图片的相对地址，进行网络请求。
使用RxJava 处理网络返回数据，在收到返回的数据流后，用 BitmapFactory.decodeStream 解析成一张
Bitmap 图片，显示到控件 ImageView 上。至此完成网络图片的显示。
接下来是将这张图片保存到手机中。在 trySaveImage 方法中，首先进行了动态权限检查/申请 ，得到存储权限后，调用
saveToFile 方法，从 ImageView 上获取图片，创建一个文件准备接收图片，接着使用bitmap.compress
结合 FileOutputStream 将图片数据压缩到文件中，至此完成了图片保存到本地文件。
但是，你会发现在手机的系统相册中找不到这张图片。这是因为上面保存的路径是应用内的目录，我们需要将文件拷贝到系统相册，才能在相册中显示。
于是，调用 moveToAlbum
方法，将文件移动到系统相册。这里按系统版本会有不同的操作方式，Android10以下稍微麻烦点。都是使用了Android四大组件之一
ContentProvider 与系统进行内容通信。
移动完毕之后，不要忘记删除原文件，防止数据冗余。

4.1 完整主界面代码 ImageDownloadActivity

import android.Manifest
import android.content.ContentResolver
import android.content.ContentValues
import android.content.pm.PackageManager
import android.graphics.Bitmap
import android.graphics.BitmapFactory
import android.os.Build
import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import android.os.Environment
import android.provider.MediaStore
import android.util.Log
import android.view.View
import android.view.ViewGroup
import android.widget.ImageView
import android.widget.Toast
import androidx.core.app.ActivityCompat
import androidx.core.content.ContextCompat
import androidx.core.graphics.drawable.toBitmapOrNull
import com.example.mytest.R
import com.example.mytest.util.FileUtil
import com.example.mytest.util.RetrofitUtil
import io.reactivex.android.schedulers.AndroidSchedulers
import io.reactivex.disposables.Disposable
import io.reactivex.schedulers.Schedulers
import java.io.File
import java.io.FileInputStream
import java.io.FileOutputStream
import java.io.IOException/*** 下载图片保存到相册* URL：https://i2.hdslb.com/bfs/archive/961b6650675f97b297bb5ec764ce89b314134544.jpg*/
class ImageDownloadActivity : AppCompatActivity() {private lateinit var container: ViewGroupprivate lateinit var imageView1: ImageViewprivate val imageUrl = "bfs/archive/961b6650675f97b297bb5ec764ce89b314134544.jpg"private val baseImageUrl = "https://i2.hdslb.com/"private var disposable: Disposable? = nulloverride fun onCreate(savedInstanceState: Bundle?) {super.onCreate(savedInstanceState)setContentView(R.layout.activity_image_download)container = findViewById(R.id.container)imageView1 = findViewById(R.id.imageView1)}fun startDownload(view: View) {disposable = RetrofitUtil.createRetrofit(baseImageUrl).downloadFile(imageUrl).subscribeOn(Schedulers.io()).observeOn(AndroidSchedulers.mainThread()).subscribe({val bitmap = BitmapFactory.decodeStream(it.byteStream())imageView1?.setImageBitmap(bitmap)trySaveImage()}, {Log.e(Companion.TAG, "startDownload: ${it.message}")})}private fun trySaveImage() {if (ContextCompat.checkSelfPermission(this,Manifest.permission.WRITE_EXTERNAL_STORAGE) != PackageManager.PERMISSION_GRANTED) {ActivityCompat.requestPermissions(this, arrayOf(Manifest.permission.WRITE_EXTERNAL_STORAGE),0)} else {saveToFile()}}override fun onRequestPermissionsResult(requestCode: Int,permissions: Array<out String>,grantResults: IntArray) {super.onRequestPermissionsResult(requestCode, permissions, grantResults)if (requestCode == 0) {if (grantResults.isNotEmpty() && grantResults[0] == PackageManager.PERMISSION_GRANTED) {saveToFile()} else {Toast.makeText(this, "拒绝了存储权限！", Toast.LENGTH_SHORT).show()}}}private fun saveToFile() {val bitmap = imageView1.drawable.toBitmapOrNull() ?: returntry {val fileSaveDirectory = File(getExternalFilesDir(null), "MyImage")if (!fileSaveDirectory.exists()) {fileSaveDirectory.mkdirs()}val fileName = System.currentTimeMillis().toString() + ".jpeg"val saveFile = File(fileSaveDirectory, fileName)Log.i(TAG, "saveToFile: ${saveFile.absolutePath}")val outputStream = FileOutputStream(saveFile)bitmap.compress(Bitmap.CompressFormat.JPEG, 100, outputStream)outputStream.flush()outputStream.close()Toast.makeText(this, "保存成功！", Toast.LENGTH_SHORT).show()moveToAlbum(saveFile)Toast.makeText(this, "移动到相册成功！", Toast.LENGTH_SHORT).show()} catch (e: Exception) {Log.e(TAG, "saveToFile: ${e.message}", e)Toast.makeText(this, "保存失败！", Toast.LENGTH_SHORT).show()}}private fun moveToAlbum(file: File): Boolean {if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {val values = ContentValues()values.put(MediaStore.MediaColumns.DISPLAY_NAME, file.name)values.put(MediaStore.MediaColumns.MIME_TYPE, "image/星") // 这里是 image/*values.put(MediaStore.MediaColumns.RELATIVE_PATH, Environment.DIRECTORY_DCIM + File.separator + "MyTest")val contentResolver: ContentResolver = contentResolverval uri = contentResolver.insert(MediaStore.Images.Media.EXTERNAL_CONTENT_URI, values) ?: return falsetry {val outputStream = contentResolver.openOutputStream(uri)?: return falseval fileInputStream = FileInputStream(file)FileUtil.copyFileStream(fileInputStream, outputStream)fileInputStream.close()outputStream.close()file.delete()return true} catch (e: IOException) {e.printStackTrace()return false}} else {val cameraDir = Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DCIM)if (!cameraDir.exists()) {cameraDir.mkdirs()}val sicilyDirPath = cameraDir.absolutePath + File.separator + "MyTest"val sicilyDir = File(sicilyDirPath)if (!sicilyDir.exists()) {sicilyDir.mkdirs()}val finalPath = sicilyDir.absolutePath + File.separator + file.nameval values = ContentValues()values.put(MediaStore.Images.Media.DISPLAY_NAME, file.name)values.put(MediaStore.Images.Media.DATA, finalPath)Log.i(TAG, "moveToAlbum: $finalPath")val uri = contentResolver.insert(MediaStore.Images.Media.EXTERNAL_CONTENT_URI, values) ?: return falsetry {val outputStream = contentResolver.openOutputStream(uri)?: return falseval fileInputStream = FileInputStream(file)FileUtil.copyFileStream(fileInputStream, outputStream)fileInputStream.close()outputStream.close()val outputFile = File(finalPath)val contentValues = ContentValues()contentValues.put(MediaStore.Images.Media.SIZE, outputFile.length())contentResolver.update(uri, contentValues, null, null)// 通知媒体库更新val intent = Intent(@Suppress("DEPRECATION") Intent.ACTION_MEDIA_SCANNER_SCAN_FILE, uri)sendBroadcast(intent)file.delete()return true} catch (e: IOException) {e.printStackTrace()return false}}}override fun onDestroy() {super.onDestroy()disposable?.dispose()}companion object {private const val TAG = "ImageDownloadActivity"}
}

4.2 布局文件

对应的布局文件：activity_image_download.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"xmlns:app="http://schemas.android.com/apk/res-auto"xmlns:tools="http://schemas.android.com/tools"android:id="@+id/container"android:layout_width="match_parent"android:layout_height="match_parent"tools:context=".imagedownload.ImageDownloadActivity"><ImageViewandroid:id="@+id/imageView1"android:layout_width="200dp"android:layout_height="200dp"android:scaleType="centerCrop"android:background="#B3807D7D"app:layout_constraintBottom_toBottomOf="parent"app:layout_constraintEnd_toEndOf="parent"app:layout_constraintHorizontal_bias="0.498"app:layout_constraintStart_toStartOf="parent"app:layout_constraintTop_toTopOf="parent"app:layout_constraintVertical_bias="0.077" /><Buttonandroid:layout_width="match_parent"android:layout_height="wrap_content"android:onClick="startDownload"android:text="下载"app:layout_constraintBottom_toBottomOf="parent"app:layout_constraintEnd_toEndOf="parent"app:layout_constraintStart_toStartOf="parent"app:layout_constraintTop_toBottomOf="@+id/imageView1" /></androidx.constraintlayout.widget.ConstraintLayout>