Database Utils

模组

· 作者 KGriffon

一个面向开发者的简易模组,使数据库使用更加便捷

0 本站下载 0 关注 更新于 4 个月前

最新 1.0.0+26.1 · 26.2 · Fabric

一键开服(送7天)

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
Key Description
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();

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源