• Android实战——使用状态模式重构下载状态及行为

    目录

    1 前言

    本文主要介绍使用状态模式来重构下载状态及行为的过程。为了展示重构前和重构后的对比，会先介绍重构前的代码，再介绍重构后的代码。

    2 正文

    2.1 下载场景说明

    我们先来说明一下下载场景：

    • 当未开始下载时，页面只显示一个下载按钮，点击下载按钮会开始下载；

    • 当下载中，页面显示一个下载进度条，一个暂停按钮和一个取消按钮，点击暂停按钮会暂停下载，点击取消按钮会取消下载并退出下载页面；

    • 当下载暂停时，页面不显示下载进度条，显示一个恢复按钮和一个取消按钮，点击恢复按钮会恢复下载，点击取消按钮会取消下载并退出下载页面；

    • 当下载完成时，页面不显示下载进度条，只显示一个安装按钮，点击立即安装按钮会开始安装。

    2.2 准备通用的代码

    2.2.1 假的下载器

    下载器 Downloader 功能包括：开始下载，暂停下载，恢复下载，取消下载，下载监听器，代码如下：

    object Downloader {

    var downloadListener: DownloadListener? = null
    @Volatile
    private var pause: Boolean = false
    @Volatile
    private var cancel: Boolean = false
    private var pauseProgress: Int = 0
    fun startDownload(startProgress: Int = 0) {
        thread {
            for (i in startProgress .. 100) {
                if (pause) {
                    pauseProgress = i
                    return@thread
                }
                if (cancel) {
                    cancel = false
                    return@thread
                }
                Thread.sleep(200)
                downloadListener?.onProgress(i)
            }
            downloadListener?.onFinished()
        }
    }

    fun pauseDownload() {
        pause = true
        downloadListener?.onPause()
    }

    fun resumeDownload() {
        pause = false
        startDownload(pauseProgress)
    }

    fun cancelDownload() {
        cancel = true
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    interface DownloadListener {
    fun onProgress(progress: Int)
    fun onPause()
    fun onFinished()
}

    • 1
    • 2
    • 3
    • 4
    • 5

    2.2.2 下载 ViewModel 类

    class DownloadViewModel: ViewModel() {
    private val _progress = MutableLiveData<Int>().apply { value = 0 }
    val progress get() = _progress
    private val _downloadState = MutableLiveData<DownloadStateEnum>().apply { value = DownloadStateEnum.DOWNLOAD_START }
    val downloadState get() = _downloadState
    init {
        Downloader.downloadListener = object : DownloadListener {
            override fun onProgress(progress: Int) {
                _progress.postValue(progress)
            }

            override fun onPause() {
                _downloadState.postValue(DownloadStateEnum.DOWNLOAD_PAUSE)
            }

            override fun onFinished() {
                _downloadState.postValue(DownloadStateEnum.DOWNLOAD_SUCCESS)
            }
        }
    }


    fun startDownload() {
        _downloadState.value = DownloadStateEnum.DOWNLOADING
        Downloader.startDownload()
    }

    fun pauseDownload() {
        Downloader.pauseDownload()
    }

    fun resumeDownload() {
        _downloadState.value = DownloadStateEnum.DOWNLOADING
        Downloader.resumeDownload()
    }

    fun cancelDownload() {
        Downloader.cancelDownload()
    }
}
@Suppress("UNCHECKED_CAST")
class DownloadViewModelFactory : ViewModelProvider.NewInstanceFactory() {

    override fun <T : ViewModel> create(modelClass: Class<T>) = DownloadViewModel() as T
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    enum class DownloadStateEnum {
    DOWNLOAD_START, DOWNLOADING, DOWNLOAD_PAUSE, DOWNLOAD_SUCCESS
}

    • 1
    • 2
    • 3

    2.2.3 下载页面的布局资源

    download_activity.xml 如下：

    
<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:layout_width="match_parent"
    android:layout_height="match_parent">

    <ProgressBar
        android:id="@+id/pb"
        style="@style/Widget.AppCompat.ProgressBar.Horizontal"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_marginHorizontal="16dp"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

    <Button
        android:id="@+id/btn_negative"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginBottom="16dp"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toStartOf="@id/btn_positive"
        app:layout_constraintStart_toStartOf="parent"
        tools:text="@string/download_cancel" />

    <Button
        android:id="@+id/btn_positive"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginBottom="16dp"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toEndOf="@id/btn_negative"
        tools:text="@string/download_resume" />
androidx.constraintlayout.widget.ConstraintLayout>

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38

    预览图如下：

    这样的布局还是很简洁的吧。

    好了，准备工作已经完成了，下面开始看与重构相关的代码了。

    2.3 重构前的代码

    DownloadActivity.kt 代码如下：

    class DownloadBeforeActivity : AppCompatActivity() {
    private lateinit var binding: DownloadActivityBinding
    private val viewModel by viewModels<DownloadViewModel> { DownloadViewModelFactory() }
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        binding = DownloadActivityBinding.inflate(layoutInflater)
        setContentView(binding.root)
        viewModel.progress.observe(this) {
            binding.pb.progress = it
        }
        viewModel.downloadState.observe(this) {
            when(it!!) {
                DownloadStateEnum.DOWNLOAD_START -> {
                    binding.pb.visibility = View.GONE
                    binding.btnNegative.visibility = View.GONE
                    binding.btnPositive.setText(R.string.download)
                    binding.btnPositive.tag = R.string.download
                }
                DownloadStateEnum.DOWNLOADING -> {
                    binding.pb.visibility = View.VISIBLE
                    binding.btnNegative.visibility = View.VISIBLE
                    binding.btnNegative.setText(R.string.download_cancel)
                    binding.btnPositive.setText(R.string.download_pause)
                    binding.btnNegative.tag = R.string.download_cancel
                    binding.btnPositive.tag = R.string.download_pause
                }
                DownloadStateEnum.DOWNLOAD_PAUSE -> {
                    binding.pb.visibility = View.GONE
                    binding.btnNegative.visibility = View.VISIBLE
                    binding.btnNegative.setText(R.string.download_cancel)
                    binding.btnPositive.setText(R.string.download_resume)
                    binding.btnNegative.tag = R.string.download_cancel
                    binding.btnPositive.tag = R.string.download_resume
                }
                DownloadStateEnum.DOWNLOAD_SUCCESS -> {
                    binding.pb.visibility = View.GONE
                    binding.btnNegative.visibility = View.GONE
                    binding.btnPositive.setText(R.string.download_success)
                    binding.btnPositive.tag = R.string.download_success
                }
            }
        }
        binding.btnNegative.setOnClickListener { view: View ->
            when (view.tag) {
                R.string.download_cancel -> {
                    viewModel.cancelDownload()
                    finish()
                }
            }
        }
        binding.btnPositive.setOnClickListener { view: View ->
            when (view.tag) {
                R.string.download -> {
                    viewModel.startDownload()
                }
                R.string.download_pause -> {
                    viewModel.pauseDownload()
                }
                R.string.download_resume -> {
                    viewModel.resumeDownload()
                }
                R.string.download_success -> {
                    Toast.makeText(this, "去安装吧！", Toast.LENGTH_SHORT).show()
                }
            }
        }
    }

    companion object {
        @JvmStatic
        fun start(context: Context) {
            val starter = Intent(context, DownloadBeforeActivity::class.java)
            context.startActivity(starter)
        }
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    • 56
    • 57
    • 58
    • 59
    • 60
    • 61
    • 62
    • 63
    • 64
    • 65
    • 66
    • 67
    • 68
    • 69
    • 70
    • 71
    • 72
    • 73
    • 74
    • 75
    • 76

    运行效果就不看了啊，我们现在主要来看看这段代码：

    根据不同的下载状态，来显示不同的 UI，并且给按钮设置了相应的 tag；在点击按钮的时候，再根据设置的 tag，来决定对应的按钮行为。

    这段代码的功能确实是 ok 的，那么我们是不是就可以满足于此了呢？

    当然不是了。

    不知道大家注意到没有：虽然代码里根据不同的下载状态显示了不同的 UI，但是对应状态的行为却没有在此时确定下来，而是通过设置 tag 标记的方式记录下来（设置标记也是比较容易犯错的）。也就是说，在目前的代码里面，状态和对应的行为是分离的。这导致了点击事件里面大段的条件判断逻辑。

    下面我们开始使用状态模式重构它。

    2.4 重构后的代码

    状态模式可以把对象的行为包装在不同的状态对象里面，每一个状态对象都有一个共同的抽象状态基类。

    状态模式的 UML 类图如下：

    在这里插入图片描述

    • Context ：环境类，维护一个 State 子类的实例，这个实例表示对象当前的状态；
    • State：抽象状态类或者状态接口，定义一个或一组接口，表示该状态下的行为；
    • ConcreteStateA、ConcreteStateB：具体状态类，每一个具体的状态类都会实现抽象 State 中定义的接口，从而达到不同状态下的不同行为。

    回到我们的下载案例，定义出相应的使用状态模式的 UML 类图：

    在这里插入图片描述

    因为这些类较小，所以我们把它们都放在一个 DownloadStates.kt 的文件中：

    class DownloadContext(val binding: DownloadActivityBinding, val viewModel: DownloadViewModel) {
    var state: BaseDownloadState = DownloadStartState(this)
}

/**
 * 下载状态基类
 */
abstract class BaseDownloadState(val downloadContext: DownloadContext) {
    abstract fun handleDownloadActionPositiveClick()
    abstract fun handleDownloadActionNegativeClick()
}

/**
 * 下载初始状态
 *
 * 职责：
 * 1，负责处理只显示正向按钮，文字为下载，负向按钮 GONE 掉
 * 2，负责 GONE 掉下载进度圈
 * 3，处理点击下载的事件
 */
class DownloadStartState(downloadContext: DownloadContext): BaseDownloadState(downloadContext) {

    init {
        downloadContext.binding.pb.visibility = View.GONE
        downloadContext.binding.btnNegative.visibility = View.GONE
        downloadContext.binding.btnPositive.setText(R.string.download)
    }

    override fun handleDownloadActionPositiveClick() {
        // 开始下载
        downloadContext.viewModel.startDownload()
    }

    override fun handleDownloadActionNegativeClick() {
        // do nothing
    }
}

/**
 * 下载中状态
 *
 * 职责：
 * 1，负责显示正向按钮为暂停，显示负向按钮为取消
 * 2，显示下载进度圈
 * 3，处理暂停，取消点击事件
 */
class DownloadingState(downloadContext: DownloadContext) : BaseDownloadState(downloadContext) {
    init {
        downloadContext.binding.pb.visibility = View.VISIBLE
        downloadContext.binding.btnNegative.visibility = View.VISIBLE
        downloadContext.binding.btnNegative.setText(R.string.download_cancel)
        downloadContext.binding.btnPositive.setText(R.string.download_pause)
    }

    override fun handleDownloadActionPositiveClick() {
        // 暂停下载
        downloadContext.viewModel.pauseDownload()
    }

    override fun handleDownloadActionNegativeClick() {
        // 取消下载
        downloadContext.viewModel.cancelDownload()
    }
}

/**
 * 下载暂停状态
 *
 * 职责：
 * 1，负责显示正向按钮为恢复，显示负向按钮为取消
 * 2，负责 GONE 掉下载进度圈
 * 3，处理恢复，取消点击事件
 */
class DownloadPauseState(downloadContext: DownloadContext): BaseDownloadState(downloadContext) {

    init {
        downloadContext.binding.pb.visibility = View.GONE
        downloadContext.binding.btnNegative.visibility = View.VISIBLE
        downloadContext.binding.btnNegative.setText(R.string.download_cancel)
        downloadContext.binding.btnPositive.setText(R.string.download_resume)
    }

    override fun handleDownloadActionPositiveClick() {
        // 恢复下载
        downloadContext.viewModel.resumeDownload()
    }

    override fun handleDownloadActionNegativeClick() {
        // 取消下载
        downloadContext.viewModel.cancelDownload()
    }
}

/**
 * 下载完成状态
 *
 * 职责：
 * 1，负责显示正向按钮为立即安装，不显示负向按钮
 * 2，处理立即安装点击事件
 */
class DownloadSuccessState(downloadContext: DownloadContext) : BaseDownloadState(downloadContext) {
    init {
        downloadContext.binding.pb.visibility = View.GONE
        downloadContext.binding.btnNegative.visibility = View.GONE
        downloadContext.binding.btnPositive.setText(R.string.download_success)
    }

    override fun handleDownloadActionPositiveClick() {
        // 立即安装
        Toast.makeText(App.instance, "去安装吧！", Toast.LENGTH_SHORT).show()
    }

    override fun handleDownloadActionNegativeClick() {
        // do nothing
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    • 56
    • 57
    • 58
    • 59
    • 60
    • 61
    • 62
    • 63
    • 64
    • 65
    • 66
    • 67
    • 68
    • 69
    • 70
    • 71
    • 72
    • 73
    • 74
    • 75
    • 76
    • 77
    • 78
    • 79
    • 80
    • 81
    • 82
    • 83
    • 84
    • 85
    • 86
    • 87
    • 88
    • 89
    • 90
    • 91
    • 92
    • 93
    • 94
    • 95
    • 96
    • 97
    • 98
    • 99
    • 100
    • 101
    • 102
    • 103
    • 104
    • 105
    • 106
    • 107
    • 108
    • 109
    • 110
    • 111
    • 112
    • 113
    • 114
    • 115
    • 116

    在下载页面里面，使用 DownloadStates.kt 文件中的类：

    class DownloadAfterActivity : AppCompatActivity() {
    private lateinit var binding: DownloadActivityBinding
    private val viewModel by viewModels<DownloadViewModel> { DownloadViewModelFactory() }
    private lateinit var downloadContext: DownloadContext
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        binding = DownloadActivityBinding.inflate(layoutInflater)
        setContentView(binding.root)
        // 创建一个 DownloadContext 对象
        downloadContext = DownloadContext(binding, viewModel)
        viewModel.progress.observe(this) {
            binding.pb.progress = it
        }
        viewModel.downloadState.observe(this) {
            // 根据下载状态枚举值，更新 DownloadContext 对象持有的下载状态对象
            downloadContext.state = when(it!!) {
                DownloadStateEnum.DOWNLOAD_START -> DownloadStartState(downloadContext)
                DownloadStateEnum.DOWNLOADING -> DownloadingState(downloadContext)
                DownloadStateEnum.DOWNLOAD_PAUSE -> DownloadPauseState(downloadContext)
                DownloadStateEnum.DOWNLOAD_SUCCESS -> DownloadSuccessState(downloadContext)
            }
        }
        binding.btnNegative.setOnClickListener {
            // 把负向的点击事件交给当前的下载状态对象的对应方法处理
            downloadContext.state.handleDownloadActionNegativeClick()
            finish()
        }
        binding.btnPositive.setOnClickListener {
            // 把正向的点击事件交给当前的下载状态对象的对应方法处理
            downloadContext.state.handleDownloadActionPositiveClick()
        }
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33

    可以明显地看到：

    • 在更新下载状态时，不必设置 tag 标记了。

    • 在正向的点击事件回调里面，没有了大段的条件判断逻辑了。这正是因为我们把下载状态及状态对应的行为封装在了一个状态对象里面，而下载上下文对象持有的状态就是当前的下载状态。因为多态的作用，在点击事件里面调用的处理方法会实际调用到当前的那个状态类的方法里面。

    3 最后

    本文结合实际开发中的下载场景，对比了未使用状态模式的代码和使用状态模式的代码，展示了状态模式的实际应用。

    希望可以帮助到大家，代码已经上传到 Github，欢迎大家点赞。

  • 相关阅读:
    Go语言学习（四）-- 流程控制
    Python学的好，工作不愁找
    智能合约，数据资产变现金的一把金钥匙？
    Python类中的property的用法
    ETL工具与数据处理的关系
    通过nginx访问另一台服务器上的图片文件
    Object.entries()
    nbcio-boot登录后首页的跟踪出现total问题修正
    数仓-oltp和olap
    Pandas数据分析29——faker构建虚拟数据集
  • 原文地址：https://blog.csdn.net/willway_wang/article/details/126334658