feat(init): 支持针对于实体类的初始化 #9

2026-06-04 18:48:20 +08:00 · 2022-12-11 02:02:16 +08:00
parent 6f97166192
commit 35398ab741
31 changed files with 447 additions and 375 deletions
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>easyconfiguration-parent</artifactId>
+        <groupId>cc.carm.lib</groupId>
+        <version>3.3.0</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+    <properties>
+        <maven.compiler.source>${java.version}</maven.compiler.source>
+        <maven.compiler.target>${java.version}</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <maven.compiler.encoding>UTF-8</maven.compiler.encoding>
+    </properties>
+    <artifactId>easyconfiguration-demo</artifactId>
+    <packaging>jar</packaging>
+
+    <dependencies>
+
+        <dependency>
+            <groupId>${project.parent.groupId}</groupId>
+            <artifactId>easyconfiguration-core</artifactId>
+            <version>${project.parent.version}</version>
+            <scope>compile</scope>
+        </dependency>
+
+    </dependencies>
+
+</project>
@@ -0,0 +1,34 @@
+package cc.carm.lib.configuration.demo;
+
+import cc.carm.lib.configuration.core.ConfigurationRoot;
+import cc.carm.lib.configuration.core.annotation.ConfigPath;
+import cc.carm.lib.configuration.core.annotation.HeaderComment;
+import cc.carm.lib.configuration.core.value.ConfigValue;
+import cc.carm.lib.configuration.core.value.type.ConfiguredValue;
+
+@HeaderComment({"", "数据库配置", "  用于提供数据库连接，进行数据库操作。"})
+public class DatabaseConfiguration extends ConfigurationRoot {
+
+    @ConfigPath("driver")
+    @HeaderComment({
+            "数据库驱动配置，请根据数据库类型设置。",
+            "- MySQL(旧): com.mysql.jdbc.Driver",
+            "- MySQL(新): com.mysql.cj.jdbc.Driver",
+            "- MariaDB(推荐): org.mariadb.jdbc.Driver",
+    })
+    protected static final ConfigValue<String> DRIVER_NAME = ConfiguredValue.of(
+            String.class, "com.mysql.cj.jdbc.Driver"
+    );
+
+    protected static final ConfigValue<String> HOST = ConfiguredValue.of(String.class, "127.0.0.1");
+    protected static final ConfigValue<Integer> PORT = ConfiguredValue.of(Integer.class, 3306);
+    protected static final ConfigValue<String> DATABASE = ConfiguredValue.of(String.class, "minecraft");
+    protected static final ConfigValue<String> USERNAME = ConfiguredValue.of(String.class, "root");
+    protected static final ConfigValue<String> PASSWORD = ConfiguredValue.of(String.class, "password");
+    protected static final ConfigValue<String> EXTRA = ConfiguredValue.of(String.class, "?useSSL=false");
+
+    protected static String buildJDBC() {
+        return String.format("jdbc:mysql://%s:%s/%s%s", HOST.get(), PORT.get(), DATABASE.get(), EXTRA.get());
+    }
+
+}
@@ -0,0 +1,78 @@
+package cc.carm.lib.configuration.demo.tests;
+
+import cc.carm.lib.configuration.core.source.ConfigurationProvider;
+import cc.carm.lib.configuration.demo.tests.model.TestModel;
+import cc.carm.lib.configuration.demo.tests.conf.DemoConfiguration;
+import cc.carm.lib.configuration.demo.tests.conf.TestConfiguration;
+
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.UUID;
+import java.util.stream.Collectors;
+import java.util.stream.IntStream;
+
+public class ConfigurationTest {
+
+    public static void testDemo(ConfigurationProvider<?> provider) {
+        provider.initialize(DemoConfiguration.class);
+
+        System.out.println("----------------------------------------------------");
+
+        System.out.println("Test Number: ");
+
+        System.out.println("before: " + DemoConfiguration.TEST_NUMBER.get());
+        DemoConfiguration.TEST_NUMBER.set((long) (Long.MAX_VALUE * Math.random()));
+        System.out.println("after: " + DemoConfiguration.TEST_NUMBER.get());
+
+        System.out.println("> Test Value:");
+        System.out.println("before: " + DemoConfiguration.Sub.UUID_CONFIG_VALUE.get());
+        DemoConfiguration.Sub.UUID_CONFIG_VALUE.set(UUID.randomUUID());
+        System.out.println("after: " + DemoConfiguration.Sub.UUID_CONFIG_VALUE.get());
+
+        System.out.println("> Test List:");
+        DemoConfiguration.Sub.That.OPERATORS.getNotNull().forEach(System.out::println);
+        List<UUID> operators = IntStream.range(0, 5).mapToObj(i -> UUID.randomUUID()).collect(Collectors.toList());
+        DemoConfiguration.Sub.That.OPERATORS.set(operators);
+
+        System.out.println("> Test Section:");
+        System.out.println(DemoConfiguration.MODEL_TEST.get());
+        DemoConfiguration.MODEL_TEST.set(TestModel.random());
+
+        System.out.println("> Test Maps:");
+        DemoConfiguration.USERS.getNotNull().forEach((k, v) -> System.out.println(k + ": " + v));
+        LinkedHashMap<Integer, UUID> data = new LinkedHashMap<>();
+        for (int i = 1; i <= 5; i++) {
+            data.put(i, UUID.randomUUID());
+        }
+        DemoConfiguration.USERS.set(data);
+        System.out.println("----------------------------------------------------");
+    }
+
+    public static void testInner(ConfigurationProvider<?> provider) {
+
+        TestConfiguration TEST = new TestConfiguration();
+
+        provider.initialize(TEST, true);
+
+        System.out.println("> Test Inner value before:");
+        System.out.println(TEST.INNER.INNER_VALUE.getNotNull());
+
+        double after = Math.random() * 200D;
+        System.out.println("> Test Inner value -> " + after);
+        TEST.INNER.INNER_VALUE.set(after);
+
+        System.out.println("> Test Inner value after:");
+        System.out.println(TEST.INNER.INNER_VALUE.getNotNull());
+
+    }
+
+    public static void save(ConfigurationProvider<?> provider) {
+        try {
+            provider.save();
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+    }
+
+
+}
@@ -0,0 +1,81 @@
+package cc.carm.lib.configuration.demo.tests.conf;
+
+import cc.carm.lib.configuration.core.ConfigInitializer;
+import cc.carm.lib.configuration.core.ConfigurationRoot;
+import cc.carm.lib.configuration.core.annotation.ConfigPath;
+import cc.carm.lib.configuration.core.annotation.HeaderComment;
+import cc.carm.lib.configuration.core.annotation.InlineComment;
+import cc.carm.lib.configuration.core.value.ConfigValue;
+import cc.carm.lib.configuration.core.value.type.ConfiguredList;
+import cc.carm.lib.configuration.core.value.type.ConfiguredMap;
+import cc.carm.lib.configuration.core.value.type.ConfiguredSection;
+import cc.carm.lib.configuration.core.value.type.ConfiguredValue;
+import cc.carm.lib.configuration.demo.tests.model.TestModel;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.UUID;
+
+
+@HeaderComment({
+        "此处内容将显示在配置文件的最上方",
+        ""/*添加一个空行与其他配置的注释分割*/
+})
+public class DemoConfiguration extends ConfigurationRoot {
+
+    @ConfigPath(root = true)
+    protected static final ConfigValue<Double> VERSION = ConfiguredValue.of(Double.class, 1.0D);
+
+    @ConfigPath(root = true)
+    public static final ConfigValue<Long> TEST_NUMBER = ConfiguredValue.of(Long.class, 1000000L);
+
+    // 支持通过 Class<?> 变量标注子配置，一并注册。
+    // 注意： 若对应类也有注解，则优先使用类的注解。
+    @ConfigPath("other-class-config") //支持通过注解修改子配置的主路径，若不修改则以变量名自动生成。
+    @HeaderComment({"", "Something..."}) // 支持给子路径直接打注释
+    @InlineComment("InlineComments for class path")
+    public static final Class<?> OTHER = OtherConfiguration.class;
+
+    @ConfigPath("user") // 通过注解规定配置文件中的路径，若不进行注解则以变量名自动生成。
+    @HeaderComment({"", "Section类型数据测试"}) // 通过注解给配置添加注释。
+    @InlineComment("Section数据也支持InlineComment注释")
+    public static final ConfigValue<TestModel> MODEL_TEST = ConfiguredSection
+            .builder(TestModel.class)
+            .defaults(new TestModel("Carm", UUID.randomUUID()))
+            .parseValue((section, defaultValue) -> TestModel.deserialize(section))
+            .serializeValue(TestModel::serialize).build();
+
+    @HeaderComment({"", "[ID - UUID]对照表", "", "用于测试Map类型的解析与序列化保存"})
+    public static final ConfigValue<Map<Integer, UUID>> USERS = ConfiguredMap
+            .builder(Integer.class, UUID.class).fromString()
+            .parseKey(Integer::parseInt)
+            .parseValue(v -> Objects.requireNonNull(UUID.fromString(v)))
+            .build();
+
+
+    /**
+     * 支持内部类的直接注册。
+     * 注意，需要使用 {@link ConfigInitializer#initialize(Class, boolean, boolean)} 方法，并设定第三个参数为 true。
+     */
+    public static class Sub extends ConfigurationRoot {
+
+        @ConfigPath(value = "uuid-value", root = true)
+        @InlineComment("This is an inline comment")
+        public static final ConfigValue<UUID> UUID_CONFIG_VALUE = ConfiguredValue
+                .builder(UUID.class).fromString()
+                .parseValue((data, defaultValue) -> UUID.fromString(data))
+                .build();
+
+        public static class That extends ConfigurationRoot {
+
+            public static final ConfigValue<List<UUID>> OPERATORS = ConfiguredList
+                    .builder(UUID.class).fromString()
+                    .parseValue(s -> Objects.requireNonNull(UUID.fromString(s)))
+                    .build();
+
+        }
+    }
+
+
+}
@@ -0,0 +1,4 @@
+package cc.carm.lib.configuration.demo.tests.conf;
+
+public class OtherConfiguration {
+}
@@ -0,0 +1,30 @@
+package cc.carm.lib.configuration.demo.tests.conf;
+
+import cc.carm.lib.configuration.core.ConfigurationRoot;
+import cc.carm.lib.configuration.core.annotation.ConfigPath;
+import cc.carm.lib.configuration.core.annotation.HeaderComment;
+import cc.carm.lib.configuration.core.annotation.InlineComment;
+import cc.carm.lib.configuration.core.value.ConfigValue;
+import cc.carm.lib.configuration.core.value.type.ConfiguredSection;
+import cc.carm.lib.configuration.core.value.type.ConfiguredValue;
+import cc.carm.lib.configuration.demo.tests.model.TestModel;
+
+import java.util.UUID;
+
+public class TestConfiguration extends ConfigurationRoot {
+
+    public final TestInnerConfiguration INNER = new TestInnerConfiguration();
+
+    public final ConfigValue<Double> CLASS_VALUE = ConfiguredValue.of(Double.class, 1.0D);
+
+    @ConfigPath("test.user") // 通过注解规定配置文件中的路径，若不进行注解则以变量名自动生成。
+    @HeaderComment({"", "Section类型数据测试"}) // 通过注解给配置添加注释。
+    @InlineComment("Section数据也支持InlineComment注释")
+    public final ConfigValue<TestModel> TEST_MODEL = ConfiguredSection
+            .builder(TestModel.class)
+            .defaults(new TestModel("Carm", UUID.randomUUID()))
+            .parseValue((section, defaultValue) -> TestModel.deserialize(section))
+            .serializeValue(TestModel::serialize).build();
+
+
+}
@@ -0,0 +1,13 @@
+package cc.carm.lib.configuration.demo.tests.conf;
+
+import cc.carm.lib.configuration.core.ConfigurationRoot;
+import cc.carm.lib.configuration.core.annotation.HeaderComment;
+import cc.carm.lib.configuration.core.value.ConfigValue;
+import cc.carm.lib.configuration.core.value.type.ConfiguredValue;
+
+@HeaderComment("Inner Test")
+public class TestInnerConfiguration extends ConfigurationRoot {
+
+    public final ConfigValue<Double> INNER_VALUE = ConfiguredValue.of(Double.class, 1.0D);
+
+}
@@ -0,0 +1,16 @@
+package cc.carm.lib.configuration.demo.tests.model;
+
+import org.jetbrains.annotations.NotNull;
+
+public abstract class AbstractModel {
+
+    protected final @NotNull String name;
+
+    public AbstractModel(@NotNull String name) {
+        this.name = name;
+    }
+
+    public @NotNull String getName() {
+        return name;
+    }
+}
@@ -0,0 +1,56 @@
+package cc.carm.lib.configuration.demo.tests.model;
+
+import cc.carm.lib.configuration.core.source.ConfigurationWrapper;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.UUID;
+
+public class TestModel extends AbstractModel {
+
+    public UUID uuid;
+
+    public TestModel(String name, UUID uuid) {
+        super(name);
+        this.uuid = uuid;
+    }
+
+    public void setUuid(UUID uuid) {
+        this.uuid = uuid;
+    }
+
+    public UUID getUuid() {
+        return uuid;
+    }
+
+    public @NotNull Map<String, Object> serialize() {
+        Map<String, Object> map = new HashMap<>();
+        map.put("name", name);
+        Map<String, Object> map2 = new HashMap<>();
+        map2.put("uuid", uuid.toString());
+        map.put("info", map2);
+        return map;
+    }
+
+    public static TestModel deserialize(ConfigurationWrapper<?> section) {
+        String name = section.getString("name");
+        if (name == null) throw new NullPointerException("name is null");
+        String uuidString = section.getString("info.uuid");
+        if (uuidString == null) throw new NullPointerException("uuid is null");
+        return new TestModel(name, UUID.fromString(uuidString));
+    }
+
+    public static TestModel random() {
+        return new TestModel(UUID.randomUUID().toString().substring(0, 5), UUID.randomUUID());
+    }
+
+
+    @Override
+    public String toString() {
+        return "TestUser{" +
+                "name='" + name + '\'' +
+                ", uuid=" + uuid +
+                '}';
+    }
+}