美文网首页Android开发实践
SignalR ——Android实践

SignalR ——Android实践

作者: lfork | 来源:发表于2019-02-20 22:30 被阅读547次

    SignalR 的版本:aspnetcore-2.2, Java SignalR-1.0.0

    一、先说几个点

    1、我使用SignalR的时候服务器使用的是自签名的HTTPS证书,所以OkHttp是无法直接解析的,会报错。需要修改SignalR里面OkHttp部分的源码,让其信任所有的HTTPS连接。当然,我这个项目是在内部网络里面使用的,所以才直接对信任了所有的HTTPS连接。

    2、还有SignalR的版本问题,服务端的版本和客户端的版本一定要匹配。我刚开始做的时候服务端是不知道用的哪个版本的,也没给我说清楚。我是直接按照微软官网的SignalR的文档来写的,但是与后台对接的时候却连不上,最后后台是换成了我的那个客户端对应的SignalR的服务器版本才连接成功的。

    3、SignalR的引入
    如果不需要对HTTPS进行全部信任的话可以直接引入微软官方的SignalR的Java版SDK

    //gradle
    implementation 'com.microsoft.signalr:signalr:1.0.0'
    

    如果需要的话就可以下载我修改过的SignalR,主要就是对里面的OkHttp加个一个Https的全部信任。
    https://github.com/lfork/androiddemo/signalr

    二、相关代码(Kotlin)

    建立连接

    关键类com.microsoft.signalr.HubConnection和com.microsoft.signalr.HubConnectionBuilder

      val hubConnection = HubConnectionBuilder.create(serverUrl)
                    .build()
    
      hubConnection.start().blockingAwait()
    

    注意需要调用blockingAwait()来等待连接成功,我之前写的时候没有加,然后在调用 hubConnection.start()后直接就调用了向服务器发送消息的方法,这样子会发送失败。因为你连接都没建立好,所以要先等下。

    关闭连接

     hubConnection.stop()
    

    对被动关闭进行监听(比如网络异常)

    hubConnection.onClosed {
    }
    

    客户端调用服务端方法

     /**
         * Invokes a hub method on the server using the specified method name.
         * Does not wait for a response from the receiver.
         *
         * @param method The name of the server method to invoke.
         * @param args   The arguments to be passed to the method.
         */
        public void send(String method, Object... args)
    

    从SignalR源码可以看到,我们只需要把服务端注册好的方法名和参数传递进行即可

    eg

      hubConnection.send("SendMessageAsync", "" + "连接测试", "test")
    

    服务端调用客户端方法

    客户端需要在hubConnection对象执行start()方法之前对服务端需要调用的方法进行注册。然后就可以接收服务端的消息了。

    ①删除用户

    //定义处理用户删除的action(方法体)
     val deleteAction = { id: String ->
        Log.d("SignalRSyncTask", "删除用户 $id")
        //doSomthing()
        Unit
     }
    
    //对action进行注册
    //第一个参数是对方法名的注册,第二个参数相当于方法体,第三个参数就是客户端注册方法的参数了,
    //我们可以看到deleteAction的lambda里面写了一个id:String。
    hubConnection.on("DeleteUser", deleteAction, String::class.java)
    

    ②添加或者更新用户

    //定义处理相关的action(方法体)
    val addOrUpdateAction = { userInfoModel: User ->
        Log.d("SignalRSyncTask", "添加或者更新用户 ${userInfoModel.id}")
            userInfoChangedListenerList.forEach {
                it.userAddedOrUpdated(userInfoModel)
            }
        Unit
    }
    
    //对action进行注册
    hubConnection?.on("AddOrUpdateUser", addOrUpdateAction, User::class.java)
    

    完整代码参考

    代码里面还维护了一个监听,开启signalR的时候可以进行监听的注册,如果服务端有调用客户端方法的话就会进行提醒

    import android.util.Log
    import com.lfork.frtest.FRApplication
    import com.lfork.frtest.data.userinfo.User
    import com.lfork.frtest.syncservice.tasklistener.UserInfoChangedListener
    import com.microsoft.signalr.HubConnection
    import com.microsoft.signalr.HubConnectionBuilder
    import java.lang.Exception
    
    /**
     * Created by L.Fork
     *
     * @author lfork@vip.qq.com
     * @date 2019/01/28 18:01
     */
    class SignalRSyncTask {
        private var hubConnection: HubConnection? = null
    
        private var userInfoChangedListenerList = ArrayList<UserInfoChangedListener>()
    
        fun start(serverUrl:String) {
    
            FRApplication.mThreadPool?.execute {
                hubConnection = HubConnectionBuilder.create(serverUrl)
                    .build()
    
                hubConnection?.onClosed {close() }
    
                val connectionTestAction = { name: String, message: String ->
                    Log.d("SignalRSyncTask", "SignalR 连接成功 $name - $message")
                    Unit
                }
    
                val addOrUpdateAction = { userInfoModel: User ->
                    Log.d("SignalRSyncTask", "添加或者更新用户 ${userInfoModel.id}")
                    userInfoChangedListenerList.forEach {
                        it.userAddedOrUpdated(userInfoModel)
                    }
                    Unit
                }
    
                val deleteAction = { id: String ->
                    Log.d("SignalRSyncTask", "删除用户 $id")
                    userInfoChangedListenerList.forEach {
                        it.userDeleted(id.toInt())
                    }
                    Unit
                }
    
    
    
                hubConnection?.on(
                    "ReciveMessage",
                    connectionTestAction,
                    String::class.java,
                    String::class.java
                )
    
                hubConnection?.on("AddOrUpdateUser", addOrUpdateAction, User::class.java)
    
                hubConnection?.on("DeleteUser", deleteAction, String::class.java)
    
    
                try {
                    //This is test blocking call
                    hubConnection?.start()?.blockingAwait()
    
                    hubConnection?.send("SendMessageAsync", "" + "连接测试", "test")
                } catch (e:Exception){
                    e.printStackTrace()
                }
    
            }
    
        }
    
        fun addUserInfoChangedListener(userInfoChangedListener: UserInfoChangedListener) {
            userInfoChangedListenerList.add(userInfoChangedListener)
        }
    
        fun close() {
            userInfoChangedListenerList.clear()
            hubConnection?.stop()
        }
    
    
    }
    

    三、参考文档

    Microsoft官方参考文档

    相关文章

      网友评论

        本文标题:SignalR ——Android实践

        本文链接:https://www.haomeiwen.com/subject/zkyfyqtx.html