自定义网络包
在这节中我们将要来学习如何自定义数据包。在之前的内容中我们已经讲过了如何利用Minecraft原版内置的功能来实现数据的同步，但是这些功能或多或少都有限制。在某些时候我们不得不自己来解决数据同步的问题，在这时我们就得使用自定义数据包了。幸运的是Forge已经提供了一个类，让我们能够简单而且方便地自定义数据包，这个类就是SimpleChannel，我们将学习如何使用它。
这一节的内容可能有些无聊，因为我们做出的物品并不能在游戏中产生实际的效果，但是这不代表的这节的内容不重要，让我们开始吧。
首先我们讲一下发包的过程，具体过程如下:
构建数据包=>序列化成字节流 ====通过本地、局域网传输或者因特网传输===> 反序列化成实例 => 实现操作
在这个过程中，前两项是在你要发送包的端执行的，后两项是在你要接受包的端执行的。
无论你是想从客户端往服务端发包，还是从服务端往客户端发包，你要做的第一件事就是——构建数据包，这个数据包就是你要发送的具体消息。接下来是序列化成字节流，因为在网络中所有的数据都是以字节流的形式传输的，你的数据包也不例外，而又因为数据包的内容是你自己定义的，你得自己实现序列化操作。
接下来数据流已经传输到了接受包的一端，你在接受时，接收的同样也是字节流，你需要从字节流中获取数据并恢复数据，重建你的数据包。让你的数据包恢复成功，接下来你就可以利用这些数据来执行操作了。
在Mod开发里，所有的数据包都是通过SimpleChannel管理的，正如这个名字暗示的那样，我们构建的数据包将通过一个个自定义的「Channel（频道）」传输。
接下来我们来注册数据包Networking:
package com.tutorial.neutrino.network;
import net.minecraft.util.ResourceLocation;
import net.minecraftforge.fml.network.NetworkRegistry;
import net.minecraftforge.fml.network.simple.SimpleChannel;
public class Networking {
public static SimpleChannel INSTANCE;
public static final String VERSION = "1.0";
private static int ID = 0;
public static int nextID() {
return ID++;
}
public static void registerMessage() {
INSTANCE = NetworkRegistry.newSimpleChannel(
new ResourceLocation("neutrino", "first_networking"),
() -> {
return VERSION;
},
(version) -> {
return version.equals(VERSION);
},
(version) -> {
return version.equals(VERSION);
});
INSTANCE.registerMessage(
nextID(),
SendPack.class,
(pack, buffer) -> {
pack.toBytes(buffer);
},
(buffer) -> {
return new SendPack(buffer);
},
(pack, ctx) -> {
pack.handler(ctx);
}
);
}
}
INSTANCE = NetworkRegistry.newSimpleChannel(
new ResourceLocation("neutrino", "first_networking"),
() -> {
return VERSION;
},
(version) -> {
return version.equals(VERSION);
},
(version) -> {
return version.equals(VERSION);
});
首先我们创建了一个SimpleChannel的实例，这个实例就是我们之后发包时需要操作的对象。
他有如下几个参数，第一个参数ResourceLocation是这个SimpleChannle的唯一标识符，因为一个mod里可以有许多个传送数据用的SimplieChannle，所以需要这个标识符。第二个参数是个匿名函数，返回值是数据包的版本，第三、四个参数是用来控制客户端和服务端可以接收的版本号的，这里的version就是具体的版本号，我们在这里判断是否和当前的版本号相同。如上我们的频道就已经构建完成了。
接下来我们来注册数据包。
INSTANCE.registerMessage(
nextID(),
SendPack.class,
(pack, buffer) -> {
pack.toBytes(buffer);
},
(buffer) -> {
return new SendPack(buffer);
},
(pack,ctx) ->{
pack.handler(ctx);
}
);
这个注册方法有5个参数，我们一一来说明，第一个参数是数据包的序号，这个数据包序号不能重复，所以我们写了一个自增的函数来提供序号。第二个是一个类，这个类就是我们要自定义数据包的类，第三个参数是用来让我们序列化（把数据包实例转换成字节流）我们的数据包，这里我们不需要返回任何值，其中的pack参数就是我们第二个参数中提供的类的一个实例。第四个参数是用来反序列化数据包的（从字节流构建数据包实例），这里我们直接调用了一个特殊的构造方法，然后返回了实例。最后一个参数是用来当接受到数据之后进行一系列操作的，这里的ctx是用来进行线程安全操作用的，至于是什么我们之后再讲。
当然像上面那样写实在过于麻烦，其实你可以省略成下面的形式。
public class Networking {
public static SimpleChannel INSTANCE;
private static int ID = 0;
public static int nextID() {
return ID++;
}
public static void registerMessage() {
INSTANCE = NetworkRegistry.newSimpleChannel(
new ResourceLocation("neutrino" + ":first_networking"),
() -> "1.0",
(s) -> true,
(s) -> true
);
INSTANCE.registerMessage(
nextID(),
SendPack.class,
SendPack::toBytes,
SendPack::new,
SendPack::handler
);
}
}
但是为了读者的理解方便，我还是保留上面的形式。
接下来就是我们自定义的数据包了SendPack.java:
public class SendPack {
private String message;
private static final Logger LOGGER = LogManager.getLogger();
public SendPack(PacketBuffer buffer) {
message = buffer.readString(Short.MAX_VALUE);
}
public SendPack(String message) {
this.message = message;
}
public void toBytes(PacketBuffer buf) {
buf.writeString(this.message);
}
public void handler(Supplier<NetworkEvent.Context> ctx) {
ctx.get().enqueueWork(() -> {
LOGGER.info(this.message);
});
ctx.get().setPacketHandled(true);
}
}
首先toBytes方法和SendPack(PacketBuffer buffer)构造方法刚好是一对相反的方法，它们的作用我们之前已经提及，这里就不加赘述了。值得一说的是PacketBuffer下面提供了很多非常方便的方法来序列化基本类型，以及在有多个变量序列化时，你得保证这两个方法中调用这些变量的顺序是相同的。请注意查看一下你调用的方法是不是物理客户端独有的（也就是有没有加@OnlyIn(Dist.CLIENT)注释)。
然后就是handler方法，这个方法的作用就是在接收端接收到数据以后，如何使用这些数据。请注意，你必须把这里的执行操作放在ctx.get().enqueueWork这个方法内，以闭包的形式呈现。并且在执行完成后需要加上ctx.get().setPacketHandled(true);表示执行成功。之所以这么做，是因为接受网络数据处在一个独立的线程中，所以网络包的执行需要等待时机，在线程安全的情况下执行。在这里我们只是简单的创建了一个Logger然后调用这个Logger输出了内容。
最后还剩下的构造方法是是用来构建发送数据用的。
当然光创建了Channel和网络数据包还不够，我们在游戏启动时创建它。
CommonEventHandler.java:
@Mod.EventBusSubscriber(bus = Mod.EventBusSubscriber.Bus.MOD)
public class CommonEventHandler {
@SubscribeEvent
public static void onCommonSetup(FMLCommonSetupEvent event) {
Networking.registerMessage();
}
}
你需要在Mod总线中的FMLCommonSetupEvent这个生命周期方法中创建你的Channel。
接下来看一个实例，如何从客户端向服务端发送数据，以及从服务端向客户端发送数据。
ObsidianMessage:
public class ObsidianMessage extends Item {
public ObsidianMessage() {
super(new Properties().group(ModGroup.itemGroup));
}
@Override
public ActionResult<ItemStack> onItemRightClick(World worldIn, PlayerEntity playerIn, Hand handIn) {
if (worldIn.isRemote) {
Networking.INSTANCE.sendToServer(new SendPack("From the Client"));
}
if (!worldIn.isRemote) {
Networking.INSTANCE.send(
PacketDistributor.PLAYER.with(
() -> {
return (ServerPlayerEntity) playerIn;
}
),
new SendPack("From Server"));
}
return super.onItemRightClick(worldIn, playerIn, handIn);
}
}
可以看到这里重要的是onItemRightClick方法。
在这个方法里，主要分成了服务端和客户端两个逻辑。
在服务端逻辑里非常简单我们通过Networking.INSTANCE.sendToServer方法向服务端发送了数据，其中new SendPack("From the Client”)就是数据包的具体内容。
在服务端里稍微有些复杂，因为一个服务端有可能有多个客户端链接，所以你必须要明确你需要向哪一个客户端发送消息。
PacketDistributor.PLAYER.with(
() -> {
return (ServerPlayerEntity) playerIn;
}
)
作用正是这个，我们确定了要向右击了这个物品的玩家发送消息。PacketDistributor类下除了有PLAYER这个类型还有很多其他的发送数据的方式，大家可自行探索。
打开游戏，右击物品，你应该就能看见客户端和服务端接收到对方的消息了。
注：「Server Thread」是服务端，「Render Thread」是客户端。
编程小课堂
在任何开始接触一个你不熟悉的编程项目，你要做的第一件事永远是通读这个项目的文档（如果有的话），对于我们来说就是Forge的文档，介于读者可能看不懂英文文档，Forge文档也有中文翻译的，请自行搜索。