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


- - - - -

Эклипсом по баккиту

плагины bukkit eclipse

Ударим автопробегом по бездорожью и разгильдяйству!
И.Ильф, Е.Петров "Золотой теленок"

Почти уверен, что уже вполне назрел сакральный вопрос: "А когда мы приедем?" (с). Отвечаю не менее шаблонно: "Приедем, когда приедем!" (с). Прежде чем приступить к собственно написанию этих самых плагинов, необходимо ответить на не менее важный вопрос - "А на чем (в чем) их писать?". Конечно, брутальные пацаны сейчас закидают меня тухлыми пингвиньими яйцами и скажут, что писать нужно в текстовом редакторе (конечно же, консольном), компилить и собирать - с помощью трехэтажной консольной конструкции, а если чего-то непонятно - RTFM (идти читать этот чертов мануал). До сих пор поражаюсь, почему они не пишут все исключительно на ассемблере?

На самом деле, все уже украдено написано до нас. Для написания плагинов используется все та же ява, на которой написаны и NMS и баккит. А под нее, в свою очередь, создано порядочное количество различных IDE (сред разработки), позволяющих, слава КПСС, обойтись без использования консольных команд. Большинство использует великолепную вещь, именуемую Eclipse(Эклипс). Работает она во всех распространенных операционных системах, имеет множество средств контроля корректности кода, а самое главное - собирает проект, благодаря специально системе компиляции, предельно быстро.
Дабы не изобретать велосипед, дам лучше ссылку на прекрасную статью Пишем простой плагин для Bukkit за авторством DmitriyMX, в которой он простыми русскими буквами описал в том числе и процесс установки и первоначальной настройки Эклипса. В свое время осваивал сей процесс именно по этой статье, не вижу причин, почему бы вам не сделать то же самое. К сожалению, некоторые моменты (и ссылки) в статье уже устарели, но в общем и целом она пока является вполне годным материалом для новичков.

Тезисно изложу некоторые основные моменты:


1. Эклипс качается в виде инсталлятора (для пользователей Windows, предпочтительно 64-битный - если позволяет система). Запускается, в открывшемся списке выбирается первый пункт (что-то вроде "Eclipse IDE for Java developers"). Далее выбирается версия среды (Eclipse - "затмение", поэтому названия разных версий посвящаются тому или иному объекту на небесной тверди), указываются путь установки, путь к установленному JRE. После этого производится непосредственно установка среды.
2. При первом запуске Эклипса вас попросят определиться с т.н. рабочим пространством (Workspace), то есть, указать каталог, где в дальнейшем будут размещаться ваши проекты. Надеюсь, вы достаточно опытны, чтобы не кидать все это на рабочем столе или в каталоге с установленным Эклипсом? Выделите под это дело отдельный каталог на диске D, например, d:\Projects\ - и искать будет проще, и меньше риска, что в один прекрасный солнечный день вы начнете биться головой об угол двери, когда ваша винда (да, вышесказанное относится в основном к счастливым обладателям продукта от дяди Билли) прикажет жить долго и счастливо.
3. Желательно в настройках среды (Window->Preferences) включить нумерацию строк в текстах исходных файлах (раздел General->Editor->Text Editors, галочка "Show line numbers"), а также в разделе General->Workspace установить кодировку по-умолчанию (в "Text file encoding" выбрать "UTF-8") - это позволит вам в дальнейшем избежать проблем с русскими символами при запуске ваших плагинов. Я обычно еще в разделе General->Editors->File associations добавляю расширения "*.properties", "*.yml" и "*.json", которым в качестве дефолтного текстового редактора назначаю Notepad++.


Теперь пару слов о том, куда будет складываться конечный результат, то есть откомпилированный jar-файл плагина. Падать он должен в папку plugins/ вашего сервера. А какой версии должен быть сервер, спросите вы? В идеале - самой новой (1.8.8 на момент написания статьи). Однако на деле это часто зависит от того, какая версия используется на вашем рабочем сервере.

