Skip to content

5-1.md

Latest commit

 

History

History
102 lines (85 loc) · 5.62 KB

5-1.md

File metadata and controls

102 lines (85 loc) · 5.62 KB

认识 NMS 和 OBC

nms，即 Java 包 net.minecraft.server，存放的是 Minecraft 服务端游戏逻辑代码，这篇教程将会采用 Spigot 作为 Bukkit API（就你们日常开发用的API） 体系的例子（CraftBukkit 也是 SpigotMC 维护，且基本所有 Bukkit 分支都是基于 Spigot 开发）

Spigot 的 NMS:
Spigot的nms

BukkitAPI 真的涵盖了不少东西，但是 BukkitAPI 并不是十全十美的，有时候我们确实需要使用 NMS。
Forge其实也有个net.minecraft.server，但他和Spigot的没半点关系

使用 NMS 之前

md_5： Wait! 你真的需要使用 NMS 吗？

NMS不是API。当你遇到什么想做的事情的时候，你不应该第一时间去考虑 NMS 或者 发包
令人费解的是，我们几乎每天都看到人们专门使用 NMS 做一些简单的事情，如 ScoreBoard、BossBar 或粒子。但是实际上，自从Mojang添加了这些东西之后，Spigot/Bukkit-API 早就有这些功能了。

每当你考虑使用 NMS 时，请思考以下问题：

  1. 我是否需要NMS来做这个？
  2. 是否有一个API来实现这个功能？
  3. 我可以为这个贡献/创建/ 提议 一个API吗？

对NMS的滥用造成的后果非常严重。

    1. 插件将失去版本迁移的能力（针对单个版本而言）
    1. 阻碍了 API 的发展并且树立了一个坏榜样。

如果你确实想清楚确实没有现有的 API 能帮到你，那么来...

怎么使用 NMS

NMS 里的内容太多，故本教程不会教授NMS有什么东西，但是可以教你怎么玩。

开发环境准备

如果你使用直接导入服务端核心到IDE里的方法，此章节可跳过
Tdiant竟然不在前面写怎么配置BukkitAPI开发环境的吗
通过在 IDE 中尝试自动补全可以判断是否有 NMS：
有NMS
如果没有且你正在使用 Gradle , Maven 这样的依赖管理器，考虑如下方法(图文):

  1. 添加源
  2. 打开 https://repo.codemc.io/#browse/browse:nms-local

获取到一个来自 API 背后的对象

当你从控制台直接输出一个 Player 对象时，会发生什么？
你会得到一个 CraftPlayer{name=玩家名}而不是NMS里面的EntityPlayer。这是因为在Bukkit-API背后还有一层，他叫OBC，也就是org.bukkit.craftbukkit。
OBC 是 Bukkit API 的实现，其本质是NMS的封装，因此我们并不需要太关心它。
就上文问题，怎么拿到一个 NMS 里面的 EntityPlayer?
首先我们需要使用反编译工具来看 CraftPlayer 对 EntityPlayer 做了什么..
CraftPlayer 将 EntityPlayer 传给了他的父类构造器，我们接着追踪..

还是在传！

经过一条不 是 很 长的继承链后，我们找到了 CraftEntity，看来 EntityPlayer 最后是被传道这里了！

注意：OBC里面的类 implements 的都是 BukkitAPI 的内容，不要搞混了!

然后往上翻，看看 entity 是什么情况。

他被protected了，这意味着只有继承树内或者同一个包里面才能访问到它，而这在NMS/OBC中是常有的事情。

反射！

我们很容易就可以写出这样的代码来获取到这个 entity 对象。

public static final String serverVersion = Bukkit.getServer().getClass().getPackage().getName().split("\\.")[3];
try{
  Player player = ....; // Who cares ?
  Class<?> clazz = Class.forName("org.bukkit.craftbukkit."+serverVersion+".entity.CraftEntity");
  Field f = clazz.getDeclaredField("entity");
  f.setAccessible(true);
  Object result = f.get(player);
}catch(Throwable t){
  t.printStackTrace();
}

现在 result 里面存的就是我们需要的 EntityPlayer，然后我们可以转换它...做点事情。
为什么要这么麻烦？其实下面的代码一样可以做到这个效果：

try{
  Player player = ....; // Who cares ?
  Field f = CraftEntity.class.getDeclaredField("entity");
  f.setAccessible(true);
  Object result = f.get(player);
}catch(Throwable t){
  t.printStackTrace();
}

甚至如果没有访问限制还可以一行搞定。

版本兼容性

实际上，如果你直接采用了 CraftEntity.class 的方法都会对这个 class 建立符号引用。
每个版本的 Spigot，无论是 OBC 或者 NMS，他们的包名都会变化——也就是说你的插件会爆炸
所以，如果你不想为了一个版本再把逻辑写一次，最好还是用反射的写法。对于公开的方法，也可以使用更高效的 MethodHandle。

如果你有注意到的话， md_5 说过 NMS 并不是一个API(其实也包括OBC)。
什么意思呢？也就是使用NMS没有任何安全性保障，你反射的字段/方法或许下一个版本就会被删改。
实例惨案： Minecraft 1.17 Spigot大改，使用 Mojang 官方混淆表，以往 NMS 插件全都报废。（除了一些自带兼容的服务端）

本章小结

  • NMS是net.minecraft.server，一个包名，放MC逻辑
  • Spigot的NMS没有安全保障，md_5 都不推荐用
  • 使用NMS之前要先找是否已经有了对应的 API
  • 在 Bukkit-API 和 NMS 之间还有一个实现，它叫 OBC。