Android即時通訊設計(騰訊IM接入和WebSocket接入)
一、前言
之前項目的群聊是用數(shù)據(jù)庫直接操作的，體驗很差，消息很難即時反饋，所以最后考慮到了使用騰訊的IM完成群聊的接入，不過中途還是有點小坎坷的，接入完成之后發(fā)現(xiàn)體驗版一個群聊只有20人，當時看到體驗版支持100個用戶也就忍了，現(xiàn)在一個群聊只能20用戶，忍不了了，所以暫時找到了WebSocket作為臨時的解決方案(等有錢了再換)，同時支持50個用戶在線聊天，也算還行，勉強夠用，下面就介紹兩種實現(xiàn)方案的接入
二、騰訊IM接入
騰訊云IM的官網(wǎng)，這里的接入將其中群聊相關的api抽取出來，更多請看文檔(如果有時間的話，完全可以實現(xiàn)一個類似QQ的簡單聊天平臺)
1.準備工作
需求分析
需要實現(xiàn)一個類似QQ中群聊的功能，只需要開發(fā)簡單的接收消息，發(fā)送消息，獲取歷史記錄這三個簡單的功能即可
創(chuàng)建應用
這部分就不演示了，很簡單，創(chuàng)建好大概是下圖的樣子
體驗版可以支持100個用戶和一個群聊20個用戶，提供免費的云存儲7天，同時可以創(chuàng)建多個IM實例，如果是學習使用的話體驗版足夠了，商業(yè)化考慮專業(yè)版和旗艦版
依賴集成
使用gradle集成，也可以使用sdk集成，這里采用新版的sdk進行集成
api 'com.tencent.imsdk:imsdk-plus:6.1.2155'
2.初始化工作
初始化IM
創(chuàng)建實例
參數(shù)中有一個回調，這里的object相當于java里面的匿名類
val config = V2TIMSDKConfig()
V2TIMManager.getInstance()
.initSDK(this, sdkId, config, object : V2TIMSDKListener() {
override fun onConnecting() {
// 正在連接到騰訊云服務器
Log.e("im", "正在連接到騰訊云服務器")
}
override fun onConnectSuccess() {
// 已經(jīng)成功連接到騰訊云服務器
Log.e("im", "已經(jīng)成功連接到騰訊云服務器")
}
override fun onConnectFailed(code: Int, error: String) {
// 連接騰訊云服務器失敗
Log.e("im", "連接騰訊云服務器失敗")
}
})
生成登錄憑據(jù)
這部分官方提供客戶端快速生成的代碼和服務端代碼，具體可以到官網(wǎng)找找，一開始測試的時候可以考慮客戶端代碼后面正式的項目最好部署到服務端進行處理，這部分就提個醒，服務端有兩個文件，當時沒看清楚，找了好久的函數(shù)，最后發(fā)現(xiàn)是某個java文件忘記看了，還是同一級目錄下，應該是其他api也復用了Base64URL這個類
同時官方還提供生成和校驗憑據(jù)的工具
用戶登錄
這部分只需要傳入?yún)?shù)即可
V2TIMManager.getInstance().login(currentUser,sig, object : V2TIMCallback {
override fun onSuccess() {
Log.e("im", "${currentUser}登錄成功")
}
override fun onError(code: Int, desc: String?) {
Log.e("im", "${currentUser}登錄失敗，錯誤碼為:$[code],具體錯誤:${desc}")
}
})
- currentUser 即用戶的id
- sig 即用戶的登錄憑據(jù)
- V2TIMCallback 回調的一個類
3.群聊相關
創(chuàng)建群聊
創(chuàng)建群聊的時候需要注意幾個方面的問題
群聊類別(groupType)
需要審批還是不需要，最大的容納用戶數(shù)，未支不支持未入群查看群聊消息，詳見下圖
其中社群其實挺符合我的需求的，但有個問題，社群需要付費才能開通(還挺貴)，所以最后選擇了Meeting類型的群組
群聊資料設置
群聊id(groupID)是沒有字母數(shù)字和特殊符號(當然不能中文)都是可以的,群聊名字(groupName),群聊介紹(introduction)等等，還有就是設置初始的成員，可以將主管理員加入(這里稍微有點疑惑的就是創(chuàng)建群聊，居然沒有默認添加創(chuàng)建人)
創(chuàng)建群聊的監(jiān)聽回調
這里傳入的參數(shù)就是上述的groupInfo和memberInfoList，主要用于初始化群聊，然后有一個回調的參數(shù)監(jiān)聽創(chuàng)建結果
val group = V2TIMGroupInfo()
group.groupName = "test"
group.groupType = "Meeting"
group.introduction = "more to show"
group.groupID = "test"
val memberInfoList: MutableList<V2TIMCreateGroupMemberInfo> = ArrayList()
val memberA = V2TIMCreateGroupMemberInfo()
memberA.setUserID("master")
memberInfoList.add(memberA)
V2TIMManager.getGroupManager().createGroup(
group, memberInfoList, object : V2TIMValueCallback<String?> {
override fun onError(code: Int, desc: String) {
// 創(chuàng)建失敗
Log.e("im","創(chuàng)建失敗$[code],詳情:${desc}")
}
override fun onSuccess(groupID: String?) {
// 創(chuàng)建成功
Log.e("im","創(chuàng)建成功,群號為${groupID}")
}
})
加入群聊
這部分只需要一個回調監(jiān)聽即可，這里沒有login的用戶的原因是，默認使用當前登錄的id加群，所以一個很重要的前提是登錄
V2TIMManager.getInstance().joinGroup("群聊ID","驗證消息",object :V2TIMCallback{
override fun onSuccess() {
Log.e("im","加群成功")
}
override fun onError(p0: Int, p1: String?) {
Log.e("im","加群失敗")
}
})
4.消息收發(fā)相關
發(fā)送消息
這里發(fā)送消息是采用高級接口，發(fā)送的消息類型比較豐富，并且支持自定義消息類型，所以這里采用了高級消息收發(fā)接口
首先創(chuàng)建消息，這里是創(chuàng)建自定義消息，其他消息同理
val myMessage = "一段自定義的json數(shù)據(jù)" //由于這里自定義消息接收的參數(shù)為byteArray類型的，所以進行一個轉換 val messageCus= V2TIMManager.getMessageManager().createCustomMessage(myMessage.toByteArray())
發(fā)送消息，這里需要設置一些參數(shù)
messageCus即轉換過后的byte類型的數(shù)據(jù)，toUserId即接收方，這里為群聊的話，用空字符串置空即可，groupId即群聊的ID，如果是單聊的話，這里同樣置空字符串即可，weight即你的消息被接收到的權重(不保證全部都能收到，這里設置權重確定優(yōu)先級)，onlineUserOnly即是否只有在線的用戶可以收到，這個的話設置false即可，offlinePushInfo這個只有旗艦版才有推送消息的功能，所以這里設置null即可，然后就是一個發(fā)送消息的回調
V2TIMManager.getMessageManager().sendMessage(messageCus,toUserId,groupId,weight,onlineUserOnly, offlinePushInfo,object:V2TIMSendCallback<V2TIMMessage>{
override fun onSuccess(message: V2TIMMessage?) {
Log.e("im","發(fā)送成功，內容為:${message?.customElem}")
//這里同時需要自己進行解析消息,需要轉換成String類型的數(shù)據(jù)
val data = String(message?.customElem?.data)
...
}
override fun onError(p0: Int, p1: String?) {
Log.e("im","錯誤碼為:${p0},具體錯誤:${p1}")
}
override fun onProgress(p0: Int) {
Log.e("im","處理進度:${p0}")
}
})
獲取歷史消息
- groupId即群聊ID
- pullNumber即拉取消息數(shù)量
- lastMessage即上一次的消息，用于獲取更多消息的定位
- V2TIMValueCallback即消息回調
這里關于lastMessage進行解釋說明，這個參數(shù)可以設置成全局變量，然后一開始設置為null，然后獲取到的消息列表的最后一條設置成lastMessage即可
V2TIMManager.getMessageManager().getGroupHistoryMessageList(
groupId,pullNumber,lastMessage,object:V2TIMValueCallback<List<V2TIMMessage>>{
override fun onSuccess(p0: List<V2TIMMessage>?) {
if (p0 != null) {
if (p0.isEmpty()){
Log.e("im","沒有更多消息了")
"沒有更多消息了".showToast()
}else {
//記錄最后一條消息
lastMessage = p0[p0.size - 1]
for (msgIndex in p0.indices) {
//解析各種消息
when(p0[msgIndex].elemType){
V2TIMMessage.V2TIM_ELEM_TYPE_CUSTOM ->{
...
}
V2TIMMessage.V2TIM_ELEM_TYPE_TEXT -> {}
...
}
else -> {
...
}
}
}
}
}
}
override fun onError(p0: Int, p1: String?) {
....
}
})
新消息的監(jiān)聽
這個主要用于新消息的接收和監(jiān)聽，同時需要自己對于各種消息的解析和相關處理
V2TIMManager.getMessageManager().addAdvancedMsgListener(object:V2TIMAdvancedMsgListener(){
override fun onRecvNewMessage(msg: V2TIMMessage?) {
Log.e("im","新消息${msg?.customElem}")
//這里針對多種消息類型有不同的處理方法
when(msg?.elemType){
V2TIMMessage.V2TIM_ELEM_TYPE_CUSTOM ->{
val message = msg.customElem?.data
...
}
V2TIMMessage.V2TIM_ELEM_TYPE_TEXT ->{
val message = msg.textElem.text
...
}
else -> {
"暫時不支持此消息的接收".showToast()
Log.e("im","${msg?.elemType}")
}
}
}
})
至此接入部分就已經(jīng)完成了，這里只是簡單的介紹接入，還有更多的細節(jié)可以查看項目源碼
三、WebSocket接入
這個需求和上面的是一樣的，同時提供和上面騰訊IM類似功能的api，這部分涉及網(wǎng)絡相關的api(不是非常專業(yè))，主要描述一些思路上的，具體代碼不是很困難
1.WebSocket介紹
webSocket可以實現(xiàn)長連接，可以作為消息接收的即時處理的一個工具，采用ws協(xié)議或者wss協(xié)議(SSL)進行通信，騰訊IM的版本也推出了webSocket實現(xiàn)方案，webSocket主要解決的痛點就是服務端不能主動推送消息，代替之前輪詢的實現(xiàn)方案
2.服務端相關
服務端采用springboot進行開發(fā)，同時也是使用kotlin進行編程
webSoket 依賴集成
下面是gradle的依賴集成
implementation "org.springframework.boot:spring-boot-starter-websocket"
WebSocketConfig配置相關
@Configuration
class WebSocketConfig {
@Bean
fun serverEndpointExporter(): ServerEndpointExporter {
return ServerEndpointExporter()
}
}
WebSocketServer相關
這部分代碼是關鍵代碼，里面重寫了webSocket的四個方法，然后配置靜態(tài)的變量和方法用于全局通信，下面給出一個框架
@ServerEndpoint("/imserver/{userId}")
@Component
class WebSocketServer {
@OnOpen
fun onOpen(session: Session?, @PathParam("userId") userId: String) {
...
}
@OnClose
fun onClose() {
...
}
@OnMessage
fun onMessage(message: String, session: Session?) {
...
}
@OnError
fun onError(session: Session?, error: Throwable) {
...
}
//主要解決@Component和@Resource沖突導致未能自動初始化的問題
@Resource
fun setMapper(chatMapper: chatMapper){
WebSocketServer.chatMapper = chatMapper
}
//這是發(fā)送消息用到的函數(shù)
@Throws(IOException::class)
fun sendMessage(message: String?) {
session!!.basicRemote.sendText(message)
}
//靜態(tài)變量和方法
companion object {
...
}
}
companion object
這里一個比較關鍵的變量就是webSocketMap存儲用戶的webSocket對象，后面將利用這個實現(xiàn)消息全員推送和部分推送
companion object {
//統(tǒng)計在線人數(shù)
private var onlineCount: Int = 0
//用于存放每個用戶對應的webSocket對象
val webSocketMap = ConcurrentHashMap<String, WebSocketServer>()
//操作數(shù)據(jù)庫的mapper對象的延遲初始化
lateinit var chatMapper:chatMapper
//服務端主動推送消息的對外開放的方法
@Throws(IOException::class)
fun sendInfo(message: String, @PathParam("userId") userId: String) {
if (userId.isNotBlank() && webSocketMap.containsKey(userId)) {
webSocketMap[userId]?.sendMessage(message)
} else {
println("用戶$userId,不在線！")
}
}
//在線統(tǒng)計
@Synchronized
fun addOnlineCount() {
onlineCount++
}
//離線統(tǒng)計
@Synchronized
fun subOnlineCount() {
onlineCount--
}
}
@OnOpen
這個方法在websocket打開時執(zhí)行，主要執(zhí)行一些初始化和統(tǒng)計工作
@OnOpen
fun onOpen(session: Session?, @PathParam("userId") userId: String) {
this.session = session
this.userId = userId
if (webSocketMap.containsKey(userId)) {
//包含此id說明此時其他地方開啟了一個webSocket通道，直接kick下線重新連接
webSocketMap.remove(userId)
webSocketMap[userId] = this
} else {
webSocketMap[userId] = this
addOnlineCount()
}
println("用戶連接:$userId,當前在線人數(shù)為:$onlineCount")
}
@OnClose
這個方法在webSocket通道結束時調用，執(zhí)行下線邏輯和相關的統(tǒng)計工作
@OnClose
fun onClose() {
if (webSocketMap.containsKey(userId)) {
webSocketMap.remove(userId)
subOnlineCount()
}
println("用戶退出:$userId,當前在線人數(shù)為:$onlineCount")
}
@OnMessage
這個方法用于處理消息分發(fā),這里一般需要對消息進行一些處理，具體處理參考自定義消息的處理，這里是設計成群聊的方案，所以采用
@OnMessage
fun onMessage(message: String, session: Session?) {
if (message.isNotBlank()) {
//解析發(fā)送的報文
val newMessage = ...
//這里需要進行插入一條數(shù)據(jù)，做持久化處理，即未在線的用戶也同樣可以看到這條消息
chatMapper.insert(newMessage)
//遍歷所有的消息
webSocketMap.forEach {
it.value.sendMessage(sendMessage.toMyJson())
}
}
}
@OnError
發(fā)生錯誤調用的方法
@OnError
fun onError(session: Session?, error: Throwable) {
println("用戶錯誤:$userId 原因: ${error.message}")
error.printStackTrace()
}
sendMessage
此方法用于消息分發(fā)給各個客戶端時調用的
fun sendMessage(message: String?) {
session!!.basicRemote.sendText(message)
}
WebSocketController
這部分主要是實現(xiàn)服務端直接推送消息設計的，類似系統(tǒng)消息的設定
@PostMapping("/sendAll/{message}")
fun sendAll(@PathVariable message: String):String{
//消息的處理
val newMessage = ...
//需不要存儲系統(tǒng)消息就看具體需求了
WebSocketServer.webSocketMap.forEach {
WebSocketServer.sendInfo(sendMessage.toMyJson(), it.key)
}
return "ok"
}
@PostMapping("/sendC2C/{userId}/{message}")
fun sendC2C(@PathVariable userId:String,@PathVariable message:String):String{
//消息的處理
val newMessage = ...
WebSocketServer.sendInfo(newMessage, userId)
return "ok"
}
至此服務端的講解就結束了，下面就看看我們安卓客戶端的實現(xiàn)了
3.客戶端相關
依賴集成
集成java語言的webSocket(四舍五入就是Kotlin版本的)
implementation 'org.java-websocket:Java-WebSocket:1.5.2'
實現(xiàn)部分
這部分的重寫的方法和服務端差不多，但少了服務相關的處理，代碼少了很多，這里需要提醒的一點就是，重寫的這些方法都是子線程中運行的，不允許直接寫入UI相關的操作，所以這里需要使用handle進行處理或者使用runOnUIThread
val userSocket = object :WebSocketClient(URI("wss://服務端地址:端口號/imserver/${userId}")){
override fun onOpen(handshakedata: ServerHandshake?) {
//打開進行初始化的操作
}
override fun onMessage(message: String?) {
...
//這里做recyclerView的更新
}
override fun onClose(code: Int, reason: String?, remote: Boolean) {
//這里執(zhí)行一個通知操作即可
...
}
override fun onError(ex: Exception?) {
...
}
}
userSocket.connect()
//斷開連接的話使用自帶的reconnect重新連接即可
//需要注意的一點就是不能在重寫方法里面執(zhí)行這個操作
userSocket.reconnect()
這里還有太多很多細節(jié)不能一一展示，但就總體而言是模仿上述騰訊IM實現(xiàn)的，具體的可以看項目地址
四、列表設計的一些細節(jié)
這里簡單敘述一下列表設計的一些細節(jié)，這部分設計還是挺繁瑣的
1.handle的使用
列表的更新時間和時機是取決于具體網(wǎng)絡獲取情況的，故需要一個全局的handle用于處理其中的消息，同時列表滑動行為不一樣，這里需要注意的一個小問題，就是message最好是用一個發(fā)一個，不然可能出現(xiàn)內存泄漏的風險
- 下拉刷新，此時刷新完畢列表肯定就是在第一個item的位置不然就有點奇怪
- 首次獲取歷史消息，此時的場景應該是列表最后一個item
- 獲取新消息，也是最后一個item
private val up = 1
private val down = 2
private val fail = 0
private val handler = object : Handler(Looper.getMainLooper()) {
override fun handleMessage(msg: android.os.Message) {
when (msg.what) {
up -> {
viewBinding.chatRecyclerview.scrollToPosition(0)
viewBinding.swipeRefresh.isRefreshing = false
}
down ->{
viewBinding.chatRecyclerview.scrollToPosition(viewModel.chatList.size-1)
}
fail -> {
"刷新失敗請檢查網(wǎng)絡".showToast()
viewBinding.swipeRefresh.isRefreshing = false
}
}
}
}
2.消息的獲取和RecycleView的刷新
消息部分設計成從新到老的設計，上述騰訊IM也是這個順序，所以這部分添加列表時需要加在最前面
viewModel.chatList.add(0,msg) adapter.notifyItemInserted(0)
同時需要注意的就是刷新位置，這部分是插入故使用adapter中響應的notifyItemInserted方法進行提醒列表刷新，雖然直接使用最通用的notifyDataSetChanged也是可以達到相同的目的，但體驗效果就不那么好了，如果是大量的數(shù)據(jù)，可能會產生比較大的延遲
3.關于消息item的設計細節(jié)
這個item具體是模仿QQ的布局進行設計的，這里底色部分沒有做調整
可以優(yōu)化的更好的部分就是時間，可以對列表時間進行判斷，然后實現(xiàn)類似昨天，前天等等的相對時間，這里使用的是constraintlayout和linearlayout的嵌套使用，這里當時遇到一個問題即文字需要自適應列表，如果沒有另外嵌套一個布局就會導致wrap_content的填充方式可能會超出界面，出現(xiàn)半個字的情況，猜測wrap_content最大的寬度是根布局的寬度導致的，所以最后嵌套了一個布局解決了，下面是設計的框架圖
五、項目使用的接口和地址
web項目比較復雜，是在之前的基礎上開發(fā)的，獨立抽離出來有點困難，所以這里就不放web端的代碼，這里提供客戶端的代碼，只需要替換自己的sdkId和服務端相關的url即可運行，同時這里涉及一些與服務端有關的交互，這里簡單介紹一下服務端需要開發(fā)的接口
獲取歷史數(shù)據(jù)的接口
這里兩個參數(shù)，一個確定拉取消息數(shù)目，一個確定拉取起始時間點
//獲取聊天記錄
@GET("chat/refreshes/{time}/{number}")
fun getChat(@Path("time")time:String, @Path("number")count:Int): Call<MessageResponse>
獲取騰訊IM的user簽名
//生成應用憑據(jù)
@GET("imSig/{userId}/{expire}")
fun getSig(@Path("userId")userId:String,@Path("expire")expire:Long):Call<String>
還有兩個推送使用的接口，在前面已經(jīng)敘述過了
項目地址：https://github.com/xyh-fu/ImTest.git
六、總結
這次IM即時通訊的設計收獲滿滿，get到一個新的知識點也算還行（主要是貧窮限制的），后期可以考慮全部換成騰訊的IM，畢竟自己實現(xiàn)的只是小規(guī)模測試和商業(yè)產品還是有很大的區(qū)別。服務端涉及的稍微多一點點，客戶端是比較簡單，比較麻煩的就是消息處理機制，考慮到設計的接口各異，還有服務端的數(shù)據(jù)庫等等，難以統(tǒng)一，故不一一展開敘述。
到此這篇關于Android即時通訊設計(騰訊IM接入和WebSocket接入)的文章就介紹到這了,更多相關Android即時通訊設計內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要介紹了Android軟鍵盤彈出時的界面控制方法,結合實例形式分析了Android軟鍵盤彈出后的三種模式,涉及Android針對AndroidManifet.xml的修改技巧,需要的朋友可以參考下2016-08-08
本篇文章是對Android本地代碼生成器的使用進行了詳細的分析介紹，需要的朋友參考下2013-05-05
Android中EditText setText方法的踩坑實戰(zhàn)
這篇文章主要給大家分享了一些關于Android中EditText setText方法的踩坑記錄，文中通過示例代碼介紹的非常詳細，對各位Android開發(fā)者們具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2018-07-07
這篇文章主要介紹了Android仿制淘寶滾動圖文條的示例代碼，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-08-08
這篇文章主要為大家詳細總結了android開發(fā)框架afinal使用方法，注解功能、文件上傳下載功能,具有一定的參考價值，感興趣的小伙伴們可以參考一下2016-11-11
這篇文章主要為大家分享了Android ActionBar使用教程，感興趣的小伙伴們可以參考一下2016-05-05
這篇文章主要介紹了Android 三種動畫詳解及簡單實例的相關資料,需要的朋友可以參考下2017-04-04
委托模式已經(jīng)被證明是實現(xiàn)繼承的一個很好的替代方式,下面這篇文章主要給大家介紹了關于Kotlin委托你必須重視的幾個點,文中通過實例代碼介紹的非常詳細,需要的朋友可以參考下2022-01-01
Android用tabhost實現(xiàn) 界面切換,每個界面為一個獨立的activity操作
這篇文章主要介紹了Android用tabhost實現(xiàn) 界面切換,每個界面為一個獨立的activity操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-09-09
Android自定義AvatarImageView實現(xiàn)頭像顯示效果
這篇文章主要為大家詳細介紹了Android自定義AvatarImageView實現(xiàn)頭像顯示效果，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-09-09