SQLib
SQLib 是满足你所有 Minecraft 数据存储需求的最简单方式!这是一个专注于 Minecraft 使用场景的简易 SQL 封装库。
重要提示:
本库并非功能完备的 SQL 封装,无法提供对许多 SQL 特性的完全访问权限。 本库的主要目的是为模组提供一种简单易用的数据存储方式。 如果你需要更高级的数据库解决方案,我建议看看 Nitrite。
配置
模组首次启动时会生成一个配置文件,允许你配置所有依赖 SQLib 的模组所使用的数据库。
默认数据库是在 sqlib 目录中运行的 SQLite 数据库。
数据类型
可以通过 JavaTypes、MinecraftTypes 或 AdventureTypes 类访问这些数据类型。我倾向于在我的项目中遇到新类型时添加支持。如果你想添加某种类型,请提交 Issue!
| Standard | Minecraft | Adventure |
|---|---|---|
| Byte | Vec3i | Key |
| Byte[] | BlockPos | Component |
| Bool | ChunkPos | |
| Short | Text | |
| Int | Identifier | |
| Float | Sound | |
| Double | Json | |
| Long | NbtElement | |
| String | ||
| Char | ||
| Date | ||
| Color | ||
| UUID | ||
| URI | ||
| URL |
你也可以像下面这样添加自定义类型:
安装设置
在你的 build.gradle 中包含以下内容:
repositories {
maven { url "https://api.modrinth.com/maven" }
}
dependencies {
modImplementation("maven.modrinth:sqlib:3.2.2")
}
开发者用法
此示例使用了由 SQLib 管理的内置数据库。对于 99% 的模组来说,使用内置数据库就足够了,但 下文提供了自定义数据库管理的示例。
// 不要在早期的模组初始化器中调用 SQLib.getDatabase()。这样做很可能会导致你的模组崩溃。
// 在常规模组初始化器期间或之后调用是可以的。
Database db = SQLib.getDatabase();
DataStore store = db.dataStore("myModId", "userdata");
DataContainer playerData = store.createDataContainer();
playerData.put(JavaTypes.STRING, "username", "CoolGuy123");
playerData.put(MinecraftTypes.BLOCKPOS, "home", new BlockPos(304, 62, 37));
playerData.put(MinecraftTypes.NBT, "nbt", new NbtCompound());
System.out.println(playerdata.get(JavaTypes.STRING, "username"));
System.out.println(playerdata.get(MinecraftTypes.BLOCKPOS, "home"));
System.out.println(playerdata.get(MinecraftTypes.NBT, "nbt"));
自定义数据库管理
Postgres db = new Postgres("name", "192.168.1.69", "3306", "cooluser", "radman");
// 或者
MySQL db = new MySQL("name", "192.168.1.69", "3306", "cooluser", "radman");
// 或者
SQLite db = new SQLite("name", "some/dir");
事务支持
这种方法会将 SQL 命令批处理为一个命令,从而加快大量数据的读写速度。
DataStore store = db.dataStore("modId", "userdata");
DataContainer playerData = table.createDataContainer();
playerData.transaction().put("username", "CoolGuy123").put("home", new BlockPos(304, 62, 37).commit();
自定义类型
你可以按照 JavaTypes、MinecraftTypes 和 AdventureTypes 中的实现来添加自定义类型。然后你可以像使用其他原生 SQLib 类型一样使用它。
// SQLPrimitive 是要序列化的基础类型,两个函数 lambda 分别用于从该类型序列化和反序列化
public static final SQLibType<JsonElement> JSON = new SQLibType<>(SQLPrimitive.STRING, JsonElement::toString, JsonParser::parseString);
// 你也可以像这样扩展类型:
public static final SQLibType<Identifier> IDENTIFIER = new SQLibType<>(SQLPrimitive.STRING, Identifier::toString, Identifier::tryParse);
public static final SQLibType<SoundEvent> SOUND = new SQLibType<>(IDENTIFIER, SoundEvent::getId, SoundEvent::of);
你是这个资源的作者?登录后可认领此资源。
相似资源
PacketEvents 是一款专为 Minecraft Java 版打造的协议库,旨在简化数据包的处理与传输。
ExyliaPlugins 的库。
重新定义服务器上的生物运输方式。使用高度可定制的口袋道具,安全地捕获、存储和释放任何实体。
为基于 Spigot/Paper/Folia 的服务器添加对 Vivecraft 的支持
一个强大的 API,用于为你的 Minecraft 服务器创建自定义进度。
SkyBlock、OneBlock、Boxed、SkyGrid、AcidIsland、CaveBlock、Poseidon、StrangerRealms——以及更多!这些只是由 BentoBox 支持的基于岛屿的游戏模式之一。来自原版 ASkyBlock 的作者。
评论 0
登录后参与评分
还没有评论,来抢沙发吧