Compare commits
10 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
2fc1bf36c1
|
|||
|
eb5396b891
|
|||
|
e12d005a25
|
|||
|
6e50fc278e
|
|||
|
c8866af418
|
|||
|
359dbba09a
|
|||
|
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.9'
|
||||
```
|
||||
|
||||
### 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.9</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
```
|
||||
@@ -1,3 +1,3 @@
|
||||
projectGroup=ghast
|
||||
projectName=ghast-tools
|
||||
projectVersion=1.4
|
||||
projectVersion=1.9
|
||||
@@ -8,6 +8,15 @@ public class DataAccessException extends RuntimeException {
|
||||
|
||||
private String sql;
|
||||
|
||||
public DataAccessException(String msg) {
|
||||
super(msg);
|
||||
}
|
||||
|
||||
public DataAccessException(String msg, String sql) {
|
||||
this(msg);
|
||||
this.sql = sql;
|
||||
}
|
||||
|
||||
public DataAccessException(String msg, Throwable cause) {
|
||||
super(msg, cause);
|
||||
}
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
package ghast.database;
|
||||
|
||||
public class EmptyResultDataAccessException extends IncorrectResultSizeDataAccessException {
|
||||
|
||||
public EmptyResultDataAccessException(int expectedSize) {
|
||||
super(expectedSize);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
package ghast.database;
|
||||
|
||||
public class IncorrectResultSizeDataAccessException extends DataAccessException {
|
||||
|
||||
public IncorrectResultSizeDataAccessException(int expectedSize) {
|
||||
super("Incorrect result size: expected " + expectedSize);
|
||||
}
|
||||
}
|
||||
@@ -2,7 +2,6 @@ package ghast.database;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Optional;
|
||||
|
||||
public interface JdbcOperations {
|
||||
|
||||
@@ -10,13 +9,15 @@ public interface JdbcOperations {
|
||||
|
||||
<T> T query(String sql, ResultSetExtractor<T> rse) throws DataAccessException;
|
||||
|
||||
<T> Optional<T> queryOne(String sql, ResultSetExtractor<T> rse) throws DataAccessException;
|
||||
<T> List<T> query(String sql, RowMapper<T> rowMapper) throws DataAccessException;
|
||||
|
||||
<T> List<T> queryList(String sql, RowMapper<T> rowMapper) throws DataAccessException;
|
||||
<T> T queryForObject(String sql, RowMapper<T> rowMapper) throws DataAccessException;
|
||||
|
||||
Map<String, Object> queryForMap(String sql) throws DataAccessException;
|
||||
|
||||
List<Map<String, Object>> queryForMapList(String sql) throws DataAccessException;
|
||||
List<Map<String, Object>> queryForList(String sql) throws DataAccessException;
|
||||
|
||||
int update(String sql) throws DataAccessException;
|
||||
|
||||
int delete(String sql) throws DataAccessException;
|
||||
}
|
||||
|
||||
@@ -6,16 +6,17 @@ import lombok.NoArgsConstructor;
|
||||
import lombok.Setter;
|
||||
|
||||
import javax.sql.DataSource;
|
||||
import java.sql.Date;
|
||||
import java.sql.*;
|
||||
import java.util.*;
|
||||
import java.util.ArrayList;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
@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) {
|
||||
@@ -24,7 +25,7 @@ public class JdbcTemplate implements JdbcOperations {
|
||||
|
||||
@Override
|
||||
public void execute(String sql) throws DataAccessException {
|
||||
XLog.debug(DBG_SQL_INFO, sql);
|
||||
XLog.debug("Execute SQL: {0}", sql);
|
||||
|
||||
Connection connection = openConnection();
|
||||
Statement statement = null;
|
||||
@@ -41,7 +42,7 @@ public class JdbcTemplate implements JdbcOperations {
|
||||
|
||||
@Override
|
||||
public <T> T query(String sql, ResultSetExtractor<T> rse) throws DataAccessException {
|
||||
XLog.debug(DBG_SQL_INFO, sql);
|
||||
XLog.debug("Execute SQL: {0}", sql);
|
||||
|
||||
Connection connection = openConnection();
|
||||
Statement statement = null;
|
||||
@@ -60,74 +61,71 @@ public class JdbcTemplate implements JdbcOperations {
|
||||
}
|
||||
|
||||
@Override
|
||||
public <T> Optional<T> queryOne(String sql, ResultSetExtractor<T> rse) throws DataAccessException {
|
||||
public <T> List<T> query(String sql, final RowMapper<T> rowMapper) throws DataAccessException {
|
||||
return query(sql, rs -> {
|
||||
if (rs.next()) {
|
||||
return Optional.ofNullable(rse.extractData(rs));
|
||||
} else {
|
||||
return Optional.empty();
|
||||
List<T> resultList = new ArrayList<>();
|
||||
int rowNum = 0;
|
||||
while (rs.next()) {
|
||||
resultList.add(rowMapper.mapRow(rs, rowNum++));
|
||||
}
|
||||
return resultList;
|
||||
});
|
||||
}
|
||||
|
||||
@Override
|
||||
public <T> List<T> queryList(String sql, final RowMapper<T> rowMapper) throws DataAccessException {
|
||||
public <T> T queryForObject(String sql, RowMapper<T> rowMapper) throws DataAccessException {
|
||||
return query(sql, rs -> {
|
||||
List<T> resultList;
|
||||
int rowNum = 0;
|
||||
if (rs.next()) {
|
||||
resultList = new ArrayList<>();
|
||||
T resultObj = rowMapper.mapRow(rs, 0);
|
||||
|
||||
do {
|
||||
resultList.add(rowMapper.mapRow(rs, rowNum++));
|
||||
} while (rs.next());
|
||||
if (rs.next()) {
|
||||
throw new IncorrectResultSizeDataAccessException(1);
|
||||
}
|
||||
|
||||
return resultObj;
|
||||
} else {
|
||||
resultList = Collections.emptyList();
|
||||
throw new EmptyResultDataAccessException(1);
|
||||
}
|
||||
|
||||
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 queryForObject(sql, (rs, rowNum) -> {
|
||||
ResultSetMetaData metaData = rs.getMetaData();
|
||||
int columnCount = metaData.getColumnCount();
|
||||
Map<String, Object> resultMap = new LinkedHashMap<>(columnCount);
|
||||
|
||||
return rowToMap(columnCount, metaData, rs);
|
||||
} else {
|
||||
return Collections.emptyMap();
|
||||
for (int i = 1; i <= columnCount; i++) {
|
||||
String key = lookupColumnName(metaData, i);
|
||||
Object value = getResultSetRawValue(rs, i);
|
||||
resultMap.put(key, value);
|
||||
}
|
||||
|
||||
return resultMap;
|
||||
});
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<Map<String, Object>> queryForMapList(String sql) throws DataAccessException {
|
||||
return query(sql, rs -> {
|
||||
List<Map<String, Object>> resultList;
|
||||
public List<Map<String, Object>> queryForList(String sql) throws DataAccessException {
|
||||
return query(sql, (rs, rowNum) -> {
|
||||
ResultSetMetaData metaData = rs.getMetaData();
|
||||
int columnCount = metaData.getColumnCount();
|
||||
Map<String, Object> resultMap = new LinkedHashMap<>(columnCount);
|
||||
|
||||
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();
|
||||
for (int i = 1; i <= columnCount; i++) {
|
||||
String key = lookupColumnName(metaData, i);
|
||||
Object value = getResultSetRawValue(rs, i);
|
||||
resultMap.put(key, value);
|
||||
}
|
||||
|
||||
return resultList;
|
||||
return resultMap;
|
||||
});
|
||||
}
|
||||
|
||||
@Override
|
||||
public int update(String sql) throws DataAccessException {
|
||||
XLog.debug(DBG_SQL_INFO, sql);
|
||||
XLog.debug("Execute SQL: {0}", sql);
|
||||
|
||||
Connection connection = openConnection();
|
||||
Statement statement = null;
|
||||
@@ -145,10 +143,16 @@ public class JdbcTemplate implements JdbcOperations {
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public int delete(String sql) throws DataAccessException {
|
||||
return update(sql);
|
||||
}
|
||||
|
||||
private Connection openConnection() {
|
||||
try {
|
||||
return getDataSource().getConnection();
|
||||
} catch (SQLException ex) {
|
||||
}
|
||||
catch (SQLException ex) {
|
||||
throw new CannotGetJdbcConnectionException("Could not get JDBC Connection", ex);
|
||||
}
|
||||
}
|
||||
@@ -161,26 +165,13 @@ public class JdbcTemplate implements JdbcOperations {
|
||||
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 = null;
|
||||
if (obj != null) {
|
||||
className = obj.getClass().getName();
|
||||
}
|
||||
|
||||
String className = obj.getClass().getName();
|
||||
|
||||
if (obj instanceof Blob) {
|
||||
Blob blob = (Blob) obj;
|
||||
obj = blob.getBytes(1, (int) blob.length());
|
||||
@@ -189,16 +180,18 @@ public class JdbcTemplate implements JdbcOperations {
|
||||
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")) {
|
||||
} else if (className != null && 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 {
|
||||
}
|
||||
else {
|
||||
obj = resultSet.getDate(index);
|
||||
}
|
||||
} else if (obj instanceof Date
|
||||
&& "java.sql.Timestamp".equals(resultSet.getMetaData().getColumnClassName(index))) {
|
||||
obj = resultSet.getTimestamp(index);
|
||||
} else if (obj instanceof Date) {
|
||||
if ("java.sql.Timestamp".equals(resultSet.getMetaData().getColumnClassName(index))) {
|
||||
obj = resultSet.getTimestamp(index);
|
||||
}
|
||||
}
|
||||
|
||||
return obj;
|
||||
|
||||
@@ -17,7 +17,6 @@ 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;
|
||||
@@ -85,7 +84,7 @@ class JdbcTemplateTest {
|
||||
}
|
||||
|
||||
@Test
|
||||
void testQuery_Simple_Single() {
|
||||
void testQuery_Single() {
|
||||
String sql = MessageFormat.format("SELECT {2} FROM {0} WHERE {1} LIKE ''{3}''",
|
||||
TABLE_NAME, COLUMN_NAME, COLUMN_VALUE, DATA[0][0]);
|
||||
|
||||
@@ -101,56 +100,39 @@ class JdbcTemplateTest {
|
||||
}
|
||||
|
||||
@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() {
|
||||
void testQuery_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));
|
||||
List<Integer> listValues = jdbcTemplate.query(sql, (rs, rowNum) -> rs.getInt(1));
|
||||
|
||||
assertIterableEquals(Lists.newArrayList(DATA[0][1], DATA[1][1]), listValues);
|
||||
}
|
||||
|
||||
@Test
|
||||
void testQuery_Object_Single() {
|
||||
void testQueryForObject() {
|
||||
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();
|
||||
}
|
||||
}
|
||||
|
||||
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 actualPlayer = jdbcTemplate.queryForObject(sql, (rs, rowNum) -> {
|
||||
Player player0 = new Player();
|
||||
player0.name = rs.getString(COLUMN_NAME);
|
||||
player0.value = rs.getInt(COLUMN_VALUE);
|
||||
@@ -158,19 +140,11 @@ class JdbcTemplateTest {
|
||||
return player0;
|
||||
});
|
||||
|
||||
Player expectedPlayer = new Player();
|
||||
expectedPlayer.name = (String) DATA[0][0];
|
||||
expectedPlayer.value = (int) DATA[0][1];
|
||||
|
||||
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);
|
||||
assertEquals(expectedPlayer, actualPlayer);
|
||||
}
|
||||
|
||||
@Test
|
||||
@@ -188,11 +162,11 @@ class JdbcTemplateTest {
|
||||
}
|
||||
|
||||
@Test
|
||||
void testQueryForMapList() {
|
||||
void testQueryForList() {
|
||||
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>> actualMapList = jdbcTemplate.queryForList(sql);
|
||||
|
||||
List<Map<String, Object>> expectedMapList = Stream.of(DATA)
|
||||
.map(datum -> ImmutableMap.of(COLUMN_NAME, datum[0], COLUMN_VALUE, datum[1]))
|
||||
@@ -237,24 +211,6 @@ class JdbcTemplateTest {
|
||||
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 {
|
||||
|
||||
|
||||
Reference in New Issue
Block a user