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

子林Android2024-08-13 11:10

文章目录

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

1. 案例简介

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

1.1 效果演示

2. 工程配置

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

groovy 复制代码 
// 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，拼接上这里的相对路径就是完整的下载地址。

kotlin 复制代码 
import io.reactivex.Single
import okhttp3.ResponseBody
import retrofit2.http.GET
import retrofit2.http.Url

interface INetApi {
    @GET
    fun downloadFile(@Url relativePath: String?): Single<ResponseBody>
}

3.2 Retrofit工具类

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

kotlin 复制代码 
import retrofit2.Retrofit
import retrofit2.adapter.rxjava2.RxJava2CallAdapterFactory
import retrofit2.converter.gson.GsonConverterFactory

object 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

你也可以随便找一个，替换成你的地址。

  1. 界面中有一个按钮 Button 和一个图片 ImageView，点击按钮，触发 startDownload 方法，通过上面封装好的 RetrofitUtil 工具类，传入 BaseUrl 和 图片的相对地址，进行网络请求。

  2. 使用RxJava 处理网络返回数据，在收到返回的数据流后，用 BitmapFactory.decodeStream 解析成一张

    Bitmap 图片，显示到控件 ImageView 上。至此完成网络图片的显示。

  3. 接下来是将这张图片保存到手机中。在 trySaveImage 方法中，首先进行了动态权限检查/申请 ，得到存储权限后，调用
    saveToFile 方法，从 ImageView 上获取图片，创建一个文件准备接收图片，接着使用bitmap.compress

    结合 FileOutputStream 将图片数据压缩到文件中，至此完成了图片保存到本地文件。

  4. 但是，你会发现在手机的系统相册中找不到这张图片。这是因为上面保存的路径是应用内的目录，我们需要将文件拷贝到系统相册，才能在相册中显示。

  5. 于是，调用 moveToAlbum

    方法，将文件移动到系统相册。这里按系统版本会有不同的操作方式，Android10以下稍微麻烦点。都是使用了Android四大组件之一

    ContentProvider 与系统进行内容通信。

  6. 移动完毕之后，不要忘记删除原文件，防止数据冗余。

4.1 完整主界面代码 ImageDownloadActivity

kotlin 复制代码 
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: ViewGroup
    private lateinit var imageView1: ImageView

    private val imageUrl = "bfs/archive/961b6650675f97b297bb5ec764ce89b314134544.jpg"
    private val baseImageUrl = "https://i2.hdslb.com/"

    private var disposable: Disposable? = null

    override 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() ?: return
        try {
            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 = contentResolver
            val uri = contentResolver.insert(MediaStore.Images.Media.EXTERNAL_CONTENT_URI, values) ?: return false
            try {
                val outputStream = contentResolver.openOutputStream(uri)?: return false
                val 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.name
            val 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 false
            try {
                val outputStream = contentResolver.openOutputStream(uri)?: return false
                val 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 复制代码 
<?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">

    <ImageView
        android: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" />

    <Button
        android: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>

5. 总结

本文我们介绍了一个下载网络图片显示并保存到系统相册的完整小案例，涉及了网络请求、文件下载、动态权限申请、文件保存、移动到系统相册，包含了一些关键实用的知识点：

  • Retrofit 网络请求
  • RxJava 处理网络数据流
  • 动态权限申请
  • 文件保存IO操作
  • ContentResolver 移动文件到系统相册

希望这篇文章能帮到你，欢迎支持，感谢！

相关推荐
IAM四十二9 天前
Google 端侧 AI 框架 LiteRT 初探
android·深度学习·tensorflow
CYRUS_STUDIO9 天前
手把手教你用 Chrome 断点调试 Frida 脚本，JS 调试不再是黑盒
android·app·逆向
Just丶Single9 天前
安卓NDK初识
android
编程乐学9 天前
网络资源模板--基于Android Studio 实现的咖啡点餐App
android·android studio·大作业·奶茶点餐·安卓移动开发·咖啡点餐
二流小码农9 天前
鸿蒙开发：基于node脚本实现组件化运行
android·ios·harmonyos
Wgllss9 天前
Kotlin+协程+FLow+Channel+Compose 实现一个直播多个弹幕效果
android·架构·android jetpack
顾林海9 天前
Android WebView内存释放全解析：从泄漏检测到彻底释放的实战指南
android·面试·性能优化
用户2018792831679 天前
🍕 披萨工厂奇遇记：Android APK打包之旅
android
程序猿陌名！9 天前
Android开发 原生设置-apps-里面隐藏应用信息
android
张风捷特烈10 天前
每日一题 Flutter#13 | build 回调的 BuildContext 是什么
android·flutter·面试
热门推荐
01鸽了六年的某大厂面试题：你会手写一个模板引擎吗？02扣子（coze）实战|我用扣子搭建了一个自动分析小红薯笔记内容的AI应用|详细步骤拆解03KGG转MP3工具|非KGM文件|解密音频04《C#图解教程 第5版》深度推荐05Coze扣子平台完整体验和实践（附国内和国际版对比）06从零安装 LLaMA-Factory 微调 Qwen 大模型成功及所有的坑07零代码入门 | Coze——让大模型接入自己的数据库08DeepSeek各版本说明与优缺点分析09YOLOv8入门 | 重要性能衡量指标、训练结果评价及分析及影响mAP的因素【发论文关注的指标】10GPU 进阶笔记（二）：华为昇腾 910B GPU