基于Netty，从零开发IM(二)：编码实践篇（im单聊功能）（Netty 入门与实战:仿写微信 IM 即时通讯系统）

基于Netty，从零开发IM(二)：编码实践篇（im单聊功能）（Netty 入门与实战:仿写微信 IM 即时通讯系统）

本文由作者“大白菜”分享，个人博客 cmsblogs.cn，有较多修订和改动。注意：本系列是给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 () 抽象方法，主要表示的是业务指令，不同的业务对应不同的指令。

@Datapublic abstract class BaseBean implements Serializable {    private Integer tag=1;//固定值，标识的是一个协议类型，不同协议对应不同的值    public abstract Byte code();//业务指令抽象方法}

登录请求实体：

@Datapublic class LoginReqBean extends BaseBean implements Serializable {    private Integer userid;//用户ID    private String username;//用户名称    public Byte code() {        return 1;//业务指令    }}

登录响应实体：

@Datapublic 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