Перейти к содержимому


- - - - -

Ведро с гайками

minecraft bukkit плагины

- Кто он такой, этот Bukkit потерпевший? Куда он пошел? Я его, говорит, первый раз вижу!
к/ф "Мимино"

По сути, оригинальный сервер minecraft, в общих чертах описанный в предыдущей статье, является "вещью в себе", ибо написан так, как было удобно разработчикам. Взаимодействие с внешними модулями сводилось к минимальному набору событий, свойства (объекты) класса объявлялись либо публичными (с полным доступом) либо с дефолтным доступом (на уровне пакета) либо приватными, причем делалось это, похоже, без всякой системы, по крайней мере, какой-то строгой логичной системы я в этом не уловил. Примерно так же обстояло дело и с доступностью методов. Обычный ООП-подход, когда объект (переменная) класса объявляется приватной, а доступ к ней осуществляется методами get() и set() практически не использовался. Ну и таких косяков был - вагон.

И вот группа социально активных граждан сбилась в шайку и сваяла свою серверную сборку, с интерфейсами и событиями.Назвала она свое творение... нет, не Bukkit, назвали это CraftBukkit. Все классы пакета org.bukkit.craftbukkit.v1_X_RY (окончание такое же, как и у соответствующего ему NMS) разложены по подпакетам (item, event, entity и т.д.) и представляют собой, по сути, обертки для оригинальных классов. Однако структура их гораздо более продумана, свойства (переменные) и методы классов имеют четкую прослеживаемую систему видимости и доступа. Все что нужно (ну, почти все) доступно через соответствующие методы getXXX() и setXXX(). Доступ к оригинальному объекту NMS осуществляется [как правило] через метод getHandle(), причем этот оригинальный NMS-объект создается одновременно с соответствующим ему объектом CraftBukkit.
Основным достижением данной модификации сервера майна является серьезная переработка серверного цикла: была проведена серьезная работа по оптимизации обработки чанков, сущностей, обмена с клиентской частью. Переработан компонент спавна мобов, в бакките тысячи мобов уже не являются проблемой для сервера. Также под это дело появились дополнительные настройки в собственном конфигурационном файле (bukkit.yml). Однако с точки зрения разработчика плагинов главная заслуга баккитовцев не в этом. Главное, что они сделали - это сконструировали великолепный механизм взаимодействия (Bukkit API) между плагинами и сервером. Хотя, надо сказать, сделали они это несколько странным способом: создали в пакете org.bukkit дополнительную иерархическую структуру с интерфейсами, которые полностью повторяют своими названиями классы в пакете org.bukkit.craftbukkit.v1_X_RY, только не имеют в названии префикс <Craft>. То есть, класс CraftEntity из пакета org.bukkit.craftbukkit.v1_X_RY.Entity наследует интерфейс Entity из пакета org.bukkit.Entity, причем все события и методы работают именно с объектами Entity, по сути, с интерфейсами. Умом я понимаю, что это связано с ограниченностью явы в плане множественного наследования классов, но в душе воротит от такой двойной бессмысленной работы.

Что еще ощутимо напрягает, так это методы, которыми действуют (а может - уже "действовали") "баккитовцы": баккит не является в чистом виде надстройкой над NMS, как, казалось бы, должно быть при строгом следовании принципам ООП, он с NMS образует чудную мешанину из кода, вызовы идут не только сверху вниз, как обычно происходит, в коде классов NMS не менее часто встречаются вызовы "наверх", к методам баккита. Особенно часто это происходит в ключевых точках генерации событий (баккитовских). В принципе, логика этого явления понятна: если у исходного продукта (NMS) нет достаточного количества контрольных точек (событий), к которым можно "прицепиться" для обработки тех или иных ситуаций, нет другого пути, кроме как вручную формировать такие точки, меняя напрямую его код. Однако методы, с помощью которых это было достигнуто, вызывают иногда по меньшей мере удивление. Хотя, нам тут просто сидеть и рассуждать - как оно на самом деле надо было сделать, и как бы мы на самом деле сделали все гораздо лучше (быстрее, дешевле - нужное подчеркнуть).

Собственно, вот эта самая совокупность интерфейсов из пакета org.bukkit, уже, как видно из названия, изолированная от версии NMS, и соответствующий им набор классов org.bukkit.craftbukkit.v1_X_RY, все еще привязанный к конкретному NMS, и называются Bukkit, он же баккит, он же ведро - прошу любить и жаловать. По сути, его же можно называть и CraftBukkit, что иногда и делают, хотя идеологически это все же немного разные вещи: CraftBukkit является модернизацией оригинального майнкрафт-сервера, а Bukkit является программным интерфейсом (API), связующим звеном между сервером и плагинами. Однако все уже давно привыкли рассматривать это как единое целое и привычно используют термин Bukkit.

