Java實(shí)現(xiàn)即時(shí)聊天:聊天服務(wù)器+聊天客戶端+Web管理控制臺(tái)

來(lái)源：cnblogs.com/blogtimes/p/14767484.html

一、前言

說(shuō)實(shí)話，寫(xiě)這個(gè)玩意兒是我上周剛剛產(chǎn)生的想法，本想寫(xiě)完后把代碼掛上來(lái)賺點(diǎn)積分也不錯(cuò)。寫(xiě)完后發(fā)現(xiàn)這東西值得寫(xiě)一篇文章，授人予魚(yú)不如授人以漁嘛（這句話是這么說(shuō)的吧），順便賺點(diǎn)應(yīng)屆學(xué)生MM的膜拜那就更妙了。然后再掛一個(gè)收款二維碼，一個(gè)人1塊錢，一天10000個(gè)人付款，一個(gè)月30萬(wàn)，一年360萬(wàn)。。?？闪瞬坏昧?，離一個(gè)億的小目標(biāo)就差幾十年了。

好了，不說(shuō)夢(mèng)話了，現(xiàn)在我們回到現(xiàn)實(shí)中，這篇博文如果能有>2個(gè)評(píng)論，我后續(xù)會(huì)再出一個(gè)Netty相關(guān)的專欄。否則，就不出了。有人會(huì)好奇，為什么把閾值定義成>2呢？不為什么，因?yàn)槲铱隙〞?huì)先用我媳婦兒的號(hào)留個(gè)言，然后用自己的號(hào)留個(gè)言。

好了，廢話不多說(shuō)了，后面還有好多事兒呢，洗菜、做飯、刷碗、跪搓衣。。。好了，言歸正傳吧。

二、最終效果

為什么先看最終效果？因?yàn)榇丝檀a已經(jīng)擼完了。更重要的是我們帶著感官的目標(biāo)去進(jìn)行后續(xù)的分析，可以更好地理解。標(biāo)題中提到了，整個(gè)工程包含三個(gè)部分：

1、聊天服務(wù)器

聊天服務(wù)器的職責(zé)一句話解釋：負(fù)責(zé)接收所有用戶發(fā)送的消息，并將消息轉(zhuǎn)發(fā)給目標(biāo)用戶。

聊天服務(wù)器沒(méi)有任何界面，但是卻是IM中最重要的角色，為表達(dá)敬意，必須要給它放個(gè)效果圖：

