fix(get): 修复获取首个Manager会出现报错的问题

This reverts commit 58bddd86aa.

.doc/example-config.yml

@@ -29,13 +29,13 @@ properties:
 databases:
 
   "example-mariadb": # 数据库源名称 不可包含“.” 以“example-”开头的数据源不会被加载
-    driver-type: mariadb
+    type: mariadb # MySQL / MariaDB 类型
     host: 127.0.0.1 # 数据库地址
     port: 3306 # 数据库端口
     username: minecraft # 数据库用户名
     password: password #数据库连接密码
     database: minecraft #数据库名
 
-  "example-h2": # 数据库源名称 不可包含“.” 以“example-”开头的数据源不会被加载
+  "example-h2":
-    driver-type: h2 #数据库驱动类型，目前支持 mariadb, mysql, h2
+    type: h2-file
     file: "example.db" #数据库文件路径，相对于“plugins/MineSQL/db-files/”

.doc/repository/REPO-README.md

@@ -13,7 +13,7 @@
     <repository>
         <id>MineSQL</id>
         <name>GitHub Branch Repository</name>
-        <url>https://github.com/CarmJos/MineSQL/blob/repo/</url>
+        <url>https://raw.githubusercontent.com/CarmJos/MineSQL/repo/</url>
     </repository>
 </repositories>
 ```

.github/workflows/deploy.yml

@@ -63,14 +63,14 @@ jobs:
           rm -rf deploy
           mkdir -vp deploy
           cp -vrf $HOME/local-deploy/* deploy/
-          cp -vrf .documentation/repository/REPO-README.md deploy/README.md
+          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 .documentation/javadoc/JAVADOC-README.md docs/README.md
+          cp -vrf .doc/javadoc/JAVADOC-README.md docs/README.md
 
       - name: "Generate Javadoc sitemap"
         id: sitemap

README.md

@@ -22,11 +22,8 @@
 ### 对于服主 (插件使用者)
 
 - 统一配置数据库连接，避免重复配置费时费力分神。
--
+- 支持更高级更全面的配置方式，以根据不同的使
-
+  用场景独立优化[连接池配置](https://github.com/Chris2018998/BeeCP/wiki/Configuration--List)。
-支持更高级更全面的配置方式，以根据不同的使用场景独立优化[连接池配置](https://github.com/Chris2018998/BeeCP/wiki/Configuration--List)
-。
-
 - 使相关插件共用连接池，避免每个插件单独新开连接池导致资源的浪费。
 
 ### 对于插件开发者
@@ -136,7 +133,7 @@ Properties 文件的文件名几位数据源的ID，允许为英文、数字、
             <!--采用github分支依赖库，稳定更新快-->
             <id>MineSQL</id>
             <name>GitHub Branch Repository</name>
-            <url>https://github.com/CarmJos/MineSQL/blob/repo/</url>
+            <url>https://raw.githubusercontent.com/CarmJos/MineSQL/repo/</url>
         </repository>
 
         <repository>
@@ -207,7 +204,7 @@ public class Main extends JavaPlugin {
 
         if (manager == null) {
             System.out.println("请配置一个正确的数据库名。");
-            setEnable(false);
+            setEnabled(false);
             return;
         }
 

api/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>minesql-parent</artifactId>
         <groupId>cc.carm.plugin</groupId>
-        <version>1.1.1</version>
+        <version>1.2.2</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

api/src/main/java/cc/carm/plugin/minesql/IMineSQL.java

@@ -4,11 +4,14 @@ import cc.carm.lib.easysql.api.SQLManager;
 import cc.carm.lib.easysql.api.SQLQuery;
 import cc.carm.plugin.minesql.api.SQLRegistry;
 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.Nullable;
 
 import javax.sql.DataSource;
 import java.io.File;
+import java.sql.SQLException;
 import java.util.Map;
 import java.util.Properties;
 import java.util.UUID;
@@ -61,4 +64,18 @@ interface IMineSQL {
      */
     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;
+
 }

api/src/main/java/cc/carm/plugin/minesql/MineSQL.java

@@ -4,6 +4,8 @@ import cc.carm.lib.easysql.api.SQLManager;
 import cc.carm.lib.easysql.api.SQLQuery;
 import cc.carm.plugin.minesql.api.SQLRegistry;
 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.Nullable;
 
@@ -114,4 +116,23 @@ public class MineSQL {
         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);
+    }
+
 }

api/src/main/java/cc/carm/plugin/minesql/api/SQLRegistry.java

@@ -12,7 +12,15 @@ import java.util.Optional;
  * 入口类
  */
 public interface SQLRegistry {
-    
+    /**
+     * 获取原生注册的首个 SQLManager 实例
+     *
+     * @return {@link SQLManager} 实例
+     */
+    default @Nullable SQLManager get() {
+        return get(null);
+    }
+
     /**
      * 获取原生注册的指定名称的 SQLManager 实例
      *

api/src/main/java/cc/carm/plugin/minesql/api/table/SQLTablesRoot.java

@@ -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 {
+}

api/src/main/java/cc/carm/plugin/minesql/api/table/SimpleSQLTable.java

@@ -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() + "\".";
+    }
+
+}

core/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>minesql-parent</artifactId>
         <groupId>cc.carm.plugin</groupId>
-        <version>1.1.1</version>
+        <version>1.2.2</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <properties>

core/src/main/java/cc/carm/plugin/minesql/MineSQLCore.java

@@ -8,6 +8,8 @@ import cc.carm.lib.easysql.api.SQLQuery;
 import cc.carm.lib.easysql.manager.SQLManagerImpl;
 import cc.carm.lib.githubreleases4j.GithubReleases4J;
 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.MineSQLHelpFormatter;
 import cc.carm.plugin.minesql.conf.PluginConfiguration;
@@ -23,6 +25,8 @@ import org.jetbrains.annotations.Nullable;
 
 import javax.sql.DataSource;
 import java.io.File;
+import java.lang.reflect.Field;
+import java.sql.SQLException;
 import java.util.*;
 import java.util.function.Consumer;
 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() {
         this.registry.getManagers().forEach((k, manager) -> {
             getLogger().info("   正在关闭数据库 " + k + "...");

core/src/main/java/cc/carm/plugin/minesql/MineSQLRegistry.java

@@ -21,7 +21,9 @@ public class MineSQLRegistry implements SQLRegistry {
 
     @Override
     public @NotNull Optional<@Nullable SQLManager> getOptional(@Nullable String id) {
-        return Optional.of(this.managers.get(id));
+        if (id != null) return Optional.of(this.managers.get(id));
+        else if (managers.isEmpty()) return Optional.empty();
+        else return Optional.ofNullable(managers.values().iterator().next());
     }
 
     @Override

core/src/main/java/cc/carm/plugin/minesql/conf/PluginConfiguration.java

@@ -8,16 +8,16 @@ import cc.carm.lib.configuration.core.value.type.ConfiguredValue;
 public class PluginConfiguration extends ConfigurationRoot {
 
     @HeaderComment("排错模式，一般留给开发者检查问题，平常使用无需开启。")
-    public ConfigValue<Boolean> DEBUG = ConfiguredValue.of(Boolean.class, false);
+    public final ConfigValue<Boolean> DEBUG = ConfiguredValue.of(Boolean.class, false);
 
-    @HeaderComment({
+    @HeaderComment({"",
             "统计数据设定",
             "该选项用于帮助开发者统计插件版本与使用情况，且绝不会影响性能与使用体验。",
             "当然，您也可以选择在这里关闭，或在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);
 
     @HeaderComment({"插件注册池配置"})
-    public SettingsConfig SETTINGS = new SettingsConfig();
+    public final SettingsConfig SETTINGS = new SettingsConfig();
 
-    @HeaderComment({
+    @HeaderComment({"",
             "Properties 数据库配置文件配置",
             "相关配置介绍(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(内存临时数据库)。",
             "详细配置介绍请查看 https://github.com/CarmJos/MineSQL/.doc/README.md"
@@ -47,7 +47,7 @@ public class PluginConfiguration extends ConfigurationRoot {
 
     public static class PropertiesConfig extends ConfigurationRoot {
 
-        @HeaderComment("该选项用于启用 Properties 配置读取，若您不希望插件启用 Properties 文件配置，可以选择关闭。")
+        @HeaderComment({"该选项用于启用 Properties 配置读取。", "若您不希望插件启用 Properties 文件配置功能，可以选择关闭。"})
         public ConfigValue<Boolean> ENABLE = ConfiguredValue.of(Boolean.class, true);
 
         @HeaderComment({

platforms/bukkit/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>minesql-parent</artifactId>
         <groupId>cc.carm.plugin</groupId>
-        <version>1.1.1</version>
+        <version>1.2.2</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>

platforms/bungee/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>minesql-parent</artifactId>
         <groupId>cc.carm.plugin</groupId>
-        <version>1.1.1</version>
+        <version>1.2.2</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>

platforms/velocity/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>minesql-parent</artifactId>
         <groupId>cc.carm.plugin</groupId>
-        <version>1.1.1</version>
+        <version>1.2.2</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>

plugin/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>minesql-parent</artifactId>
         <groupId>cc.carm.plugin</groupId>
-        <version>1.1.1</version>
+        <version>1.2.2</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <properties>

pom.xml

@@ -24,7 +24,7 @@
     <groupId>cc.carm.plugin</groupId>
     <artifactId>minesql-parent</artifactId>
     <packaging>pom</packaging>
-    <version>1.1.1</version>
+    <version>1.2.2</version>
     <modules>
         <module>api</module>
         <module>core</module>