返回首页

Lode.Api:为什么要开发它

0x0 Lode.Api 是什么

Lode.Api 是一个用于 Nukkit/Bukkit(like)(1) 服务器的插件。提供了访问服务器各种数据和功能的 Http Api 接口。你可以通过这些接口来制作网站、App,以及提供让玩家在线购买物品并且在游戏中自动接收相关物品的能力。

(1):Bukkit Like - 基于 Bukkit 或 Bukkit 相兼容的服务端,譬如 Spigot、Paper 等。

0x1 初衷篇

关于开发 Lode.Api 的初衷要追溯到七八年前,我第一次接触 MineCraft 这款游戏开始说起了。当年还是高中生的我疯狂的迷恋上上了 MineCraft 这款充满创造力的游戏,为了能和朋友一起愉快的玩游戏,一步步开始摸索从租用 VPS 到搭建 MC 服务器再到各种插件和 MOD 的安装修改等,想来那时候我竟然还是个充满干劲的人,可以研究插件什么的到半夜。

后来有了一定的开服经验后为了维持服务器的生计,我又走上了当 MC 主机商的行当,也就是出租 MC 服务器给其他想开服的玩家并且代为提供维护服务。从这就开始有了远程管理 MC 服务器的问题:因为 MC 服务端是一个个运行在服务器上的程序,如果购买我们服务器的玩家想自行进行一些命令行的操作或者上传插件之类的话,就很难达到需求。我们不可能把远程桌面或者 SSH 的权限给客户,只能尽量及时响应客户的工单请求。

直到我发现了一个叫 RemoteToolkit 的插件,它可以通过 Telnet 的方式让客户连接到自己对应的命令控制台进行操作,再搭配上分配权限的 FTP 账号,也算是暂时解决了这个问题。

但是随着客户的增加,又有新的问题出现:客户如果误删除了什么文件或者客户是个完全不懂如何使用 Telnet 的小白,那么这种比较原始的管理办法对他们来说就显得很鸡肋。那么有没有更好的解决方案呢,能让客户方便快捷且没有风险的对自己的服务器进行管理?谷歌一番之后我发现了比较满意的解决方案——各种控制面板,其中以 MulticraftMcMyAdmin 为代表。但是问题是:它们是要付费的,并且还是需要国际支付渠道,当时的我还搞不明白怎么通过国际支付渠道去购买,并且当年这俩货的安装配置还是略显复杂。

这时候 JSONAPI 出现了,它也是我现在开发 Lode.Api 的灵感。JSONAPI 是一个可以通过 Http 或 Socket 调用接口对服务器进行管理的插件。其所提供的众多接口也算是满足了基本管理的需求,我靠当年仅有的一点编程技术制作了基于 JSONAPI 的 SimplePanel 以及其后继 SeanPanel(因为年久失修已经找不到当时的信息了……)。这俩靠着百度谷歌找代码示例进行拼拼凑凑的作品也算是我第一次认真的基础了变成,说起来也算是我从电脑爱好者到编程爱好者的桥梁呢。

靠着 JSONAPI 和我写的控制面板,我当年也算在 MC 服务器商领域小有名气并且赚了人生第一桶金。我记得当时有一个月营业额达到 9K 多,利润的话也有个四五千,这在当时还是学生的我来看真是一笔大钱。不过随着后来面临着人生的一些抉择以及同行低价策略的围攻,我也逐渐放弃了这门生意,顺带着也慢慢离开了 MineCraft 这款游戏。

一直到 2017 年,无意中又在 Windows 10 自带的 Microsoft Store 上看到了微软重制的 UWP 版 MineCraft (曾经的 MineCraft PE 也就是现在的 基岩版 MineCraft),我又购买了这款游戏想着趁着工作之余可以娱乐一下。不过在了解基岩版 MC 开服的途径后,我发现因为服务端和 PC 版 MC 的割裂以及 JSONAPI 未更新对 PocketMine(一款基岩版 MC 的服务端)的支持,所以管理起来并不方便,于是我只是在单机模式下自娱自乐一下。直到 2018 年,我发现了一个新的基岩版 MC 服务端 Nukkit,Nukkit 基于 Java 并且 API 架构和 PC 版 MC 服务端 Bukkit 类似(而 PocketMine 是基于 PHP 开发的),可以方便的开发插件,于是便萌生了开发一款能用于 Nukkit 的管理插件的想法。

毕竟此时我已经步入秃头程序员行列多年,已经有了阅读并理解 JSONAPI 源代码的能力,在拜读了 JSONAPI 的代码后,我发现 JSONAPI 的代码结构略为混乱,并且调用 API 的方式过于繁琐,对基于 JSONAPI 进行二次开发的用户不太友好(天知道当年我是踩了多少坑才做了 SimplePanel 和 SeanPanel)。所以我便放弃了将 JSONAPI 移植到 Nukkit 的想法,转而决定继承 JSONAPI 的通过 Http 对服务端进行管理的思想开发一款新的插件。

因为工作繁忙加上近几年拖延症愈发严重,拖拖拉拉到今年(2019年)八月我才实际开始动工。本来是想实现一套完整的 RESTful 风格的 API 调用风格。但是在架构搭建到一半的时候我意识到我为了在最简代码的情况(不引入 Spring 等第三方包,只使用 JDK 自带 API)下搭建 RESTful API 响应框架浪费的时间太多了,完全背离了插件管理服务端的开发初衷,而更像在从头做一个 Web 框架一样。所以权衡之下,我决定发放弃对 API 接口进行 RESTful 风格化的想法,而是转为通过全部 API 使用 POST 方法并在 Body 中传输需要的数据这种可以迅速开发并且满足插件需求的方法。事实证明,这节省了我不少时间也对插件功能没什么影响。

截止到今天,Lode.Api 已经发布了三个测试版本,并且有了一些服主在使用。接下来我会把插件的开发思路和开发中遇到的问题整理成一系列的文章,这篇就作为《初衷篇》告一段落吧。