2021-05-11 10:41:40.037  INFO 9392 ---?[ntLoopGroup-3-1] c.e.o.s.netty.handler.HeartBeatHandler ??: server收到心跳包：{"time":1620700900029,"messageType":"99"}
2021-05-11 10:41:50.049  INFO 9392 ---?[ntLoopGroup-3-1] c.e.o.s.n.handler.BussMessageHandler ????:?收到消息：{"time":1620700910045,"messageType":"14","sendUserName":"guodegang","recvUserName":"yuqian","sendMessage":"于老師你好"}
2021-05-11?10:41:50.055??INFO?9392?---?[ntLoopGroup-3-2]?c.e.o.s.netty.executor.SendMsgExecutor???:?消息轉(zhuǎn)發(fā)成功:{"time":1620700910052,"messageType":"14","sendUserName":"guodegang","recvUserName":"yuqian","sendMessage":"于老師你好"}
2021-05-11 10:41:54.068  INFO 9392 ---?[ntLoopGroup-3-2] c.e.o.s.netty.handler.HeartBeatHandler ??: server收到心跳包：{"time":1620700914064,"messageType":"99"}
2021-05-11 10:41:57.302  INFO 9392 ---?[ntLoopGroup-3-2] c.e.o.s.n.handler.BussMessageHandler ????:?收到消息：{"time":1620700917301,"messageType":"14","sendUserName":"yuqian","recvUserName":"guodegang","sendMessage":"郭老師你好"}
2021-05-11?10:41:57.304??INFO?9392?---?[ntLoopGroup-3-1]?c.e.o.s.netty.executor.SendMsgExecutor???:?消息轉(zhuǎn)發(fā)成功:{"time":1620700917303,"messageType":"14","sendUserName":"yuqian","recvUserName":"guodegang","sendMessage":"郭老師你好"}
2021-05-11 10:42:05.050? INFO 9392 ---?[ntLoopGroup-3-1] c.e.o.s.netty.handler.HeartBeatHandler ??: server收到心跳包：{"time":1620700925049,"messageType":"99"}
2021-05-11 10:42:12.309  INFO 9392 ---?[ntLoopGroup-3-2] c.e.o.s.netty.handler.HeartBeatHandler ??: server收到心跳包：{"time":1620700932304,"messageType":"99"}
2021-05-11 10:42:20.066  INFO 9392 ---?[ntLoopGroup-3-1] c.e.o.s.netty.handler.HeartBeatHandler ??: server收到心跳包：{"time":1620700940050,"messageType":"99"}
2021-05-11 10:42:27.311  INFO 9392 ---?[ntLoopGroup-3-2] c.e.o.s.netty.handler.HeartBeatHandler ??: server收到心跳包：{"time":1620700947309,"messageType":"99"}
2021-05-11 10:42:35.070? INFO 9392 ---?[ntLoopGroup-3-1] c.e.o.s.netty.handler.HeartBeatHandler ??: server收到心跳包：{"time":1620700955068,"messageType":"99"}
2021-05-11 10:42:42.316  INFO 9392 ---?[ntLoopGroup-3-2] c.e.o.s.netty.handler.HeartBeatHandler ??: server收到心跳包：{"time":1620700962312,"messageType":"99"}
2021-05-11 10:42:50.072  INFO 9392 ---?[ntLoopGroup-3-1] c.e.o.s.netty.handler.HeartBeatHandler ??: server收到心跳包：{"time":1620700970071,"messageType":"99"}
2021-05-11 10:42:57.316  INFO 9392 ---?[ntLoopGroup-3-2] c.e.o.s.netty.handler.HeartBeatHandler ??: server收到心跳包：{"time":1620700977315,"messageType":"99"}

從效果圖我們看到了一些內(nèi)容：收到心跳包、收到消息，轉(zhuǎn)發(fā)消息，這些內(nèi)容后面會(huì)詳細(xì)講解。

2、聊天客戶端

聊天客戶端的職責(zé)一句話解釋：登陸，給別人發(fā)聊天內(nèi)容，收其它人發(fā)給自己的聊天內(nèi)容。

下面為方便演示，我會(huì)打開(kāi)兩個(gè)客戶端，用兩個(gè)不同用戶登陸，然后發(fā)消息。

3、Web管理控制臺(tái)

目前只做了一個(gè)賬戶管理，具體看圖吧：

三、需求分析

無(wú)（見(jiàn)第二章節(jié)）。

四、概要設(shè)計(jì)

1、技術(shù)選型

1）聊天服務(wù)端　　?

聊天服務(wù)器與客戶端通過(guò)TCP協(xié)議進(jìn)行通信，使用長(zhǎng)連接、全雙工通信模式，基于經(jīng)典通信框架Netty實(shí)現(xiàn)。

那么什么是長(zhǎng)連接？顧名思義，客戶端和服務(wù)器連上后，會(huì)在這條連接上面反復(fù)收發(fā)消息，連接不會(huì)斷開(kāi)。與長(zhǎng)連接對(duì)應(yīng)的當(dāng)然就是短連接了，短連接每次發(fā)消息之前都需要先建立連接，然后發(fā)消息，最后斷開(kāi)連接。顯然，即時(shí)聊天適合使用長(zhǎng)連接。

那么什么又是全雙工？當(dāng)長(zhǎng)連接建立起來(lái)后，在這條連接上既有上行的數(shù)據(jù)，又有下行的數(shù)據(jù)，這就叫全雙工。那么對(duì)應(yīng)的半雙工、單工，大家自行百度吧。

2）Web管理控制臺(tái)

Web管理端使用SpringBoot腳手架，前端使用Layuimini（一個(gè)基于Layui前端框架封裝的前端框架），后端使用SpringMVC+Jpa+Shiro。

3）聊天客戶端

