在Java中集成和使用Kotlin ViewModel（Hilt支持）

1. Kotlin ViewModel结构概述

首先，我们来看一个典型的kotlin viewmodel，它使用了hilt进行依赖注入，并管理着数据流：

@HiltViewModel
class PermProdsTestViewModel @Inject constructor(
    private val prodsUseCase: ProductUseCase // 注入 ProductUseCase
) : ViewModel() {

    private val _prods = MutableStateFlow(ProdsState())
    val prods: StateFlow<ProdsState> = _prods

    /**
     * 获取允许的产品列表
     * @param serviceName 服务名称
     * @param productTypes 产品类型列表
     * @param permission 权限
     * @param subServiceName 子服务名称
     * @param filter 是否过滤
     */
    fun getPermittedProducts(
        serviceName: String?,
        productTypes: List<String>?,
        permission: String?,
        subServiceName: String?,
        filter: Boolean?
    ) = viewModelScope.launch(Dispatchers.IO) {
        prodsUseCase.invoke(serviceName, productTypes, permission, subServiceName, filter).collect {
            when (it) {
                is DataResult.Success -> {
                    _prods.value = ProdsState(products = it.data)
                    Timber.d("Api request success, getting results")
                }
                is DataResult.Error -> {
                    _prods.value = ProdsState(error = it.cause.localizedMessage ?: "Unexpected Error")
                    Timber.d("Error getting permitted products")
                }
            }
        }
    }
}

在这个ViewModel中：

• @HiltViewModel：Hilt注解，标记这是一个由Hilt提供的ViewModel。
• @Inject constructor(...)：指示Hilt如何构造这个ViewModel，并注入其依赖（例如ProductUseCase）。
• MutableStateFlow和StateFlow：用于管理和暴露UI状态。
• viewModelScope.launch：在ViewModel的生命周期内启动协程，用于执行耗时操作。

2. 在Java代码中初始化和调用ViewModel

要在Java代码中成功初始化并使用上述Kotlin ViewModel，关键在于正确利用ViewModelProvider和Hilt的@AndroidEntryPoint注解。

以下是一个Java Activity的示例，展示了如何实现：

import androidx.annotation.Nullable;
import androidx.appcompat.app.AppCompatActivity;
import androidx.lifecycle.ViewModelProvider;
import android.os.Bundle;
import dagger.hilt.android.AndroidEntryPoint;

// 必须添加 @AndroidEntryPoint 注解，以便 Hilt 能够为该 Activity 注入依赖（包括 ViewModel）
@AndroidEntryPoint
public class TestActivity extends AppCompatActivity {

    private PermProdsTestViewModel vm; // 声明 Kotlin ViewModel 实例

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        // 假设您有一个布局文件 activity_test.xml
        // setContentView(R.layout.activity_test);

        // 使用 ViewModelProvider 初始化 ViewModel
        // ViewModelProvider 会负责创建或获取与当前 Activity 生命周期关联的 ViewModel 实例
        vm = new ViewModelProvider(this).get(PermProdsTestViewModel.class);

        // 调用 ViewModel 中的方法
        // 注意：getPermittedProducts 方法需要参数，这里为了示例使用 null。
        // 在实际应用中，您需要根据业务逻辑提供正确的参数。
        vm.getPermittedProducts(null, null, null, null, null);
    }
}

代码解析：

MyBatis3.2.3帮助文档 中文CHM版

MyBatis 是支持普通 SQL 查询,存储过程和高级映射的优秀持久层框架。MyBatis 消除 了几乎所有的 JDBC 代码和参数的手工设置以及结果集的检索。MyBatis 使用简单的 XML 或注解用于配置和原始映射,将接口和 Java 的 POJOs(Plan Old Java Objects,普通的 Java 对象)映射成数据库中的记录。有需要的朋友可以下载看看

1

查看详情

立即学习“Java免费学习笔记（深入）”；

1. @AndroidEntryPoint 注解： 这是最关键的一步。Hilt需要知道在哪里进行依赖注入。在Java或Kotlin的Activity、Fragment、Service、BroadcastReceiver等组件上添加@AndroidEntryPoint注解，Hilt才能为其注入依赖，包括通过Hilt构造的ViewModel。如果缺少此注解，Hilt将无法提供PermProdsTestViewModel所需的依赖（如ProductUseCase），导致运行时错误。
2. new ViewModelProvider(this).get(PermProdsTestViewModel.class);：
   • ViewModelProvider：这是一个Android Architecture Components提供的类，用于创建或获取ViewModel实例。它确保ViewModel在配置更改（如屏幕旋转）时得以保留，并在其关联的生命周期所有者（这里是this，即TestActivity）销毁时自动清除。
   • this：作为ViewModelStoreOwner，通常是当前的Activity或Fragment。
   • .get(PermProdsTestViewModel.class)：指定要获取的ViewModel的Class对象。即使ViewModel是用Kotlin编写的，其编译后的字节码与Java兼容，因此可以直接通过.class引用。
3. vm.getPermittedProducts(...)： 一旦ViewModel实例被获取，您就可以像调用任何Java对象的方法一样，直接调用Kotlin ViewModel中定义的方法。Kotlin的函数在Java中会被编译为普通方法。

3. 关键概念与注意事项

• Hilt的依赖注入： Hilt简化了Android应用中的依赖注入。@HiltViewModel标记ViewModel为可注入的，@Inject constructor指定了其依赖。@AndroidEntryPoint则是Hilt在Android组件中执行注入的入口点。确保Hilt的完整配置（包括在Application类上添加@HiltAndroidApp）是前提。
• Kotlin与Java的互操作性： Kotlin被设计为与Java完全互操作。这意味着Kotlin类、函数和属性可以从Java代码中无缝访问，反之亦然。ViewModel作为普通的Kotlin类，其公共方法可以直接在Java中调用。
• ViewModel的生命周期： ViewModelProvider确保ViewModel的生命周期与Activity或Fragment的生命周期绑定。ViewModel在关联的UI组件首次创建时被创建，并在该组件最终销毁（例如，用户退出Activity）时被清除。这有助于避免内存泄漏。
• 参数传递： 当Kotlin ViewModel的方法有参数时，在Java中调用时必须提供相应类型的参数。如果参数是可空的（如Kotlin中的String?），在Java中可以传递null。
• 错误排查： 如果在Java中初始化Hilt ViewModel时遇到问题（例如java.lang.IllegalArgumentException: CreationExtras must be non-empty或Hilt相关的错误），首先检查：
  • Java Activity/Fragment是否添加了@AndroidEntryPoint。
  • Hilt是否已在Application类上正确配置@HiltAndroidApp。
  • Hilt的依赖（如ProductUseCase）是否已正确绑定并可供注入。

4. 总结

在Java代码中集成和使用Kotlin ViewModel是一个常见且直接的过程。核心在于理解Hilt的依赖注入机制，并正确使用ViewModelProvider来获取ViewModel实例。通过在Java组件上添加@AndroidEntryPoint注解，并利用ViewModelProvider的标准API，开发者可以轻松地在Java项目中利用Kotlin ViewModel的强大功能。

以上就是在Java中集成和使用Kotlin ViewModel（Hilt支持）的详细内容，更多请关注php中文网其它相关文章！