第六章：L2JMobius学习 – 源码讲解网络数据通信

本章节介绍客户端和服务器端的网络数据通信，使用的技术是Java NIO（也就是套接字Socket）。服务器端和客户端使用Socket通信的原因在于，它是双向的，持久的。也就是说，服务器端可以随时的向客户端发送数据，客户端也可以随时的向服务端发送数据。

请注意，不同于HTTP这样的高级协议，使用Socket通信的数据格式往往是Byte字节。当我们收到客户端发来的Byte字节数据的时候，我们就需要将这些字节数据转化为相应数据类型的数据。例如，真实的数据是一个int类型的话，我们就需要将4个字节的数据转化成一个int类型数据。同样的，服务器端发给客户端的数据，也有统一转化成字节数据。

那么，这一堆堆的字节数据如何转化为真实数据呢？我们怎么知道哪几个字节数据需要转化成那些类型的数据呢？这就要求我们对双方通信的数据进行“格式约定”。例如，当我们接收到一个数据的时候，我们“固定读取”前两个字节转化成一个short类型数值数据，该数值数据就代表了当前数据包的长度，我们接下来就需要根据这个长度来获取后面的数据即可。

当获取完整的数据包之后，我们继续读取一个int类型数值数据，这个数值数据代表了“业务模型类”。接下来，我们就可以将数据包中的数据，按照“业务模型类”里面定义的属性（变量）进行转化了。这些类属性（变量）的顺序与数据包中的字节数据是一一对应的关系。例如，当前“业务模型类”中有一个int类型的a变量和short类型的b变量，那么我们就讲前4个字节转化成int类型赋值给a变量，后面2个字节转化成short类型赋值给b变量。对于String类型的话，还要约定它的长度，然后将这个长度的字节数据整体转化成字符串类型数据。

成功获取“业务模型类”之后，我们就可以根据“游戏业务逻辑”对它进行下一步的处理。例如，这个“业务模型类”是登录请求的话，那么里面就包含了账号和密码数据。那么，我们下一步的处理就应该是验证账号和密码是否正确。如果不正确，就要向客户端发送失败数据包；如果正确，就要向客户端发送成功数据包。当然，这里返回给客户端的数据包，就需要将各种数据类型的数据按照顺序逐一放进byte数组中，最后再通过Socket发送给客户端。这就是服务端和客户端的一个简单通信流程。

这里面需要注意的是，因为Socket通信的字节数据发送并不是“有序”的，它不会一个一个数据包的进行发送，而是将一个或多个，甚至半个数据包进行发送。因此，当我们接收到Byte数据的时候，一定要按照“格式约定”来读取完整的数据包。如果不是完整的数据包，我们就需要等待读取后面的数据，拼凑成完整的。

接下来，我们回到“L2J_Mobius”工程里面。

在上面的目录结构中，很多文件实际是没有用的。我们重点说一下几个目录。

config是配置文件目录，里面有很多配置文件，其中就包括数据连接的配置（我们之前改过）。

data是游戏数据目录，里面有很多的游戏数据，比如NPC对话等等。

libs是数据库链接驱动文件，这个我们之前也介绍过。

log是日志目录，服务启动后，很多日志都是在这里纪录的。

src是源码目录，这是我们要重点讲解的。

接下来，我们就进入到src/org/l2jmobius 目录下

commons是公共包，里面提供了一些封装好的实现某种特定功能的类，供其他模块使用。

gameserver游戏服务包，启动里面的GameServer.java就能处理来自客户端的数据包。

log日志包，负责完成日志记录的功能。

loginserver登录服务包，启动里面的LoginServer.java就能处理客户端的登录操作。

tools工具包，包含游戏账号管理和数据库初始化等等，这个我们暂时不用。

Config.java配置类，其实就对应了我们上面介绍的config配置文件目录。