使用SpringBoot+JavaFX，做了一個(gè)極其簡(jiǎn)陋的客戶端，JavaFX是一個(gè)開(kāi)發(fā)Java桌面程序的框架，本人也是第一次使用，代碼中的寫(xiě)法都是網(wǎng)上查的，這并不是本文的重點(diǎn)，有興趣的仔細(xì)百度吧。

4）SpringBoot

以上三個(gè)組件，全部以SpringBoot做為腳手架開(kāi)發(fā)。

5）代碼構(gòu)建

Maven。

2、數(shù)據(jù)庫(kù)設(shè)計(jì)

我們只簡(jiǎn)單用到一張用戶表，比較簡(jiǎn)單直接貼腳本：

CREATE?TABLE?`sys_user`?(
??`id`?bigint(20)?NOT?NULL?AUTO_INCREMENT?COMMENT?'主鍵',
??`user_name`?varchar(64)?DEFAULT?NULL?COMMENT?'用戶名：登陸賬號(hào)',
??`pass_word`?varchar(128)?DEFAULT?NULL?COMMENT?'密碼',
??`name`?varchar(16)?DEFAULT?NULL?COMMENT?'昵稱',
??`sex`?char(1)?DEFAULT?NULL?COMMENT?'性別:1-男，2女',
??`status`?bit(1)?DEFAULT?NULL?COMMENT?'用戶狀態(tài)：1-有效，0-無(wú)效',
??`online`?bit(1)?DEFAULT?NULL?COMMENT?'在線狀態(tài)：1-在線，0-離線',
??`salt`?varchar(128)?DEFAULT?NULL?COMMENT?'密碼鹽值',
??`admin`?bit(1)?DEFAULT?NULL?COMMENT?'是否管理員（只有管理員才能登錄Web端）：1-是，0-否',
??PRIMARY?KEY?(`id`)
)?ENGINE=InnoDB?AUTO_INCREMENT=1?DEFAULT?CHARSET=utf8;

這張表都在什么時(shí)候用到？

1）Web管理端登陸的時(shí)候；

2）聊天客戶端將登陸請(qǐng)求發(fā)送到聊天服務(wù)端時(shí)，聊天服務(wù)端進(jìn)行用戶認(rèn)證；

3）聊天客戶端的好友列表加載。

3、通信設(shè)計(jì)

本節(jié)將會(huì)是本文的核心內(nèi)容之一，主要描述通信報(bào)文協(xié)議格式、以及通信報(bào)文的交互場(chǎng)景。

1）報(bào)文協(xié)議格式

下面這張圖應(yīng)該能說(shuō)明99%了：

剩下的1%在這里說(shuō)：

a）粘包問(wèn)題，TCP長(zhǎng)連接中，粘包是第一個(gè)需要解決的問(wèn)題。通俗的講，粘包的意思是消息接收方往往收到的不是“整個(gè)”報(bào)文，有時(shí)候比“整個(gè)”多一點(diǎn)，有時(shí)候比“整個(gè)”少一點(diǎn)，這樣就導(dǎo)致接收方無(wú)法解析這個(gè)報(bào)文。那么上圖中的頭8個(gè)字節(jié)就為了解決這個(gè)問(wèn)題，接收方根據(jù)頭8個(gè)字節(jié)標(biāo)識(shí)的長(zhǎng)度來(lái)獲取到“整個(gè)”報(bào)文，從而進(jìn)行正常的業(yè)務(wù)處理；

b）2字節(jié)報(bào)文類型，為了方便解析報(bào)文而設(shè)計(jì)。根據(jù)這兩個(gè)字節(jié)將后面的json轉(zhuǎn)成相應(yīng)的實(shí)體以便進(jìn)行后續(xù)處理；

c）變長(zhǎng)報(bào)文體實(shí)際上就是json格式的串，當(dāng)然，你可以自己設(shè)計(jì)報(bào)文格式，我這里為了方便處理就直接放json了；

d）當(dāng)然，你可以把報(bào)文設(shè)計(jì)的更復(fù)雜、更專業(yè)，比如加密、加簽名等。

2）報(bào)文交互場(chǎng)景

a）登陸

b）發(fā)送消息-成功

