Database connection. Only PostgreSQL and SQLite.

Author: UnFamousSoul

src/main/java/com/unfamoussoul/sapi/api/database/DatabaseConfig.java

@@ -0,0 +1,52 @@
+package com.unfamoussoul.sapi.api.database;
+
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Класс конфигурации для работы с базами данных.
+ * @param url JDBC строка подключения.
+ * @param username в случае с базой данных, которым нужен пользователь для подключения (PostgreSQL).
+ * @param password в случае с базой данных, которым нужен пароль для подключения (PostgreSQL).
+ * @param maxPoolSize
+ * @param minIdle
+ * @param connectionTimeoutMs
+ * @param idleTimeoutMs
+ * @param maxLifetimeMs
+ * @param type тип базы данных {@link DatabaseType}
+ */
+@SuppressWarnings("unused")
+public record DatabaseConfig(
+    String url,
+    String username,
+    String password,
+    int maxPoolSize,
+    int minIdle,
+    long connectionTimeoutMs,
+    long idleTimeoutMs,
+    long maxLifetimeMs,
+    DatabaseType type
+) {
+
+    /**
+     * Создание стандартной конфигурации для SQLite на JDBC строке.
+     * @param url JDBC строка подключения.
+     * @return конфиг для создания экземпляра класса {@link DatabaseHandler}.
+     */
+    @Contract("_ -> new")
+    public static @NotNull DatabaseConfig forSqlite(String url) {
+        return new DatabaseConfig(url, null, null, 5, 2, 30_000, 600_000, 1_800_000, DatabaseType.SQLITE);
+    }
+
+    /**
+     * Создание стандартной конфигурации для PostgreSQL на JDBC строке, пользователе и пароле.
+     * @param url JDBC строка подключения.
+     * @param user пользователь.
+     * @param password пароль.
+     * @return конфиг для создания экземпляра класса {@link DatabaseHandler}.
+     */
+    @Contract("_, _, _ -> new")
+    public static @NotNull DatabaseConfig forPostgresql(String url, String user, String password) {
+        return new DatabaseConfig(url, user, password, 10, 4, 30_000, 600_000, 1_800_000, DatabaseType.POSTGRESQL);
+    }
+}

src/main/java/com/unfamoussoul/sapi/api/database/DatabaseHandler.java

@@ -0,0 +1,34 @@
+package com.unfamoussoul.sapi.api.database;
+
+import java.sql.Connection;
+import java.sql.SQLException;
+import java.util.List;
+
+/**
+ * Абстрактный класс для создания обработчика базы данных
+ */
+@SuppressWarnings("unused")
+public abstract class DatabaseHandler implements AutoCloseable {
+
+    /**
+     * Создание обработчика базы данных.
+     * @param config конфиг базы данных {@link DatabaseConfig}
+     * @param migrations список миграций базы данных {@link Migration}
+     */
+    protected DatabaseHandler(DatabaseConfig config, List<Migration> migrations) {
+        //
+    }
+
+    /**
+     * Получить подключение к базе данных.
+     * @return класс подключения к базе данных {@link Connection}
+     * @throws SQLException если вы допустили ошибку в SQL записи.
+     */
+    public native Connection connection() throws SQLException;
+
+    /**
+     * Метод закрытия обработчика
+     */
+    @Override
+    public native void close();
+}

src/main/java/com/unfamoussoul/sapi/api/database/DatabaseType.java

@@ -0,0 +1,9 @@
+package com.unfamoussoul.sapi.api.database;
+
+/**
+ * Да, мы работаем только с SQLite и PostgreSQL, мне лень.
+ */
+public enum DatabaseType {
+    SQLITE,
+    POSTGRESQL
+}

src/main/java/com/unfamoussoul/sapi/api/database/Migration.java

@@ -0,0 +1,28 @@
+package com.unfamoussoul.sapi.api.database;
+
+/**
+ * Класс, который нужен для хранения версии и действий.
+ * Просто храните миграции таким образом и база данных автоматически при запуске {@link DatabaseHandler} мигрировать на самую новую версию.
+ * <p>
+ * Пример:
+ * <pre><code>
+ * public class TestDatabaseHandler extends DatabaseHandler {
+ *
+ *     protected TestDatabaseHandler(DatabaseConfig config) {
+ *         super(
+ *                 config,
+ *                 List.of(
+ *                 // Создаём базу данных players в первой версии.
+ *                 new Migration(1, c -> c.createStatement()
+ *                         .execute("CREATE TABLE players (id INTEGER PRIMARY KEY, name TEXT)")),
+ *                 // При обновлении кода потребовалось добавить колонку score в базу данных. При запуске модуля база данных сама обновится до второй версии.
+ *                 new Migration(2, c -> c.createStatement()
+ *                         .execute("ALTER TABLE players ADD COLUMN score INTEGER DEFAULT 0"))
+ *         ));
+ *     }
+ * }
+ * </code></pre>
+ * @param version версия миграции
+ * @param action действие миграции {@link MigrationAction}
+ */
+public record Migration(int version, MigrationAction action) {}

src/main/java/com/unfamoussoul/sapi/api/database/MigrationAction.java

@@ -0,0 +1,12 @@
+package com.unfamoussoul.sapi.api.database;
+
+import java.sql.Connection;
+import java.sql.SQLException;
+
+/**
+ * Действие миграции. В одной версии может быть множество таких действий.
+ */
+@FunctionalInterface
+public interface MigrationAction {
+    void apply(Connection connection) throws SQLException;
+}