在挪动应用程序中，数据层是屏幕上显示内容的实在起源。然而，当咱们往年早些时候在 Tinder 中集成了 WebSocket API 时，保护它成为了一个令人头疼的问题。为了在 Android 上更轻松地集成 WebSocket，Scarlet应运而生，这是一个申明性 Kotlin 库。
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<WebSocket.Event> @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 等工具。