Вообще, главное богатство баккита заключается не в том, что он завернул все оригинальные классы в красивую обертку, а в том, что у него имеется огромное количество разного типа событий (несколько десятков), генерируемых сервером (теперь уже под управлением баккита) ежесекундно, и сообщающих о возникновении разного рода ситуаций. Теперь любой плагин может зарегистрировать на сервере свой обработчик событий нужного типа и выполнять какие-нибудь действия по возникновению оного. Это покрывает 99% всех потребностей плагинописателей, есть множество вполне серьезных плагинов, которые даже не лезут глубже баккитовских интерфейсов и событий.

Зачем же люди морочатся с низкоуровневым доступом к объектам NMS, рискуя заработать несовместимость своего плагина с будущими версиями сервера? Дело в том, что даже баккит, при все богатстве его средств, не всегда может обеспечить полный спектр, так сказать, услуг и сервиса. Например, в нем до сих пор нет нормального интерфейса для работы со сделками торговца-непися, нет возможности отправить клиенту кастомный пакет, многие характеристики сущностей также доступны только средствами NMS. Поэтому волей-неволей периодически приходится лезть на уровень NMS и добывать информацию оттуда. Делается это, как уже было сказано выше, через метод getHandle():
void process(Entity entity)
{
CraftEntity ce= (CraftEntity)entity;
net.minecraft.server.v1_8_R3.Entity handle= ce.getHandle();
if (handle instanceof net.minecraft.server.v1_8_R3.Entity)
{
...
}
}

То есть, сначала объект приводится к классу CraftBukkitа, соответствующему данному интерфейсу, а уж затем для полученного объекта пытаемся получить соответствующий ему NMS-объект. Желательно при этом проверять полученный результат на "вшивость", дабы не получить исключение со всеми вытекающими. Можно, в принципе, опустить эту проверку, поскольку баккитовский объект в отрыве от соответствующего ему NMS-объекта - это нонсенс. Но береженого, как говорится, бог бережет. Тем более, что сам баккит именно так и делает внутри методов своих классов. Отдельно нужно отметить, что иногда (в редких случаях) нет прямого соответствия классов баккита и NMS и, соответственно, у такого класса нет метода getHandle(), либо он может называться иначе. Исходники вам в помощь, бесценный кладезь информации по программированию на яве вообще и по устройству майнкрафтовского сервера в частности.

Самое интересное, что на этом дело не закончилось. Компания еще более ушлых товарищей решила, что баккит уже не торт, и запилила свою сборку на его основе, назвав ее Spigot. С потоками и таймингами. Функционально они добавили всего-ничего, но вот оптимизировали они его еще более серьезно, добавив по сложившейся традиции в систему еще один конфиг-файл spigot.yml, в котором также имеется куча настроек по дальнейшему тюнингу системы. Особенно хорошо преимущества спигота раскрываются на многопроцессорных системах и с хорошим онлайном.

А потом, в один прекрасный день, баккит как-бы приказал жить долго и счастливо. По крайней мере, народ высказал свое твердое и категоричное "фи" на известную тему (см. Страсти по ведру, еще и еще). А потом, после слива толстого небритого мужика в дурацкой шляпе и продажей всего нажитого жадному Билли дела и вовсе пошли по известному маршруту. В итоге компания негодующих активистов объединилась для создания мегамодификации мейнкрафт-сервера под названием Sponge (губка) на основе не менее легендарной системы тюнинга клиента майнкрафта Forge. Обещают задвинуть и баккит и спигот (тем более, что спиготовцы, вроде как, тоже решили поучаствовать в гешефте). Что они там наваяли еще не видел, но боюсь даже представить, во что выльется переделка всех написанных плагинов под новый API. Но, похоже, рано или поздно сделать это все равно придется.

