本帖最后由 耗子 于 2018-8-3 11:13 编辑

简单网络通信包装类(SimpleNetworkWrapper)——简单地进行网络通信

在实际开发过程中，我们常常需要用到网络通信。用到网络通信的地方有很多，例如按下按键释放技能，同步玩家属性，监听图形界面按钮按下，让客户端播放特效等等。那么怎么样进行网络通信呢？

简单网络通信包装类 SimpleNetworkWrapper

为了方便的进行网络通信，Forge提供一个简单的网络通信包装类——SimpleNetworkWrapper。这个类位于net.minecraftforge.fml.common.network.simpleimpl包下。

那么，怎么使用这个类呢？首先我们需要获取一个SimpleNetworkWrapper对象。

  1. NetworkRegistry.INSTANCE.newSimpleChannel(channel);
复制代码

在此解释一下channel(频道)参数，该参数是一个字符串(String)，表示网络通信频道名，只有在相同的频道，数据才能互相传输。

以上代码可以获取到一个SimpleNetworkWrapper对象，然后我们将这个对象储存至一个静态字段中以便在模组的任何地方调用，比如这样：

  1. @Mod(modid = ChinaCraft.MODID, name = ChinaCraft.NAME, version = ChinaCraft.VERSION)
  2. public final class ChinaCraft {
  3.     public static final String MODID = "chinacraft";
  4.     public static final String NAME = "ChinaCraft 2";
  5.     public static final String VERSION = "0.0.1";

  7.     private static SimpleNetworkWrapper network;

  9.     @EventHandler
  10.     public void init(FMLInitializationEvent event) {
  11.         network = NetworkRegistry.INSTANCE.newSimpleChannel(MODID);
  12.     }

  14.     public static SimpleNetworkWrapper getNetwork() {
  15.         return network;
  16.     }
  17. }
复制代码

这样，我们就可以使用ChinaCraft.getNetwork()方法在模组的任何地方调用SimpleNetworkWrapper对象了。

消息类和消息处理类

接下来，我们开始编写我们的消息类和消息处理类。消息类需要实现IMessage接口，该类必须要有一个无参构造方法，并且需要实现fromBytes和toBytes方法。

  2. public class RedPacketMessage implements IMessage {

  4.     public RedPacketMessage() {} //必须要有一个无参构造方法

  6.     @Override
  7.     public void fromBytes(ByteBuf buf) {} //将字节流转换为信息

  9.     @Override
  10.     public void toBytes(ByteBuf buf) {} //将信息转换为字节流
  11. }
复制代码

可以看到，fromBytes和toBytes方法都有一个ByteBuf类型的参数，ByteBuf类中提供了很多read和write方法，那么我们该如何使用呢？举个例子：

  1. public class RedPacketMessage implements IMessage {

  3.     private String sender;

  5.     public RedPacketMessage() {}

  7.     public RedPacketMessage(String sender) {
  8.         this.sender = sender;
  9.     }

  11.     @Override
  12.     public void fromBytes(ByteBuf buf) {
  13.         char chars[] = new char[buf.readInt()]; //读取字符串长度
  14.         for(int i=0;i<chars.length;i++) //读取字符
  15.             chars = buf.readChar();
  16.         sender = String.valueOf(chars); //创建字符串对象
  17.     }

  19.     @Override
  20.     public void toBytes(ByteBuf buf) {
  21.         buf.writeInt(sender.length()); //写入字符串长度
  22.         for(char c:sender.toCharArray()) //写入字符串
  23.             buf.writeChar(c);
  24.     }
复制代码

提示：可以看到ByteBuf类有些不方便使用，所以可以使用MC实现的PacketBuffer类和Forge提供的ByteBufUtils类。
接下来，我们需要为这个消息编写一个处理类，来处理收到的消息，消息处理类需要实现IMessageHandler接口，并且需要实现onMessage方法。此外，该接口还是一个泛型接口，拥有两个泛型形参REQ extends IMessage和REPLY extends IMessage，其中REQ表示收到的消息类，REPLY表示回复的消息类。

  1. public class RedPacketMessageHandler implements IMessageHandler<RedPacketMessage, IMessage> {

  3.         @Override
  4.         public IMessage onMessage(RedPacketMessage message, MessageContext ctx) {
  5.             return null; //当你不需要回复消息时，可以将REPLY填写为IMessage，并且返回null;
  6.         }
  7. }
复制代码

接下来，我们需要将消息类和消息处理类注册到SimpleNetworkWrapper对象中。

  1. network.registerMessage(handler,message,id,side);
复制代码

解释一下registerMessage方法的四个参数，第一个参数handler需要一个IMessageHandler对象，第二个参数message则是对应的消息类的类对象，第三个参数id表示该消息的id，范围为0~255，且不得重复，第四个参数side表示收到消息的对象，Side.SERVER表示消息由客户端发送，服务器接收，Side.CLIENT表示消息由服务端发送，客户端接收。

发送消息

那么，注册好了以后我们怎么发送消息呢？SimpleNetworkWrapper类实现了五个发送方法，分别有不同的作用。

  2.     /**
  3.      * 发送消息给所有玩家（服务端调用该方法）
  4.      */
  5.     public void sendToAll(IMessage message)

  7.     /**
  8.      * 发送消息到指定玩家（服务端调用该方法）
  9.      */
  10.     public void sendTo(IMessage message, EntityPlayerMP player)

  12.     /**
  13.      * 发送消息到指定范围内的所有玩家（服务端调用该方法）
  14.      */
  15.     public void sendToAllAround(IMessage message, NetworkRegistry.TargetPoint point)

  17.     /**
  18.      * 发送消息到指定世界内的所有玩家（服务端调用该方法）
  19.      */
  20.     public void sendToDimension(IMessage message, int dimensionId)

  22.     /**
  23.      * 发送消息到服务器（客户端调用该方法）
  24.      */
  25.     public void sendToServer(IMessage message)
复制代码

例如：

  1. ChinaCraft.getNetwork().sendToServer(new RedPacketMessage());
复制代码

ByteBufUtils优化的字符串处理

  1. public class RedPacketMessage implements IMessage {

  3.     private String sender;

  5.     public RedPacketMessage() {}

  7.     public RedPacketMessage(String sender) {
  8.         this.sender = sender;
  9.     }

  11.     @Override
  12.     public void fromBytes(ByteBuf buf) {
  13.         sender = ByteBufUtils.readUTF8String(buf);
  14.     }

  16.     @Override
  17.     public void toBytes(ByteBuf buf) {
  18.         ByteBufUtils.writeUTF8String(buf,sender);
  19.     }
复制代码

本篇教程到这就结束了，感谢您的阅读。
本教程来自ChinaCraft2代码详解——大型模组开发笔记    Github

欢迎各位支持作者，以编写和翻译更多优秀教程。
[afd]mouse[/afd]