数据库工具

数据库工具

一个为开发者简化数据库使用的简单模组

基础库

Database Utils


🔎 说明

此模组包含一些用于操作数据库的工具。
最常用的连接器已直接包含在模组 JAR 中,这样可以避免将它们导入到每个模组中,并有助于减小项目的整体体积。

要导入此库,你需要在 build.gradle 文件中添加以下内容。

repositories {
    maven { url "https://api.modrinth.com/maven" }
}

dependencies {
    implementation "maven.modrinth:database-utils:1.0.0"
}

🖥️ 用法

配置由该库管理。使用以下代码行,会自动创建(如果尚不存在)并从 config 文件夹加载一个 .properties 文件。

Config config = new Config(MOD_ID);

在此示例中,文件将命名为 MOD_ID.properties。
以下是一个配置文件的示例。

storage=postgres
host=127.0.0.1
port=5432
database=minecraft_db
user=user
password=password
键 描述
storage 数据库类型。必须是以下之一:postgres、mysql、mariadb、sqlite 或 test。
host 数据库服务器的 IP 地址或主机名
port 数据库服务器使用的端口。
database 数据库的名称。
user 用于连接数据库的用户。
password 用户的密码。

然后,你需要定义自己的类 MyCustomDB,它继承 DatabaseQueries。
此类用于包含所有与 SQL 相关的方法。 在此上下文中,你可以使用 DatabaseQueries 中的一些方法,例如 getType,这有助于你创建兼容多种数据库的实现。

public class MyCustomDB extends DatabaseQueries {

    public MyCustomDB(Database db) {
        super(db);
    }
    
    @Override
    public void init() {
        try (Connection connection = getConnection()) {
            /* ... */
        } catch (SQLException | DatabaseLinkException e) {
            LOGGER.error("Unable to initialize: {}", e.getMessage());
        }
    }
    
    /* other methods */
    
    public void someMethod() {
        /* ... */
    }
}

你还需要创建一个数据库实例。这里会用到 Config 对象。以下代码片段会获取配置中定义的数据库,并初始化你的 DatabaseQueries 实现。

Database database = DatabaseUtils.getDatabase(config);
MyCustomDB custom = new MyCustomDB(database);

现在,你可以通过 custom 实例调用 DatabaseQueries 实现中定义的任何查询。

custom.someMethod();