c）發(fā)送消息-目標(biāo)客戶端不在線

d）發(fā)送消息-目標(biāo)客戶端在線，但消息轉(zhuǎn)發(fā)失敗

五、編碼實(shí)現(xiàn)

前面說(shuō)了那么多，現(xiàn)在總得說(shuō)點(diǎn)有用的。

1、先說(shuō)說(shuō)Netty

Netty是一個(gè)相當(dāng)優(yōu)秀的通信框架，大多數(shù)的頂級(jí)開(kāi)源框架中都有Netty的身影。具體它有多么優(yōu)秀，建議大家自行百度，我不如百度說(shuō)的好。我只從應(yīng)用方面說(shuō)說(shuō)Netty。應(yīng)用過(guò)程中，它最核心的東西叫handler，我們可以簡(jiǎn)單理解它為消息處理器。收到的消息和出去的消息都會(huì)經(jīng)過(guò)一系列的handler加工處理。收到的消息我們叫它入站消息，發(fā)出去的消息我們叫它出站消息，因此handler又分為出站handler和入站handler。收到的消息只會(huì)被入站handler處理，發(fā)出去的消息只會(huì)被出站handler處理。

舉個(gè)例子，我們從網(wǎng)絡(luò)上收到的消息是二進(jìn)制的字節(jié)碼，我們的目標(biāo)是將消息轉(zhuǎn)換成java bean，這樣方便我們程序處理，針對(duì)這個(gè)場(chǎng)景我設(shè)計(jì)這么幾個(gè)入站handler：

1）將字節(jié)轉(zhuǎn)換成String的handler；

2）將String轉(zhuǎn)成java bean的handler；

3）對(duì)java bean進(jìn)行業(yè)務(wù)處理的handler。

發(fā)出去的消息呢，我設(shè)計(jì)這么幾個(gè)出站handler：

1）java bean 轉(zhuǎn)成String的handler；

2）String轉(zhuǎn)成byte的handler。

以上是關(guān)于handler的說(shuō)明。

接下來(lái)再說(shuō)一下Netty的異步。異步的意思是當(dāng)你做完一個(gè)操作后，不會(huì)立馬得到操作結(jié)果，而是有結(jié)果后Netty會(huì)通知你。通過(guò)下面的一段代碼來(lái)說(shuō)明：

channel.writeAndFlush(sendMsgRequest).addListener(new?GenericFutureListener>()?{
????????????????@Override
????????????????public?void?operationComplete(Future?future)?throws?Exception?{
????????????????????if?(future.isSuccess()){
????????????????????????logger.info("消息發(fā)送成功:{}",sendMsgRequest);
????????????????????}else?{
????????????????????????logger.info("消息發(fā)送失敗:{}",sendMsgRequest);
????????????????????}
????????????????}
????????????});

上面的writeAndFlush操作無(wú)法立即返回結(jié)果，如果你關(guān)注結(jié)果，那么為他添加一個(gè)listener，有結(jié)果后會(huì)在listener中響應(yīng)。

到這里，百度上搜到的Netty相關(guān)的代碼你基本就能看懂了。

2、聊天服務(wù)端

首先看主入口的代碼

