本文由作者“大白菜”分享，有較多修訂和改動。注意：本系列是給IM初學者的文章，IM老油條們還望海涵，勿噴！

1、引言

接上篇《IM系統設計篇》， 本篇主要講解的是通過實戰編碼實現IM的單聊功能，內容涉及技術原理、編碼實踐。

補充說明： 因為本系列文章主要目的是引導IM初學者在基於Netty的情況下，如何一步一步從零寫出IM的邏輯和思維能力，因而為了簡化編碼實現，本系列中編碼實現的客戶端都是基於控制檯實現的（希望不要被嫌棄），因為理解技術的本質顯然比炫酷的外在表現形式更為重要。

2、寫在前面

建議你在閱讀本文之前，務必先讀本系列首篇《IM系統設計篇》，在著重理解IM系統的理論設計思路之後，再來讀實戰程式碼則效果更好。

最後，在開始本文之前，請您務必提前瞭解Netty的相關基礎知識，可從本系列首篇《IM系統設計篇》中的“知識準備”一章開始。

3、系列文章

本文是系列文章的第2篇，以下是系列目錄：

• 《基於Netty，從零開發IM(一)：IM系統設計篇》
• 《基於Netty，從零開發IM(二)：編碼實踐篇（單聊功能）》 （* 本文）
• 《基於Netty，從零開發IM(三)：編碼實踐篇（群聊功能）》（稍後釋出.. ）
• 《基於Netty，從零開發IM(四)：編碼實踐篇（系統優化）》（稍後釋出.. ）

4、執行效果

本篇我們主要來實現的是IM單聊功能，具體就是：模擬IM聊天的兩個使用者分別登陸各自的賬號，然後可以互相傳送聊天訊息。

我們提前看一下本篇要實現的功能執行效果。

客戶端 1 登陸效果：

客戶端 2 登陸效果：

客戶端 1 傳送訊息效果圖：

客戶端 2 接受訊息效果圖：

5、技術原理

5.1 概述

上節中，可以看到此次實戰的執行效果是一個基於 console 控制檯的聊天，根據上篇《IM系統設計篇》的思路設計，我們也知道主要核心是服務端儲存一份關係對映，通過接受人 ID 找到對應的通道進行訊息傳送。

但是，我們要想實現具體的功能，則需要大體上做一個核心技術實現步驟的拆解，具體拆分成以下三步。

5.2 第一步： 編碼和解碼的實現

針對IM單聊功能，有兩個核心技術點：

• 1）一是序列化和反序列化；

• 2）二是通訊協議實現。

客戶端和服務端之間的資料通訊，我們是基於實體物件去互動的，這樣資料格式更加的方便。

對於實體物件的序列化和反序列化，推薦使用 Fastjson 框架去實現，而不是Netty官方示例所使用的物件流。

同時為了更加規範的管理不同業務實體，我們需要定義一個實體基類，所有的業務實體都繼承它（下面的章節會詳細講解）。

5.3 第二步： 登入和訊息傳送兩個業務點的實現

登入主要是為了讓使用者 ID 和通道（就是Netty中的Channel，也即網路連線）進行繫結。

在登入成功之後為 Channel 通過 attr() 方法繫結該使用者 ID，主要目的有三個：

• 1）客戶端A在傳送訊息時，服務端可以通過 Channel 獲取訊息傳送者的使用者ID，以便知道訊息是“誰”發過來的；

• 2）服務端在收到客戶端A發過來的訊息時，通過訊息中的接收者使用者ID，可以獲取接收者的Channel，以便知道訊息該發給“誰”；

• 3）在 Channel 斷開的時候，服務端可以監聽到 Channel，並且獲取 Channel 的屬性，從而刪除對應的使用者ID和Chennel對映關係。

對於業務處理來說，使用者登入和訊息傳送是兩個不同的業務點，一般來說需要定義多個 Handler 來分別處理，但是這裡為了減少 Handler 的數量，統一一個 Handler 處理。

* 友情提示： 使用者ID和Chennel的繫結，可以參考成熟的開源IM工程 MobileIMSDK 中的實現邏輯 OnlineProcessor.java，以便通過更接近IM產品級實踐進行學習。

5.4 第三步： 對映關係的實現

前面也分析過了，服務端需要儲存一份使用者ID和Channel對映關係，這個對映關係只需要使用一個 Map 進行儲存即可，即Map，其中：key 是使用者 ID、value 是 Channel（Channel也就是客戶端的網路連線物件啦）。

這部分需要交待的不多，理解清楚使用者ID和Channel的關係就足夠了。

接下來就是具體的編碼實戰了。。。

6、實體定義實戰

實體的設計，主要從兩個方面進行入手考慮：

• 1）通訊協議的規則，分別是協議識別符號、業務指令、資料長度、資料四個部分；

• 2）不同業務對應不同的欄位屬性。

具體如下圖所示：

基礎實體：

主要定義 tag 欄位，標識協議的識別符號，code () 抽象方法，主要表示的是業務指令，不同的業務對應不同的指令。

@Data

public abstract class BaseBean implements Serializable {

private Integer tag=1;//固定值，標識的是一個協議型別，不同協議對應不同的值

public abstract Byte code();//業務指令抽象方法

}

登入請求實體：

@Data

public class LoginReqBean extends BaseBean implements Serializable {

private Integer userid;//使用者ID

private String username;//使用者名稱稱

public Byte code() {

return 1;//業務指令

}

}

登入響應實體：

@Data

public class LoginResBean extends BaseBean implements Serializable {

private Integer status;//響應狀態，0登入成功，1登入失敗

private String msg;//響應資訊

private Integer userid;//使用者ID

public Byte code() {

return 2;//業務指令

}

}

訊息傳送實體：

public class MsgReqBean extends BaseBean implements Serializable {
private Integer fromuserid;//傳送人ID
private Integer touserid;//接受人ID
private String msg;//傳送訊息
public Byte code() {
return 3;//業務指令
}
}

訊息響應響應：

public class MsgResBean extends BaseBean implements Serializable {

private Integer status;//響應狀態，0傳送成功，1傳送失敗

private String msg;//響應資訊

public Byte code() {

return 4;//業務指令

}

}

訊息接受實體：

public class MsgRecBean extends BaseBean implements Serializable {

private Integer fromuserid;//傳送人ID

private String msg;//訊息

public Byte code() {

return 5;//業務指令

}

}

7、編碼和解碼實戰

7.1 依賴座標

com.alibaba

fastjson

1.2.47

7.2 編碼實現

public class MyEncoder extends MessageToByteEncoder {

protected void encode(

ChannelHandlerContext channelHandlerContext,

BaseBean baseBean,

ByteBuf byteBuf) throws Exception {

//1.把實體序列化成位元組數字

byte[] bytes= JSON.toJSONBytes(baseBean);

//2.根據協議組裝資料

byteBuf.writeInt(baseBean.getTag());//標識（4個位元組）

byteBuf.writeByte(baseBean.code());//指令（1個位元組）

byteBuf.writeInt(bytes.length);//長度（4個位元組）

byteBuf.writeBytes(bytes);//

}

}

7.3 解碼實現

public class MyDecoder extends ByteToMessageDecoder {
protected void decode( ChannelHandlerContext channelHandlerContext, ByteBuf byteBuf, List