А сколько вообще нужно серверов? Тут тоже одной фразой не ответишь. Если вы пишете плагины исключительно для собственного сервера, то их должно быть как минимум два: один, назовем его условно "рабочий" (work) - это сервер, на котором, собственно, и тусуется народ. Он неприкосновенен, плагины на нем обновляются только тогда, когда есть полная уверенность, что они будут работать на нем бэз шуму и пыли. Причем делать это желательно через остановку сервера (в крайнем случае - через его перезапуск сразу после замены файлов). Второй, назовем его "подопытный" (dev) - на нем вы будете тренироваться, как на кошечках, именно в его папку plugins/ и следует сваливать скомпилированные jar-файлы ваших плагинов. При этом перезапуск плагинов на нем производится, как правило, командой reload с консоли сервера (либо /reload из клиента). Хоть баккит в последних версиях настоятельно не рекомендует использовать эту команду, но от ее поддержки не отказался. Да, при подобном способе перезапуска возможны ошибки (и рано или поздно они случаются), но в 99% релоадов этот процесс проходит безболезненно.

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

В особых случаях, когда рабочий сервер является серьезным объектом, как например наш Мinecrafting.ru, в пару к нему на той же машине поднимается тестовый сервер (с другим рабочим портом и вайт-листом). Он может либо работать в постоянном режиме, как рабочий, либо запускаться по требованию. С некоторой периодичностью на него заливается бэкап рабочей карты. Используется он для финишной шлифовки плагинов, отработки пермишенсов (система прав на нем копируется, как правило, с рабочего сервера). На нем же производится строительство объектов для рабочей карты, которые затем в виде схематиков копируются на рабочий сервер.

В общем и целом, ваш dev-сервер должен располагаться в легкодоступном месте, например, d:\bukkit_1.8\. Указывать версию для каталога сервера очень желательно, ведь у вас еще может быть сервер для более старой версии, например, d:\bukkit_1.7\, на котором вы будете тестировать совместимость вашего плагина. Просто менять jar-файл сервера разных мажорных версий в одном и том же каталоге не получится, поскольку структура каталогов и файлов в разных версиях различается довольно серьезно.

И еще, прежде чем перейти непосредственно к описанию того, что из себя представляет плагин, хочется сделать несколько замечаний на тему того, как избежать стандартных ошибок, на исправление которых я потратил ОЧЕНЬ много времени и сил:


1. Не пихайте все в одну кучу. Если ваш плагин выполняет какую-то простейшую задачу (например, выдает игроку сообщение при входе на сервер), это еще прокатит, однако в дальнейшем ни к чему, кроме путаницы, не приведет. Образно это можно представить как 103: десять строк -> десять методов -> десять классов. То есть, методы ваших классов должны содержать не более чем по 10 строк, в классе не должно быть больше десятка методов, а пакет должен состоять не более чем из 10 классов. Конечно же, это недостижимый идеал. Не нужно упираться рогом для того, чтобы подогнать под него ваш проект. Однако ненавязчивое стремление к нему очень хорошо дисциплинирует, значительно повышает читабельность текста и в итоге позволяет значительно отодвинуть тот неизбежный момент, когда проект без коренной модернизации попросту начинает "сыпаться". Если есть возможность вынести некий функционал в отдельный метод, а то и в отдельный класс - это надо сделать. Это позволит вам в дальнейшем просто вставлять вызов необходимого метода, а не заниматься копипастом. Опять же, если в одном пакете скопилось несколько десятков файлов - это уже повод задуматься о создании подпакетов и вынесении туда определенных классов, группируя их по схожести функций.


2. Давайте переменным (и уж тем более методам, классам и пакетам) осмысленные названия. Я еще допускаю варианты i, j, k в качестве названий переменных цикла - это вполне себе устоявшаяся практика. Но все остальное должно иметь название, отражающее их смысл: buffer, UserSystem, ru.vasco.UserSystem. Как только вы опуститесь до употребления чего-то вроде var12, Class1, Class2 - ждите проблем. Также желательно, чтобы названия элементов были как можно более полными (читай, длинными). Как ни странно, это, как правило, ускоряет доведение кода до рабочего состояния. Какую конкретно стилистическую систему применять для именования объектов - дело ваше, но система эта должна быть.