public?void?start(){
????????EventLoopGroup?boss?=?new?NioEventLoopGroup();
????????EventLoopGroup?worker?=?new?NioEventLoopGroup();
????????ServerBootstrap?serverBootstrap?=?new?ServerBootstrap();
????????serverBootstrap.group(boss,?worker)
????????????????.channel(NioServerSocketChannel.class)
????????????????.option(ChannelOption.SO_BACKLOG,?1024)
????????????????.handler(new?LoggingHandler(LogLevel.INFO))
????????????????.childHandler(new?ChannelInitializer()?{
????????????????????@Override
????????????????????protected?void?initChannel(SocketChannel?ch)?throws?Exception?{
????????????????????????//心跳
????????????????????????ch.pipeline().addLast(new?IdleStateHandler(25,?20,?0,?TimeUnit.SECONDS));
????????????????????????//收整包
????????????????????????ch.pipeline().addLast(new?StringLengthFieldDecoder());
????????????????????????//轉(zhuǎn)字符串
????????????????????????ch.pipeline().addLast(new?StringDecoder(Charset.forName("UTF-8")));
????????????????????????//json轉(zhuǎn)對(duì)象
????????????????????????ch.pipeline().addLast(new?JsonDecoder());
????????????????????????//心跳
????????????????????????ch.pipeline().addLast(new?HeartBeatHandler());
????????????????????????//實(shí)體轉(zhuǎn)json
????????????????????????ch.pipeline().addLast(new?JsonEncoder());
????????????????????????//消息處理
????????????????????????ch.pipeline().addLast(bussMessageHandler);
????????????????????}
????????????????});
????????try?{
????????????ChannelFuture?f?=?serverBootstrap.bind(port).sync();
????????????f.channel().closeFuture().sync();
????????}catch?(InterruptedException?e)?{
????????????logger.error("服務(wù)啟動(dòng)失?。簕}",?ExceptionUtils.getStackTrace(e));
????????}finally?{
????????????worker.shutdownGracefully();
????????????boss.shutdownGracefully();
????????}
????}

代碼中除了initChannel方法中的代碼，其他代碼都是固定寫(xiě)法。那么什么叫固定寫(xiě)法呢？通俗來(lái)講就是可以Ctrl+c、Ctrl+v。

下面我們著重看initChannel方法里面的代碼。這里面就是上面講到的各種handler，我們下面挨個(gè)講這些handler都是干啥的。

1）IdleStateHandler。這個(gè)是Netty內(nèi)置的一個(gè)handler，既是出站handler又是入站handler。它的作用一般是用來(lái)實(shí)現(xiàn)心跳監(jiān)測(cè)。所謂心跳，就是客戶端和服務(wù)端建立連接后，服務(wù)端要實(shí)時(shí)監(jiān)控客戶端的健康狀態(tài)，如果客戶端掛了或者h(yuǎn)ung住了，服務(wù)端及時(shí)釋放相應(yīng)的資源，以及做出其他處理比如通知運(yùn)維。所以在我們的場(chǎng)景中，客戶端需要定時(shí)上報(bào)自己的心跳，如果服務(wù)端檢測(cè)到一段時(shí)間內(nèi)沒(méi)收到客戶端上報(bào)的心跳，那么及時(shí)做出處理，我們這里就是簡(jiǎn)單的將其連接斷開(kāi)，并修改數(shù)據(jù)庫(kù)中相應(yīng)賬戶的在線狀態(tài)。

現(xiàn)在開(kāi)始說(shuō)IdleStateHandler，第一個(gè)參數(shù)叫讀超時(shí)時(shí)間，第二個(gè)參數(shù)叫寫(xiě)超時(shí)時(shí)間，第三個(gè)參數(shù)叫讀寫(xiě)超時(shí)時(shí)間，第四個(gè)參數(shù)時(shí)時(shí)間單位秒。這個(gè)handler表達(dá)的意思是當(dāng)25秒內(nèi)沒(méi)讀到客戶端的消息，或者20秒內(nèi)沒(méi)往客戶端發(fā)消息，就會(huì)產(chǎn)生一個(gè)超時(shí)事件。那么這個(gè)超時(shí)事件我們?cè)搶?duì)他做什么處理呢，請(qǐng)看下一條。

2）HeartBeatHandler。結(jié)合a）一起看，當(dāng)發(fā)生超時(shí)事件時(shí)，HeartBeatHandler會(huì)收到這個(gè)事件，并對(duì)它做出處理：第一將鏈接斷開(kāi)；第二講數(shù)據(jù)庫(kù)中相應(yīng)的賬戶更新為不在線狀態(tài)。

