Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
e4b1b40104
|
|||
|
73f044ab8b
|
|||
|
32b868df22
|
|||
|
3a66dffa10
|
636
README.MD
636
README.MD
@@ -1,636 +0,0 @@
|
||||
# GHAST TOOLS
|
||||
|
||||
|
||||
|
||||
|
||||
Набор вспомогательных инструментов для Bukkit API.
|
||||
_Основан на версии Bukkit API 1.12._
|
||||
|
||||
## Содержание
|
||||
|
||||
1. [Перед использованием](#перед-использованием)
|
||||
2. [GhastTools](#ghasttools)
|
||||
3. [AssetsManager](#assetsmanager)
|
||||
4. [BuildHelper](#buildhelper)
|
||||
5. [CommandManager](#commandmanager)
|
||||
6. [EffectsHelper](#effectshelper)
|
||||
7. [EventContext](#eventcontext)
|
||||
8. [JdbcTemplate](#jdbctemplate)
|
||||
9. [ScheduleManager](#schedulemanager)
|
||||
10. [ScheduleTask](#scheduletask)
|
||||
11. [I18n](#i18n)
|
||||
12. [XLog](#xlog)
|
||||
13. [Подключение](#подключение)
|
||||
1. [Gradle](#gradle)
|
||||
2. [Maven](#maven)
|
||||
|
||||
---
|
||||
|
||||
## Перед использованием
|
||||
|
||||
Перед началом использования, необходимо в вашем Bukkit-плагине прописать подобный код:
|
||||
|
||||
```java
|
||||
void onLoad() {
|
||||
GhastTools.setPlugin(this);
|
||||
}
|
||||
```
|
||||
|
||||
Это необходимо сделать, т.к. весь инструментарий основан на статических (static) методах.
|
||||
|
||||
Все методы данного набора инструментов объеденены в классы, выполняющие роль группировщиков.
|
||||
|
||||
## GhastTools
|
||||
|
||||
Методы общего назначения или без определённой группировки.
|
||||
|
||||
### loadConfig
|
||||
|
||||
Загрузка файла настроек плагина - `config.yml`.
|
||||
|
||||
```java
|
||||
YamlConfiguration config = GhastTools.loadConfig();
|
||||
```
|
||||
|
||||
По-умолчанию "гаст" пытается файл найти в папке плагина - `getDataFolder()`.
|
||||
Если файла там нет, то выгружает встроенный (имеющийся в `.jar` файле плагина) в эту папку и загружает его.
|
||||
|
||||
```java
|
||||
YamlConfiguration config = GhastTools.loadConfig(false);
|
||||
```
|
||||
|
||||
Если передать параметр `false`, то при отсутствии файла `config.yml` в папке плагина,
|
||||
будет загруден исключительно встроенный файл настроек.
|
||||
|
||||
## AssetsManager
|
||||
|
||||
Методы по работе с файлами плагина (_"ассетами"_).
|
||||
|
||||
У каждой группы методов один и тот же набор входных параметров:
|
||||
|
||||
- `resourceName` - наименование и путь к файлу в папке плагина
|
||||
- `defaultResourceName` - наименование и путь к файлу в плагине.
|
||||
_Опционально. По-умолчанию равнен `resourceName`_
|
||||
- `saveDefault` - необходимость скопировать содержимое файла из `defaultResourceName` в файл `resourceName`.
|
||||
_Опционально. По-умолчанию равен `true`_
|
||||
|
||||
Правила поиска файлов так же одинаков для каждой группы:
|
||||
|
||||
- В начале файл ищется в папке плагина
|
||||
- Если файл отсутствует в папке плагина, то...
|
||||
- если `defaultResourceName` не равен `null`...
|
||||
- если `saveDefault` равен `true`, то файл из плагина будет выгружен в папку плагина и от туда загружен в память.
|
||||
- если `saveDefault` равен `false`, то данные будут взяты из файлв в плагине.
|
||||
- если `defaultResourceName` равен `null`, то будет брошено исключение `AssetsException` с описанием ошибки вида "Файл X не найден".
|
||||
|
||||
### getAsInputStream
|
||||
|
||||
```java
|
||||
InputStream inputStream = AssetsManager.getAsInputStream("translate.ru.yml", "translate.yml", false);
|
||||
```
|
||||
|
||||
### getAsReader
|
||||
|
||||
```java
|
||||
Reader reader = AssetsManager.getAsReader("translate.ru.yml", "translate.yml", false);
|
||||
```
|
||||
|
||||
### getAsString
|
||||
|
||||
```java
|
||||
String string = AssetsManager.getAsString("readme.txt", "readme.txt", StandardCharsets.UTF_8, false);
|
||||
```
|
||||
|
||||
У этой группы есть дополнительный _опциональный_ параметр - `charset` - в котором указывается кодиривка получаемой строки.
|
||||
_По-умолчанию равен `StandardCharsets.UTF_8`_
|
||||
|
||||
## BuildHelper
|
||||
|
||||
Набор методов облегчающих размецение объектов на карте.
|
||||
|
||||
### placeSkull
|
||||
|
||||
```java
|
||||
Location location = ...;
|
||||
Skull skull = BuildHelper.placeSkull(location, BlockFace.NORTH)
|
||||
```
|
||||
|
||||
### placeSignWall
|
||||
|
||||
```java
|
||||
Location location = ...;
|
||||
Sign signWall = BuildHelper.placeSignWall(location, BlockFace.NORTH)
|
||||
```
|
||||
|
||||
## CommandManager
|
||||
|
||||
Регистрация команд.
|
||||
|
||||
Имеется два варианта использования: упрощённый
|
||||
|
||||
```java
|
||||
CommandManager.register("start", (sender, args) -> sender.sendMessage("hello!"));
|
||||
```
|
||||
|
||||
и подробный:
|
||||
|
||||
```java
|
||||
CommandManager.create("start")
|
||||
.useOnlyPlayer()
|
||||
.executer((sender, args) -> sender.sendMessage("hello!"))
|
||||
.register();
|
||||
```
|
||||
|
||||
### register
|
||||
|
||||
Упрощенная регистрация команды. Указывается лишь название команды и исполнитель.
|
||||
|
||||
```java
|
||||
CommandManager.register("start", (sender, args) -> sender.sendMessage("hello!"));
|
||||
```
|
||||
|
||||
### create
|
||||
|
||||
Конструктор для подробного варианта регистрации команды.
|
||||
|
||||
```java
|
||||
CommandManager.Builder builder = CommandManager.create("start");
|
||||
```
|
||||
|
||||
### executer
|
||||
|
||||
Указание исполнителя для команды
|
||||
|
||||
```java
|
||||
CommandManager.Builder builder = CommandManager.create("start")
|
||||
.executer((sender, args) -> sender.sendMessage("hello!"));
|
||||
```
|
||||
|
||||
### onError
|
||||
|
||||
Обработчик исключений
|
||||
|
||||
```java
|
||||
CommandManager.Builder builder = CommandManager.create("start")
|
||||
.onError((sender, commandName, args, exception) -> {
|
||||
sender.sendMessage(ChatColor.RED + "Произошла ошибка при выполнении команды '" + commandName + "'.");
|
||||
exception.printStackTrace();
|
||||
});
|
||||
```
|
||||
|
||||
### useOnlyPlayer
|
||||
|
||||
Указание, что данную команду могут использовать только Игроки.
|
||||
Опционально можно указать сообщение, которое будет выводиться в консоль.
|
||||
_Отменяет действие указателя `useOnlyConsole`_
|
||||
|
||||
```java
|
||||
CommandManager.Builder builder = CommandManager.create("start")
|
||||
.useOnlyPlayer("Команду могут использовать только игроки");
|
||||
```
|
||||
|
||||
### useOnlyConsole
|
||||
|
||||
Указание, что данную команду можно использовать только в консоле.
|
||||
Опционально можно указать сообщение, которое будет выводиться Игроку.
|
||||
_Отменяет действие указателя `useOnlyPlayer`_
|
||||
|
||||
```java
|
||||
CommandManager.Builder builder = CommandManager.create("start")
|
||||
.useOnlyConsole(ChatColor.RED + "Команду можно использовать только в консоли");
|
||||
```
|
||||
|
||||
### register
|
||||
|
||||
Регистрация описанной в Конструкторе команды.
|
||||
|
||||
```java
|
||||
CommandManager.create("start")
|
||||
.useOnlyPlayer()
|
||||
.executer((sender, args) -> sender.sendMessage("hello!"))
|
||||
.register();
|
||||
```
|
||||
|
||||
## EffectsHelper
|
||||
|
||||
Набор методов для работы с эффектами.
|
||||
|
||||
### playSound
|
||||
|
||||
Воспроизвести звук.
|
||||
|
||||
```java
|
||||
Location location = ...;
|
||||
EffectsHelper.playSound(location, Sound.AMBIENT_CAVE, 1.0f);
|
||||
```
|
||||
|
||||
### particle
|
||||
|
||||
Создание частиц.
|
||||
|
||||
```java
|
||||
Location location = ...;
|
||||
EffectsHelper.particle(location, Particle.REDSTONE, 1.0d, 1.0d, 1.0d, 1.0d, 5);
|
||||
```
|
||||
|
||||
## EventContext
|
||||
|
||||
Регистрация группы обработчиков событий, объединённых общим условием выполнения.
|
||||
|
||||
```java
|
||||
EventContext.create()
|
||||
.filter(() -> Bukkit.getOnlinePlayers().size() > 10)
|
||||
.onEvent(PlayerJoinEvent.class, event -> { event.getPlayer().kickPlayer("Max players"); });
|
||||
```
|
||||
|
||||
### create
|
||||
|
||||
Создание контекста событий.
|
||||
|
||||
```java
|
||||
EventContext eventContext = EventContext.create();
|
||||
```
|
||||
|
||||
### filter
|
||||
|
||||
Условие, при котором будут срабатывать обработчики событий в данном контексте.
|
||||
|
||||
```java
|
||||
EventContext.create()
|
||||
.filter(() -> Bukkit.getOnlinePlayers().size() > 10)
|
||||
```
|
||||
|
||||
### onEvent
|
||||
|
||||
Указание события и его обработчика.
|
||||
_Обработчик события регистрируется сразу же._
|
||||
|
||||
```java
|
||||
EventContext.create()
|
||||
.filter(() -> Bukkit.getOnlinePlayers().size() > 10)
|
||||
.onEvent(PlayerJoinEvent.class, event -> event.getPlayer().kickPlayer("Max players"));
|
||||
```
|
||||
|
||||
### cancelEvent
|
||||
|
||||
Отменить событие.
|
||||
_Обработчик события регистрируется сразу же._
|
||||
|
||||
```java
|
||||
EventContext.create()
|
||||
.cancelEvent(BlockPlaceEvent.class);
|
||||
```
|
||||
|
||||
эквивалентен коду:
|
||||
|
||||
```java
|
||||
EventContext.create()
|
||||
.onEvent(BlockPlaceEvent.class, event -> event.setCancelled(true))
|
||||
```
|
||||
|
||||
## JdbcTemplate
|
||||
|
||||
Инструмент для упрощения работы с SQL базами данных, работающими через JDBC.
|
||||
|
||||
Для начала потребуется создать объект `DataSource`
|
||||
|
||||
```java
|
||||
// На примере MySQL
|
||||
MysqlDataSource dataSource = new MysqlDataSource();
|
||||
dataSource.setServerName("localhost");
|
||||
dataSource.setPort(3306);
|
||||
dataSource.setCharacterEncoding(StandardCharsets.UTF_8.name());
|
||||
dataSource.setDatabaseName("MyDataBase");
|
||||
dataSource.setUser("root");
|
||||
dataSource.setPassword("secret");
|
||||
```
|
||||
|
||||
После чего создать `JdbcTemplate`
|
||||
|
||||
```java
|
||||
JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
|
||||
```
|
||||
|
||||
### execute
|
||||
|
||||
Выполнение SQL запроса без последующей обработки результатов выполнения.
|
||||
|
||||
```java
|
||||
jdbcTemplate.execute("CREATE TABLE my_table (id int, name varchar(16));");
|
||||
```
|
||||
|
||||
### query
|
||||
|
||||
Выполнение SQL запроса и обработка его результатов.
|
||||
Может возвращать любой тип объектов.
|
||||
|
||||
```java
|
||||
String name = jdbcTemplate.query("SELECT name FROM my_table LIMIT 0,1", resultSet -> {
|
||||
if (resultSet.next()) {
|
||||
return resultSet.getString("name");
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
```java
|
||||
List<String> names = jdbcTemplate.query("SELECT name FROM my_table", resultSet -> {
|
||||
if (resultSet.next()) {
|
||||
List<String> list = new ArrayList<>();
|
||||
do {
|
||||
list.add(resultSet.getString("name"));
|
||||
} while (resultSet.next());
|
||||
return list;
|
||||
} else {
|
||||
return Collections.emptyList();
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### queryOne
|
||||
|
||||
Выполнение SQL запроса с расчетом, что результат будет единичным либо не будет вовсе.
|
||||
Возвращает `Optional`.
|
||||
|
||||
```java
|
||||
Optional<String> optName = jdbcTemplate.queryOne("SELECT name FROM my_table WHERE name LIKE 'dmitriymx'", rs -> rs.getString("name"));
|
||||
```
|
||||
|
||||
### queryList
|
||||
|
||||
Выполнение SQL запроса и обработка результата как списка данных.
|
||||
Возвращает `List`.
|
||||
|
||||
```java
|
||||
List<String> names = jdbcTemplate.queryList("SELECT name FROM my_table", (resultSet, rowNum) -> resultSet.getString("name"));
|
||||
```
|
||||
|
||||
### queryForMap
|
||||
|
||||
Выполнение SQL запроса с расчетом, что результат будет единичным либо не будет вовсе.
|
||||
Возвращает `Map<String, Object>`, где ключ — это наименование колонок таблицы, а значения — это значения в ячейках таблицы.
|
||||
|
||||
```java
|
||||
Map<String, Object> map = jdbcTemplate.queryForMap("SELECT * FROM my_table LIMIT 0,1;");
|
||||
```
|
||||
|
||||
### queryForMapList
|
||||
|
||||
Выполнение SQL запроса и обработка результата как списка данных.
|
||||
Возвращает `List<Map<String, Object>>`, где ключ — это наименование колонок таблицы, а значения — это значения в ячейках таблицы.
|
||||
|
||||
```java
|
||||
List<Map<String, Object>> mapList = jdbcTemplate.queryForMapList("SELECT * FROM my_table");
|
||||
```
|
||||
|
||||
### update
|
||||
|
||||
Выполнение SQL запроса где будет происходить обновление данных в таблице.
|
||||
Под "обновлением" подразумеваются любые изменения в таблице: `UPDATE`, `DELETE`, `INSERT`.
|
||||
Возвращает число строк, которые были _по факту обновлены_ в таблице.
|
||||
|
||||
```java
|
||||
int rows = jdbcTemplate.update("DELETE FROM my_table WHERE name LIKE 'dmitriymx';");
|
||||
```
|
||||
|
||||
## ScheduleManager
|
||||
|
||||
Набор методов для создания параллельных задач, выполняющихся один раз или по рассписанию.
|
||||
|
||||
### createTask
|
||||
|
||||
Создание конструктора задачи.
|
||||
|
||||
```java
|
||||
ScheduleManager.Builder builder = ScheduleManager.createTask();
|
||||
```
|
||||
|
||||
### useBukkitScheduler
|
||||
|
||||
Если задача будет взаимодействоватьс **Bukkit API** или необходима привязка задачи к _тикам_,
|
||||
то необходимо использовать данный указатель.
|
||||
|
||||
В ином случае, указатель не нужен.
|
||||
|
||||
```java
|
||||
ScheduleManager.Builder builder = ScheduleManager.createTask()
|
||||
.useBukkitScheduler();
|
||||
```
|
||||
|
||||
### after
|
||||
|
||||
Указание, что задачу нужно выполнить не сразу, а с некоторой задержкой перед запуском.
|
||||
|
||||
```java
|
||||
ScheduleManager.Builder builder = ScheduleManager.createTask()
|
||||
.after(5, TimeUnit.MINUTES);
|
||||
```
|
||||
|
||||
### every
|
||||
|
||||
Указание, что задачу нужно повторять через указанное время.
|
||||
|
||||
```java
|
||||
ScheduleManager.Builder builder = ScheduleManager.createTask()
|
||||
.every(5, TimeUnit.MINUTES);
|
||||
```
|
||||
|
||||
### create
|
||||
|
||||
Создание описанной задачи.
|
||||
|
||||
```java
|
||||
ScheduleTask scheduleTask = ScheduleManager.createTask()
|
||||
.every(1, TimeUnit.SECONDS)
|
||||
.create(() -> Bukkit.getServer().getLogger().info("TimeMS: " + System.currentTimeMillis()));
|
||||
```
|
||||
|
||||
_Задача будет только создана. Для её выполнения нужно вызвать `scheduleTask.start()`._
|
||||
|
||||
### execute
|
||||
|
||||
Создание и выполнение описанной задачи.
|
||||
|
||||
```java
|
||||
ScheduleTask scheduleTask = ScheduleManager.createTask()
|
||||
.every(1, TimeUnit.SECONDS)
|
||||
.execute(() -> Bukkit.getServer().getLogger().info("TimeMS: " + System.currentTimeMillis()));
|
||||
```
|
||||
|
||||
## ScheduleTask
|
||||
|
||||
Вспомогательный объект, созданный через `ScheduleManager`. Позволяет управлять созданной задачей.
|
||||
|
||||
### start
|
||||
|
||||
Запускает задачу, если она еще не запущена.
|
||||
|
||||
```java
|
||||
ScheduleTask scheduleTask = ...;
|
||||
scheduleTask.start();
|
||||
```
|
||||
|
||||
### isCanceled
|
||||
|
||||
Возвращает состояние задачи. Если `true`, значит задача была или _отменена/остоновлена_ или была завершена.
|
||||
|
||||
```java
|
||||
ScheduleTask scheduleTask = ...;
|
||||
boolean status = scheduleTask.isCanceled();
|
||||
```
|
||||
|
||||
### cancel
|
||||
|
||||
Отменяет/Остонавливает выполнение задачи.
|
||||
|
||||
```java
|
||||
ScheduleTask scheduleTask = ...;
|
||||
scheduleTask.cancel();
|
||||
```
|
||||
|
||||
## I18n
|
||||
|
||||
Инструмент для работы с мультиязыковыми сообщениями или просто сообщениями, которые храняться в отдельном файле.
|
||||
|
||||
Позволяет использовать шаблонизированные сообщения вида `Привет, {player}!`.
|
||||
|
||||
### loadMessages
|
||||
|
||||
Загрузка сообщений в инструмент.
|
||||
|
||||
Передать можно как "мапу" с перечислением ключ-сообщение, так и `Reader` на файл в формате `key=message` (как у `Properties`).
|
||||
|
||||
```java
|
||||
Map<String, String> messagesMap = ...;
|
||||
I18n.loadMessages(messagesMap);
|
||||
```
|
||||
|
||||
```java
|
||||
Reader reader = AssetsManager.getAsReader("messages.properties");
|
||||
I18n.loadMessages(reader);
|
||||
```
|
||||
|
||||
В первом параметре можно указать код языка, для которого загружаются сообщения. По-умолчанию будет "en".
|
||||
|
||||
```java
|
||||
Map<String, String> enMessagesMap = ...;
|
||||
Map<String, String> ruMessagesMap = ...;
|
||||
|
||||
I18n.loadMessages("en", enMessagesMap);
|
||||
I18n.loadMessages("ru", ruMessagesMap);
|
||||
```
|
||||
|
||||
```java
|
||||
Reader readerEn = AssetsManager.getAsReader("messages.properties");
|
||||
Reader readerRu = AssetsManager.getAsReader("messages.ru.properties");
|
||||
|
||||
I18n.loadMessages("en", readerEn);
|
||||
I18n.loadMessages("ru", readerRu);
|
||||
```
|
||||
|
||||
### get
|
||||
|
||||
Получение сообщения по его ключу.
|
||||
|
||||
```java
|
||||
String msg = I18n.get("player.join.msg");
|
||||
```
|
||||
|
||||
Если следующим сообщением указать `Map<String, Object>`, то можно будет воспользоваться шаблонизатором.
|
||||
|
||||
```java
|
||||
Map<String, String> messagesMap = new HashMap<>();
|
||||
messagesMap.put("player.join.msg", "Привет, {player}!");
|
||||
|
||||
I18n.loadMessages(messagesMap);
|
||||
|
||||
Map<String, String> params = new HashMap<>();
|
||||
params.put("player", event.getPlayer().getName());
|
||||
|
||||
String msg = I18n.get("player.join.msg", params);
|
||||
```
|
||||
|
||||
Однако можно создавать `Map<String, String> params` явно, а воспользоваться [paramBuilder()](#parambuilder)
|
||||
|
||||
```java
|
||||
String msg = I18n.get("player.join.msg", I18n.paramBuilder()
|
||||
.add("player", event.getPlayer().getName())
|
||||
.build());
|
||||
```
|
||||
|
||||
Можно первым параметром указать код языка.
|
||||
|
||||
```java
|
||||
String msg = I18n.get("ru", "player.join.msg");
|
||||
```
|
||||
|
||||
### paramBuilder
|
||||
|
||||
Инструмент для параметизирования шаблонов сообщений.
|
||||
|
||||
```java
|
||||
Map<String, Object> params = I18n.paramBuilder()
|
||||
.add("player", event.getPlayer().getName())
|
||||
.build();
|
||||
String msg = I18n.get("player.join.msg", params);
|
||||
```
|
||||
|
||||
## XLog
|
||||
|
||||
Замена стандартному `getLogger()`, который использует `java.utils.Logger` и не всегда удобен для логирования.
|
||||
|
||||
Имеет 4 уровня логирования: `debug`, `info`, `warning`, `error`.
|
||||
|
||||
Сообщения могут быть шаблонизированными. Синтаксис шаблонов — `java.text.MessageFormat`.
|
||||
|
||||
Примеры:
|
||||
|
||||
```java
|
||||
XLog.info("Hello");
|
||||
XLog.info("Player {0} join game", event.getPlayer().getName());
|
||||
|
||||
XLog.error("ERROR!", exception);
|
||||
XLog.error("ERROR: {0}", exception.getMessage());
|
||||
// Для экранирования "{" нужно перед ней поставить "'".
|
||||
// А для использования "'" нужно их дублировать.
|
||||
XLog.error("ERROR ''{0}'' in Event '{{1}'}: {2}", exception.getClass(), event.getClass(), exception.getMessage());
|
||||
XLog.error("ERROR: {0}", exception.getMessage(), exception);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Подключение
|
||||
|
||||
### Gradle
|
||||
|
||||
```groovy
|
||||
repositories {
|
||||
maven { url 'https://dmx-mc-project.gitlab.io/maven-repository/' }
|
||||
}
|
||||
```
|
||||
|
||||
```groovy
|
||||
implementation group: 'ghast', name: 'ghast-tools', version: '1.11-SNAPSHOT'
|
||||
```
|
||||
|
||||
### Maven
|
||||
|
||||
```xml
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>dmx-mc-project</id>
|
||||
<url>https://dmx-mc-project.gitlab.io/maven-repository/</url>
|
||||
</repository>
|
||||
</repositories>
|
||||
```
|
||||
|
||||
```xml
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>ghast</groupId>
|
||||
<artifactId>ghast-tools</artifactId>
|
||||
<version>1.11-SNAPSHOT</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
```
|
||||
69
build.gradle
69
build.gradle
@@ -1,33 +1,50 @@
|
||||
import libs.LibsPlugin
|
||||
plugins {
|
||||
id 'java'
|
||||
}
|
||||
|
||||
subprojects {
|
||||
apply plugin: 'java'
|
||||
apply plugin: LibsPlugin
|
||||
apply plugin: LogicPlugin
|
||||
def publishScript = file(rootProject.getProjectDir().getPath() + '/publish.gradle')
|
||||
if (publishScript.exists()) {
|
||||
apply from: publishScript.path
|
||||
}
|
||||
|
||||
def publishScript = rootDir.toPath().resolve('publish.gradle').toFile()
|
||||
if (publishScript.exists()) {
|
||||
apply from: publishScript
|
||||
}
|
||||
project.group = projectGroup
|
||||
project.version = projectVersion
|
||||
|
||||
project.group = projectGroup
|
||||
project.version = moduleVersion
|
||||
jar.archiveBaseName.set(moduleName)
|
||||
repositories {
|
||||
mavenLocal()
|
||||
mavenCentral()
|
||||
maven { url 'https://hub.spigotmc.org/nexus/content/groups/public' }
|
||||
maven { url 'https://dmx-mc-project.gitlab.io/maven-repository/' }
|
||||
}
|
||||
|
||||
repositories {
|
||||
mavenLocal()
|
||||
mavenCentral()
|
||||
}
|
||||
ext {
|
||||
libs = [
|
||||
bukkit: [lib: 'org.bukkit:bukkit:1.12.2-R0.1-SNAPSHOT', exclude: [
|
||||
'com.google.code.gson:gson',
|
||||
'com.googlecode.json-simple:json-simple',
|
||||
'commons-lang:commons-lang',
|
||||
'org.yaml:snakeyaml'
|
||||
]],
|
||||
commons_text: 'org.apache.commons:commons-text:1.9',
|
||||
lombok: 'org.projectlombok:lombok:1.18.12',
|
||||
reflection_object: 'ru.dmitriymx:reflection-object:1.0-BETA'
|
||||
]
|
||||
}
|
||||
|
||||
dependencies {
|
||||
compileOnly libs.lombok
|
||||
annotationProcessor libs.lombok
|
||||
|
||||
testImplementation libs.test.junit5
|
||||
testImplementation libs.test.mock
|
||||
}
|
||||
|
||||
test {
|
||||
useJUnitPlatform()
|
||||
def compileOnly2(library) {
|
||||
dependencies.compileOnly library.lib, {
|
||||
library.exclude.each { String excludeLibStr ->
|
||||
String[] excludeLib = excludeLibStr.split(':')
|
||||
exclude group: excludeLib[0], module: excludeLib[1]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
dependencies {
|
||||
compileOnly libs.lombok
|
||||
annotationProcessor libs.lombok
|
||||
|
||||
compileOnly2 libs.bukkit
|
||||
implementation libs.commons_text
|
||||
implementation libs.reflection_object
|
||||
}
|
||||
@@ -1,67 +0,0 @@
|
||||
import org.gradle.api.DefaultTask
|
||||
import org.gradle.api.Plugin
|
||||
import org.gradle.api.Project
|
||||
import org.gradle.api.tasks.TaskAction
|
||||
|
||||
import java.nio.charset.StandardCharsets
|
||||
import java.nio.file.Path
|
||||
|
||||
class LogicPlugin implements Plugin<Project> {
|
||||
|
||||
@Override
|
||||
void apply(Project project) {
|
||||
project.tasks.register('incrementVersion', IncrementVersion)
|
||||
}
|
||||
}
|
||||
|
||||
class IncrementVersion extends DefaultTask {
|
||||
|
||||
@TaskAction
|
||||
def incrementVersion() {
|
||||
String nextVer
|
||||
if (project.hasProperty('nextVersion')) {
|
||||
nextVer = project.property('nextVersion')
|
||||
} else {
|
||||
nextVer = nextVersion()
|
||||
}
|
||||
|
||||
incrementReadmeVersion(nextVer)
|
||||
incrementGradlePropsVersion(nextVer)
|
||||
}
|
||||
|
||||
private void incrementReadmeVersion(String nextVersion) {
|
||||
String nextVersion2 = nextVersion.replaceAll(/-/, '--')
|
||||
|
||||
Reader reader = this.getClass().getResource('README.SRC.MD').toURI().toURL().newReader()
|
||||
File readmeFile = project.file(project.getRootDir().toPath().resolve('README.MD'))
|
||||
|
||||
readmeFile.withWriter { wr ->
|
||||
reader.eachLine { line ->
|
||||
wr << line.replaceAll('@VERSION@', nextVersion)
|
||||
.replaceAll('@VERSION2@', nextVersion2)
|
||||
wr << "\n"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void incrementGradlePropsVersion(String nextVersion) {
|
||||
Path gradlePropertiesPath = project.projectDir.toPath().resolve('gradle.properties');
|
||||
|
||||
Properties gradleProperties = new Properties()
|
||||
gradleProperties.load(gradlePropertiesPath.newReader())
|
||||
gradleProperties.setProperty('moduleVersion', nextVersion)
|
||||
|
||||
gradlePropertiesPath.withWriter(StandardCharsets.UTF_8.name(), { wr ->
|
||||
gradleProperties.each {
|
||||
wr << "${it.key}=${it.value}"
|
||||
wr << "\n"
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
private String nextVersion() {
|
||||
def matcher = project.property('moduleVersion') =~ /^(.*\d+\.)(\d+)(-.+)?$/
|
||||
matcher.find()
|
||||
return matcher.group(1) + (matcher.group(2).toInteger() + 1) + (matcher.group(3) == null ? '' : matcher.group(3))
|
||||
}
|
||||
}
|
||||
@@ -1,40 +0,0 @@
|
||||
package libs
|
||||
|
||||
class LibsExtention {
|
||||
private def junit_version = '5.5.2'
|
||||
|
||||
final def commons_text = 'org.apache.commons:commons-text:1.9'
|
||||
final def lombok = 'org.projectlombok:lombok:1.18.12'
|
||||
final def refobj = 'ru.dmitriymx:reflection-object:1.0-BETA'
|
||||
|
||||
final def bukkit = filter([
|
||||
lib : 'org.bukkit:bukkit:1.12.2-R0.1-SNAPSHOT',
|
||||
exclude: [
|
||||
'com.google.code.gson:gson',
|
||||
'com.googlecode.json-simple:json-simple',
|
||||
'commons-lang:commons-lang',
|
||||
'org.yaml:snakeyaml'
|
||||
]])
|
||||
|
||||
final def test = [
|
||||
junit5: [
|
||||
"org.junit.jupiter:junit-jupiter-api:$junit_version",
|
||||
"org.junit.jupiter:junit-jupiter-engine:$junit_version"
|
||||
],
|
||||
mock : ['org.mockito:mockito-core:1.10.19'],
|
||||
h2db : 'com.h2database:h2:1.4.200'
|
||||
]
|
||||
|
||||
private static def filter(library) {
|
||||
Object[] result = new Object[2]
|
||||
result[0] = library.lib
|
||||
result[1] = {
|
||||
library.exclude.each { String excludeLibStr ->
|
||||
String[] excludeLib = excludeLibStr.split(':')
|
||||
exclude group: excludeLib[0], module: excludeLib[1]
|
||||
}
|
||||
}
|
||||
|
||||
return result
|
||||
}
|
||||
}
|
||||
@@ -1,13 +0,0 @@
|
||||
package libs
|
||||
|
||||
import org.gradle.api.Plugin
|
||||
import org.gradle.api.Project
|
||||
|
||||
class LibsPlugin implements Plugin<Project> {
|
||||
|
||||
@Override
|
||||
void apply(Project project) {
|
||||
project.extensions.create('libs', LibsExtention)
|
||||
project.extensions.create('repos', ReposExtention)
|
||||
}
|
||||
}
|
||||
@@ -1,20 +0,0 @@
|
||||
package libs
|
||||
|
||||
import org.gradle.api.Action
|
||||
import org.gradle.api.artifacts.repositories.MavenArtifactRepository
|
||||
|
||||
class ReposExtention {
|
||||
|
||||
final def mavenSpigotMC = createSimpleMavenRepo('SpigotMC repository', 'https://hub.spigotmc.org/nexus/content/groups/public')
|
||||
final def mavenDmxMcProject = createSimpleMavenRepo('DmitriyMX MC Project repository', 'https://dmx-mc-project.gitlab.io/maven-repository/')
|
||||
|
||||
private static Action<MavenArtifactRepository> createSimpleMavenRepo(String name, String url) {
|
||||
return new Action<MavenArtifactRepository>() {
|
||||
@Override
|
||||
void execute(MavenArtifactRepository mavenArtifactRepository) {
|
||||
mavenArtifactRepository.setName(name)
|
||||
mavenArtifactRepository.setUrl(url)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,636 +0,0 @@
|
||||
# GHAST TOOLS
|
||||
|
||||
|
||||
|
||||
|
||||
Набор вспомогательных инструментов для Bukkit API.
|
||||
_Основан на версии Bukkit API 1.12._
|
||||
|
||||
## Содержание
|
||||
|
||||
1. [Перед использованием](#перед-использованием)
|
||||
2. [GhastTools](#ghasttools)
|
||||
3. [AssetsManager](#assetsmanager)
|
||||
4. [BuildHelper](#buildhelper)
|
||||
5. [CommandManager](#commandmanager)
|
||||
6. [EffectsHelper](#effectshelper)
|
||||
7. [EventContext](#eventcontext)
|
||||
8. [JdbcTemplate](#jdbctemplate)
|
||||
9. [ScheduleManager](#schedulemanager)
|
||||
10. [ScheduleTask](#scheduletask)
|
||||
11. [I18n](#i18n)
|
||||
12. [XLog](#xlog)
|
||||
13. [Подключение](#подключение)
|
||||
1. [Gradle](#gradle)
|
||||
2. [Maven](#maven)
|
||||
|
||||
---
|
||||
|
||||
## Перед использованием
|
||||
|
||||
Перед началом использования, необходимо в вашем Bukkit-плагине прописать подобный код:
|
||||
|
||||
```java
|
||||
void onLoad() {
|
||||
GhastTools.setPlugin(this);
|
||||
}
|
||||
```
|
||||
|
||||
Это необходимо сделать, т.к. весь инструментарий основан на статических (static) методах.
|
||||
|
||||
Все методы данного набора инструментов объеденены в классы, выполняющие роль группировщиков.
|
||||
|
||||
## GhastTools
|
||||
|
||||
Методы общего назначения или без определённой группировки.
|
||||
|
||||
### loadConfig
|
||||
|
||||
Загрузка файла настроек плагина - `config.yml`.
|
||||
|
||||
```java
|
||||
YamlConfiguration config = GhastTools.loadConfig();
|
||||
```
|
||||
|
||||
По-умолчанию "гаст" пытается файл найти в папке плагина - `getDataFolder()`.
|
||||
Если файла там нет, то выгружает встроенный (имеющийся в `.jar` файле плагина) в эту папку и загружает его.
|
||||
|
||||
```java
|
||||
YamlConfiguration config = GhastTools.loadConfig(false);
|
||||
```
|
||||
|
||||
Если передать параметр `false`, то при отсутствии файла `config.yml` в папке плагина,
|
||||
будет загруден исключительно встроенный файл настроек.
|
||||
|
||||
## AssetsManager
|
||||
|
||||
Методы по работе с файлами плагина (_"ассетами"_).
|
||||
|
||||
У каждой группы методов один и тот же набор входных параметров:
|
||||
|
||||
- `resourceName` - наименование и путь к файлу в папке плагина
|
||||
- `defaultResourceName` - наименование и путь к файлу в плагине.
|
||||
_Опционально. По-умолчанию равнен `resourceName`_
|
||||
- `saveDefault` - необходимость скопировать содержимое файла из `defaultResourceName` в файл `resourceName`.
|
||||
_Опционально. По-умолчанию равен `true`_
|
||||
|
||||
Правила поиска файлов так же одинаков для каждой группы:
|
||||
|
||||
- В начале файл ищется в папке плагина
|
||||
- Если файл отсутствует в папке плагина, то...
|
||||
- если `defaultResourceName` не равен `null`...
|
||||
- если `saveDefault` равен `true`, то файл из плагина будет выгружен в папку плагина и от туда загружен в память.
|
||||
- если `saveDefault` равен `false`, то данные будут взяты из файлв в плагине.
|
||||
- если `defaultResourceName` равен `null`, то будет брошено исключение `AssetsException` с описанием ошибки вида "Файл X не найден".
|
||||
|
||||
### getAsInputStream
|
||||
|
||||
```java
|
||||
InputStream inputStream = AssetsManager.getAsInputStream("translate.ru.yml", "translate.yml", false);
|
||||
```
|
||||
|
||||
### getAsReader
|
||||
|
||||
```java
|
||||
Reader reader = AssetsManager.getAsReader("translate.ru.yml", "translate.yml", false);
|
||||
```
|
||||
|
||||
### getAsString
|
||||
|
||||
```java
|
||||
String string = AssetsManager.getAsString("readme.txt", "readme.txt", StandardCharsets.UTF_8, false);
|
||||
```
|
||||
|
||||
У этой группы есть дополнительный _опциональный_ параметр - `charset` - в котором указывается кодиривка получаемой строки.
|
||||
_По-умолчанию равен `StandardCharsets.UTF_8`_
|
||||
|
||||
## BuildHelper
|
||||
|
||||
Набор методов облегчающих размецение объектов на карте.
|
||||
|
||||
### placeSkull
|
||||
|
||||
```java
|
||||
Location location = ...;
|
||||
Skull skull = BuildHelper.placeSkull(location, BlockFace.NORTH)
|
||||
```
|
||||
|
||||
### placeSignWall
|
||||
|
||||
```java
|
||||
Location location = ...;
|
||||
Sign signWall = BuildHelper.placeSignWall(location, BlockFace.NORTH)
|
||||
```
|
||||
|
||||
## CommandManager
|
||||
|
||||
Регистрация команд.
|
||||
|
||||
Имеется два варианта использования: упрощённый
|
||||
|
||||
```java
|
||||
CommandManager.register("start", (sender, args) -> sender.sendMessage("hello!"));
|
||||
```
|
||||
|
||||
и подробный:
|
||||
|
||||
```java
|
||||
CommandManager.create("start")
|
||||
.useOnlyPlayer()
|
||||
.executer((sender, args) -> sender.sendMessage("hello!"))
|
||||
.register();
|
||||
```
|
||||
|
||||
### register
|
||||
|
||||
Упрощенная регистрация команды. Указывается лишь название команды и исполнитель.
|
||||
|
||||
```java
|
||||
CommandManager.register("start", (sender, args) -> sender.sendMessage("hello!"));
|
||||
```
|
||||
|
||||
### create
|
||||
|
||||
Конструктор для подробного варианта регистрации команды.
|
||||
|
||||
```java
|
||||
CommandManager.Builder builder = CommandManager.create("start");
|
||||
```
|
||||
|
||||
### executer
|
||||
|
||||
Указание исполнителя для команды
|
||||
|
||||
```java
|
||||
CommandManager.Builder builder = CommandManager.create("start")
|
||||
.executer((sender, args) -> sender.sendMessage("hello!"));
|
||||
```
|
||||
|
||||
### onError
|
||||
|
||||
Обработчик исключений
|
||||
|
||||
```java
|
||||
CommandManager.Builder builder = CommandManager.create("start")
|
||||
.onError((sender, commandName, args, exception) -> {
|
||||
sender.sendMessage(ChatColor.RED + "Произошла ошибка при выполнении команды '" + commandName + "'.");
|
||||
exception.printStackTrace();
|
||||
});
|
||||
```
|
||||
|
||||
### useOnlyPlayer
|
||||
|
||||
Указание, что данную команду могут использовать только Игроки.
|
||||
Опционально можно указать сообщение, которое будет выводиться в консоль.
|
||||
_Отменяет действие указателя `useOnlyConsole`_
|
||||
|
||||
```java
|
||||
CommandManager.Builder builder = CommandManager.create("start")
|
||||
.useOnlyPlayer("Команду могут использовать только игроки");
|
||||
```
|
||||
|
||||
### useOnlyConsole
|
||||
|
||||
Указание, что данную команду можно использовать только в консоле.
|
||||
Опционально можно указать сообщение, которое будет выводиться Игроку.
|
||||
_Отменяет действие указателя `useOnlyPlayer`_
|
||||
|
||||
```java
|
||||
CommandManager.Builder builder = CommandManager.create("start")
|
||||
.useOnlyConsole(ChatColor.RED + "Команду можно использовать только в консоли");
|
||||
```
|
||||
|
||||
### register
|
||||
|
||||
Регистрация описанной в Конструкторе команды.
|
||||
|
||||
```java
|
||||
CommandManager.create("start")
|
||||
.useOnlyPlayer()
|
||||
.executer((sender, args) -> sender.sendMessage("hello!"))
|
||||
.register();
|
||||
```
|
||||
|
||||
## EffectsHelper
|
||||
|
||||
Набор методов для работы с эффектами.
|
||||
|
||||
### playSound
|
||||
|
||||
Воспроизвести звук.
|
||||
|
||||
```java
|
||||
Location location = ...;
|
||||
EffectsHelper.playSound(location, Sound.AMBIENT_CAVE, 1.0f);
|
||||
```
|
||||
|
||||
### particle
|
||||
|
||||
Создание частиц.
|
||||
|
||||
```java
|
||||
Location location = ...;
|
||||
EffectsHelper.particle(location, Particle.REDSTONE, 1.0d, 1.0d, 1.0d, 1.0d, 5);
|
||||
```
|
||||
|
||||
## EventContext
|
||||
|
||||
Регистрация группы обработчиков событий, объединённых общим условием выполнения.
|
||||
|
||||
```java
|
||||
EventContext.create()
|
||||
.filter(() -> Bukkit.getOnlinePlayers().size() > 10)
|
||||
.onEvent(PlayerJoinEvent.class, event -> { event.getPlayer().kickPlayer("Max players"); });
|
||||
```
|
||||
|
||||
### create
|
||||
|
||||
Создание контекста событий.
|
||||
|
||||
```java
|
||||
EventContext eventContext = EventContext.create();
|
||||
```
|
||||
|
||||
### filter
|
||||
|
||||
Условие, при котором будут срабатывать обработчики событий в данном контексте.
|
||||
|
||||
```java
|
||||
EventContext.create()
|
||||
.filter(() -> Bukkit.getOnlinePlayers().size() > 10)
|
||||
```
|
||||
|
||||
### onEvent
|
||||
|
||||
Указание события и его обработчика.
|
||||
_Обработчик события регистрируется сразу же._
|
||||
|
||||
```java
|
||||
EventContext.create()
|
||||
.filter(() -> Bukkit.getOnlinePlayers().size() > 10)
|
||||
.onEvent(PlayerJoinEvent.class, event -> event.getPlayer().kickPlayer("Max players"));
|
||||
```
|
||||
|
||||
### cancelEvent
|
||||
|
||||
Отменить событие.
|
||||
_Обработчик события регистрируется сразу же._
|
||||
|
||||
```java
|
||||
EventContext.create()
|
||||
.cancelEvent(BlockPlaceEvent.class);
|
||||
```
|
||||
|
||||
эквивалентен коду:
|
||||
|
||||
```java
|
||||
EventContext.create()
|
||||
.onEvent(BlockPlaceEvent.class, event -> event.setCancelled(true))
|
||||
```
|
||||
|
||||
## JdbcTemplate
|
||||
|
||||
Инструмент для упрощения работы с SQL базами данных, работающими через JDBC.
|
||||
|
||||
Для начала потребуется создать объект `DataSource`
|
||||
|
||||
```java
|
||||
// На примере MySQL
|
||||
MysqlDataSource dataSource = new MysqlDataSource();
|
||||
dataSource.setServerName("localhost");
|
||||
dataSource.setPort(3306);
|
||||
dataSource.setCharacterEncoding(StandardCharsets.UTF_8.name());
|
||||
dataSource.setDatabaseName("MyDataBase");
|
||||
dataSource.setUser("root");
|
||||
dataSource.setPassword("secret");
|
||||
```
|
||||
|
||||
После чего создать `JdbcTemplate`
|
||||
|
||||
```java
|
||||
JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
|
||||
```
|
||||
|
||||
### execute
|
||||
|
||||
Выполнение SQL запроса без последующей обработки результатов выполнения.
|
||||
|
||||
```java
|
||||
jdbcTemplate.execute("CREATE TABLE my_table (id int, name varchar(16));");
|
||||
```
|
||||
|
||||
### query
|
||||
|
||||
Выполнение SQL запроса и обработка его результатов.
|
||||
Может возвращать любой тип объектов.
|
||||
|
||||
```java
|
||||
String name = jdbcTemplate.query("SELECT name FROM my_table LIMIT 0,1", resultSet -> {
|
||||
if (resultSet.next()) {
|
||||
return resultSet.getString("name");
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
```java
|
||||
List<String> names = jdbcTemplate.query("SELECT name FROM my_table", resultSet -> {
|
||||
if (resultSet.next()) {
|
||||
List<String> list = new ArrayList<>();
|
||||
do {
|
||||
list.add(resultSet.getString("name"));
|
||||
} while (resultSet.next());
|
||||
return list;
|
||||
} else {
|
||||
return Collections.emptyList();
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### queryOne
|
||||
|
||||
Выполнение SQL запроса с расчетом, что результат будет единичным либо не будет вовсе.
|
||||
Возвращает `Optional`.
|
||||
|
||||
```java
|
||||
Optional<String> optName = jdbcTemplate.queryOne("SELECT name FROM my_table WHERE name LIKE 'dmitriymx'", rs -> rs.getString("name"));
|
||||
```
|
||||
|
||||
### queryList
|
||||
|
||||
Выполнение SQL запроса и обработка результата как списка данных.
|
||||
Возвращает `List`.
|
||||
|
||||
```java
|
||||
List<String> names = jdbcTemplate.queryList("SELECT name FROM my_table", (resultSet, rowNum) -> resultSet.getString("name"));
|
||||
```
|
||||
|
||||
### queryForMap
|
||||
|
||||
Выполнение SQL запроса с расчетом, что результат будет единичным либо не будет вовсе.
|
||||
Возвращает `Map<String, Object>`, где ключ — это наименование колонок таблицы, а значения — это значения в ячейках таблицы.
|
||||
|
||||
```java
|
||||
Map<String, Object> map = jdbcTemplate.queryForMap("SELECT * FROM my_table LIMIT 0,1;");
|
||||
```
|
||||
|
||||
### queryForMapList
|
||||
|
||||
Выполнение SQL запроса и обработка результата как списка данных.
|
||||
Возвращает `List<Map<String, Object>>`, где ключ — это наименование колонок таблицы, а значения — это значения в ячейках таблицы.
|
||||
|
||||
```java
|
||||
List<Map<String, Object>> mapList = jdbcTemplate.queryForMapList("SELECT * FROM my_table");
|
||||
```
|
||||
|
||||
### update
|
||||
|
||||
Выполнение SQL запроса где будет происходить обновление данных в таблице.
|
||||
Под "обновлением" подразумеваются любые изменения в таблице: `UPDATE`, `DELETE`, `INSERT`.
|
||||
Возвращает число строк, которые были _по факту обновлены_ в таблице.
|
||||
|
||||
```java
|
||||
int rows = jdbcTemplate.update("DELETE FROM my_table WHERE name LIKE 'dmitriymx';");
|
||||
```
|
||||
|
||||
## ScheduleManager
|
||||
|
||||
Набор методов для создания параллельных задач, выполняющихся один раз или по рассписанию.
|
||||
|
||||
### createTask
|
||||
|
||||
Создание конструктора задачи.
|
||||
|
||||
```java
|
||||
ScheduleManager.Builder builder = ScheduleManager.createTask();
|
||||
```
|
||||
|
||||
### useBukkitScheduler
|
||||
|
||||
Если задача будет взаимодействоватьс **Bukkit API** или необходима привязка задачи к _тикам_,
|
||||
то необходимо использовать данный указатель.
|
||||
|
||||
В ином случае, указатель не нужен.
|
||||
|
||||
```java
|
||||
ScheduleManager.Builder builder = ScheduleManager.createTask()
|
||||
.useBukkitScheduler();
|
||||
```
|
||||
|
||||
### after
|
||||
|
||||
Указание, что задачу нужно выполнить не сразу, а с некоторой задержкой перед запуском.
|
||||
|
||||
```java
|
||||
ScheduleManager.Builder builder = ScheduleManager.createTask()
|
||||
.after(5, TimeUnit.MINUTES);
|
||||
```
|
||||
|
||||
### every
|
||||
|
||||
Указание, что задачу нужно повторять через указанное время.
|
||||
|
||||
```java
|
||||
ScheduleManager.Builder builder = ScheduleManager.createTask()
|
||||
.every(5, TimeUnit.MINUTES);
|
||||
```
|
||||
|
||||
### create
|
||||
|
||||
Создание описанной задачи.
|
||||
|
||||
```java
|
||||
ScheduleTask scheduleTask = ScheduleManager.createTask()
|
||||
.every(1, TimeUnit.SECONDS)
|
||||
.create(() -> Bukkit.getServer().getLogger().info("TimeMS: " + System.currentTimeMillis()));
|
||||
```
|
||||
|
||||
_Задача будет только создана. Для её выполнения нужно вызвать `scheduleTask.start()`._
|
||||
|
||||
### execute
|
||||
|
||||
Создание и выполнение описанной задачи.
|
||||
|
||||
```java
|
||||
ScheduleTask scheduleTask = ScheduleManager.createTask()
|
||||
.every(1, TimeUnit.SECONDS)
|
||||
.execute(() -> Bukkit.getServer().getLogger().info("TimeMS: " + System.currentTimeMillis()));
|
||||
```
|
||||
|
||||
## ScheduleTask
|
||||
|
||||
Вспомогательный объект, созданный через `ScheduleManager`. Позволяет управлять созданной задачей.
|
||||
|
||||
### start
|
||||
|
||||
Запускает задачу, если она еще не запущена.
|
||||
|
||||
```java
|
||||
ScheduleTask scheduleTask = ...;
|
||||
scheduleTask.start();
|
||||
```
|
||||
|
||||
### isCanceled
|
||||
|
||||
Возвращает состояние задачи. Если `true`, значит задача была или _отменена/остоновлена_ или была завершена.
|
||||
|
||||
```java
|
||||
ScheduleTask scheduleTask = ...;
|
||||
boolean status = scheduleTask.isCanceled();
|
||||
```
|
||||
|
||||
### cancel
|
||||
|
||||
Отменяет/Остонавливает выполнение задачи.
|
||||
|
||||
```java
|
||||
ScheduleTask scheduleTask = ...;
|
||||
scheduleTask.cancel();
|
||||
```
|
||||
|
||||
## I18n
|
||||
|
||||
Инструмент для работы с мультиязыковыми сообщениями или просто сообщениями, которые храняться в отдельном файле.
|
||||
|
||||
Позволяет использовать шаблонизированные сообщения вида `Привет, {player}!`.
|
||||
|
||||
### loadMessages
|
||||
|
||||
Загрузка сообщений в инструмент.
|
||||
|
||||
Передать можно как "мапу" с перечислением ключ-сообщение, так и `Reader` на файл в формате `key=message` (как у `Properties`).
|
||||
|
||||
```java
|
||||
Map<String, String> messagesMap = ...;
|
||||
I18n.loadMessages(messagesMap);
|
||||
```
|
||||
|
||||
```java
|
||||
Reader reader = AssetsManager.getAsReader("messages.properties");
|
||||
I18n.loadMessages(reader);
|
||||
```
|
||||
|
||||
В первом параметре можно указать код языка, для которого загружаются сообщения. По-умолчанию будет "en".
|
||||
|
||||
```java
|
||||
Map<String, String> enMessagesMap = ...;
|
||||
Map<String, String> ruMessagesMap = ...;
|
||||
|
||||
I18n.loadMessages("en", enMessagesMap);
|
||||
I18n.loadMessages("ru", ruMessagesMap);
|
||||
```
|
||||
|
||||
```java
|
||||
Reader readerEn = AssetsManager.getAsReader("messages.properties");
|
||||
Reader readerRu = AssetsManager.getAsReader("messages.ru.properties");
|
||||
|
||||
I18n.loadMessages("en", readerEn);
|
||||
I18n.loadMessages("ru", readerRu);
|
||||
```
|
||||
|
||||
### get
|
||||
|
||||
Получение сообщения по его ключу.
|
||||
|
||||
```java
|
||||
String msg = I18n.get("player.join.msg");
|
||||
```
|
||||
|
||||
Если следующим сообщением указать `Map<String, Object>`, то можно будет воспользоваться шаблонизатором.
|
||||
|
||||
```java
|
||||
Map<String, String> messagesMap = new HashMap<>();
|
||||
messagesMap.put("player.join.msg", "Привет, {player}!");
|
||||
|
||||
I18n.loadMessages(messagesMap);
|
||||
|
||||
Map<String, String> params = new HashMap<>();
|
||||
params.put("player", event.getPlayer().getName());
|
||||
|
||||
String msg = I18n.get("player.join.msg", params);
|
||||
```
|
||||
|
||||
Однако можно создавать `Map<String, String> params` явно, а воспользоваться [paramBuilder()](#parambuilder)
|
||||
|
||||
```java
|
||||
String msg = I18n.get("player.join.msg", I18n.paramBuilder()
|
||||
.add("player", event.getPlayer().getName())
|
||||
.build());
|
||||
```
|
||||
|
||||
Можно первым параметром указать код языка.
|
||||
|
||||
```java
|
||||
String msg = I18n.get("ru", "player.join.msg");
|
||||
```
|
||||
|
||||
### paramBuilder
|
||||
|
||||
Инструмент для параметизирования шаблонов сообщений.
|
||||
|
||||
```java
|
||||
Map<String, Object> params = I18n.paramBuilder()
|
||||
.add("player", event.getPlayer().getName())
|
||||
.build();
|
||||
String msg = I18n.get("player.join.msg", params);
|
||||
```
|
||||
|
||||
## XLog
|
||||
|
||||
Замена стандартному `getLogger()`, который использует `java.utils.Logger` и не всегда удобен для логирования.
|
||||
|
||||
Имеет 4 уровня логирования: `debug`, `info`, `warning`, `error`.
|
||||
|
||||
Сообщения могут быть шаблонизированными. Синтаксис шаблонов — `java.text.MessageFormat`.
|
||||
|
||||
Примеры:
|
||||
|
||||
```java
|
||||
XLog.info("Hello");
|
||||
XLog.info("Player {0} join game", event.getPlayer().getName());
|
||||
|
||||
XLog.error("ERROR!", exception);
|
||||
XLog.error("ERROR: {0}", exception.getMessage());
|
||||
// Для экранирования "{" нужно перед ней поставить "'".
|
||||
// А для использования "'" нужно их дублировать.
|
||||
XLog.error("ERROR ''{0}'' in Event '{{1}'}: {2}", exception.getClass(), event.getClass(), exception.getMessage());
|
||||
XLog.error("ERROR: {0}", exception.getMessage(), exception);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Подключение
|
||||
|
||||
### Gradle
|
||||
|
||||
```groovy
|
||||
repositories {
|
||||
maven { url 'https://dmx-mc-project.gitlab.io/maven-repository/' }
|
||||
}
|
||||
```
|
||||
|
||||
```groovy
|
||||
implementation group: 'ghast', name: 'ghast-tools', version: '@VERSION@'
|
||||
```
|
||||
|
||||
### Maven
|
||||
|
||||
```xml
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>dmx-mc-project</id>
|
||||
<url>https://dmx-mc-project.gitlab.io/maven-repository/</url>
|
||||
</repository>
|
||||
</repositories>
|
||||
```
|
||||
|
||||
```xml
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>ghast</groupId>
|
||||
<artifactId>ghast-tools</artifactId>
|
||||
<version>@VERSION@</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
```
|
||||
@@ -1 +1,3 @@
|
||||
projectGroup=ghast
|
||||
projectGroup=ghast
|
||||
projectName=ghast-tools
|
||||
projectVersion=1.6
|
||||
@@ -1,5 +0,0 @@
|
||||
dependencies {
|
||||
implementation project(':tools')
|
||||
|
||||
compileOnly libs.bukkit
|
||||
}
|
||||
@@ -1,2 +0,0 @@
|
||||
moduleName=ghast-mg
|
||||
moduleVersion=1.0-SNAPSHOT
|
||||
@@ -1,29 +0,0 @@
|
||||
package ghast.mg;
|
||||
|
||||
import com.google.common.collect.Maps;
|
||||
import ghast.mg.stage.GameStage;
|
||||
import ghast.mg.stage.StageContext;
|
||||
import lombok.Getter;
|
||||
|
||||
import java.util.Map;
|
||||
|
||||
public abstract class Game {
|
||||
|
||||
private final Map<GameStage, StageContext> stageMap = Maps.newHashMap();
|
||||
|
||||
@Getter
|
||||
private GameStage stage;
|
||||
|
||||
public StageContext setupStage(GameStage stage) {
|
||||
return stageMap.computeIfAbsent(stage, stage1 -> new StageContext(this, stage1));
|
||||
}
|
||||
|
||||
public void changeStage(GameStage nextStage) {
|
||||
StageContext stageContext = stageMap.get(nextStage);
|
||||
if (stageContext != null && stageContext.getScenario() != null) {
|
||||
stageContext.getScenario().run();
|
||||
}
|
||||
|
||||
this.stage = nextStage;
|
||||
}
|
||||
}
|
||||
@@ -1,5 +0,0 @@
|
||||
package ghast.mg.stage;
|
||||
|
||||
public interface GameStage {
|
||||
|
||||
}
|
||||
@@ -1,47 +0,0 @@
|
||||
package ghast.mg.stage;
|
||||
|
||||
import ghast.EventContext;
|
||||
import ghast.mg.Game;
|
||||
import lombok.Getter;
|
||||
import org.bukkit.event.Cancellable;
|
||||
import org.bukkit.event.Event;
|
||||
import org.bukkit.event.EventPriority;
|
||||
|
||||
import java.util.function.Consumer;
|
||||
|
||||
public class StageContext {
|
||||
|
||||
private final EventContext eventContext;
|
||||
|
||||
@Getter
|
||||
private Runnable scenario;
|
||||
|
||||
public StageContext(Game gameInstance, GameStage stage) {
|
||||
eventContext = EventContext.create();
|
||||
eventContext.filter(() -> gameInstance.getStage() == (stage));
|
||||
}
|
||||
|
||||
public StageContext onSetStage(Runnable scenario) {
|
||||
this.scenario = scenario;
|
||||
return this;
|
||||
}
|
||||
|
||||
public <T extends Event> StageContext onEvent(Class<T> eventType, EventPriority eventPriority, Consumer<T> consumer) {
|
||||
eventContext.onEvent(eventType, eventPriority, consumer);
|
||||
return this;
|
||||
}
|
||||
|
||||
public <T extends Event> StageContext onEvent(Class<T> eventType, Consumer<T> consumer) {
|
||||
return onEvent(eventType, EventPriority.NORMAL, consumer);
|
||||
}
|
||||
|
||||
public <T extends Event & Cancellable> StageContext cancelEvent(Class<T> eventType, EventPriority eventPriority) {
|
||||
eventContext.cancelEvent(eventType, eventPriority);
|
||||
return this;
|
||||
}
|
||||
|
||||
public <T extends Event & Cancellable> StageContext cancelEvent(Class<T> eventType) {
|
||||
eventContext.cancelEvent(eventType);
|
||||
return this;
|
||||
}
|
||||
}
|
||||
@@ -1,19 +0,0 @@
|
||||
package ghast.mg.stage;
|
||||
|
||||
public enum StandartGameStage implements GameStage {
|
||||
|
||||
/**
|
||||
* Ожидание новой игровой сессии.
|
||||
*/
|
||||
WAIT_NEW_GAME,
|
||||
|
||||
/**
|
||||
* Начало игровой сессии.
|
||||
*/
|
||||
START_GAME,
|
||||
|
||||
/**
|
||||
* Завершение игровой сессии.
|
||||
*/
|
||||
END_GAME
|
||||
}
|
||||
@@ -1,3 +1,2 @@
|
||||
include 'tools'
|
||||
include 'minigame'
|
||||
rootProject.name = projectName
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package ghast.assets;
|
||||
package ghast;
|
||||
|
||||
public class AssetsException extends RuntimeException {
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
package ghast.assets;
|
||||
package ghast;
|
||||
|
||||
import ghast.GhastTools;
|
||||
import lombok.experimental.UtilityClass;
|
||||
import org.bukkit.plugin.Plugin;
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
package ghast;
|
||||
|
||||
import ghast.assets.AssetsManager;
|
||||
import lombok.experimental.UtilityClass;
|
||||
import org.bukkit.configuration.file.YamlConfiguration;
|
||||
import org.bukkit.plugin.Plugin;
|
||||
@@ -1,7 +1,6 @@
|
||||
package ghast.scheduler;
|
||||
package ghast;
|
||||
|
||||
import com.google.common.util.concurrent.ThreadFactoryBuilder;
|
||||
import ghast.GhastTools;
|
||||
import lombok.AccessLevel;
|
||||
import lombok.NoArgsConstructor;
|
||||
import lombok.experimental.UtilityClass;
|
||||
@@ -46,68 +45,48 @@ public class ScheduleManager {
|
||||
return this;
|
||||
}
|
||||
|
||||
public ScheduleTask create(Runnable runnable) {
|
||||
public void execute(Runnable runnable) {
|
||||
if (useBukkitScheduler) {
|
||||
return createBukkitSchedule(runnable);
|
||||
createBukkitSchedule(runnable);
|
||||
} else {
|
||||
return createSchedule(runnable);
|
||||
createSchedule(runnable);
|
||||
}
|
||||
}
|
||||
|
||||
public ScheduleTask execute(Runnable runnable) {
|
||||
ScheduleTask scheduleTask = create(runnable);
|
||||
scheduleTask.start();
|
||||
return scheduleTask;
|
||||
}
|
||||
|
||||
private ScheduleTask createBukkitSchedule(Runnable runnable) {
|
||||
private void createBukkitSchedule(Runnable runnable) {
|
||||
BukkitScheduler bukkitScheduler = Bukkit.getScheduler();
|
||||
BukkitScheduleTask resultTask;
|
||||
|
||||
if (this.afterMs == null && this.everyMs == null) {
|
||||
resultTask = new BukkitScheduleTask(() -> bukkitScheduler.runTask(GhastTools.getPlugin(), runnable));
|
||||
bukkitScheduler.runTask(GhastTools.getPlugin(), runnable);
|
||||
} else if (this.everyMs != null) {
|
||||
long everyTicks = this.everyMs / MS_PER_ONE_TICK;
|
||||
long afterTicks = this.afterMs != null ? this.afterMs / MS_PER_ONE_TICK : 0;
|
||||
resultTask = new BukkitScheduleTask(() ->
|
||||
bukkitScheduler.runTaskTimer(GhastTools.getPlugin(), runnable, afterTicks, everyTicks));
|
||||
bukkitScheduler.runTaskTimer(GhastTools.getPlugin(), runnable, afterTicks, everyTicks);
|
||||
} else {
|
||||
long ticks = this.afterMs / MS_PER_ONE_TICK;
|
||||
resultTask = new BukkitScheduleTask(() ->
|
||||
bukkitScheduler.runTaskLater(GhastTools.getPlugin(), runnable, ticks));
|
||||
bukkitScheduler.runTaskLater(GhastTools.getPlugin(), runnable, ticks);
|
||||
}
|
||||
|
||||
return resultTask;
|
||||
}
|
||||
|
||||
private ScheduleTask createSchedule(Runnable runnable) {
|
||||
private void createSchedule(Runnable runnable) {
|
||||
ExecutorService executorService;
|
||||
JavaScheduleTask resultTask;
|
||||
|
||||
if (this.afterMs == null && this.everyMs == null) {
|
||||
executorService = Executors.newSingleThreadExecutor(THREAD_FACTORY);
|
||||
resultTask = new JavaScheduleTask(() -> executorService.submit(runnable));
|
||||
executorService.execute(runnable);
|
||||
} else if (this.everyMs != null) {
|
||||
ScheduledExecutorService scheduledExecutorService
|
||||
= Executors.newScheduledThreadPool(1, THREAD_FACTORY);
|
||||
|
||||
resultTask = new JavaScheduleTask(() ->
|
||||
scheduledExecutorService.scheduleAtFixedRate(runnable,
|
||||
this.afterMs != null ? this.afterMs : 0,
|
||||
everyMs, TimeUnit.MILLISECONDS));
|
||||
|
||||
ScheduledExecutorService scheduledExecutorService = Executors.newScheduledThreadPool(1, THREAD_FACTORY);
|
||||
scheduledExecutorService.scheduleAtFixedRate(runnable,
|
||||
this.afterMs != null ? this.afterMs : 0,
|
||||
everyMs, TimeUnit.MILLISECONDS);
|
||||
executorService = scheduledExecutorService;
|
||||
} else {
|
||||
ScheduledExecutorService scheduledExecutorService
|
||||
= Executors.newScheduledThreadPool(1, THREAD_FACTORY);
|
||||
|
||||
resultTask = new JavaScheduleTask(() ->
|
||||
scheduledExecutorService.schedule(runnable, afterMs, TimeUnit.MILLISECONDS));
|
||||
ScheduledExecutorService scheduledExecutorService = Executors.newScheduledThreadPool(1, THREAD_FACTORY);
|
||||
scheduledExecutorService.schedule(runnable, afterMs, TimeUnit.MILLISECONDS);
|
||||
executorService = scheduledExecutorService;
|
||||
}
|
||||
|
||||
executorService.shutdown();
|
||||
return resultTask;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,13 +0,0 @@
|
||||
repositories {
|
||||
maven repos.mavenSpigotMC
|
||||
maven repos.mavenDmxMcProject
|
||||
}
|
||||
|
||||
dependencies {
|
||||
compileOnly libs.bukkit
|
||||
implementation libs.commons_text
|
||||
implementation libs.refobj
|
||||
|
||||
testImplementation libs.bukkit
|
||||
testImplementation libs.test.h2db
|
||||
}
|
||||
@@ -1,2 +0,0 @@
|
||||
moduleName=ghast-tools
|
||||
moduleVersion=1.11-SNAPSHOT
|
||||
@@ -1,27 +0,0 @@
|
||||
package ghast;
|
||||
|
||||
import lombok.experimental.UtilityClass;
|
||||
import org.bukkit.Location;
|
||||
import org.bukkit.Particle;
|
||||
import org.bukkit.Sound;
|
||||
import org.bukkit.SoundCategory;
|
||||
import org.bukkit.util.Vector;
|
||||
|
||||
@UtilityClass
|
||||
@SuppressWarnings("unused")
|
||||
public class EffectsHelper {
|
||||
|
||||
public void playSound(Location location, Sound sound, float pitch) {
|
||||
location.getWorld().playSound(location, sound, SoundCategory.MASTER, 1.0f, pitch);
|
||||
}
|
||||
|
||||
public void particle(Location location, Particle particle, double dx, double dy, double dz, double speed, int amount) {
|
||||
location.getWorld().spawnParticle(particle, location, amount, dx, dy, dz, speed);
|
||||
}
|
||||
|
||||
//TODO нужно проверить
|
||||
public void particle(Location location, Particle particle, Vector vector, double speed, int amount) {
|
||||
particle(location, particle, vector.getX(), vector.getY(), vector.getZ(), speed, amount);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
package ghast.database;
|
||||
|
||||
import java.sql.SQLException;
|
||||
|
||||
public class CannotGetJdbcConnectionException extends DataAccessException {
|
||||
|
||||
public CannotGetJdbcConnectionException(String msg, SQLException ex) {
|
||||
super(msg, ex);
|
||||
}
|
||||
}
|
||||
@@ -1,19 +0,0 @@
|
||||
package ghast.database;
|
||||
|
||||
import lombok.Getter;
|
||||
|
||||
@SuppressWarnings("java:S1165")
|
||||
@Getter
|
||||
public class DataAccessException extends RuntimeException {
|
||||
|
||||
private String sql;
|
||||
|
||||
public DataAccessException(String msg, Throwable cause) {
|
||||
super(msg, cause);
|
||||
}
|
||||
|
||||
public DataAccessException(String msg, String sql, Throwable cause) {
|
||||
this(msg, cause);
|
||||
this.sql = sql;
|
||||
}
|
||||
}
|
||||
@@ -1,22 +0,0 @@
|
||||
package ghast.database;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Optional;
|
||||
|
||||
public interface JdbcOperations {
|
||||
|
||||
void execute(String sql) throws DataAccessException;
|
||||
|
||||
<T> T query(String sql, ResultSetExtractor<T> rse) throws DataAccessException;
|
||||
|
||||
<T> Optional<T> queryOne(String sql, ResultSetExtractor<T> rse) throws DataAccessException;
|
||||
|
||||
<T> List<T> queryList(String sql, RowMapper<T> rowMapper) throws DataAccessException;
|
||||
|
||||
Map<String, Object> queryForMap(String sql) throws DataAccessException;
|
||||
|
||||
List<Map<String, Object>> queryForMapList(String sql) throws DataAccessException;
|
||||
|
||||
int update(String sql) throws DataAccessException;
|
||||
}
|
||||
@@ -1,244 +0,0 @@
|
||||
package ghast.database;
|
||||
|
||||
import ghast.XLog;
|
||||
import lombok.Getter;
|
||||
import lombok.NoArgsConstructor;
|
||||
import lombok.Setter;
|
||||
|
||||
import javax.sql.DataSource;
|
||||
import java.sql.Date;
|
||||
import java.sql.*;
|
||||
import java.util.*;
|
||||
|
||||
@NoArgsConstructor
|
||||
@Getter
|
||||
@Setter
|
||||
public class JdbcTemplate implements JdbcOperations {
|
||||
|
||||
private static final String DBG_SQL_INFO = "Execute SQL: {0}";
|
||||
private DataSource dataSource;
|
||||
|
||||
public JdbcTemplate(DataSource dataSource) {
|
||||
setDataSource(dataSource);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void execute(String sql) throws DataAccessException {
|
||||
XLog.debug(DBG_SQL_INFO, sql);
|
||||
|
||||
Connection connection = openConnection();
|
||||
Statement statement = null;
|
||||
try {
|
||||
statement = connection.createStatement();
|
||||
statement.execute(sql);
|
||||
} catch (SQLException e) {
|
||||
throw new DataAccessException("Error execute SQL", sql, e);
|
||||
} finally {
|
||||
closeStatement(statement);
|
||||
closeConnection(connection);
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public <T> T query(String sql, ResultSetExtractor<T> rse) throws DataAccessException {
|
||||
XLog.debug(DBG_SQL_INFO, sql);
|
||||
|
||||
Connection connection = openConnection();
|
||||
Statement statement = null;
|
||||
ResultSet resultSet = null;
|
||||
try {
|
||||
statement = connection.createStatement();
|
||||
resultSet = statement.executeQuery(sql);
|
||||
return rse.extractData(resultSet);
|
||||
} catch (SQLException e) {
|
||||
throw new DataAccessException("Error execute SQL", sql, e);
|
||||
} finally {
|
||||
closeResultSet(resultSet);
|
||||
closeStatement(statement);
|
||||
closeConnection(connection);
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public <T> Optional<T> queryOne(String sql, ResultSetExtractor<T> rse) throws DataAccessException {
|
||||
return query(sql, rs -> {
|
||||
if (rs.next()) {
|
||||
return Optional.ofNullable(rse.extractData(rs));
|
||||
} else {
|
||||
return Optional.empty();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
@Override
|
||||
public <T> List<T> queryList(String sql, final RowMapper<T> rowMapper) throws DataAccessException {
|
||||
return query(sql, rs -> {
|
||||
List<T> resultList;
|
||||
int rowNum = 0;
|
||||
if (rs.next()) {
|
||||
resultList = new ArrayList<>();
|
||||
|
||||
do {
|
||||
resultList.add(rowMapper.mapRow(rs, rowNum++));
|
||||
} while (rs.next());
|
||||
} else {
|
||||
resultList = Collections.emptyList();
|
||||
}
|
||||
|
||||
return resultList;
|
||||
});
|
||||
}
|
||||
|
||||
@Override
|
||||
public Map<String, Object> queryForMap(String sql) throws DataAccessException {
|
||||
return query(sql, rs -> {
|
||||
if (rs.next()) {
|
||||
ResultSetMetaData metaData = rs.getMetaData();
|
||||
int columnCount = metaData.getColumnCount();
|
||||
|
||||
return rowToMap(columnCount, metaData, rs);
|
||||
} else {
|
||||
return Collections.emptyMap();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<Map<String, Object>> queryForMapList(String sql) throws DataAccessException {
|
||||
return query(sql, rs -> {
|
||||
List<Map<String, Object>> resultList;
|
||||
|
||||
if (rs.next()) {
|
||||
resultList = new ArrayList<>();
|
||||
|
||||
ResultSetMetaData metaData = rs.getMetaData();
|
||||
int columnCount = metaData.getColumnCount();
|
||||
|
||||
do {
|
||||
resultList.add(rowToMap(columnCount, metaData, rs));
|
||||
} while (rs.next());
|
||||
} else {
|
||||
resultList = Collections.emptyList();
|
||||
}
|
||||
|
||||
return resultList;
|
||||
});
|
||||
}
|
||||
|
||||
@Override
|
||||
public int update(String sql) throws DataAccessException {
|
||||
XLog.debug(DBG_SQL_INFO, sql);
|
||||
|
||||
Connection connection = openConnection();
|
||||
Statement statement = null;
|
||||
try {
|
||||
statement = connection.createStatement();
|
||||
int rows = statement.executeUpdate(sql);
|
||||
XLog.debug("Affected {0} rows", rows);
|
||||
return rows;
|
||||
} catch (SQLException e) {
|
||||
XLog.error("Error execute SQL: {0}", e.getMessage(), e);
|
||||
return 0;
|
||||
} finally {
|
||||
closeStatement(statement);
|
||||
closeConnection(connection);
|
||||
}
|
||||
}
|
||||
|
||||
private Connection openConnection() {
|
||||
try {
|
||||
return getDataSource().getConnection();
|
||||
} catch (SQLException ex) {
|
||||
throw new CannotGetJdbcConnectionException("Could not get JDBC Connection", ex);
|
||||
}
|
||||
}
|
||||
|
||||
private String lookupColumnName(ResultSetMetaData resultSetMetaData, int columnIndex) throws SQLException {
|
||||
String name = resultSetMetaData.getColumnLabel(columnIndex);
|
||||
if (name == null || name.isEmpty()) {
|
||||
name = resultSetMetaData.getColumnName(columnIndex);
|
||||
}
|
||||
return name;
|
||||
}
|
||||
|
||||
private Map<String, Object> rowToMap(int columnCount, ResultSetMetaData metaData, ResultSet rs) throws SQLException {
|
||||
Map<String, Object> rowMap = new LinkedHashMap<>(columnCount);
|
||||
|
||||
for (int i = 1; i <= columnCount; i++) {
|
||||
String key = lookupColumnName(metaData, i);
|
||||
Object value = getResultSetRawValue(rs, i);
|
||||
rowMap.put(key, value);
|
||||
}
|
||||
|
||||
return rowMap;
|
||||
}
|
||||
|
||||
private Object getResultSetRawValue(ResultSet resultSet, int index) throws SQLException {
|
||||
Object obj = resultSet.getObject(index);
|
||||
if (obj == null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
String className = obj.getClass().getName();
|
||||
|
||||
if (obj instanceof Blob) {
|
||||
Blob blob = (Blob) obj;
|
||||
obj = blob.getBytes(1, (int) blob.length());
|
||||
} else if (obj instanceof Clob) {
|
||||
Clob clob = (Clob) obj;
|
||||
obj = clob.getSubString(1, (int) clob.length());
|
||||
} else if ("oracle.sql.TIMESTAMP".equals(className) || "oracle.sql.TIMESTAMPTZ".equals(className)) {
|
||||
obj = resultSet.getTimestamp(index);
|
||||
} else if (className.startsWith("oracle.sql.DATE")) {
|
||||
String metaDataClassName = resultSet.getMetaData().getColumnClassName(index);
|
||||
if ("java.sql.Timestamp".equals(metaDataClassName) || "oracle.sql.TIMESTAMP".equals(metaDataClassName)) {
|
||||
obj = resultSet.getTimestamp(index);
|
||||
} else {
|
||||
obj = resultSet.getDate(index);
|
||||
}
|
||||
} else if (obj instanceof Date
|
||||
&& "java.sql.Timestamp".equals(resultSet.getMetaData().getColumnClassName(index))) {
|
||||
obj = resultSet.getTimestamp(index);
|
||||
}
|
||||
|
||||
return obj;
|
||||
}
|
||||
|
||||
private void closeResultSet(ResultSet resultSet) {
|
||||
if (resultSet != null) {
|
||||
try {
|
||||
resultSet.close();
|
||||
} catch (SQLException e) {
|
||||
XLog.debug("Could not close JDBC ResultSet", e);
|
||||
} catch (Exception e) {
|
||||
XLog.debug("Unexpected exception on closing JDBC ResultSet", e);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void closeStatement(Statement statement) {
|
||||
if (statement != null) {
|
||||
try {
|
||||
statement.close();
|
||||
} catch (SQLException e) {
|
||||
XLog.debug("Could not close JDBC Statement", e);
|
||||
} catch (Exception e) {
|
||||
XLog.debug("Unexpected exception on closing JDBC Statement", e);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void closeConnection(Connection con) {
|
||||
if (con == null) {
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
con.close();
|
||||
} catch (SQLException e) {
|
||||
XLog.debug("Could not close JDBC Connection", e);
|
||||
} catch (Exception e) {
|
||||
XLog.debug("Unexpected exception on closing JDBC Connection", e);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,9 +0,0 @@
|
||||
package ghast.database;
|
||||
|
||||
import java.sql.ResultSet;
|
||||
import java.sql.SQLException;
|
||||
|
||||
public interface ResultSetExtractor<T> {
|
||||
|
||||
T extractData(ResultSet rs) throws SQLException, DataAccessException;
|
||||
}
|
||||
@@ -1,9 +0,0 @@
|
||||
package ghast.database;
|
||||
|
||||
import java.sql.ResultSet;
|
||||
import java.sql.SQLException;
|
||||
|
||||
public interface RowMapper<T> {
|
||||
|
||||
T mapRow(ResultSet rs, int rowNum) throws SQLException;
|
||||
}
|
||||
@@ -1,33 +0,0 @@
|
||||
package ghast.scheduler;
|
||||
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import org.bukkit.scheduler.BukkitTask;
|
||||
|
||||
import java.util.function.Supplier;
|
||||
|
||||
@RequiredArgsConstructor
|
||||
public class BukkitScheduleTask implements ScheduleTask {
|
||||
|
||||
private final Supplier<BukkitTask> generator;
|
||||
private BukkitTask bukkitTask;
|
||||
|
||||
@Override
|
||||
public void start() {
|
||||
if (isCanceled()) {
|
||||
bukkitTask = generator.get();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isCanceled() {
|
||||
return bukkitTask == null || bukkitTask.isCancelled();
|
||||
}
|
||||
|
||||
@Override
|
||||
public void cancel() {
|
||||
if (bukkitTask != null) {
|
||||
bukkitTask.cancel();
|
||||
bukkitTask = null;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,33 +0,0 @@
|
||||
package ghast.scheduler;
|
||||
|
||||
import lombok.RequiredArgsConstructor;
|
||||
|
||||
import java.util.concurrent.Future;
|
||||
import java.util.function.Supplier;
|
||||
|
||||
@RequiredArgsConstructor
|
||||
public class JavaScheduleTask implements ScheduleTask {
|
||||
|
||||
private final Supplier<Future<?>> generator;
|
||||
private Future<?> future;
|
||||
|
||||
@Override
|
||||
public void start() {
|
||||
if (future == null || future.isDone()) {
|
||||
future = generator.get();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isCanceled() {
|
||||
return future == null || future.isCancelled();
|
||||
}
|
||||
|
||||
@Override
|
||||
public void cancel() {
|
||||
if (future != null) {
|
||||
future.cancel(true);
|
||||
future = null;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,10 +0,0 @@
|
||||
package ghast.scheduler;
|
||||
|
||||
public interface ScheduleTask {
|
||||
|
||||
void start();
|
||||
|
||||
boolean isCanceled();
|
||||
|
||||
void cancel();
|
||||
}
|
||||
@@ -1,289 +0,0 @@
|
||||
package ghast.database;
|
||||
|
||||
import com.google.common.collect.ImmutableMap;
|
||||
import com.google.common.collect.Lists;
|
||||
import ghast.GhastTools;
|
||||
import org.apache.commons.lang3.builder.EqualsBuilder;
|
||||
import org.apache.commons.lang3.builder.HashCodeBuilder;
|
||||
import org.bukkit.plugin.Plugin;
|
||||
import org.h2.jdbcx.JdbcDataSource;
|
||||
import org.junit.jupiter.api.*;
|
||||
|
||||
import javax.sql.DataSource;
|
||||
import java.sql.Connection;
|
||||
import java.sql.DriverManager;
|
||||
import java.sql.ResultSet;
|
||||
import java.sql.SQLException;
|
||||
import java.text.MessageFormat;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Optional;
|
||||
import java.util.StringJoiner;
|
||||
import java.util.logging.Logger;
|
||||
import java.util.stream.Collectors;
|
||||
import java.util.stream.Stream;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.when;
|
||||
|
||||
class JdbcTemplateTest {
|
||||
|
||||
static final String JDBC_USER = "sa";
|
||||
static final String JDBC_PASSWORD = "";
|
||||
static final String JDBC_DB_NAME = "in_mem_db";
|
||||
static final String JDBC_URL = "jdbc:h2:mem:" + JDBC_DB_NAME + ";DB_CLOSE_DELAY=-1";
|
||||
|
||||
static final String TABLE_NAME = "TEST_TABLE";
|
||||
static final String COLUMN_ID = "ID";
|
||||
static final String COLUMN_NAME = "C_NAME";
|
||||
static final String COLUMN_VALUE = "C_VALUE";
|
||||
|
||||
static final Object[][] DATA = new Object[][]{
|
||||
{ "Player 1", 100 }, { "Player 2", 250 },
|
||||
{ "Player 3", 0 }, { "Player 4", 780 }
|
||||
};
|
||||
|
||||
static DataSource dataSource;
|
||||
JdbcTemplate jdbcTemplate;
|
||||
|
||||
@BeforeAll
|
||||
static void beforeAll() {
|
||||
Logger logger = Logger.getLogger(JdbcTemplateTest.class.getName());
|
||||
|
||||
Plugin mockPlugin = mock(Plugin.class);
|
||||
when(mockPlugin.getLogger()).thenReturn(logger);
|
||||
|
||||
GhastTools.setPlugin(mockPlugin);
|
||||
|
||||
JdbcDataSource jdbcDataSource = new JdbcDataSource();
|
||||
jdbcDataSource.setUser(JDBC_USER);
|
||||
jdbcDataSource.setPassword(JDBC_PASSWORD);
|
||||
jdbcDataSource.setURL(JDBC_URL);
|
||||
|
||||
dataSource = jdbcDataSource;
|
||||
}
|
||||
|
||||
@BeforeEach
|
||||
void before() {
|
||||
jdbcTemplate = new JdbcTemplate(dataSource);
|
||||
createTable();
|
||||
|
||||
String sql_head = MessageFormat.format("INSERT INTO {0} ({1}, {2}) VALUES ",
|
||||
TABLE_NAME, COLUMN_NAME, COLUMN_VALUE);
|
||||
StringJoiner sql_sj = new StringJoiner(", ");
|
||||
for (Object[] datum : DATA) {
|
||||
sql_sj.add(MessageFormat.format("( ''{0}'', {1} )", datum[0], datum[1]));
|
||||
}
|
||||
|
||||
jdbcTemplate.execute(sql_head + sql_sj.toString());
|
||||
}
|
||||
|
||||
@AfterEach
|
||||
void after() {
|
||||
dropTable();
|
||||
}
|
||||
|
||||
@Test
|
||||
void testQuery_Simple_Single() {
|
||||
String sql = MessageFormat.format("SELECT {2} FROM {0} WHERE {1} LIKE ''{3}''",
|
||||
TABLE_NAME, COLUMN_NAME, COLUMN_VALUE, DATA[0][0]);
|
||||
|
||||
Integer value = jdbcTemplate.query(sql, rs -> {
|
||||
if (rs.next()) {
|
||||
return rs.getInt(1);
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
});
|
||||
|
||||
assertEquals(DATA[0][1], value);
|
||||
}
|
||||
|
||||
@Test
|
||||
void testQuery_Simple_Optional() {
|
||||
String sql = MessageFormat.format("SELECT {2} FROM {0} WHERE {1} LIKE ''{3}''",
|
||||
TABLE_NAME, COLUMN_NAME, COLUMN_VALUE, DATA[0][0]);
|
||||
|
||||
Optional<Integer> optValue = jdbcTemplate.queryOne(sql, rs -> rs.getInt(1));
|
||||
|
||||
assertTrue(optValue.isPresent());
|
||||
assertEquals(DATA[0][1], optValue.get());
|
||||
}
|
||||
|
||||
@Test
|
||||
void testQuery_Simple_List() {
|
||||
String sql = MessageFormat.format("SELECT {2} FROM {0} WHERE {1} LIKE ''{3}'' OR {1} LIKE ''{4}''",
|
||||
TABLE_NAME, COLUMN_NAME, COLUMN_VALUE, DATA[0][0], DATA[1][0]);
|
||||
|
||||
List<Integer> listValues = jdbcTemplate.queryList(sql, (rs, rowNum) -> rs.getInt(1));
|
||||
|
||||
assertIterableEquals(Lists.newArrayList(DATA[0][1], DATA[1][1]), listValues);
|
||||
}
|
||||
|
||||
@Test
|
||||
void testQuery_Object_Single() {
|
||||
String sql = MessageFormat.format("SELECT {1}, {2} FROM {0} WHERE {1} LIKE ''{3}''",
|
||||
TABLE_NAME, COLUMN_NAME, COLUMN_VALUE, DATA[0][0]);
|
||||
|
||||
Player actualPlayer = jdbcTemplate.query(sql, rs -> {
|
||||
if (rs.next()) {
|
||||
Player player0 = new Player();
|
||||
player0.name = rs.getString(COLUMN_NAME);
|
||||
player0.value = rs.getInt(COLUMN_VALUE);
|
||||
|
||||
return player0;
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
});
|
||||
|
||||
Player expectedPlayer = new Player();
|
||||
expectedPlayer.name = (String) DATA[0][0];
|
||||
expectedPlayer.value = (int) DATA[0][1];
|
||||
|
||||
assertEquals(expectedPlayer, actualPlayer);
|
||||
}
|
||||
|
||||
@Test
|
||||
void testQuery_Object_List() {
|
||||
String sql = MessageFormat.format("SELECT {1}, {2} FROM {0}",
|
||||
TABLE_NAME, COLUMN_NAME, COLUMN_VALUE);
|
||||
|
||||
List<Player> actualPlayers = jdbcTemplate.queryList(sql, (rs, num) -> {
|
||||
Player player0 = new Player();
|
||||
player0.name = rs.getString(COLUMN_NAME);
|
||||
player0.value = rs.getInt(COLUMN_VALUE);
|
||||
|
||||
return player0;
|
||||
});
|
||||
|
||||
|
||||
List<Player> expectedPlayers = Stream.of(DATA)
|
||||
.map(datum -> {
|
||||
Player player1 = new Player();
|
||||
player1.name = (String) datum[0];
|
||||
player1.value = (int) datum[1];
|
||||
|
||||
return player1;
|
||||
})
|
||||
.collect(Collectors.toList());
|
||||
|
||||
|
||||
assertIterableEquals(expectedPlayers, actualPlayers);
|
||||
}
|
||||
|
||||
@Test
|
||||
void testQueryForMap() {
|
||||
String sql = MessageFormat.format("SELECT {1}, {2} FROM {0} WHERE {1} LIKE ''{3}''",
|
||||
TABLE_NAME, COLUMN_NAME, COLUMN_VALUE, DATA[0][0]);
|
||||
|
||||
Map<String, Object> actualMap = jdbcTemplate.queryForMap(sql);
|
||||
|
||||
Map<String, Object> expectedMap = ImmutableMap.of(
|
||||
COLUMN_NAME, DATA[0][0],
|
||||
COLUMN_VALUE, DATA[0][1]);
|
||||
|
||||
assertIterableEquals(expectedMap.entrySet(), actualMap.entrySet());
|
||||
}
|
||||
|
||||
@Test
|
||||
void testQueryForMapList() {
|
||||
String sql = MessageFormat.format("SELECT {1}, {2} FROM {0}",
|
||||
TABLE_NAME, COLUMN_NAME, COLUMN_VALUE);
|
||||
|
||||
List<Map<String, Object>> actualMapList = jdbcTemplate.queryForMapList(sql);
|
||||
|
||||
List<Map<String, Object>> expectedMapList = Stream.of(DATA)
|
||||
.map(datum -> ImmutableMap.of(COLUMN_NAME, datum[0], COLUMN_VALUE, datum[1]))
|
||||
.collect(Collectors.toList());
|
||||
|
||||
assertIterableEquals(expectedMapList, actualMapList);
|
||||
|
||||
}
|
||||
|
||||
@Test
|
||||
void testUpdate() {
|
||||
String newName = "Player X";
|
||||
String sql = MessageFormat.format("UPDATE {0} SET {1} = ''{3}'' WHERE {1} LIKE ''{2}''",
|
||||
TABLE_NAME, COLUMN_NAME, DATA[0][0], newName);
|
||||
|
||||
int rows = jdbcTemplate.update(sql);
|
||||
|
||||
assertEquals(1, rows);
|
||||
|
||||
sql = MessageFormat.format("SELECT {2} FROM {0} WHERE {1} LIKE ''{3}''",
|
||||
TABLE_NAME, COLUMN_NAME, COLUMN_VALUE, newName);
|
||||
|
||||
Integer value = jdbcTemplate.query(sql, rs -> {
|
||||
if (rs.next()) {
|
||||
return rs.getInt(1);
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
});
|
||||
|
||||
assertEquals(DATA[0][1], value);
|
||||
}
|
||||
|
||||
private void createTable() {
|
||||
jdbcTemplate.execute("CREATE TABLE " + TABLE_NAME + " (" +
|
||||
COLUMN_ID + " bigint auto_increment," +
|
||||
COLUMN_NAME + " varchar(16)," +
|
||||
COLUMN_VALUE + " integer)");
|
||||
}
|
||||
|
||||
private void dropTable() {
|
||||
jdbcTemplate.execute("DROP TABLE IF EXISTS " + TABLE_NAME);
|
||||
}
|
||||
|
||||
class Player {
|
||||
String name;
|
||||
int value;
|
||||
|
||||
@Override
|
||||
public boolean equals(Object o) {
|
||||
if (this == o) return true;
|
||||
if (!(o instanceof Player)) return false;
|
||||
Player player = (Player) o;
|
||||
return new EqualsBuilder().append(value, player.value).append(name, player.name).isEquals();
|
||||
}
|
||||
|
||||
@Override
|
||||
public int hashCode() {
|
||||
return new HashCodeBuilder(17, 37).append(name).append(value).toHashCode();
|
||||
}
|
||||
}
|
||||
|
||||
@Nested
|
||||
class JdbcTemplateTest_ExecuteTestCase {
|
||||
|
||||
@BeforeEach
|
||||
void before() {
|
||||
jdbcTemplate = new JdbcTemplate(dataSource);
|
||||
dropTable();
|
||||
}
|
||||
|
||||
@AfterEach
|
||||
void after() {
|
||||
dropTable();
|
||||
}
|
||||
|
||||
@Test
|
||||
void test() throws ClassNotFoundException, IllegalAccessException, InstantiationException, SQLException {
|
||||
createTable();
|
||||
|
||||
//region Check result
|
||||
Class.forName("org.h2.Driver").newInstance();
|
||||
Connection connection = DriverManager.getConnection(JDBC_URL, JDBC_USER, JDBC_PASSWORD);
|
||||
ResultSet resultSet = connection.getMetaData().getTables(JDBC_DB_NAME.toUpperCase(), "PUBLIC",
|
||||
TABLE_NAME.toUpperCase(), new String[]{"TABLE"});
|
||||
|
||||
assertTrue(resultSet.next());
|
||||
|
||||
resultSet.close();
|
||||
connection.close();
|
||||
//endregion
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user