SignalR ——Android实践

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官方参考文档

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 196,302评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,563评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,433评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,628评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,467评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,354评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,777评论 3 387
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,419评论 0 255
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,725评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,768评论 2 314
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,543评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,387评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,794评论 3 300
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,032评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,305评论 1 252
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,741评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,946评论 2 336