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

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

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

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

设置

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

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

  • 1.
  • 2.
  • 3.
  • 4.
  • 5.

在 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' 

  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.

如果大家对 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) 

  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.

如上所示,服务接口看起来与改造非常相似。大家可以使用@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() 
    ... 

  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.
  • 19.
  • 20.
  • 21.
  • 22.
  • 23.
  • 24.
  • 25.
  • 26.
  • 27.
  • 28.
  • 29.
  • 30.
  • 31.
  • 32.
  • 33.
  • 34.
  • 35.

测试

现在我们可以通过向 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() 
        } 
    } 
     
    ... 

  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.
  • 19.
  • 20.
  • 21.
  • 22.
  • 23.
  • 24.
  • 25.
  • 26.
  • 27.
  • 28.
  • 29.
  • 30.
  • 31.
  • 32.
  • 33.
  • 34.
  • 35.
  • 36.
  • 37.
  • 38.
  • 39.
  • 40.
  • 41.
  • 42.
  • 43.
  • 44.
  • 45.

总结

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

 

责任编辑:武晓燕 来源: 程序员巴士
相关推荐

2021-10-27 05:47:53

通信协议协议网络技术

2024-09-02 00:03:00

tabs组件CSS

2025-03-26 01:35:00

tabs开发组件

2024-05-16 11:13:16

Helm工具release

2009-11-09 12:55:43

WCF事务

2024-12-18 10:24:59

代理技术JDK动态代理

2022-06-28 12:35:21

DockerPython

2024-04-29 08:50:26

Python模块BERT

2023-12-27 08:15:47

Java虚拟线程

2021-04-20 13:59:37

云计算

2022-02-17 09:24:11

TypeScript编程语言javaScrip

2024-08-30 08:50:00

2024-01-16 07:46:14

FutureTask接口用法

2020-06-30 10:45:28

Web开发工具

2013-06-28 14:30:26

棱镜计划棱镜棱镜监控项目

2022-02-21 18:16:38

Go语言枚举

2024-07-29 12:21:12

2021-12-17 07:47:37

IT风险框架

2024-01-12 07:38:38

AQS原理JUC

2009-11-05 16:04:19

Oracle用户表
点赞
收藏

51CTO技术栈公众号