Kotlin Flows Java 互操作回调

Question

当我想将 Kotlin Flows 与普通回调一起使用时，我一直在寻找合适的解决方案或最佳实践。我的用例是我编写了一个在内部使用 Kotlin Flow 的 kotlin 库，我必须假设用户将使用 Java。所以我认为最好的解决方案是为我的流方法重载一个基本的回调接口，并以collect这样的方式调用它：

class KotlinClass {

    interface Callback {
        fun onResult(result: Int)
    }

    private fun foo() = flow {
        for (i in 1..3) {
            emit(i)
        }
    }

    fun bar(callback: Callback) {
        runBlocking {
            foo().collect { callback.onResult(it) }
        }
    }

  private fun main() {
    bar(object : Callback {
        override fun onResult(result: Int) {
            TODO("Not yet implemented")
        }
    })
}

在我的 Java 应用程序中，我可以像这样简单地使用它：

public class JavaClass {

    public void main() {
        KotlinClass libraryClass = new KotlinClass();
        libraryClass.bar(new KotlinClass.Callback() {
            @Override
            public void onResult(int result) {
                // TODO("Not yet implemented")
            }
        });
    } 
}

我不确定要走什么路，因为我希望我的 Kotlin 库使用 Flows 以良好的方式用于 Java 和 Kotlin。

我遇到过，callbackFlow但似乎只有当我想将其称为流化基于回调的 API 时才如此？因为我对 Kotlin 和 Flows 还很陌生，如果我的问题由于缺少 kotlin 的一些基本概念而有缺陷，请道歉。

Answer 1

我会给 Java 客户端更多的流程控制权。我会在你的回调接口中添加一个onStartandonCompletion方法。除此之外，我会使用自己的CoroutineScope——也许可以从 Java 客户端进行定制。而且我不会从 Kotlin 函数中阻止调用线程 - 不runBlocking。

@InternalCoroutinesApi
class KotlinClass {
    val coroutineScope = CoroutineScope(Dispatchers.Default)

    interface FlowCallback {
        @JvmDefault
        fun onStart() = Unit

        @JvmDefault
        fun onCompletion(thr: Throwable?) = Unit
        fun onResult(result: Int)
    }

    private fun foo() = flow {
        for (i in 1..3) {
            emit(i)
        }
    }

    fun bar(flowCallback: FlowCallback) {
        coroutineScope.launch {
            foo().onStart { flowCallback.onStart() }
                .onCompletion { flowCallback.onCompletion(it) }
                .collect { flowCallback.onResult(it) }
        }
    }

    fun close() {
        coroutineScope.cancel()
    }    
}

现在 Java 客户端可以完全控制如何启动、收集和取消流。例如，您可以使用闩锁等待完成、设置超时并取消协程作用域。这首先看起来像很多代码，但通常您需要这种灵活性。

public class JavaClass {
    public static void main(String[] args) throws InterruptedException {
        CountDownLatch latch = new CountDownLatch(1);
        KotlinClass libraryClass = new KotlinClass();
        libraryClass.bar(new KotlinClass.FlowCallback() {
            @Override
            public void onCompletion(@Nullable Throwable thr) {
                latch.countDown();
            }


            @Override
            public void onResult(int result) {
                System.out.println(result);
            }
        });

        try {
            latch.await(5, TimeUnit.SECONDS);
        } finally {
            libraryClass.close();
        }
    }
}