1
mirror of https://github.com/CarmJos/MineSQL.git synced 2026-06-14 05:11:08 +08:00

Compare commits

...

13 Commits

19 changed files with 487 additions and 130 deletions
+3 -3
View File
@@ -29,13 +29,13 @@ properties:
databases: databases:
"example-mariadb": # 数据库源名称 不可包含“.” 以“example-”开头的数据源不会被加载 "example-mariadb": # 数据库源名称 不可包含“.” 以“example-”开头的数据源不会被加载
driver-type: mariadb type: mariadb # MySQL / MariaDB 类型
host: 127.0.0.1 # 数据库地址 host: 127.0.0.1 # 数据库地址
port: 3306 # 数据库端口 port: 3306 # 数据库端口
username: minecraft # 数据库用户名 username: minecraft # 数据库用户名
password: password #数据库连接密码 password: password #数据库连接密码
database: minecraft #数据库名 database: minecraft #数据库名
"example-h2": # 数据库源名称 不可包含“.” 以“example-”开头的数据源不会被加载 "example-h2":
driver-type: h2 #数据库驱动类型,目前支持 mariadb, mysql, h2 type: h2-file
file: "example.db" #数据库文件路径,相对于“plugins/MineSQL/db-files/” file: "example.db" #数据库文件路径,相对于“plugins/MineSQL/db-files/”
+27
View File
@@ -0,0 +1,27 @@
# MineSQL Repository
采用github的repo分支进行依赖,随项目发布而自动更新。
其他依赖方式见主页介绍。
## 依赖方式
### Maven
```xml
<repositories>
<repository>
<id>MineSQL</id>
<name>GitHub Branch Repository</name>
<url>https://github.com/CarmJos/MineSQL/blob/repo/</url>
</repository>
</repositories>
```
### Gradle
```groovy
repositories {
maven { url 'https://github.com/CarmJos/MineSQL/blob/repo/' }
}
```
+77 -2
View File
@@ -8,8 +8,8 @@ on:
types: [ published ] types: [ published ]
jobs: jobs:
gh-deploy: packages-deploy:
name: "Deploy Project (GitHub)" name: "Deploy Project (GitHub Packages)"
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
@@ -43,6 +43,81 @@ jobs:
asset_path: ".asset/*.jar" asset_path: ".asset/*.jar"
asset_content_type: application/java-archive asset_content_type: application/java-archive
github-deploy:
name: "Deploy Project (GitHub Repo)"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: "Set up JDK"
uses: actions/setup-java@v2
with:
java-version: '11'
distribution: 'adopt'
cache: maven
- name: "Maven Deploy"
run: mvn -B -Plocal deploy --file pom.xml -DskipTests -Dgpg.skip
- name: "Copy artifacts"
run: |
rm -rf deploy
mkdir -vp deploy
cp -vrf $HOME/local-deploy/* deploy/
cp -vrf .doc/repository/REPO-README.md deploy/README.md
- name: "Copy Javadoc"
run: |
rm -rf docs
mkdir -vp docs
cp -vrf api/target/apidocs/* docs/
cp -vrf .doc/javadoc/JAVADOC-README.md docs/README.md
- name: "Generate Javadoc sitemap"
id: sitemap
uses: cicirello/generate-sitemap@v1
with:
base-url-path: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}
path-to-root: docs
- name: "Output Javadoc stats"
run: |
echo "sitemap-path = ${{ steps.sitemap.outputs.sitemap-path }}"
echo "url-count = ${{ steps.sitemap.outputs.url-count }}"
echo "excluded-count = ${{ steps.sitemap.outputs.excluded-count }}"
ls -l docs
- name: "Configure Git"
env:
DEPLOY_PRI: ${{secrets.DEPLOY_PRI}}
run: |
sudo timedatectl set-timezone "Asia/Shanghai"
mkdir -p ~/.ssh/
echo "$DEPLOY_PRI" > ~/.ssh/id_rsa
chmod 600 ~/.ssh/id_rsa
ssh-keyscan github.com >> ~/.ssh/known_hosts
git config --global user.name '${{ github.repository_owner }}'
git config --global user.email '${{ github.repository_owner }}@users.noreply.github.com'
- name: "Commit&Push repository files"
run: |
cd deploy
git init
git remote add origin git@github.com:${{ github.repository_owner }}/${{ github.event.repository.name }}.git
git checkout -b repo
git add -A
git commit -m "Maven project deployment."
git push origin HEAD:repo --force
- name: "Commit&Push API documentation"
run: |
cd docs
git init
git remote add origin git@github.com:${{ github.repository_owner }}/${{ github.event.repository.name }}.git
git checkout -b gh-pages
git add -A
git commit -m "API Document generated."
git push origin HEAD:gh-pages --force
central-deploy: central-deploy:
name: "Deploy Project (Central)" name: "Deploy Project (Central)"
runs-on: ubuntu-latest runs-on: ubuntu-latest
-74
View File
@@ -1,74 +0,0 @@
name: "Publish Javadoc"
on:
# 支持手动触发构建
workflow_dispatch:
release:
# 创建release的时候触发
types: [ published ]
jobs:
javadoc-deploy:
name: "Deploy Javadoc (Github Pages)"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: "Set up JDK"
uses: actions/setup-java@v2
with:
java-version: '8'
distribution: 'adopt'
cache: maven
- name: "Generate Javadoc"
run: mvn -B javadoc:javadoc -pl api --file pom.xml -DskipTests
- name: "Copy Javadoc"
run: |
rm -rf docs
mkdir -vp docs
cp -vrf api/target/site/apidocs/* docs/
cp -vrf .doc/javadoc/JAVADOC-README.md docs/README.md
- name: "Generate Sitemap"
id: sitemap
uses: cicirello/generate-sitemap@v1
with:
base-url-path: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}
path-to-root: docs
- name: Output stats
run: |
echo "sitemap-path = ${{ steps.sitemap.outputs.sitemap-path }}"
echo "url-count = ${{ steps.sitemap.outputs.url-count }}"
echo "excluded-count = ${{ steps.sitemap.outputs.excluded-count }}"
ls -l docs
- name: Configure Git
env:
DEPLOY_PRI: ${{secrets.DEPLOY_PRI}}
run: |
sudo timedatectl set-timezone "Asia/Shanghai"
mkdir -p ~/.ssh/
echo "$DEPLOY_PRI" > ~/.ssh/id_rsa
chmod 600 ~/.ssh/id_rsa
ssh-keyscan github.com >> ~/.ssh/known_hosts
git config --global user.name '${{ github.repository_owner }}'
git config --global user.email '${{ github.repository_owner }}@users.noreply.github.com'
- name: Commit documentation changes
run: |
echo "Committing changes to git@github.com:${{ github.repository_owner }}/${{ github.event.repository.name }}.git ..."
cd docs
git init
git remote add origin git@github.com:${{ github.repository_owner }}/${{ github.event.repository.name }}.git
git checkout -b gh-pages
git add -A
git commit -m "API Document generated."
- name: Javadoc Website Push
run: |
cd docs
git push origin HEAD:gh-pages --force
+86 -30
View File
@@ -7,6 +7,7 @@
``` ```
# MineSQL (EasySQL-Plugin) # MineSQL (EasySQL-Plugin)
[![version](https://img.shields.io/github/v/release/CarmJos/MineSQL)](https://github.com/CarmJos/MineSQL/releases) [![version](https://img.shields.io/github/v/release/CarmJos/MineSQL)](https://github.com/CarmJos/MineSQL/releases)
[![License](https://img.shields.io/github/license/CarmJos/MineSQL)](https://opensource.org/licenses/GPL-3.0) [![License](https://img.shields.io/github/license/CarmJos/MineSQL)](https://opensource.org/licenses/GPL-3.0)
[![workflow](https://github.com/CarmJos/MineSQL/actions/workflows/maven.yml/badge.svg?branch=master)](https://github.com/CarmJos/MineSQL/actions/workflows/maven.yml) [![workflow](https://github.com/CarmJos/MineSQL/actions/workflows/maven.yml/badge.svg?branch=master)](https://github.com/CarmJos/MineSQL/actions/workflows/maven.yml)
@@ -16,30 +17,49 @@
轻松(用)SQL的独立运行库插件,支持多种服务端,适用于MineCraft全版本。 轻松(用)SQL的独立运行库插件,支持多种服务端,适用于MineCraft全版本。
## 使用场景 ## 优势
### 对于插件使用者 ### 对于服主 (插件使用者)
- 统一配置数据库连接,避免重复配置费时费力分神。
- 支持更高级更全面的配置方式,以根据不同的使
用场景独立优化[连接池配置](https://github.com/Chris2018998/BeeCP/wiki/Configuration--List)。
- 使相关插件共用连接池,避免每个插件单独新开连接池导致资源的浪费。
### 对于插件开发者 ### 对于插件开发者
- 基于 [EasySQL](https://github.com/CarmJos/EasySQL) 进行快捷的数据库操作。
- 通过 `MineSQL.getRegistry().get(database-name)` 快捷获取数据源,避免繁琐的链接过程。
- 详细的 DEBUG 方法,找到可恶的错误究竟在哪。
- 不再需要打包各类JDBC-Driver、连接池依赖以及EasySQL本体到插件中。
### 额外提醒 ### 额外提醒
- 使用本依赖时,请保证其他插件的来源安全,避免可能带来的数据安全风险。
## 安装 ## 安装
1. 从 [Releases(发行)](https://github.com/CarmJos/MineSQL/releases/)
中点击 [最新版](https://github.com/CarmJos/MineSQL/releases/latest) 下载 `MineSQL-x.y.z.jar`
2. 将下载的 `MineSQL-x.y.z.jar` 放入服务器 `plugins/` 文件夹下。
3. 启动服务器,预加载配置文件后关闭服务器。
4. 修改 `plugins/MineSQL/config.yml` 以配置您的数据库选项。
5. 启动服务器,若配置无误,则您会看到 MineSQL一切正常的提示消息。
## 配置 ## 配置
### 插件配置文件 [`config.yml`](minesql-core/src/main/resources/config.yml) ### 插件配置文件 [`config.yml`](.doc/example-config.yml)
完整示例配置请见 [文件](minesql-core/src/main/resources/config.yml)。 完整示例配置请见 [示例配置文件](.doc/example-config.yml)。
#### MySQL/MariaDB 数据源详细配置示例 #### MySQL/MariaDB 数据源详细配置示例
```yaml ```yaml
databases: sources:
"mysql-database": # 数据源ID,建议全英文小写并以“-”分隔,例如:hello-minecraft "mysql-database": # 数据源ID,建议全英文小写并以“-”分隔,例如:hello-minecraft
# 数据库驱动类型 # 数据库驱动类型
# 若您的数据库为 mariadb,则强烈推荐设置为 mariadb # 若您的数据库为 mariadb,则强烈推荐设置为 mariadb
driver-type: mysql type: mysql
host: 127.0.0.1 # 数据库地址 host: 127.0.0.1 # 数据库地址
port: 3306 # 数据库端口 port: 3306 # 数据库端口
database: minecraft # 数据库库名 database: minecraft # 数据库库名
@@ -50,20 +70,21 @@ databases:
#### h2 数据源详细配置示例 #### h2 数据源详细配置示例
```yaml ```yaml
databases: sources:
"h2-database": # 数据源ID,建议全小写以“-”分隔,例如:hello-minecraft
driver-type: h2
# h2数据库运行模式 # h2数据库运行模式
# 可选 file(文件模式) 与 mem(内存模式) # 可选 h2-file(文件模式) 与 h2-mem(内存模式)
# 文件模式下,须指定 file-path ,以服务器运行目录为基准,支持绝对路径和相对路径。 # 文件模式下,须指定 file路径 ,以服务器运行目录为基准,支持绝对路径和相对路径。
# 内存模式下,所有数据库都将存储在内存中,一旦关服则数据将全部丢失,该模式一般用于测试 # 内存模式下,所有数据库都将存储在内存中,一旦关服则数据将全部丢失,该模式一般用于测试
mode: file # 可选 mem(内存) file(文件) ;内存模式 "h2-file-db": # 数据源ID,建议全小写以“-”分隔,例如:hello-minecraft
type: h2-file
file-path: "db-files/minecraft" file-path: "db-files/minecraft"
"h2-mem-db": # 数据源ID,建议全小写以“-”分隔,例如:hello-minecraft
type: h2-mem
``` ```
### Properties 配置文件 [`<插件目录>/db-properties/*.properties`](minesql-core/src/main/resources/db-properties/.example-mysql.properties) ### Properties 配置文件 [`<插件目录>/db-properties/*.properties`](core/src/main/resources/db-properties/.example-mysql.properties)
示例配置请见 [示例MySQL数据源Properties](minesql-core/src/main/resources/db-properties/.example-mysql.properties)。 示例配置请见 [示例MySQL数据源Properties](core/src/main/resources/db-properties/.example-mysql.properties)。
Properties 文件的文件名几位数据源的ID,允许为英文、数字、下划线、短横线;请不要包含中文、其他特殊符号与空格,以`.`开头的文件将被忽略。 Properties 文件的文件名几位数据源的ID,允许为英文、数字、下划线、短横线;请不要包含中文、其他特殊符号与空格,以`.`开头的文件将被忽略。
@@ -71,6 +92,24 @@ Properties 文件的文件名几位数据源的ID,允许为英文、数字、
更多帮助详见 [BeeCP项目帮助](https://github.com/Chris2018998/BeeCP) 。 更多帮助详见 [BeeCP项目帮助](https://github.com/Chris2018998/BeeCP) 。
## 指令
插件主指令为 `/minesql` ,所有指令只允许后台执行。
```text
# help
- 查看插件指令帮助。
# version
- 查看当前插件、核心库(EasySQL)与连接池依赖版本。
# list
- 列出当前所有的数据源管理器与相关信息。
# info <数据源名称>
- 查看指定数据源的统计信息与当前仍未关闭的查询。
```
## 开发 ## 开发
### 依赖方式 ### 依赖方式
@@ -91,10 +130,10 @@ Properties 文件的文件名几位数据源的ID,允许为英文、数字、
</repository> </repository>
<repository> <repository>
<!--采用github依赖库,安全稳定,但需要配置 (推荐)--> <!--采用github分支依赖库,稳定更新快-->
<id>MineSQL</id> <id>MineSQL</id>
<name>GitHub Packages</name> <name>GitHub Branch Repository</name>
<url>https://maven.pkg.github.com/CarmJos/MineSQL</url> <url>https://github.com/CarmJos/MineSQL/blob/repo/</url>
</repository> </repository>
<repository> <repository>
@@ -130,8 +169,8 @@ repositories {
//采用Maven中心库,安全稳定,但版本更新需要等待同步 //采用Maven中心库,安全稳定,但版本更新需要等待同步
mavenCentral() mavenCentral()
// 采用github依赖库,安全稳定,但需要配置 (推荐) // 采用github分支依赖库,稳定更新快
maven { url 'https://maven.pkg.github.com/CarmJos/MineSQL' } maven { url 'https://github.com/CarmJos/MineSQL/blob/repo/' }
// 采用我的私人依赖库,简单方便,但可能因为变故而无法使用 // 采用我的私人依赖库,简单方便,但可能因为变故而无法使用
maven { url 'https://repo.carm.cc/repository/maven-public/' } maven { url 'https://repo.carm.cc/repository/maven-public/' }
@@ -144,24 +183,41 @@ dependencies {
</details> </details>
## 指令 ### 操作示例
插件主指令为 `/easysql` ,所有指令只允许后台执行 插件接口入口类为 `MineSQL` ,更多方法详见 [MineSQL-Javadoc](https://carmjos.github.io/MineSQL/)
```text 关于 EasySQL的使用方法,请详见 [EasySQL开发文档](https://github.com/CarmJos/EasySQL/tree/master/.documentation) 。
# help
- 查看插件指令帮助。
# version
- 查看当前插件、核心库(EasySQL)与连接池依赖版本。
# list <details>
- 列出当前所有的数据源管理器与相关信息。 <summary>点击查看简单实例</summary>
```java
public class Main extends JavaPlugin {
@Override
public void onEnable() {
SQLManager manager = MineSQL.getRegistery().get(getConfig().getString("database"));
if (manager == null) {
System.out.println("请配置一个正确的数据库名。");
setEnabled(false);
return;
}
// do something...
}
}
# info <数据源名称>
- 查看指定数据源的统计信息与当前仍未关闭的查询。
``` ```
</details>
## 开源协议 ## 开源协议
本项目源码采用 [GNU General Public License v3.0](https://opensource.org/licenses/GPL-3.0) 开源协议。 本项目源码采用 [GNU General Public License v3.0](https://opensource.org/licenses/GPL-3.0) 开源协议。
+1 -1
View File
@@ -5,7 +5,7 @@
<parent> <parent>
<artifactId>minesql-parent</artifactId> <artifactId>minesql-parent</artifactId>
<groupId>cc.carm.plugin</groupId> <groupId>cc.carm.plugin</groupId>
<version>1.1.0</version> <version>1.2.1</version>
</parent> </parent>
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
@@ -4,11 +4,14 @@ import cc.carm.lib.easysql.api.SQLManager;
import cc.carm.lib.easysql.api.SQLQuery; import cc.carm.lib.easysql.api.SQLQuery;
import cc.carm.plugin.minesql.api.SQLRegistry; import cc.carm.plugin.minesql.api.SQLRegistry;
import cc.carm.plugin.minesql.api.source.SQLSourceConfig; import cc.carm.plugin.minesql.api.source.SQLSourceConfig;
import cc.carm.plugin.minesql.api.table.SQLTablesRoot;
import cc.carm.plugin.minesql.api.table.SimpleSQLTable;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable; import org.jetbrains.annotations.Nullable;
import javax.sql.DataSource; import javax.sql.DataSource;
import java.io.File; import java.io.File;
import java.sql.SQLException;
import java.util.Map; import java.util.Map;
import java.util.Properties; import java.util.Properties;
import java.util.UUID; import java.util.UUID;
@@ -61,4 +64,18 @@ interface IMineSQL {
*/ */
void shutdown(SQLManager manager, @Nullable Consumer<Map<UUID, SQLQuery>> activeQueries); void shutdown(SQLManager manager, @Nullable Consumer<Map<UUID, SQLQuery>> activeQueries);
/**
* 读取一个 {@link SQLTablesRoot} 中全部的 {@link SimpleSQLTable} 实例并初始化。
*
* @param tablesRoot {@link SQLTablesRoot}实例
*/
void createTables(@NotNull SQLTablesRoot tablesRoot) throws Exception;
/**
* 读取一个 {@link SQLTablesRoot}类中 中全部的静态 {@link SimpleSQLTable} 实例并初始化。
*
* @param tablesRootClazz {@link SQLTablesRoot}静态类
*/
void createTables(@NotNull Class<? extends SQLTablesRoot> tablesRootClazz) throws Exception;
} }
@@ -4,6 +4,8 @@ import cc.carm.lib.easysql.api.SQLManager;
import cc.carm.lib.easysql.api.SQLQuery; import cc.carm.lib.easysql.api.SQLQuery;
import cc.carm.plugin.minesql.api.SQLRegistry; import cc.carm.plugin.minesql.api.SQLRegistry;
import cc.carm.plugin.minesql.api.source.SQLSourceConfig; import cc.carm.plugin.minesql.api.source.SQLSourceConfig;
import cc.carm.plugin.minesql.api.table.SQLTablesRoot;
import cc.carm.plugin.minesql.api.table.SimpleSQLTable;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable; import org.jetbrains.annotations.Nullable;
@@ -114,4 +116,23 @@ public class MineSQL {
shutdown(manager, true); shutdown(manager, true);
} }
/**
* 读取一个 {@link SQLTablesRoot} 中全部的 {@link SimpleSQLTable} 实例并初始化。
*
* @param tablesRoot {@link SQLTablesRoot}实例
*/
public static void createTables(@NotNull SQLTablesRoot tablesRoot) throws Exception {
instance.createTables(tablesRoot);
}
/**
* 读取一个 {@link SQLTablesRoot}类中 中全部的静态 {@link SimpleSQLTable} 实例并初始化。
*
* @param tablesRootClazz {@link SQLTablesRoot}静态类
*/
public static void createTables(@NotNull Class<? extends SQLTablesRoot> tablesRootClazz) throws Exception {
instance.createTables(tablesRootClazz);
}
} }
@@ -12,6 +12,14 @@ import java.util.Optional;
* 入口类 * 入口类
*/ */
public interface SQLRegistry { public interface SQLRegistry {
/**
* 获取原生注册的首个 SQLManager 实例
*
* @return {@link SQLManager} 实例
*/
default @Nullable SQLManager get() {
return get(null);
}
/** /**
* 获取原生注册的指定名称的 SQLManager 实例 * 获取原生注册的指定名称的 SQLManager 实例
@@ -0,0 +1,12 @@
package cc.carm.plugin.minesql.api.table;
import cc.carm.lib.easysql.api.function.SQLHandler;
import java.util.function.Supplier;
/**
* 表声明类的根节点,用于标注该类用于记录表的结构信息。
* <br> 创建表请使用 {@link SimpleSQLTable#of(String, String, Supplier, SQLHandler)}。
*/
public abstract class SQLTablesRoot {
}
@@ -0,0 +1,156 @@
package cc.carm.plugin.minesql.api.table;
import cc.carm.lib.easysql.api.SQLManager;
import cc.carm.lib.easysql.api.action.PreparedSQLUpdateAction;
import cc.carm.lib.easysql.api.action.PreparedSQLUpdateBatchAction;
import cc.carm.lib.easysql.api.builder.*;
import cc.carm.lib.easysql.api.function.SQLHandler;
import cc.carm.plugin.minesql.MineSQL;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.sql.SQLException;
import java.util.Optional;
import java.util.function.Supplier;
public class SimpleSQLTable {
public static @NotNull SimpleSQLTable of(@NotNull String tableName,
@NotNull SQLHandler<TableCreateBuilder> tableBuilder) {
return new SimpleSQLTable(null, tableName, null, tableBuilder);
}
public static @NotNull SimpleSQLTable of(@Nullable String database, @NotNull String tableName,
@NotNull SQLHandler<TableCreateBuilder> tableBuilder) {
return new SimpleSQLTable(database, tableName, null, tableBuilder);
}
public static @NotNull SimpleSQLTable of(@Nullable String database, @NotNull String tableName,
@Nullable String tablePrefix, @NotNull SQLHandler<TableCreateBuilder> tableBuilder) {
return new SimpleSQLTable(database, tableName, () -> tablePrefix, tableBuilder);
}
public static @NotNull SimpleSQLTable of(@Nullable String database, @NotNull String tableName,
@Nullable Supplier<String> tablePrefix, @NotNull SQLHandler<TableCreateBuilder> tableBuilder) {
return new SimpleSQLTable(database, tableName, tablePrefix, tableBuilder);
}
protected final @Nullable String database;
protected final @NotNull String tableName;
protected final @Nullable Supplier<String> tablePrefix;
protected final @NotNull SQLHandler<TableCreateBuilder> tableCreator;
public SimpleSQLTable(@Nullable String database, @NotNull String tableName,
@Nullable Supplier<String> tablePrefix, @NotNull SQLHandler<TableCreateBuilder> table) {
this.database = database;
this.tableName = tableName;
this.tablePrefix = tablePrefix;
this.tableCreator = table;
}
public boolean create() throws SQLException {
SQLManager sqlManager = getSQLManager();
if (sqlManager == null) throw new SQLException(getExceptionReason());
TableCreateBuilder tableBuilder = sqlManager.createTable(getTableName());
tableCreator.accept(tableBuilder);
return tableBuilder.build().executeFunction(l -> l > 0, false);
}
public @Nullable String getDatabase() {
return database;
}
public @Nullable SQLManager getSQLManager() {
return MineSQL.getRegistry().get(getDatabase());
}
public @NotNull String getTableName() {
String prefix = getTablePrefix();
return (prefix != null ? prefix : "") + tableName;
}
public @Nullable String getTablePrefix() {
return Optional.ofNullable(tablePrefix).map(Supplier::get).orElse(null);
}
public @NotNull TableQueryBuilder createQuery() {
return Optional.ofNullable(getSQLManager()).map(this::createQuery)
.orElseThrow(() -> new NullPointerException(getExceptionReason()));
}
public @NotNull TableQueryBuilder createQuery(@NotNull SQLManager sqlManager) {
return sqlManager.createQuery().inTable(getTableName());
}
public @NotNull DeleteBuilder createDelete() {
return Optional.ofNullable(getSQLManager()).map(this::createDelete)
.orElseThrow(() -> new NullPointerException(getExceptionReason()));
}
public @NotNull DeleteBuilder createDelete(@NotNull SQLManager sqlManager) {
return sqlManager.createDelete(getTableName());
}
public @NotNull UpdateBuilder createUpdate() {
return Optional.ofNullable(getSQLManager()).map(this::createUpdate)
.orElseThrow(() -> new NullPointerException(getExceptionReason()));
}
public @NotNull UpdateBuilder createUpdate(@NotNull SQLManager sqlManager) {
return sqlManager.createUpdate(getTableName());
}
public @NotNull InsertBuilder<PreparedSQLUpdateAction<Integer>> createInsert() {
return Optional.ofNullable(getSQLManager()).map(this::createInsert)
.orElseThrow(() -> new NullPointerException(getExceptionReason()));
}
public @NotNull InsertBuilder<PreparedSQLUpdateAction<Integer>> createInsert(@NotNull SQLManager sqlManager) {
return sqlManager.createInsert(getTableName());
}
public @NotNull InsertBuilder<PreparedSQLUpdateBatchAction<Integer>> createInsertBatch() {
return Optional.ofNullable(getSQLManager()).map(this::createInsertBatch)
.orElseThrow(() -> new NullPointerException(getExceptionReason()));
}
public @NotNull InsertBuilder<PreparedSQLUpdateBatchAction<Integer>> createInsertBatch(@NotNull SQLManager sqlManager) {
return sqlManager.createInsertBatch(getTableName());
}
public @NotNull ReplaceBuilder<PreparedSQLUpdateAction<Integer>> createReplace() {
return Optional.ofNullable(getSQLManager()).map(this::createReplace)
.orElseThrow(() -> new NullPointerException(getExceptionReason()));
}
public @NotNull ReplaceBuilder<PreparedSQLUpdateAction<Integer>> createReplace(@NotNull SQLManager sqlManager) {
return sqlManager.createReplace(getTableName());
}
public @NotNull ReplaceBuilder<PreparedSQLUpdateBatchAction<Integer>> createReplaceBatch() {
return Optional.ofNullable(getSQLManager()).map(this::createReplaceBatch)
.orElseThrow(() -> new NullPointerException(getExceptionReason()));
}
public @NotNull ReplaceBuilder<PreparedSQLUpdateBatchAction<Integer>> createReplaceBatch(@NotNull SQLManager sqlManager) {
return sqlManager.createReplaceBatch(getTableName());
}
public @NotNull TableAlterBuilder alter() {
return Optional.ofNullable(getSQLManager()).map(this::alter)
.orElseThrow(() -> new NullPointerException(getExceptionReason()));
}
public @NotNull TableAlterBuilder alter(@NotNull SQLManager sqlManager) {
return sqlManager.alterTable(getTableName());
}
private String getExceptionReason() {
if (getDatabase() == null) return "Cannot find any SQLManager.";
else return "Cannot find any SQLManager for \"" + getDatabase() + "\".";
}
}
+1 -1
View File
@@ -5,7 +5,7 @@
<parent> <parent>
<artifactId>minesql-parent</artifactId> <artifactId>minesql-parent</artifactId>
<groupId>cc.carm.plugin</groupId> <groupId>cc.carm.plugin</groupId>
<version>1.1.0</version> <version>1.2.1</version>
</parent> </parent>
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<properties> <properties>
@@ -8,6 +8,8 @@ import cc.carm.lib.easysql.api.SQLQuery;
import cc.carm.lib.easysql.manager.SQLManagerImpl; import cc.carm.lib.easysql.manager.SQLManagerImpl;
import cc.carm.lib.githubreleases4j.GithubReleases4J; import cc.carm.lib.githubreleases4j.GithubReleases4J;
import cc.carm.plugin.minesql.api.source.SQLSourceConfig; import cc.carm.plugin.minesql.api.source.SQLSourceConfig;
import cc.carm.plugin.minesql.api.table.SQLTablesRoot;
import cc.carm.plugin.minesql.api.table.SimpleSQLTable;
import cc.carm.plugin.minesql.command.MineSQLCommand; import cc.carm.plugin.minesql.command.MineSQLCommand;
import cc.carm.plugin.minesql.command.MineSQLHelpFormatter; import cc.carm.plugin.minesql.command.MineSQLHelpFormatter;
import cc.carm.plugin.minesql.conf.PluginConfiguration; import cc.carm.plugin.minesql.conf.PluginConfiguration;
@@ -23,6 +25,8 @@ import org.jetbrains.annotations.Nullable;
import javax.sql.DataSource; import javax.sql.DataSource;
import java.io.File; import java.io.File;
import java.lang.reflect.Field;
import java.sql.SQLException;
import java.util.*; import java.util.*;
import java.util.function.Consumer; import java.util.function.Consumer;
import java.util.logging.Logger; import java.util.logging.Logger;
@@ -157,6 +161,48 @@ public class MineSQLCore implements IMineSQL {
} }
} }
@Override
public void createTables(@NotNull SQLTablesRoot tablesRoot) throws SQLException {
for (Field field : tablesRoot.getClass().getDeclaredFields()) {
initializeTableField(tablesRoot, field);
}
}
@Override
public void createTables(@NotNull Class<? extends SQLTablesRoot> clazz) throws SQLException {
initializeTableClass(clazz);
}
protected void initializeTableClass(@NotNull Class<?> clazz) throws SQLException {
if (!SQLTablesRoot.class.isAssignableFrom(clazz)) return;
for (Field field : clazz.getDeclaredFields()) {
initializeTableField(clazz, field);
}
for (Class<?> subClass : clazz.getDeclaredClasses()) {
initializeTableClass(subClass);
}
}
protected void initializeTableField(@NotNull Object source, @NotNull Field field) throws SQLException {
try {
field.setAccessible(true);
Object object = field.get(source);
if (object instanceof SimpleSQLTable) {
((SimpleSQLTable) object).create();
} else if (source instanceof SQLTablesRoot && object instanceof SQLTablesRoot) {
createTables((SQLTablesRoot) object);
} else if (source instanceof Class<?> && object instanceof Class<?>) {
// 当且仅当 源字段与字段 均为静态类时,才对目标字段进行下一步初始化加载。
initializeTableClass((Class<?>) object);
}
} catch (IllegalAccessException ignored) {
}
}
public void shutdownAll() { public void shutdownAll() {
this.registry.getManagers().forEach((k, manager) -> { this.registry.getManagers().forEach((k, manager) -> {
getLogger().info(" 正在关闭数据库 " + k + "..."); getLogger().info(" 正在关闭数据库 " + k + "...");
@@ -8,16 +8,16 @@ import cc.carm.lib.configuration.core.value.type.ConfiguredValue;
public class PluginConfiguration extends ConfigurationRoot { public class PluginConfiguration extends ConfigurationRoot {
@HeaderComment("排错模式,一般留给开发者检查问题,平常使用无需开启。") @HeaderComment("排错模式,一般留给开发者检查问题,平常使用无需开启。")
public ConfigValue<Boolean> DEBUG = ConfiguredValue.of(Boolean.class, false); public final ConfigValue<Boolean> DEBUG = ConfiguredValue.of(Boolean.class, false);
@HeaderComment({ @HeaderComment({"",
"统计数据设定", "统计数据设定",
"该选项用于帮助开发者统计插件版本与使用情况,且绝不会影响性能与使用体验。", "该选项用于帮助开发者统计插件版本与使用情况,且绝不会影响性能与使用体验。",
"当然,您也可以选择在这里关闭,或在plugins/bStats下的配置文件中关闭所有插件的统计信息。" "当然,您也可以选择在这里关闭,或在plugins/bStats下的配置文件中关闭所有插件的统计信息。"
}) })
public ConfigValue<Boolean> METRICS = ConfiguredValue.of(Boolean.class, true); public final ConfigValue<Boolean> METRICS = ConfiguredValue.of(Boolean.class, true);
@HeaderComment({ @HeaderComment({"",
"检查更新设定", "检查更新设定",
"该选项用于插件判断是否要检查更新,若您不希望插件检查更新并提示您,可以选择关闭。", "该选项用于插件判断是否要检查更新,若您不希望插件检查更新并提示您,可以选择关闭。",
"检查更新为异步操作,绝不会影响性能与使用体验。" "检查更新为异步操作,绝不会影响性能与使用体验。"
@@ -25,15 +25,15 @@ public class PluginConfiguration extends ConfigurationRoot {
public ConfigValue<Boolean> UPDATE_CHECKER = ConfiguredValue.of(Boolean.class, true); public ConfigValue<Boolean> UPDATE_CHECKER = ConfiguredValue.of(Boolean.class, true);
@HeaderComment({"插件注册池配置"}) @HeaderComment({"插件注册池配置"})
public SettingsConfig SETTINGS = new SettingsConfig(); public final SettingsConfig SETTINGS = new SettingsConfig();
@HeaderComment({ @HeaderComment({"",
"Properties 数据库配置文件配置", "Properties 数据库配置文件配置",
"相关配置介绍(BeeCP) https://github.com/Chris2018998/BeeCP/wiki/Configuration--List#配置列表" "相关配置介绍(BeeCP) https://github.com/Chris2018998/BeeCP/wiki/Configuration--List#配置列表"
}) })
public PropertiesConfig PROPERTIES = new PropertiesConfig(); public final PropertiesConfig PROPERTIES = new PropertiesConfig();
@HeaderComment({ @HeaderComment({"",
"数据库源配置", "数据库源配置",
"目前支持的驱动类型(type)有 mariadb、mysql、h2-file(文件数据库) 与 h2-mem(内存临时数据库)。", "目前支持的驱动类型(type)有 mariadb、mysql、h2-file(文件数据库) 与 h2-mem(内存临时数据库)。",
"详细配置介绍请查看 https://github.com/CarmJos/MineSQL/.doc/README.md" "详细配置介绍请查看 https://github.com/CarmJos/MineSQL/.doc/README.md"
@@ -47,7 +47,7 @@ public class PluginConfiguration extends ConfigurationRoot {
public static class PropertiesConfig extends ConfigurationRoot { public static class PropertiesConfig extends ConfigurationRoot {
@HeaderComment("该选项用于启用 Properties 配置读取若您不希望插件启用 Properties 文件配置,可以选择关闭。") @HeaderComment({"该选项用于启用 Properties 配置读取", "若您不希望插件启用 Properties 文件配置功能,可以选择关闭。"})
public ConfigValue<Boolean> ENABLE = ConfiguredValue.of(Boolean.class, true); public ConfigValue<Boolean> ENABLE = ConfiguredValue.of(Boolean.class, true);
@HeaderComment({ @HeaderComment({
+1 -1
View File
@@ -5,7 +5,7 @@
<parent> <parent>
<artifactId>minesql-parent</artifactId> <artifactId>minesql-parent</artifactId>
<groupId>cc.carm.plugin</groupId> <groupId>cc.carm.plugin</groupId>
<version>1.1.0</version> <version>1.2.1</version>
<relativePath>../../pom.xml</relativePath> <relativePath>../../pom.xml</relativePath>
</parent> </parent>
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
+1 -1
View File
@@ -5,7 +5,7 @@
<parent> <parent>
<artifactId>minesql-parent</artifactId> <artifactId>minesql-parent</artifactId>
<groupId>cc.carm.plugin</groupId> <groupId>cc.carm.plugin</groupId>
<version>1.1.0</version> <version>1.2.1</version>
<relativePath>../../pom.xml</relativePath> <relativePath>../../pom.xml</relativePath>
</parent> </parent>
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
+1 -1
View File
@@ -5,7 +5,7 @@
<parent> <parent>
<artifactId>minesql-parent</artifactId> <artifactId>minesql-parent</artifactId>
<groupId>cc.carm.plugin</groupId> <groupId>cc.carm.plugin</groupId>
<version>1.1.0</version> <version>1.2.1</version>
<relativePath>../../pom.xml</relativePath> <relativePath>../../pom.xml</relativePath>
</parent> </parent>
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
+1 -1
View File
@@ -5,7 +5,7 @@
<parent> <parent>
<artifactId>minesql-parent</artifactId> <artifactId>minesql-parent</artifactId>
<groupId>cc.carm.plugin</groupId> <groupId>cc.carm.plugin</groupId>
<version>1.1.0</version> <version>1.2.1</version>
</parent> </parent>
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<properties> <properties>
+15 -2
View File
@@ -24,7 +24,7 @@
<groupId>cc.carm.plugin</groupId> <groupId>cc.carm.plugin</groupId>
<artifactId>minesql-parent</artifactId> <artifactId>minesql-parent</artifactId>
<packaging>pom</packaging> <packaging>pom</packaging>
<version>1.1.0</version> <version>1.2.1</version>
<modules> <modules>
<module>api</module> <module>api</module>
<module>core</module> <module>core</module>
@@ -297,11 +297,24 @@
<repository> <repository>
<id>github</id> <id>github</id>
<name>GitHub Packages</name> <name>GitHub Packages</name>
<url>https://maven.pkg.github.com/CarmJos/MineConfiguration</url> <url>https://maven.pkg.github.com/CarmJos/MineSQL</url>
</repository> </repository>
</distributionManagement> </distributionManagement>
</profile> </profile>
<profile>
<id>local</id>
<distributionManagement>
<snapshotRepository>
<id>localRepository</id>
<url>file:${user.home}/local-deploy/</url>
</snapshotRepository>
<repository>
<id>localRepository</id>
<url>file:${user.home}/local-deploy/</url>
</repository>
</distributionManagement>
</profile>
</profiles> </profiles>