Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cssxsh/mirai-hibernate-plugin
Mirai Console Hibernate/ORM 数据库前置插件
https://github.com/cssxsh/mirai-hibernate-plugin
hibernate mirai mirai-console orm
Last synced: 3 months ago
JSON representation
Mirai Console Hibernate/ORM 数据库前置插件
- Host: GitHub
- URL: https://github.com/cssxsh/mirai-hibernate-plugin
- Owner: cssxsh
- License: agpl-3.0
- Created: 2021-12-22T14:34:04.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-11T06:07:39.000Z (4 months ago)
- Last Synced: 2024-10-03T12:42:11.869Z (4 months ago)
- Topics: hibernate, mirai, mirai-console, orm
- Language: Kotlin
- Homepage:
- Size: 755 KB
- Stars: 31
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# [Mirai Hibernate Plugin](https://github.com/cssxsh/mirai-hibernate-plugin)
> Mirai Hibernate 前置插件
[Mirai Console](https://github.com/mamoe/mirai-console) 的前置插件，用于 Hibernate ORM 框架的初始化
[](https://search.maven.org/artifact/xyz.cssxsh.mirai/mirai-hibernate-plugin)
[](https://github.com/cssxsh/mirai-hibernate-plugin/actions/workflows/test.yml)
[](https://www.codacy.com/gh/cssxsh/mirai-hibernate-plugin/dashboard?utm_source=github.com&utm_medium=referral&utm_content=cssxsh/mirai-hibernate-plugin&utm_campaign=Badge_Grade)
插件自带聊天记录器 [MiraiHibernateRecorder](src/main/kotlin/xyz/cssxsh/mirai/hibernate/MiraiHibernateLoader.kt),
会记录 `群聊/私聊` 的内容到数据库方便其他插件使用，默认是 `h2database` 数据库(since `2.2.0+`)
每个插件都有应有独立的数据库配置在其配置文件目录 `config/.../hibernate.properties`
例如，聊天记录器数据库配置在 `config/xyz.cssxsh.mirai.plugin.mirai-hibernate-plugin/hibernate.properties`
## 数据库支持
本插件打包了以下版本的数据库驱动和连接池
* `com.mysql:mysql-connector-j:9.0.0` - [mysql.hibernate.properties](example/mysql.hibernate.properties)
* `org.mariadb.jdbc:mariadb-java-client:3.4.1` - [mariadb.hibernate.properties](example/mariadb.hibernate.properties)
* `org.xerial:sqlite-jdbc:3.46.0.1` - [sqlite.hibernate.properties](example/sqlite.hibernate.properties)
* `org.postgresql:postgresql:42.7.3` - [postgresql.hibernate.properties](example/postgresql.hibernate.properties)
* `com.h2database:h2:2.3.230` - [h2.hibernate.properties](example/h2.hibernate.properties)
* `com.microsoft.sqlserver:mssql-jdbc:12.8.0.jre11` - [sqlserver.hibernate.properties](example/sqlserver.hibernate.properties)
* `com.zaxxer:HikariCP:5.0.1`
需要其他数据库驱动或连接池支持，请添加 `plugin-shared-libraries` 依赖，有2种方法
1. 将 **Jar包** 放到 `plugin-shared-libraries` 目录中一同被 `mirai-console` 加载
2. 在 `plugin-shared-libraries/libraries.txt` 中添加 maven 引用，
例如 `com.oracle.database.jdbc:ojdbc11:21.8.0.0`
## 在 Mirai Console Plugin 项目中引用
```kotlin
repositories {
mavenCentral()
}
dependencies {
compileOnly("xyz.cssxsh.mirai:mirai-hibernate-plugin:${version}")
}
// hibernate 6 和 HikariCP 5 需要 jdk11
mirai {
jvmTarget = JavaVersion.VERSION_11
}
```
## 在 Mirai Core Jvm 项目中引用
```kotlin
repositories {
mavenCentral()
}
dependencies {
implementation("xyz.cssxsh.mirai:mirai-hibernate-plugin:${version}")
}
```
需要手动对 `xyz.cssxsh.mirai.hibernate.factory` 进行初始化，和对 `MiraiHibernateRecorder` 进行注册
**Maven 项目请根据上面的 maven-central 指向的链接查询相关配置方法**
## 在 mirai-api-http 中引用
使用本插件作为 mirai-api-http 的消息源需要额外的拓展插件
## 一些方法和类说明
* [MiraiHibernateConfiguration](src/main/kotlin/xyz/cssxsh/mirai/hibernate/MiraiHibernateConfiguration.kt)
配置的，对应于 `JvmPlugin` 的 `SessionFactory`
默认将会读取(生成)在 `config` 目录下的 `hibernate.properties` 作为配置文件
并且自动扫描加载当前插件的 `entry` 类包中被 `jakarta.persistence.Entity` 标记的实体类
* [MiraiHibernateRecorder](src/main/kotlin/xyz/cssxsh/mirai/hibernate/MiraiHibernateRecorder.kt)
是本插件自带的消息记录器，通过对 `MessageEvent` 和 `MessagePostSendEvent` 记录，保存消息历史到数据库
* [CriteriaBuilder.rand](src/main/kotlin/xyz/cssxsh/hibernate/Criteria.kt)
`MiraiHibernateConfiguration` 中会对 Sqlite / PostgreSql 的 `random` 进行别名注册为 `rand` 统一SQL语句的中的随机函数名
* [CriteriaBuilder.dice](src/main/kotlin/xyz/cssxsh/hibernate/Criteria.kt)
`MiraiHibernateConfiguration` 中会注册名为 `dice` 的宏，用于随机取行
### 示例代码
* [kotlin](src/test/kotlin/xyz/cssxsh/mirai/test/MiraiHibernatePluginTest.kt)
* [java](src/test/java/xyz/cssxsh/mirai/test/MiraiHibernateDemo.java)
## 安装
### MCL 指令安装
**请确认 mcl.jar 的版本是 2.1.0+**
`./mcl --update-package xyz.cssxsh.mirai:mirai-hibernate-plugin --channel maven-stable --type plugins`
### 手动安装
1. 从 [Releases](https://github.com/cssxsh/mirai-hibernate-plugin/releases) 或者 [Maven](https://repo1.maven.org/maven2/xyz/cssxsh/mirai/mirai-hibernate-plugin/) 下载 `mirai2.jar`
2. 将其放入 `plugins` 文件夹中
### 聊天数据迁移
1. 将原 `config/xyz.cssxsh.mirai.plugin.mirai-hibernate-plugin/hibernate.properties` 改名备份为 `hibernate.backup.properties`
2. 按照 [example](example) 中的例子写一份新的 `hibernate.properties`
3. 重启 `mirai-console`
## [爱发电](https://afdian.net/@cssxsh)
