data.PluginDataStorage.kt Maven / Gradle / Ivy
/*
* Copyright 2019-2020 Mamoe Technologies and contributors.
*
* 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
* Use of this source code is governed by the GNU AFFERO GENERAL PUBLIC LICENSE version 3 license that can be found through the following link.
*
* https://github.com/mamoe/mirai/blob/master/LICENSE
*/
@file:Suppress("NOTHING_TO_INLINE", "UNCHECKED_CAST", "unused")
package net.mamoe.mirai.console.data
import net.mamoe.mirai.console.internal.data.MemoryPluginDataStorageImpl
import net.mamoe.mirai.console.internal.data.MultiFilePluginDataStorageImpl
import net.mamoe.mirai.console.plugin.jvm.JvmPlugin
import net.mamoe.mirai.console.plugin.jvm.JvmPluginLoader
import net.mamoe.mirai.console.util.ConsoleExperimentalApi
import java.io.File
import java.nio.file.Path
/**
* [数据对象][PluginData] 存储仓库.
*
* ## 职责
* [PluginDataStorage] 类似于一个数据库, 它只承担将序列化之后的数据保存到数据库中, 和从数据库取出这个对象的任务.
*
*
* 此为较低层的 API, 一般插件开发者不会接触.
*
* [JvmPluginLoader] 实现一个 [PluginDataStorage], 用于管理所有 [JvmPlugin] 的 [PluginData] 实例.
*
* ### 实现 [PluginDataStorage]
* 无特殊需求. 实现两个成员函数即可. 可参考内建 [MultiFilePluginDataStorageImpl]
*
* @see PluginDataHolder
* @see JvmPluginLoader.dataStorage
*/
@ConsoleExperimentalApi
public interface PluginDataStorage {
/**
* 读取一个实例. 并为 [instance] [设置 [PluginDataStorage]][PluginData.onInit]
*/
@ConsoleExperimentalApi
public fun load(holder: PluginDataHolder, instance: PluginData)
/**
* 保存一个实例.
*
* **实现细节**: 调用 [PluginData.updaterSerializer]
*/
@ConsoleExperimentalApi
public fun store(holder: PluginDataHolder, instance: PluginData)
/*
public companion object {
/**
* 通过反射
* 读取一个实例.
*
* 在 [T] 实例创建后 [设置 [PluginDataStorage]][PluginData.setStorage]
*/
@ConsoleExperimentalAPI
@JvmStatic
public fun PluginDataStorage.load(holder: PluginDataHolder, dataClass: KClass): T {
@Suppress("UNCHECKED_CAST")
val instance = with(dataClass){
objectInstance
?: createInstanceOrNull()
?: throw IllegalArgumentException(
"Cannot create PluginData instance. Make sure dataClass is PluginData::class.java or a Kotlin's object, " +
"or has a constructor which either has no parameters or all parameters of which are optional"
)
}
load(holder, instance)
return instance
}
/**
* 读取一个实例. 在 [T] 实例创建后 [设置 [PluginDataStorage]][PluginData.setStorage]
*/
@JvmStatic
public fun PluginDataStorage.load(holder: PluginDataHolder, dataClass: Class): T =
this.load(holder, dataClass.java)
/**
* 读取一个实例. 在 [T] 实例创建后 [设置 [PluginDataStorage]][PluginData.setStorage]
*/
@JvmSynthetic
public inline fun PluginDataStorage.load(holder: PluginDataHolder): T =
this.load(holder, T::class)
}
*/
}
/**
* 在内存存储所有 [PluginData] 实例的 [PluginDataStorage]. 在内存数据丢失后相关 [PluginData] 实例也会丢失.
* @see PluginDataStorage
*/
@ConsoleExperimentalApi
public interface MemoryPluginDataStorage : PluginDataStorage {
public companion object {
/**
* 创建一个 [MemoryPluginDataStorage] 实例.
*/
@JvmStatic
@JvmName("create")
// @JvmOverloads
public operator fun invoke(): MemoryPluginDataStorage = MemoryPluginDataStorageImpl()
}
}
/**
* 用多个文件存储 [PluginData] 实例的 [PluginDataStorage].
*/
@ConsoleExperimentalApi
public interface MultiFilePluginDataStorage : PluginDataStorage {
/**
* 存放 [PluginData] 的目录.
*/
public val directoryPath: Path
public companion object {
/**
* 创建一个 [MultiFilePluginDataStorage] 实例.
*
* @see directory 存放 [PluginData] 的目录.
*/
@JvmStatic
@JvmName("create")
public operator fun invoke(directory: Path): MultiFilePluginDataStorage =
MultiFilePluginDataStorageImpl(directory)
}
}
@ConsoleExperimentalApi
@get:JvmSynthetic
public inline val MultiFilePluginDataStorage.directory: File
get() = this.directoryPath.toFile()