这里稍微说明一下gameserver和loginserver的区别。loginserver用来处理玩家的账号登录，然后玩家选择完游戏大区之后，就返回该游戏大区的IP地址，然后玩家就能进入到指定游戏大区的游戏世界里面了，这就对应了gameserver。很明显，loginserver只有一个，而游戏大区有很多，他们都对应一个个的gameserver。也就是说，他们是一对多的关系。当然，我们本地测试的话，只需要一个loginserver和一个gameserver，并且他们在同一台电脑上。在实际的游戏部署的时候，loginserver和gameserver都会独占一台服务器，都拥有独立的IP地址。当然，这些不是我们章节介绍的内容。

本章节要介绍网络数据通信的部分，它对应的代码位于commons\network目录下。

ReadablePacket.java：客户端发送给服务器端的数据包父类。
WritablePacket.java：服务器端发送给客户端的数据包父类。

ReadThread.java：读取线程，用来读取客户端发送过来的数据包。
ExecuteThread.java：执行线程，主要用来解密数据包，在进行游戏逻辑处理。

EncryptionInterface.java：加密和解密的接口而已，需要子类来实现。
PacketHandlerInterface.java：数据包游戏逻辑处理接口，需要子类来实现。

NetConfig.java：网络数据通信的配置参数，例如线程池的大小配置。
NetClient.java：客户端父类，持有SocketChannel通道对象。
NetServer.java：服务端类，就是ServerSocketChannel类。

首先，我们介绍一下ReadablePacket.java和WritablePacket.java两个数据包父类。他们只是完成基础的数据功能，不包括与游戏相关的业务数据。他们两个里面都有一个byte数组，这是客户端和服务器端通信的底层字节数据。其次，ReadablePacket.java包含了将byte转化成各种数据类型的方法，而WritablePacket.java而是包含了将各种数据类型转化成byte的方法。这个我们在本章节开始的位置就讲解过，应该很容易理解。在游戏开发过程中，数据包的处理是非常多的，他们都要继承ReadablePacket或者WritablePacket。

接下来，我们详细介绍一下ReadThread.java读取线程。该线程里面有一个set集合，集合中存放了NetClient客户端对象。在这个NetClient.java类中，有三个重要的属性变量。

// 完整的数据包队列，需要下一步解密
private Queue<byte[]> _pendingPacketData;
// 不完整的数据包，需要继续从客户端读取剩余数据
private ByteBuffer _pendingByteBuffer;
// 不完整的数据包的长度，根据这个长度来读取
private int _pendingPacketSize;

有了这三个属性变量的理解之后，我们就很容易理解ReadThread.java读取线程了。首先，我们要循环遍历set集合，获取到里面的每一个NetClient客户端对象，然后获取对应的SocketChannel通道对象，然后就可以通过read方法读取客户端发送过来的数据了。这里分两种情况，第一种就是“半包”的情况，第二种就是“非半包”的情况。

如果是“半包”的情况的话。我们就需要将这个不完整的数据包放入到NetClient中的pendingByteBuffer中，并且还要设置该数据包的完整长度pendingPacketSize。所以，我们再读取客户端发送过来的数据的时候，就要考虑pendingByteBuffer中是否数据。如果存在数据的话，就需要先获取pendingByteBuffer的数据，然后在根据pendingPacketSize获取剩余的数据。这个就非常简单了，使用pendingPacketSize减去pendingByteBuffer的长度。

final ByteBuffer pendingByteBuffer = client.getPendingByteBuffer();
final int pendingPacketSize = client.getPendingPacketSize();
final ByteBuffer additionalData = ByteBuffer.allocate(pendingPacketSize - pendingByteBuffer.position());
channel.read(additionalData)

读取完毕之后，就可以将完整的数据包放入到NetClient中的pendingPacketData队列中了。当然不要忘记清除缓存的“半包”数据。

client.addPacketData(pendingByteBuffer.array());
client.setPendingByteBuffer(null);

接下来，我们继续读取客户端的数据包。首先要读取2个字节的长度_sizeBuffer，这是接下来的数据包的完整长度。接下来，就按照sizeBuffer的长度来读取数据包。

final int packetSize = calculatePacketSize();
final ByteBuffer packetByteBuffer = ByteBuffer.allocate(packetSize);
channel.read(packetByteBuffer)

