三分钟教你用Scarlet写一个WebSocket App javascript

在移动应用程序中，数据层是屏幕上显示内容的真实来源。然而，当我们今年早些时候在 Tinder 中集成了 WebSocket API 时，维护它成为了一个令人头疼的问题。为了在 Android 上更轻松地集成 WebSocket，Scarlet应运而生，这是一个声明性 Kotlin 库。
【三分钟教你用Scarlet写一个WebSocket App】WebSocket 是在 Android 应用程序中实现数据层的选项之一，尤其是在应用需要实时更新数据的情况下，例如聊天、在线多人游戏和实时提要。它在客户端和服务器之间建立双向连接。当连接打开时，它们可以以低开销来回发送文本和二进制消息。本文将教大家如何在Android应用中快速实现WebSocket。

文章图片

设置要实现 Scarlet，首先将其添加到 app/build.gradle 文件。

dependencies { ... // scarlet implementation 'com.tinder.scarlet:scarlet:0.1.12' }

在 Scarlet 提供的示例中，RxJava 用于帮助管理 Web 套接字发送的数据流。在 app/build.gradle 中实现它。

dependencies { // rx implementation 'io.reactivex.rxjava2:rxjava:2.2.21' implementation 'io.reactivex.rxjava2:rxandroid:2.1.1' implementation 'io.reactivex.rxjava2:rxkotlin:2.4.0' }

如果大家对 Coroutine 和 Kotlin Flow 的支持感到好奇，请参阅此处：https : //github.com/Tinder/Scarlet/issues/114
现在我们设置的重要部分是服务。我们可以使用websocket-echo (wss://websocket-echo.glitch.me)测试我们的 WebSocket；
创建接口函数接下来，创建一个interface以定义与 WebSocket 通信的函数。

interface EchoService {@Receive fun observeConnection(): Flowable@Send fun sendMessage(param: String) }

如上所示，服务接口看起来与改造非常相似。大家可以使用@Receive注解来观察来自 WebSocket 的数据流，并用于@Send向WebSocket发送或订阅数据。
设置好服务后，我们可以继续在我们的活动中实现服务；在这种情况下，我没有使用任何架构,只是在Activity中实现了服务。

class MainActivity : AppCompatActivity() { ... private fun setupWebSocketService() { webSocketService = provideWebSocketService( scarlet = provideScarlet( client = provideOkhttp(), lifecycle = provideLifeCycle(), streamAdapterFactory = provideStreamAdapterFactory(), ) ) }private fun provideWebSocketService(scarlet: Scarlet) = scarlet.create(EchoService::class.java)private fun provideScarlet( client: OkHttpClient, lifecycle: Lifecycle, streamAdapterFactory: StreamAdapter.Factory, ) = Scarlet.Builder() .webSocketFactory(client.newWebSocketFactory(ECHO_URL)) .lifecycle(lifecycle) .addStreamAdapterFactory(streamAdapterFactory) .build()private fun provideOkhttp() = OkHttpClient.Builder() .addInterceptor(HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.BASIC)) .build()private fun provideLifeCycle() = AndroidLifecycle.ofApplicationForeground(application)private fun provideStreamAdapterFactory() = RxJava2StreamAdapterFactory() ... }

测试现在我们可以通过向 WebSocket 发送一些东西来测试下代码。WebSocket 将在它们检索时发送相同的消息。

class MainActivity : AppCompatActivity() { ...private fun sendMessage(message: String) { webSocketService.sendMessage(message) adapter.addItem(Message(message = message, isFromSender = true)) }@SuppressLint("CheckResult") private fun observeConnection() { webSocketService.observeConnection() .observeOn(AndroidSchedulers.mainThread()) .subscribe({ response -> Log.d("observeConnection", response.toString()) onReceiveResponseConnection(response) }, { error -> Log.e("observeConnection", error.message.orEmpty()) Snackbar.make(binding.root, error.message.orEmpty(), Snackbar.LENGTH_SHORT).show() }) }private fun onReceiveResponseConnection(response: WebSocket.Event) { when (response) { is OnConnectionOpened<*> -> changeToolbarTitle("connection opened") is OnConnectionClosed -> changeToolbarTitle("connection closed") is OnConnectionClosing -> changeToolbarTitle("closing connection..") is OnConnectionFailed -> changeToolbarTitle("connection failed") is OnMessageReceived -> handleOnMessageReceived(response.message) } }private fun handleOnMessageReceived(message: MessageScarlet) { adapter.addItem(Message(message.toValue(), false)) binding.etMessage.setText("") }private fun MessageScarlet.toValue(): String { return when (this) { is Text -> value is Bytes -> value.toString() } }... }

总结这就是本文讨论的全部内容。Scarlet 是一个很棒的库，可让大家访问在 Android 应用程序中实现 WebSocket。大家可以通过以上教程轻松为自己的应用设置 Scarlet ，特别是如果已经熟悉 Retrofit 等工具。