public?class?HeartBeatHandler?extends?ChannelInboundHandlerAdapter?{
????private?static?Logger?logger?=?LoggerFactory.getLogger(HeartBeatHandler.class);

????@Override
????public?void?userEventTriggered(ChannelHandlerContext?ctx,?Object?evt)?throws?Exception?{
????????if?(evt?instanceof?IdleStateEvent){
????????????IdleStateEvent?event?=?(IdleStateEvent)evt;
????????????if?(event.state()?==?IdleState.READER_IDLE)?{
????????????????//讀超時(shí)，應(yīng)將連接斷掉
????????????????InetSocketAddress?socketAddress?=?(InetSocketAddress)ctx.channel().remoteAddress();
????????????????String?ip?=?socketAddress.getAddress().getHostAddress();
????????????????ctx.channel().disconnect();
????????????????logger.info("【{}】連接超時(shí)，斷開(kāi)",ip);
????????????????String?userName?=?SessionManager.removeSession(ctx.channel());
????????????????SpringContextUtil.getBean(UserService.class).updateOnlineStatus(userName,Boolean.FALSE);
????????????}else?{
????????????????super.userEventTriggered(ctx,?evt);
????????????}
????????}else?{
????????????super.userEventTriggered(ctx,?evt);
????????}

????}

????@Override
????public?void?channelRead(ChannelHandlerContext?ctx,?Object?msg)?throws?Exception?{
????????if?(msg?instanceof?HeartBeat){
????????????//收到心跳包，不處理
????????????logger.info("server收到心跳包：{}",msg);
????????????return;
????????}
????????super.channelRead(ctx,?msg);
????}
}

3）StringLengthFieldDecoder。這是個(gè)入站handler，他的作用就是解決上面提到的粘包問(wèn)題：

public?class?StringLengthFieldDecoder?extends?LengthFieldBasedFrameDecoder?{
????public?StringLengthFieldDecoder()?{
????????super(10*1024*1024,0,8,0,8);
????}


????@Override
????protected?long?getUnadjustedFrameLength(ByteBuf?buf,?int?offset,?int?length,?ByteOrder?order)?{
????????buf?=?buf.order(order);
????????byte[]?lenByte?=?new?byte[length];
????????buf.getBytes(offset,?lenByte);
????????String?lenStr?=?new?String(lenByte);
????????Long?len?=??Long.valueOf(lenStr);
????????return?len;
????}
}

只需要集成Netty提供的LengthFieldBasedFrameDecoder 類，并重寫(xiě)getUnadjustedFrameLength方法即可。

首先看構(gòu)造方法中的5個(gè)參數(shù)。第一個(gè)表示能處理的包的最大長(zhǎng)度；第二三個(gè)參數(shù)應(yīng)該結(jié)合起來(lái)理解，表示長(zhǎng)度字段從第幾位開(kāi)始，長(zhǎng)度的長(zhǎng)度是多少，也就是上面報(bào)文格式協(xié)議中的頭8個(gè)字節(jié)；第四個(gè)參數(shù)表示長(zhǎng)度是否需要校正，舉例理解，比如頭8個(gè)字節(jié)解析出來(lái)的長(zhǎng)度=包體長(zhǎng)度+頭8個(gè)字節(jié)的長(zhǎng)度，那么這里就需要校正8個(gè)字節(jié)，我們的協(xié)議中長(zhǎng)度只包含報(bào)文體，因此這個(gè)參數(shù)填0；最后一個(gè)參數(shù)，表示接收到的報(bào)文是否要跳過(guò)一些字節(jié)，本例中設(shè)置為8，表示跳過(guò)頭8個(gè)字節(jié)，因此經(jīng)過(guò)這個(gè)handler后，我們收到的數(shù)據(jù)就只有報(bào)文本身了，不再包含8個(gè)長(zhǎng)度字節(jié)了。

再看getUnadjustedFrameLength方法，其實(shí)就是將頭8個(gè)字符串型的長(zhǎng)度為轉(zhuǎn)換成long型。重寫(xiě)完這個(gè)方法后，Netty就知道如何收一個(gè)“完整”的數(shù)據(jù)包了。

4）StringDecoder。這個(gè)是Netty自帶的入站handler，會(huì)將字節(jié)流以指定的編碼解析成String。

5）JsonDecoder。是我們自定義的一個(gè)入站handler，目的是將json String轉(zhuǎn)換成java bean，以方便后續(xù)處理：

public?class?JsonDecoder?extends?MessageToMessageDecoder?{
????@Override
????protected?void?decode(ChannelHandlerContext?channelHandlerContext,?String?o,?List