如果能够读取完毕，那就是一个完整的数据包，我们将其放入到NetClient中的pendingPacketData队列中就可以了。如果实际读取的数据不完整，也就是出现了“半包”的情况，我们就只能将读取的数据放入到NetClient中的pendingByteBuffer中，并且还要设置该数据包的完整长度pendingPacketSize。

client.setPendingByteBuffer(packetByteBuffer);
client.setPendingPacketSize(packetSize);

这样，就又回到了刚刚开始的地方。我们要记住的就是，读取完整的数据包是放置在NetClient中的pendingPacketData队列中就可以了。

接下来，我们介绍ExecuteThread执行线程。他里面也有一个Set集合，里面同样存放着NetClient客户端对象。同时在线程中，还有一个PacketHandlerInterface子类，它用来对数据包进行游戏逻辑的处理。但是，在进行游戏逻辑处理之前，还需要对数据包进行解密。这就需要借助EncryptionInterface子类的实现。我们还是回到ExecuteThread线程中。首先就是循环遍历Set集合，然后获取到每一个NetClient客户端对象。然后获取一个完整的数据包，再对其进行解密，最后交给PacketHandlerInterface子类来处理。

final byte[] data = client.getPacketData().poll();
client.getEncryption().decrypt(data, 0, data.length);
_packetHandler.handle(client, new ReadablePacket(data));

最后我们来介绍一下NetServer服务端类，他里面持有ServerSocketChannel对象，可以监听指定的端口。在这个类里面，有两个重要的List列表对象，如下所示

protected final List<Set<E>> _clientReadPools = new LinkedList<>();
protected final List<Set<E>> _clientExecutePools = new LinkedList<>();

看名称就知道，一个是读取客户端列表，一个是执行客户端列表。两个列表里面存放的都是Set集合。这个Set集合里面放的就是NetClient客户端对象。而每一个Set集合会对应一个ReadThread读取线程或者ExecuteThread执行线程。我们可以这样理解，有两个列表，里面存放了很多的ReadThread读取线程或者ExecuteThread执行线程，每一个线程对应一个Set集合，这个Set集合里面放了一定数量的NetClient客户端对象。为什么要这样设计呢？其实非常的容易理解。我们处理客户端的请求，肯定是需要借助多线程的。所以，我们要实例化出来很多的线程，这些线程可以分为读取线程和执行线程两种。这些线程肯定要放到List列表中，或者使用线程池也是可以的。每一个线程不可能只处理一个NetClient客户端对象，那样就太浪费服务器端的资源了，所以每个线程都会处理一定数量的NetClient客户端对象。这些NetClient客户端对象就需要放置到Set集合中。这样就很容易理解了吧。

NetServer服务端类的主要代码是用来接收新的客户端链接，然后实例化NetClient客户端对象。然后将NetClient客户端对象放入到Set集合中。如果不存在Set集合的话，就实例化一个新的Set集合，同时在实例化一个读取或执行线程，将Set集合传递给该线程。最后将我们的Set集合放入到List中就行了。NetServer服务端类的代码就是这些了。

我们总结一下，客户端和服务器端的网络数据通信的代码位于commons\network目录下，它是封装好的公共模块。我们的loginServer和gameServer都要借助它才能实现数据通信。使用network包的方式就是继承里面的父类。例如，读取客户端的数据包类要继承ReadablePacket.java；而发送给客户端的数据包要继承WritablePacket.java；数据的加密解密要继承EncryptionInterface.java；处理游戏数据包要继承PacketHandlerInterface.java；客户端页要继承NetClient.java；服务器端同样要继承NetServer.java（也可以直接使用该类）。这里，我们没有介绍如何向客户端发送数据包，这个非常的简单，只需要调用NetClient客户端对象的SocketChannel通道对象的write方法即可。它的执行实际是在游戏数据包被实例化出来之后由一个线程来执行的。实例化的过程就是byte数据转化成类属性变量。这部分内容我们在后面的章节中再详细介绍。

本章节涉及的内容均已上传百度网盘：

https://pan.baidu.com/s/1XdlcCFPvXnzfwFoVK7Sn7Q?pwd=avd4

欢迎加企鹅交流裙：874700842（裙文件里面也可以下载所有内容）。