Use driver class instead of datasource for Postgres (#3705)

This commit is contained in:
Luck 2023-08-05 10:28:01 +01:00
parent b8d1f52d7d
commit 71416baff2
No known key found for this signature in database
GPG Key ID: EFA9B3EC5FD90F8B
5 changed files with 98 additions and 54 deletions

View File

@ -0,0 +1,80 @@
/*
* This file is part of LuckPerms, licensed under the MIT License.
*
* Copyright (c) lucko (Luck) <luck@lucko.me>
* Copyright (c) contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package me.lucko.luckperms.common.storage.implementation.sql.connection.hikari;
import com.zaxxer.hikari.HikariConfig;
import me.lucko.luckperms.common.storage.misc.StorageCredentials;
import java.sql.Driver;
import java.sql.DriverManager;
import java.sql.SQLException;
import java.util.Enumeration;
/**
* Extension of {@link HikariConnectionFactory} that uses the driver class name to configure Hikari.
*/
public abstract class DriverBasedHikariConnectionFactory extends HikariConnectionFactory {
protected DriverBasedHikariConnectionFactory(StorageCredentials configuration) {
super(configuration);
}
protected abstract String driverClassName();
protected abstract String driverJdbcIdentifier();
@Override
protected void configureDatabase(HikariConfig config, String address, String port, String databaseName, String username, String password) {
config.setDriverClassName(driverClassName());
config.setJdbcUrl(String.format("jdbc:%s://%s:%s/%s", driverJdbcIdentifier(), address, port, databaseName));
config.setUsername(username);
config.setPassword(password);
}
@Override
protected void postInitialize() {
super.postInitialize();
// Calling Class.forName("<driver class name>") is enough to call the static initializer
// which makes our driver available in DriverManager. We don't want that, so unregister it after
// the pool has been setup.
deregisterDriver(driverClassName());
}
private static void deregisterDriver(String driverClassName) {
Enumeration<Driver> drivers = DriverManager.getDrivers();
while (drivers.hasMoreElements()) {
Driver driver = drivers.nextElement();
if (driver.getClass().getName().equals(driverClassName)) {
try {
DriverManager.deregisterDriver(driver);
} catch (SQLException e) {
// ignore
}
}
}
}
}

View File

@ -37,11 +37,8 @@ import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.format.NamedTextColor;
import java.sql.Connection;
import java.sql.Driver;
import java.sql.DriverManager;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
@ -245,18 +242,4 @@ public abstract class HikariConnectionFactory implements ConnectionFactory {
logger.warn("Class " + className + " has been loaded by: " + loaderName);
}
}
protected static void deregisterDriver(String driverClassName) {
Enumeration<Driver> drivers = DriverManager.getDrivers();
while (drivers.hasMoreElements()) {
Driver driver = drivers.nextElement();
if (driver.getClass().getName().equals(driverClassName)) {
try {
DriverManager.deregisterDriver(driver);
} catch (SQLException e) {
// ignore
}
}
}
}
}

View File

@ -25,12 +25,11 @@
package me.lucko.luckperms.common.storage.implementation.sql.connection.hikari;
import com.zaxxer.hikari.HikariConfig;
import me.lucko.luckperms.common.storage.misc.StorageCredentials;
import java.util.function.Function;
public class MariaDbConnectionFactory extends HikariConnectionFactory {
public class MariaDbConnectionFactory extends DriverBasedHikariConnectionFactory {
public MariaDbConnectionFactory(StorageCredentials configuration) {
super(configuration);
}
@ -46,21 +45,13 @@ public class MariaDbConnectionFactory extends HikariConnectionFactory {
}
@Override
protected void configureDatabase(HikariConfig config, String address, String port, String databaseName, String username, String password) {
config.setDriverClassName("org.mariadb.jdbc.Driver");
config.setJdbcUrl("jdbc:mariadb://" + address + ":" + port + "/" + databaseName);
config.setUsername(username);
config.setPassword(password);
protected String driverClassName() {
return "org.mariadb.jdbc.Driver";
}
@Override
protected void postInitialize() {
super.postInitialize();
// Calling Class.forName("org.mariadb.jdbc.Driver") is enough to call the static initializer
// which makes our driver available in DriverManager. We don't want that, so unregister it after
// the pool has been setup.
deregisterDriver("org.mariadb.jdbc.Driver");
protected String driverJdbcIdentifier() {
return "mariadb";
}
@Override

View File

@ -25,13 +25,12 @@
package me.lucko.luckperms.common.storage.implementation.sql.connection.hikari;
import com.zaxxer.hikari.HikariConfig;
import me.lucko.luckperms.common.storage.misc.StorageCredentials;
import java.util.Map;
import java.util.function.Function;
public class MySqlConnectionFactory extends HikariConnectionFactory {
public class MySqlConnectionFactory extends DriverBasedHikariConnectionFactory {
public MySqlConnectionFactory(StorageCredentials configuration) {
super(configuration);
}
@ -47,21 +46,13 @@ public class MySqlConnectionFactory extends HikariConnectionFactory {
}
@Override
protected void configureDatabase(HikariConfig config, String address, String port, String databaseName, String username, String password) {
config.setDriverClassName("com.mysql.cj.jdbc.Driver");
config.setJdbcUrl("jdbc:mysql://" + address + ":" + port + "/" + databaseName);
config.setUsername(username);
config.setPassword(password);
protected String driverClassName() {
return "com.mysql.cj.jdbc.Driver";
}
@Override
protected void postInitialize() {
super.postInitialize();
// Calling Class.forName("com.mysql.cj.jdbc.Driver") is enough to call the static initializer
// which makes our driver available in DriverManager. We don't want that, so unregister it after
// the pool has been setup.
deregisterDriver("com.mysql.cj.jdbc.Driver");
protected String driverJdbcIdentifier() {
return "mysql";
}
@Override

View File

@ -25,13 +25,12 @@
package me.lucko.luckperms.common.storage.implementation.sql.connection.hikari;
import com.zaxxer.hikari.HikariConfig;
import me.lucko.luckperms.common.storage.misc.StorageCredentials;
import java.util.Map;
import java.util.function.Function;
public class PostgresConnectionFactory extends HikariConnectionFactory {
public class PostgresConnectionFactory extends DriverBasedHikariConnectionFactory {
public PostgresConnectionFactory(StorageCredentials configuration) {
super(configuration);
}
@ -47,13 +46,13 @@ public class PostgresConnectionFactory extends HikariConnectionFactory {
}
@Override
protected void configureDatabase(HikariConfig config, String address, String port, String databaseName, String username, String password) {
config.setDataSourceClassName("org.postgresql.ds.PGSimpleDataSource");
config.addDataSourceProperty("serverName", address);
config.addDataSourceProperty("portNumber", port);
config.addDataSourceProperty("databaseName", databaseName);
config.addDataSourceProperty("user", username);
config.addDataSourceProperty("password", password);
protected String driverClassName() {
return "org.postgresql.Driver";
}
@Override
protected String driverJdbcIdentifier() {
return "postgresql";
}
@Override