3. Забудьте про использование операции конкатенации для склейки строк:

String str= "Пользователь " + player.getName() + " вошел на сервер";

Одна строка, конечно, погоды не сделает, но вот сотни строк, ежесекундно сливающиеся в объектно-ориентированном экстазе, рано или поздно скушают память вашего сервера, сколько бы вы ее не выделили. Причем проблема даже не в скушанной памяти как таковой, а во времени, которое сборщик мусора (Garbage collector) виртуальной машины (JVM) потратит на ее освобождение. Проблема эта (конкатенации строк) связана с особенностями реализации строк в языке Java и лечится следующим способом:

StringBuilder str= new StringBuilder("Пользователь ").append(player.getName()).append(" вошел на сервер");
...
... str.ToString() ... // преобразование объекта StringBuilder в строку

Да, получается немного длиннее, но, поверьте, ваш сервер вам будет весьма благодарен.


4. Комментируйте сложные куски кода. Вставить пару слов перед телом какого-нибудь цикла (особенно вложенного) несложно, а вернувшись к этому куску кода через несколько месяцев, вы уже не будете смотреть на него как баран на новые ворота. В обязательном порядке необходимо добавлять комментарии к объявлениям методов и классов.


5. Не используйте без необходимости конструкции try...catch как средство "исправления" ошибок времени выполнения программы. Вернее, используйте их только тех местах, где их использование совершенно необходимо. Например, при вызове методов пакета lang.reflect или при работе с запросами к базам данных. По-первости очень соблазняет возможность закрыть все проблемы конструкцией:

try
{
...
}
catch (Exception e) {}

Казалось бы, нет ошибки - нет проблемы. Однако на самом деле ошибка никуда не делась, она просто не отображается в логе и в консоли. Только узнаете вы об этом какое-то время спустя и только по косвенным результатам - в основном по неправильной работе алгоритма обработки данных. И лечить эти ошибки, поверьте, будет гораздо сложнее. Так что учитывайте парадоксальную вещь: если в консоль сыпятся исключения - это хорошо, значит можно посмотреть - что это за исключения, найти метод, который их генерит и быстро устранить причину этого. В дополнение к этому небольшое замечание: если при вынужденном использовании конструкции try...catch есть возможность как-то конкретизировать ситуацию - это, опять же, надо сделать. Например, при работе с базами данных следует использовать конструкции вида:

try
{
...
}
catch (SQLException e)
{
...
}

Это позволит перехватывать только исключения sql-запросов, пропуская все остальное дальше. Причем даже в этом случае очень желательно не "гасить" ошибки, а как-то реагировать на них, например, сообщением в консоль сервера.


6. Основная часть кода программы, плотно взаимодействующей с пользователем - это т.н. "защита от дурака". Поэтому код вашего плагина не менее чем на 75% должен состоять из конструкций if(). Не ленитесь проверять и перепроверять все значения, поступающие на вход. Это убережет вас от постоянных эксцепшенов в консоли а то и от крашей сервера. Желательно все проверки вынести на самую раннюю стадию: во-первых, это разгрузит ваш основной код от лишнего обвеса, как-бы разделив его на две части - блок взаимодействия с пользователем и основной целевой блок, а во-вторых, лишние проверки, вынесенные наверх из тела рабочего цикла (а то и неоднократно вложенных циклов) позволят сэкономить пару-тройку шекелей милисекунд/мегабайт из выделенных плагину ресурсов сервера.


7. При использовании т.н. generic-классов, например, ArrayList или HashMap не ленитесь указывать, чем параметризируется данный класс:

Map<String, Player> players= new HashMap<String, Player>();
List<ItemStack> items= new ArrayList<ItemStack>();

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