Кстати, об исходниках. Поскольку исходных кодов ни NMS ни баккита в свободном доступе нет и не предвидится, приходится как-то выкручиваться. Для выкручивания используется обычно маленькая, но гордая весьма полезная утилита FernFlowe. Я использую ее с небольшим патчиком, который исправляет кое-какие огрехи декомпиляции сложных классов. Пропатченный FernFlower можно скачать с нашего сайта. Утилита консольная, поэтому для декомпиляции jar-файлов использую обычно командный файл такого вида:
java -jar fernflower.jar %1 decomp\
pause
Как видно из примера, в каталоге с утилитой необходимо создать подкаталог decomp/. После этого перетаскиваем мышью (в винде, конечно) jar-файл, который нуждается в декомпиляции, на командный файл, в результате чего тот стартует и запускает утилиту fernflower.jar, передавая ему в качестве параметра декомпилируемый файл. Утилита шуршит некоторое время, захламляя черный экран белыми букафками, а затем в каталог decomp/ скидывает декомпилированный файл (с тем же именем и тем же расширением), в котором все файлы типа .class заменены декомпилированными файлами типа .java. Обычно я сразу распаковываю полученный jar с исходниками в каталог decomp/, в результате получаю каталог с именем исходного файла и набором распакованных исходников в нем. Очень удобно копаться, не нужно каждый раз лазить в архив.

Первое, что вы должны декомпилировать, будет сам баккит (bukkit.jar), либо spigot.jar, если вы используете данную модификацию. Процесс это неппыстрый, минут 20 на покурить-оправиться у вас точно будет. Зато потом вы получите неплохой справочник по внутренностям вашего сервера, причем в текущей рабочей версии. Поверьте, это вам не раз еще пригодится для понимания особо сложных моментов. Кроме того, с помощью данной утилиты я частенько декомпилирую различные плагины (не всегда удается добыть исходники, да и иногда проще закинуть его на декомпиляцию, чем искать их в инете, благо обфускацию из плагинописателей почти никто не использует) на предмет посмотреть - как оно там все устроено унутре. Очень познавательное чтиво, надо сказать - почерпнул много ценных идей, чего и вам желаю.

В общем, баккит - зло, но меньшее из имеющихся. Работать с ним можно и нужно. И совсем неплохо было бы уметь это делать.
- У меня вопрос к свидетелю, можно? Спасибо. Скажите, подсудимый испытывал личную неприязнь к потерпевшему?
- Да, испытывал... Он мне сказал: "Такую личную неприязнь я испытываю к потерпевшему... что кушать не могу!"
к/ф "Мимино"

В следующий раз, наверное, слегка затронем конфигурационные файлы (yml и json) и перейдем непосредственно к плагинам.
  • Поблагодарили: aleksey_t и Frank


3 Комментарии

Декомпиляция конечно хорошо, но так-же и всегда полезно иметь под рукой и исходные коды баккита с комментариями разботчиков. На днях скачал себе репозиторий со снапшотами и исходниками. Когда нашел их, был очень рад.

Декомпиляция конечно хорошо, но так-же и всегда полезно иметь под рукой и исходные коды баккита с комментариями разботчиков. На днях скачал себе репозиторий со снапшотами и исходниками. Когда нашел их, был очень рад.

Сразу вспомнилось: :)

 

- Я никак не могу понять, Хаус, зачем нужно брать порно в прокате, если можно просто скачать его в интернете?!

- Но тогда не увидишь "Фильм о фильме" с комментариями режиссера!

 

А какой версии там снапшоты? И что, собственно? NMS чистый или баккит или спигот? Опять же, если там исходники, то скорее всего с деобфускацией методов, а значит придется вручную искать соответствие переименованным методам в финальных джарах. В общем, интерес скорее энтомологический, на предмет посмотреть "как оно там унутре". А насколько вообще доступен этот репозиторий (в смысле лицензионности)?

Сразу вспомнилось: :)

 

А какой версии там снапшоты? И что, собственно? NMS чистый или баккит или спигот? Опять же, если там исходники, то скорее всего с деобфускацией методов, а значит придется вручную искать соответствие переименованным методам в финальных джарах. В общем, интерес скорее энтомологический, на предмет посмотреть "как оно там унутре". А насколько вообще доступен этот репозиторий (в смысле лицензионности)?

Вы можете и сами на всё взглянуть
http://repo.mikeprimm.com/

Меня интересовали исходники для версии 1.5.2 и к моему удивлению они нашлись. Имеется: bukkit, craftbukkit и куча другого барахла о существовании которого я даже не знаю. Найти исходники для того-же Spigot для 1.5.2 мне пока не удалось. Декомпиляция решает некоторые вопросы, но для меня с моим опытом не вариант. Попытавшись перекомпилировать таким образом полученный плагин я его только сломал.

В смысле лицензионности это определенно "DCMA takedown".

 

Видимо я был пьян когда писал данный ответ и из исходников там только bukkit-1.4.7. Остальное же всё, снапшоты