chore(project): 修改项目文件结构

2026-06-04 15:28:20 +08:00 · 2022-06-02 21:41:09 +08:00
parent 96ccc604ed
commit 9bac83f739
17 changed files with 25 additions and 17 deletions
@@ -0,0 +1,123 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>easysql-parent</artifactId>
+        <groupId>cc.carm.lib</groupId>
+        <version>0.3.16</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <properties>
+        <maven.compiler.source>${jdk.version}</maven.compiler.source>
+        <maven.compiler.target>${jdk.version}</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <maven.compiler.encoding>UTF-8</maven.compiler.encoding>
+        <maven.javadoc.skip>true</maven.javadoc.skip>
+        <maven.deploy.skip>true</maven.deploy.skip>
+
+        <log4j.version>2.17.2</log4j.version>
+    </properties>
+
+    <artifactId>easysql-demo</artifactId>
+    <packaging>jar</packaging>
+
+    <name>EasySQL-Demo</name>
+    <description>EasySQL的演示部分</description>
+    <url>https://github.com/CarmJos/EasySQL</url>
+
+    <developers>
+        <developer>
+            <id>CarmJos</id>
+            <name>Carm Jos</name>
+            <email>carm@carm.cc</email>
+            <url>https://www.carm.cc</url>
+            <roles>
+                <role>Main Developer</role>
+            </roles>
+        </developer>
+    </developers>
+
+    <licenses>
+        <license>
+            <name>The MIT License</name>
+            <url>https://opensource.org/licenses/MIT</url>
+        </license>
+    </licenses>
+
+    <issueManagement>
+        <system>GitHub Issues</system>
+        <url>${project.url}/issues</url>
+    </issueManagement>
+
+    <ciManagement>
+        <system>GitHub Actions</system>
+        <url>${project.url}/actions/workflows/maven.yml</url>
+    </ciManagement>
+
+    <dependencies>
+
+        <dependency>
+            <groupId>${project.parent.groupId}</groupId>
+            <artifactId>easysql-impl</artifactId>
+            <version>${project.parent.version}</version>
+            <scope>compile</scope>
+        </dependency>
+
+        <dependency>
+            <!--项目地址 https://github.com/brettwooldridge/HikariCP/  -->
+            <groupId>com.zaxxer</groupId>
+            <artifactId>HikariCP</artifactId>
+            <version>4.0.3</version>
+            <scope>test</scope>
+        </dependency>
+
+        <!-- https://mvnrepository.com/artifact/com.h2database/h2 -->
+        <dependency>
+            <groupId>com.h2database</groupId>
+            <artifactId>h2</artifactId>
+            <version>2.1.212</version>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-api</artifactId>
+            <version>${log4j.version}</version>
+            <scope>compile</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-core</artifactId>
+            <version>${log4j.version}</version>
+            <scope>compile</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-slf4j-impl</artifactId>
+            <version>${log4j.version}</version>
+            <scope>compile</scope>
+        </dependency>
+
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-jar-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-shade-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
+</project>
@@ -0,0 +1,160 @@
+import cc.carm.lib.easysql.api.SQLManager;
+import cc.carm.lib.easysql.api.SQLQuery;
+import cc.carm.lib.easysql.api.SQLTable;
+import cc.carm.lib.easysql.api.enums.ForeignKeyRule;
+import cc.carm.lib.easysql.api.enums.IndexType;
+import cc.carm.lib.easysql.api.enums.NumberType;
+import cc.carm.lib.easysql.api.util.TimeDateUtils;
+import cc.carm.lib.easysql.api.util.UUIDUtil;
+import org.jetbrains.annotations.TestOnly;
+
+import java.sql.ResultSet;
+import java.sql.SQLException;
+import java.util.UUID;
+
+@TestOnly
+@SuppressWarnings("all")
+public class EasySQLDemo {
+
+    public void createTable(SQLManager sqlManager) {
+        // 同步创建表
+        sqlManager.createTable("users")
+//				.addColumn("id", "INT(11) AUTO_INCREMENT NOT NULL PRIMARY KEY")
+                .addAutoIncrementColumn("id", NumberType.INT, true, true)
+                .addColumn("uuid", "VARCHAR(32) NOT NULL UNIQUE KEY")
+                .addColumn("username", "VARCHAR(16) NOT NULL")
+                .addColumn("age", "TINYINT NOT NULL DEFAULT 1")
+                .addColumn("email", "VARCHAR(32)")
+                .addColumn("phone", "VARCHAR(16)")
+                .addColumn("registerTime", "DATETIME NOT NULL")
+//				.addColumn("INDEX `phone`") // 原始方法添加索引
+                .setIndex("username", IndexType.UNIQUE_KEY) // 添加唯一索引
+                .setIndex(IndexType.INDEX, "contact", "email", "phone") //添加联合索引 (示例)
+                .build().execute(null /* 不处理错误 */);
+
+        sqlManager.createTable("user_ipaddr")
+                .addAutoIncrementColumn("id", NumberType.INT, true, true)
+                .addColumn("uuid", "VARCHAR(32) NOT NULL")
+                .addColumn("ip", "VARCHAR(16)")
+                .addColumn("time", "DATETIME NOT NULL")
+                .addForeignKey("uuid", null,
+                        "users", "uuid",
+                        ForeignKeyRule.CASCADE, ForeignKeyRule.CASCADE
+                )
+                .build().execute(null /* 不处理错误 */);
+    }
+
+    public void useSQLTable(SQLManager sqlManager) {
+        SQLTable tags = SQLTable.of("servers", table -> {
+            table.addAutoIncrementColumn("id", true);
+            table.addColumn("user", "INT UNSIGNED NOT NULL");
+            table.addColumn("content", "TEXT NOT NULL");
+            table.addColumn("time", "DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP");
+
+            table.addForeignKey(
+                    "user", "fk_user_tags",
+                    "users", "id",
+                    ForeignKeyRule.CASCADE, ForeignKeyRule.CASCADE
+            );
+
+        });
+
+        try {
+            tags.create(sqlManager);
+        } catch (SQLException e) {
+            e.printStackTrace();
+        }
+
+        tags.createQuery().addCondition("id", 5).build()
+                .executeAsync(success -> {
+                    System.out.println("success!");
+                });
+    }
+
+    public void alertTable(SQLManager sqlManager) {
+        // 同步更新表
+        sqlManager.alterTable("users")
+                .modifyColumn("age", "TINYINT NOT NULL DEFAULT 0")
+                .execute(null /* 不处理错误 */);
+    }
+
+
+    public void sqlQuery(SQLManager sqlManager) {
+        // 同步SQL查询
+        try (SQLQuery query = sqlManager.createQuery()
+                .inTable("users") // 在users表中查询
+                .selectColumns("id", "name") // 选中 id 与 name列
+                .addCondition("age", ">", 18) // 限定 age 要大于5
+                .addCondition("email", null) // 限定查询 email 字段为空
+                .addNotNullCondition("phone") // 限定 phone 字段不为空
+                .addTimeCondition("registerTime", // 时间字段
+                        System.currentTimeMillis() - 100000, //限制开始时间
+                        -1//不限制结束时间
+                ).build().execute()) {
+            ResultSet resultSet = query.getResultSet();
+            //do something
+
+        } catch (SQLException exception) {
+            exception.printStackTrace();
+        }
+
+        UUID userUUID = sqlManager.createQuery()
+                .inTable("users") // 在users表中查询
+                .selectColumns("uuid")
+                .addCondition("id", 5) // 限定 id 为 5
+                .setLimit(1) // 只取出一个数据
+                .build().execute(query -> {
+                    //可以直接进行数据处理
+                    ResultSet result = query.getResultSet();
+                    return result.next() ? UUIDUtil.toUUID(result.getString("uuid")) : null;
+                }, (exception, action) -> {
+                    // 处理异常，不想处理直接填null
+                });
+
+    }
+
+    public void sqlQueryAsync(SQLManager sqlManager) {
+        // 异步SQL查询
+        sqlManager.createQuery()
+                .inTable("users") // 在users表中查询
+                .addCondition("id", 5) // 限定 id 为 5
+                .setLimit(1) // 只取出一个数据
+                .build().executeAsync(success -> {
+                    ResultSet resultSet = success.getResultSet();
+                    if (resultSet != null && resultSet.next()) {
+                        String username = resultSet.getString("username");
+                    }
+                }, (exception, action) -> {
+                    //do something
+                    long createTIme = action.getCreateTime();
+                    String shortID = action.getShortID();
+                    String sqlContent = action.getSQLContent();
+                });
+    }
+
+    public void sqlInsert(SQLManager sqlManager) {
+        // 同步SQL插入 （不使用try-catch的情况下，返回的数值可能为空。）
+        Long id = sqlManager.createInsert("users")
+                .setColumnNames("username", "phone", "email", "registerTime")
+                .setParams("CarmJos", "18888888888", "carm@carm.cc", TimeDateUtils.getCurrentTime())
+                .setReturnGeneratedKey(true)// 设定在后续返回自增主键
+                .execute((exception, action) -> {
+                    // 处理异常
+                    System.out.println("#" + action.getShortID() + " -> " + action.getSQLContent());
+                    exception.printStackTrace();
+                });
+
+        try {
+            Long userID = sqlManager.createInsert("users")
+                    .setColumnNames("username", "phone", "email", "registerTime")
+                    .setParams("CarmJos", "18888888888", "carm@carm.cc", TimeDateUtils.getCurrentTime())
+                    .returnGeneratedKey().execute();
+
+            System.out.println("新用户的ID为 " + userID);
+
+        } catch (SQLException exception) {
+            exception.printStackTrace();
+        }
+    }
+
+}
@@ -0,0 +1,76 @@
+package cc.carm.lib.easysql;
+
+import cc.carm.lib.easysql.api.SQLManager;
+import cc.carm.lib.easysql.manager.SQLManagerImpl;
+import cc.carm.lib.easysql.tests.*;
+import com.zaxxer.hikari.HikariConfig;
+import com.zaxxer.hikari.HikariDataSource;
+import org.jetbrains.annotations.NotNull;
+import org.junit.Test;
+
+import java.util.LinkedHashSet;
+import java.util.Set;
+
+public class EasySQLTest {
+
+
+    @Test
+    public void onTest() {
+
+        HikariConfig config = new HikariConfig();
+        config.setDriverClassName("org.h2.Driver");
+        config.setJdbcUrl("jdbc:h2:mem:test;DB_CLOSE_DELAY=-1;MODE=MYSQL;");
+
+        SQLManager sqlManager = new SQLManagerImpl(new HikariDataSource(config), "test");
+        sqlManager.setDebugMode(true);
+
+        print("加载测试类...");
+        Set<TestHandler> tests = new LinkedHashSet<>();
+        tests.add(new TableCreateTest());
+//		tests.add(new TableAlterTest());
+//		tests.add(new TableRenameTest());
+//		tests.add(new QueryNotCloseTest());
+        tests.add(new QueryCloseTest());
+        tests.add(new SQLUpdateBatchTests());
+        tests.add(new SQLUpdateReturnKeysTest());
+        tests.add(new QueryFunctionTest());
+        tests.add(new DeleteTest());
+
+        print("准备进行测试...");
+
+        int index = 1;
+        int success = 0;
+
+        for (TestHandler currentTest : tests) {
+            print("-------------------------------------------------");
+            if (currentTest.executeTest(index, sqlManager)) {
+                success++;
+            }
+
+            index++;
+            try {
+                Thread.sleep(1000L);
+            } catch (InterruptedException e) {
+                e.printStackTrace();
+            }
+
+        }
+
+        print(" ");
+        print("全部测试执行完毕，成功 %s 个，失败 %s 个。",
+                success, (tests.size() - success)
+        );
+
+        if (sqlManager.getDataSource() instanceof HikariDataSource) {
+            //Close bee connection pool
+            ((HikariDataSource) sqlManager.getDataSource()).close();
+        }
+
+    }
+
+
+    public static void print(@NotNull String format, Object... params) {
+        System.out.printf((format) + "%n", params);
+    }
+
+}
@@ -0,0 +1,36 @@
+package cc.carm.lib.easysql;
+
+import cc.carm.lib.easysql.api.SQLManager;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+
+import java.sql.SQLException;
+
+public abstract class TestHandler {
+
+    protected static void print(@NotNull String format, Object... params) {
+        EasySQLTest.print(format, params);
+    }
+
+    @ApiStatus.OverrideOnly
+    public abstract void onTest(SQLManager sqlManager) throws SQLException;
+
+    public boolean executeTest(int index, SQLManager sqlManager) {
+        String testName = getClass().getSimpleName();
+
+        print("  #%s 测试 @%s 开始", index, testName);
+        long start = System.currentTimeMillis();
+
+        try {
+            onTest(sqlManager);
+            print("  #%s 测试 @%s 成功，耗时 %s ms。", index, testName, (System.currentTimeMillis() - start));
+            return true;
+        } catch (Exception exception) {
+            print("  #%s 测试 @%s 失败，耗时 %s ms。", index, testName, (System.currentTimeMillis() - start));
+            exception.printStackTrace();
+            return false;
+        }
+    }
+
+
+}
@@ -0,0 +1,21 @@
+package cc.carm.lib.easysql.tests;
+
+import cc.carm.lib.easysql.TestHandler;
+import cc.carm.lib.easysql.api.SQLManager;
+
+import java.sql.SQLException;
+
+public class DeleteTest extends TestHandler {
+
+
+    @Override
+    public void onTest(SQLManager sqlManager) throws SQLException {
+
+
+        System.out.println("change(s): " + sqlManager.createDelete("test_user_table")
+                .addCondition("id", ">", 5)
+                .addNotNullCondition("username")
+                .build().execute());
+
+    }
+}
@@ -0,0 +1,35 @@
+package cc.carm.lib.easysql.tests;
+
+import cc.carm.lib.easysql.api.SQLManager;
+import cc.carm.lib.easysql.api.SQLQuery;
+import cc.carm.lib.easysql.TestHandler;
+
+import java.sql.ResultSet;
+import java.sql.SQLException;
+
+public class QueryCloseTest extends TestHandler {
+
+
+    @Override
+    public void onTest(SQLManager sqlManager) throws SQLException {
+
+        try (SQLQuery query = sqlManager.createQuery()
+                .inTable("test_user_table")
+                .orderBy("id", false)
+                .setLimit(5)
+                .build().execute()) {
+            ResultSet resultSet = query.getResultSet();
+
+            while (resultSet.next()) {
+
+                System.out.printf(
+                        "id: %d username: %s%n",
+                        resultSet.getInt("id"),
+                        resultSet.getString("username")
+                );
+
+            }
+        }
+
+    }
+}
@@ -0,0 +1,26 @@
+package cc.carm.lib.easysql.tests;
+
+import cc.carm.lib.easysql.TestHandler;
+import cc.carm.lib.easysql.api.SQLManager;
+
+import java.sql.SQLException;
+
+public class QueryFunctionTest extends TestHandler {
+
+
+    @Override
+    public void onTest(SQLManager sqlManager) throws SQLException {
+
+        Integer id_1 = sqlManager.createQuery()
+                .inTable("test_user_table")
+                .orderBy("id", false)
+                .setLimit(1)
+                .build().executeFunction(query -> {
+                    if (!query.getResultSet().next()) return -1;
+                    else return query.getResultSet().getInt("id");
+                });
+
+        System.out.println("id (ps): " + id_1);
+
+    }
+}
@@ -0,0 +1,38 @@
+package cc.carm.lib.easysql.tests;
+
+import cc.carm.lib.easysql.api.SQLManager;
+import cc.carm.lib.easysql.TestHandler;
+
+import java.sql.SQLException;
+import java.util.Arrays;
+import java.util.List;
+import java.util.UUID;
+import java.util.stream.Collectors;
+import java.util.stream.IntStream;
+
+public class SQLUpdateBatchTests extends TestHandler {
+
+
+    protected static List<Object[]> generateParams() {
+        return IntStream.range(0, 5).mapToObj(i -> generateParam()).collect(Collectors.toList());
+    }
+
+    protected static Object[] generateParam() {
+        UUID uuid = UUID.randomUUID();
+        return new Object[]{uuid, uuid.toString().substring(0, 5), (int) (Math.random() * 50)};
+    }
+
+    @Override
+    public void onTest(SQLManager sqlManager) throws SQLException {
+
+        List<Long> updates = sqlManager.createInsertBatch("test_user_table")
+                .setColumnNames("uuid", "username", "age")
+                .setAllParams(generateParams())
+                .execute();
+
+        System.out.println("changes " + Arrays.toString(updates.toArray()));
+
+    }
+
+
+}
@@ -0,0 +1,24 @@
+package cc.carm.lib.easysql.tests;
+
+import cc.carm.lib.easysql.api.SQLManager;
+
+import java.sql.SQLException;
+import java.util.Arrays;
+import java.util.List;
+
+public class SQLUpdateReturnKeysTest extends SQLUpdateBatchTests {
+
+
+    @Override
+    public void onTest(SQLManager sqlManager) throws SQLException {
+        List<Long> generatedKeys = sqlManager.createInsertBatch("test_user_table")
+                .setColumnNames("uuid", "username", "age")
+                .setAllParams(generateParams())
+                .returnGeneratedKeys()
+                .execute();
+
+        System.out.println("generated " + Arrays.toString(generatedKeys.toArray()));
+    }
+
+
+}
@@ -0,0 +1,35 @@
+package cc.carm.lib.easysql.tests;
+
+import cc.carm.lib.easysql.api.SQLManager;
+import cc.carm.lib.easysql.api.enums.NumberType;
+import cc.carm.lib.easysql.TestHandler;
+
+import java.sql.SQLException;
+
+public class TableAlterTest extends TestHandler {
+
+    @Override
+    public void onTest(SQLManager sqlManager) throws SQLException {
+
+        print("	修改 test_user_table");
+        sqlManager.alterTable("test_user_table")
+                .addColumn("test", "VARCHAR(16) NOT NULL")
+                .execute();
+
+        sqlManager.alterTable("test_user_table")
+                .addColumn("test2", "VARCHAR(16) NOT NULL", "username")
+                .execute();
+
+
+        print("	修改 test_user_info");
+        sqlManager.alterTable("test_user_info")
+                .addAutoIncrementColumn("num", NumberType.BIGINT, false, true)
+                .execute();
+
+        sqlManager.alterTable("test_user_info")
+                .addColumn("a", "VARCHAR(16) NOT NULL", "")
+                .execute();
+
+    }
+
+}
@@ -0,0 +1,37 @@
+package cc.carm.lib.easysql.tests;
+
+import cc.carm.lib.easysql.api.SQLManager;
+import cc.carm.lib.easysql.api.enums.ForeignKeyRule;
+import cc.carm.lib.easysql.api.enums.IndexType;
+import cc.carm.lib.easysql.TestHandler;
+
+import java.sql.SQLException;
+
+public class TableCreateTest extends TestHandler {
+
+    @Override
+    public void onTest(SQLManager sqlManager) throws SQLException {
+
+        print("	创建 test_user_table");
+        sqlManager.createTable("test_user_table")
+                .addAutoIncrementColumn("id")
+                .addColumn("uuid", "VARCHAR(36) NOT NULL", "用户UUID")
+                .addColumn("username", "VARCHAR(16) NOT NULL", "用户名")
+                .addColumn("age", "TINYINT DEFAULT 0 NOT NULL", "年龄")
+
+                .setIndex("uuid", IndexType.UNIQUE_KEY)
+                .build().execute();
+
+        print("	创建 test_user_info");
+        sqlManager.createTable("test_user_info")
+                .addColumn("uid", "INT UNSIGNED NOT NULL")
+                .addColumn("info", "TEXT", "相关信息")
+                .addForeignKey("uid", "user",
+                        "test_user_table", "id",
+                        ForeignKeyRule.CASCADE, ForeignKeyRule.CASCADE
+                )
+                .build().execute();
+
+    }
+
+}
@@ -0,0 +1,16 @@
+package cc.carm.lib.easysql.tests;
+
+import cc.carm.lib.easysql.api.SQLManager;
+import cc.carm.lib.easysql.TestHandler;
+
+import java.sql.SQLException;
+
+public class TableRenameTest extends TestHandler {
+    @Override
+    public void onTest(SQLManager sqlManager) throws SQLException {
+        print("	重命名 test_user_table");
+        sqlManager.alterTable("test_user_table")
+                .renameTo("test_user_table2")
+                .execute();
+    }
+}