详解Android如何设计一个全局可调用的ViewModel对象

囚风渋水

一、思路

1. viewModel

复制代码

对象是存储在

1. ViewModelStore

复制代码

中的，那么如果我们创建一个全局使用的

1. ViewModelStore

复制代码

并且在获取

1. viewModel

复制代码

对象的时候从它里面获取就可以了。

1. viewModel

复制代码

是通过

1. ViewModelProvider

复制代码

的

1. get

复制代码

方法获取的，一般是

1. ViewModelProvider(owner: ViewModelStoreOwner, factory: Factory).get(ViewModel::class.java)

复制代码

。
如何将

1. ViewModelProvider

复制代码

与

1. ViewModelStore

复制代码

关联起来? 纽带就是

1. ViewModelStoreOwner

复制代码

,

1. ViewModelStoreOwner

复制代码

是一个接口，需要实现

1. getViewModelStore()

复制代码

方法，而该方法返回的就是

1. ViewModelStore

复制代码

:

1. public interface ViewModelStoreOwner {
   
2.     /**
   
3.      * Returns owned {@link ViewModelStore}
   
4.      *
   
5.      * @return a {@code ViewModelStore}
   
6.      */
   
7.     @NonNull
   
8.     ViewModelStore getViewModelStore();   //返回一个ViewModelStore
   
9. }

复制代码

让某个类实现这个接口，重写方法返回我们定义的

1. ViewModelStore

复制代码

就可以了。
至于上面

1. ViewModelProvider

复制代码

构造方法的第二个参数

1. Factory

复制代码

是什么呢?
源码中提供了二种

1. Factory

复制代码

，一种是

1. NewInstanceFactory

复制代码

，一种是

1. AndroidViewModelFactory

复制代码

，它们的主要区别是：

• NewInstanceFactory创建ViewModel时，会为每个Activity或Fragment创建一个新的ViewModel实例，这会导致ViewModel无法在应用程序的不同部分共享数据。（ComponentActivity源码getDefaultViewModelProviderFactory方法）
  
• AndroidViewModelFactory可以访问应用程序的全局状态，并且ViewModel实例可以在整个应用程序中是共享的。
  

根据我们的需求，需要用的是AndroidViewModelFactory。

二、具体实现


1、方式一：可以全局添加和获取任意

1. ViewModel

复制代码

定义Application，

1. Ktx.kt

复制代码

文件

1. import android.app.Application
   
2. 
   
3. lateinit var appContext: Application
   
4. 
   
5. fun setApplicationContext(context: Application) {
   
6.     appContext = context
   
7. }

复制代码

定义全局可用的

1. ViewModelOwner

复制代码

实现类

1. object ApplicationScopeViewModelProvider : ViewModelStoreOwner {
   
2. 
   
3.     private val eventViewModelStore: ViewModelStore = ViewModelStore()
   
4. 
   
5.     override fun getViewModelStore(): ViewModelStore {
   
6.         return eventViewModelStore
   
7.     }
   
8. 
   
9.     private val mApplicationProvider: ViewModelProvider by lazy {
   
10.         ViewModelProvider(
    
11.             ApplicationScopeViewModelProvider,
    
12.             ViewModelProvider.AndroidViewModelFactory.getInstance(appContext)
    
13.         )
    
14.     }
    
15. 
    
16.     fun <T : ViewModel> getApplicationScopeViewModel(modelClass: Class<T>): T {
    
17.         return mApplicationProvider.get(modelClass)
    
18.     }
    
19. }

复制代码

定义一个

1. ViewModel

复制代码

通过

1. StateFlow

复制代码

定义发送和订阅事件的方法

1. class EventViewModel : ViewModel() {
   
2. 
   
3.     private val mutableStateFlow = MutableStateFlow(0)
   
4. 
   
5.     fun postEvent(state: Int) {
   
6.         mutableStateFlow.value = state
   
7.     }
   
8. 
   
9.     fun observeEvent(scope: CoroutineScope? = null, method: (Int) -> Unit = { _ -> }) {
   
10.         val eventScope = scope ?: viewModelScope
    
11.         eventScope.launch {
    
12.             mutableStateFlow.collect {
    
13.                 method.invoke(it)
    
14.             }
    
15.         }
    
16.     }
    
17. }

复制代码

定义一个调用的类

1. object FlowEvent {
   
2. 
   
3.     //发送事件
   
4.     fun postEvent(state: Int) {
   
5.         ApplicationScopeViewModelProvider.getApplicationScopeViewModel(EventViewModel::class.java)
   
6.             .postEvent(state)
   
7.     }
   
8. 
   
9.     //订阅事件
   
10.     fun observeEvent(scope: CoroutineScope? = null, method: (Int) -> Unit = { _ -> }) {
    
11.         ApplicationScopeViewModelProvider.getApplicationScopeViewModel(EventViewModel::class.java)
    
12.             .observeEvent(scope, method)
    
13.     }
    
14. }

复制代码

测试代码如下:

1. class MainActivity : AppCompatActivity() {
   
2. 
   
3.     override fun onCreate(savedInstanceState: Bundle?) {
   
4.         super.onCreate(savedInstanceState)
   
5.         setContentView(R.layout.activity_main)
   
6.         //打印协程名称
   
7.         System.setProperty("kotlinx.coroutines.debug", "on")
   
8. 
   
9.         FlowEvent.observeEvent {
   
10.             printMsg("MainActivity observeEvent before :$it")
    
11.         }
    
12.         //修改值
    
13.         FlowEvent.postEvent(1)
    
14. 
    
15. 
    
16.         FlowEvent.observeEvent {
    
17.             printMsg("MainActivity observeEvent after :$it")
    
18.         }
    
19. 
    
20.     }
    
21. 
    
22. }
    
