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

时间:2021-07-11 13:59:49

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

在移动应用程序中,数据层是屏幕上显示内容的真实来源。然而,在今年早些时候在 Tinder 中集成了 WebSocket API 时,维护它成为了一个令人头疼的问题。为了在 Android 上更轻松地集成 WebSocket,Scarlet应运而生。

WebSocket 是在 Android 应用程序中实现数据层的选项之一,尤其是在应用需要实时更新数据的情况下,例如聊天、在线多人游戏和实时提要。它在客户端和服务器之间建立双向连接。当连接打开时,它们可以以低开销来回发送文本和二进制消息。本文将教大家如何在Android应用中快速实现WebSocket。

设置

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

  1. dependencies { 
  2.     ... 
  3.     // scarlet 
  4.     implementation 'com.tinder.scarlet:scarlet:0.1.12' 

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

  1. dependencies { 
  2.      // rx 
  3.      implementation 'io.reactivex.rxjava2:rxjava:2.2.21' 
  4.      implementation 'io.reactivex.rxjava2:rxandroid:2.1.1' 
  5.      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 通信的函数。

  1. interface EchoService { 
  2.  
  3.     @Receive 
  4.     fun observeConnection(): Flowable<WebSocket.Event> 
  5.  
  6.     @Send 
  7.     fun sendMessage(param: String) 

如上所示,服务接口看起来与改造非常相似。大家可以使用@Receive注解来观察来自 WebSocket 的数据流,并用于@Send向WebSocket发送或订阅数据。

设置好服务后,我们可以继续在我们的活动中实现服务;在这种情况下,我没有使用任何架构,只是在Activity中实现了服务。

  1. class MainActivity : AppCompatActivity() { 
  2.     ... 
  3.     private fun setupWebSocketService() { 
  4.         webSocketService = provideWebSocketService( 
  5.             scarlet = provideScarlet( 
  6.                 client = provideOkhttp(), 
  7.                 lifecycle = provideLifeCycle(), 
  8.                 streamAdapterFactory = provideStreamAdapterFactory(), 
  9.             ) 
  10.         ) 
  11.     } 
  12.      
  13.     private fun provideWebSocketService(scarlet: Scarlet) = scarlet.create(EchoService::class.java) 
  14.      
  15.     private fun provideScarlet( 
  16.         client: OkHttpClient, 
  17.         lifecycle: Lifecycle, 
  18.         streamAdapterFactory: StreamAdapter.Factory, 
  19.     ) = 
  20.         Scarlet.Builder() 
  21.             .webSocketFactory(client.newWebSocketFactory(ECHO_URL)) 
  22.             .lifecycle(lifecycle) 
  23.             .addStreamAdapterFactory(streamAdapterFactory) 
  24.             .build() 
  25.              
  26.     private fun provideOkhttp() = 
  27.         OkHttpClient.Builder() 
  28.             .addInterceptor(HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.BASIC)) 
  29.             .build() 
  30.              
  31.     private fun provideLifeCycle() = AndroidLifecycle.ofApplicationForeground(application) 
  32.      
  33.     private fun provideStreamAdapterFactory() = RxJava2StreamAdapterFactory() 
  34.     ... 

测试

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

  1. class MainActivity : AppCompatActivity() { 
  2.     ... 
  3.    
  4.     private fun sendMessage(message: String) { 
  5.         webSocketService.sendMessage(message) 
  6.         adapter.addItem(Message(message = message, isFromSender = true)) 
  7.     } 
  8.      
  9.     @SuppressLint("CheckResult"
  10.     private fun observeConnection() { 
  11.         webSocketService.observeConnection() 
  12.             .observeOn(AndroidSchedulers.mainThread()) 
  13.             .subscribe({ response -> 
  14.                 Log.d("observeConnection", response.toString()) 
  15.                 onReceiveResponseConnection(response) 
  16.             }, { error -> 
  17.                 Log.e("observeConnection", error.message.orEmpty()) 
  18.                 Snackbar.make(binding.root, error.message.orEmpty(), Snackbar.LENGTH_SHORT).show() 
  19.             }) 
  20.     } 
  21.  
  22.     private fun onReceiveResponseConnection(response: WebSocket.Event) { 
  23.         when (response) { 
  24.             is OnConnectionOpened<*> -> changeToolbarTitle("connection opened"
  25.             is OnConnectionClosed -> changeToolbarTitle("connection closed"
  26.             is OnConnectionClosing -> changeToolbarTitle("closing connection.."
  27.             is OnConnectionFailed -> changeToolbarTitle("connection failed"
  28.             is OnMessageReceived -> handleOnMessageReceived(response.message) 
  29.         } 
  30.     } 
  31.  
  32.     private fun handleOnMessageReceived(message: MessageScarlet) { 
  33.         adapter.addItem(Message(message.toValue(), false)) 
  34.         binding.etMessage.setText(""
  35.     } 
  36.  
  37.     private fun MessageScarlet.toValue(): String { 
  38.         return when (this) { 
  39.             is Text -> value 
  40.             is Bytes -> value.toString() 
  41.         } 
  42.     } 
  43.      
  44.     ... 

总结

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

原文地址:https://mp.weixin.qq.com/s/sH1y5D63eYWEL5amgf06AA