8. Заведите в корне вашего проекта файлик todo.txt и записывайте туда построчно все, что вам хотелось бы (или вас попросили) допилить в вашем плагине. Если этого не делать, через две недели вы благополучно об этом забудете. Замечания и пожелания можно предварять знаком '-', после реализации задуманного можно менять его на '+'.


Вот теперь, наверное, можно уже поговорить о том, из чего состоит плагин и как он работает.
  • Поблагодарил: aleksey_t


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

Фотография
Zahatustra
16.12.2015 00:17

по поводу пункта 3 - компилятор сам первый вариант переделает во второй.

Да и в целом, кмк, людей, которым необходимы такие советы, лучше занимать чем-нибудь более тривиальным, типа каконичных учебных проектов (справочные системы и все в таком роде). 

по поводу пункта 3 - компилятор сам первый вариант переделает во второй.

Нет ему веры (уже) :)

Да и в целом, кмк, людей, которым необходимы такие советы, лучше занимать чем-нибудь более тривиальным, типа каконичных учебных проектов (справочные системы и все в таком роде). 

Кто бы мне обо всем этом пару лет назад рассказал. А насчет каноничных учебных проектов - так таких "Hello world" в интернете море. Мне "в общем" не интересно, я пишу про практическое конкретное использование явы. А эти "советы" - так, мысли вслух, не более. Никого ни к чему не обязывают.

    • Поблагодарил: avttrue

Нет ему веры (уже) :)

Ну, если использовать оракловский javac, он заменяет + на билдер и объединяет в один билдер подряд идущие (с точки зрения байткода) сложения строк. Но, если встречаются тернарные операторы, а уж тем более условия и цыклы, придется использовать билдер самому, так как компилятор создаст по отдельному билдеру, на каждую кучку сложений.
В спецификации это, к сожалению, в виде рекомндации, так что javac из других jdk, могут вести себя иначе. В таком случае, вас ждет этот чертов мануал. :)

Фотография
pakos2835
17.12.2015 18:22
А на чем (в чем) их писать?

 

 

как я понял писать для майна можно также на jruby, этот вариант мне больше сейчас нравится чем ява

Писать можно, в принципе, на всем, что компилируется в байт-код и совместимо по этому байт-коду с JVM. На том же Groovy, например. Если есть желание, напиши статью по особенностям написания модов/плагинов для майна с помощью Ruby, с удовольствием опубликуем.

Фотография
DmitriyMX
22.01.2016 09:51

Зарегистрировался для того, что бы поблагодарить автора статьи за добрые слова. Хотя я честно приятно удивлён, что по этому древнему куску пергамента еще кто-то "обучается" :)

    • Поблагодарил: fromgate

Зарегистрировался для того, что бы поблагодарить автора статьи за добрые слова. Хотя я честно приятно удивлён, что по этому древнему куску пергамента еще кто-то "обучается" :)

Ну, я его аккуратно разворачивал :).

На самом деле, это было года два с половиной назад, тогда ей было не так много лет. За статьи ваши действительно огромное спасибо, тогда с подобной информацией была некая напряженка.

Фотография
fromgate
04.03.2016 20:30

Я недавно вместе с nukkit'ом (серверная платформа для MCPE) открыл для себя IntelliJ IDEA. Это великолепная среда разработки, после которой я не могу представить, чтобы я вернулся на Eclipse (хотя раньше он меня устраивал во всём ;))

    • Поблагодарил: angal

Я недавно вместе с nukkit'ом (серверная платформа для MCPE) открыл для себя IntelliJ IDEA. Это великолепная среда разработки, после которой я не могу представить, чтобы я вернулся на Eclipse (хотя раньше он меня устраивал во всём ;))

К данному непотребству меня второй месяц склоняет Ангал. Пока держусь!

Фотография
fromgate
06.03.2016 10:44

@vasco

Рекомендую попробовать. Главное, при этом включить в настройках, поддержку сочетаний клавиш как в Eclipse. До этого я именно из-за непривычных сочетаний клавиш не мог перейти.