23. 
    
24. //日志
    
25. 内容:MainActivity observeEvent before :0 线程:main @coroutine#1
    
26. 内容:MainActivity observeEvent before :1 线程:main @coroutine#1
    
27. 内容:MainActivity observeEvent after :1 线程:main @coroutine#2

复制代码

2、方式二：更方便在Activity和Fragment中调用

定义Application，让

1. BaseApplication

复制代码

实现

1. ViewModelStoreOwner

复制代码

1. //BaseApplication实现ViewModelStoreOwner接口
   
2. class BaseApplication : Application(), ViewModelStoreOwner {
   
3. 
   
4.     private lateinit var mAppViewModelStore: ViewModelStore
   
5.     private var mFactory: ViewModelProvider.Factory? = null
   
6. 
   
7.     override fun onCreate() {
   
8.         super.onCreate()
   
9.         //设置全局的上下文
   
10.         setApplicationContext(this)
    
11.         //创建ViewModelStore
    
12.         mAppViewModelStore = ViewModelStore()
    
13. 
    
14.     }
    
15. 
    
16.     override fun getViewModelStore(): ViewModelStore = mAppViewModelStore
    
17. 
    
18.     /**
    
19.      * 获取一个全局的ViewModel
    
20.      */
    
21.     fun getAppViewModelProvider(): ViewModelProvider {
    
22.         return ViewModelProvider(this, this.getAppFactory())
    
23.     }
    
24. 
    
25.     private fun getAppFactory(): ViewModelProvider.Factory {
    
26.         if (mFactory == null) {
    
27.             mFactory = ViewModelProvider.AndroidViewModelFactory.getInstance(this)
    
28.         }
    
29.         return mFactory as ViewModelProvider.Factory
    
30.     }
    
31. }

复制代码

1. Ktx.kt

复制代码

文件也有变化，如下

1. lateinit var appContext: Application
   
2. 
   
3. fun setApplicationContext(context: Application) {
   
4.     appContext = context
   
5. }
   
6. 
   
7. //定义扩展方法
   
8. inline fun <reified VM : ViewModel> Fragment.getAppViewModel(): VM {
   
9.     (this.requireActivity().application as? BaseApplication).let {
   
10.         if (it == null) {
    
11.             throw NullPointerException("Application does not inherit from BaseApplication")
    
12.         } else {
    
13.             return it.getAppViewModelProvider().get(VM::class.java)
    
14.         }
    
15.     }
    
16. }
    
17. 
    
18. //定义扩展方法
    
19. inline fun <reified VM : ViewModel> AppCompatActivity.getAppViewModel(): VM {
    
20.     (this.application as? BaseApplication).let {
    
21.         if (it == null) {
    
22.             throw NullPointerException("Application does not inherit from BaseApplication")
    
23.         } else {
    
24.             return it.getAppViewModelProvider().get(VM::class.java)
    
25.         }
    
26.     }
    
27. }

复制代码

在

1. BaseActivity

复制代码

和

1. BaseFragment

复制代码

中调用上述扩展方法

1. abstract class BaseActivity: AppCompatActivity() {
   
2. 
   
3.     //创建ViewModel对象
   
4.     val eventViewModel: EventViewModel by lazy { getAppViewModel() }
   
5. 
   
6.     override fun onCreate(savedInstanceState: Bundle?) {
   
7.         super.onCreate(savedInstanceState)
   
8. 
   
9.     }
   
10. }

复制代码

1. abstract class BaseFragment: Fragment() {
   
2. 
   
3.     //创建ViewModel对象
   
4.     val eventViewModel: EventViewModel by lazy { getAppViewModel() }
   
5. 
   
6.     override fun onCreate(savedInstanceState: Bundle?) {
   
7.         super.onCreate(savedInstanceState)
   
8. 
   
9.     }
   
10. }

复制代码

测试代码

1. class MainActivity : BaseActivity() {
   
2. 
   
3.     override fun onCreate(savedInstanceState: Bundle?) {
   
4.         super.onCreate(savedInstanceState)
   
5.         setContentView(R.layout.activity_main)
   
6.         //打印协程名称
   
7.         System.setProperty("kotlinx.coroutines.debug", "on")
   
8. 
   
9.         eventViewModel.observeEvent {
   
10.             printMsg("MainActivity observeEvent :$it")
    
11.         }
    
12. 
    
13.         findViewById<AppCompatButton>(R.id.bt).setOnClickListener {
    
14.             //点击按钮修改值
    
15.             eventViewModel.postEvent(1)
    
16.             //跳转到其他Activity
    
17.             Intent(this, TwoActivity::class.java).also { startActivity(it) }
    
18.         }
    
19.     }
    
20. 
    
21. }

复制代码

1. class TwoActivity : BaseActivity() {
   
2. 
   
3.     override fun onCreate(savedInstanceState: Bundle?) {
   
4.         super.onCreate(savedInstanceState)
   
5.         setContentView(R.layout.activity_two)
   
6. 
   
7.         eventViewModel.observeEvent {
   
8.             printMsg("TwoActivity observeEvent :$it")
   
9.         }
   
10.     }
    
11. }

复制代码

日志

1. 内容:MainActivity observeEvent :0 线程:main @coroutine#1
   
2. 内容:MainActivity observeEvent :1 线程:main @coroutine#1
   
3. 内容:TwoActivity observeEvent :1 线程:main @coroutine#2

复制代码

以上就是详解Android如何设计一个全局可调用的ViewModel对象的详细内容，更多关于Android ViewModel对象的资料请关注晓枫资讯其它相关文章！

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

双阳湖拼

感谢分享～～～～学习学习～～～～～

天行龙伺

感谢大大分享~~~~~~~~