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

impl/yaml/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>easyconfiguration-parent</artifactId>
         <groupId>cc.carm.lib</groupId>
-        <version>3.2.1</version>
+        <version>3.3.0</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>
@@ -28,6 +28,13 @@
             <scope>compile</scope>
         </dependency>
 
+        <dependency>
+            <groupId>${project.parent.groupId}</groupId>
+            <artifactId>easyconfiguration-demo</artifactId>
+            <version>${project.parent.version}</version>
+            <scope>test</scope>
+        </dependency>
+
         <dependency>
             <groupId>org.bspfsystems</groupId>
             <artifactId>yamlconfiguration</artifactId>

impl/yaml/src/test/java/config/DemoConfigTest.java

@@ -1,85 +1,45 @@
 package config;
 
 import cc.carm.lib.configuration.EasyConfiguration;
+import cc.carm.lib.configuration.demo.tests.ConfigurationTest;
+import cc.carm.lib.configuration.demo.tests.model.AbstractModel;
 import cc.carm.lib.configuration.yaml.YAMLConfigProvider;
-import config.model.AbstractModel;
+import config.model.AnyModel;
 import config.model.SomeModel;
-import config.model.TestModel;
-import config.source.DemoConfiguration;
-import config.source.ImplConfiguration;
+import config.source.ModelConfiguration;
 import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerialization;
 import org.junit.Test;
 
-import java.util.LinkedHashMap;
-import java.util.List;
-import java.util.UUID;
-import java.util.stream.Collectors;
-import java.util.stream.IntStream;
-
 public class DemoConfigTest {
 
     static {
-        ConfigurationSerialization.registerClass(TestModel.class);
         ConfigurationSerialization.registerClass(SomeModel.class);
+        ConfigurationSerialization.registerClass(AnyModel.class);
     }
 
     protected final YAMLConfigProvider provider = EasyConfiguration.from("target/config.yml", "config.yml");
 
     @Test
     public void onTest() {
-        provider.initialize(DemoConfiguration.class);
+        ConfigurationTest.testDemo(this.provider);
+        ConfigurationTest.testInner(this.provider);
 
-        testDemo();
-        testSerialization();
-
-        try {
-            provider.save();
-        } catch (Exception e) {
-            e.printStackTrace();
-        }
+        testSerialization(this.provider);
 
+        ConfigurationTest.save(this.provider);
     }
 
 
-    public static void testDemo() {
+    public static void testSerialization(YAMLConfigProvider provider) {
+        provider.initialize(ModelConfiguration.class);
         System.out.println("----------------------------------------------------");
 
-        System.out.println("Test Number: ");
+        AbstractModel someModel = ModelConfiguration.SOME_MODEL.get();
+        if (someModel != null) System.out.println(someModel.getName());
 
-        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());
+        AbstractModel anyModel = ModelConfiguration.ANY_MODEL.get();
+        if (anyModel != null) System.out.println(anyModel.getName());
 
-        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 testSerialization() {
-        System.out.println("----------------------------------------------------");
-        AbstractModel model = ImplConfiguration.TEST.get();
-        if (model != null) {
-            System.out.println(model.getName());
-        }
         System.out.println("----------------------------------------------------");
     }
 

impl/yaml/src/test/java/config/model/AbstractModel.java

@@ -1,17 +0,0 @@
-package config.model;
-
-import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable;
-import org.jetbrains.annotations.NotNull;
-
-public abstract class AbstractModel implements ConfigurationSerializable {
-
-    protected final @NotNull String name;
-
-    public AbstractModel(@NotNull String name) {
-        this.name = name;
-    }
-
-    public @NotNull String getName() {
-        return name;
-    }
-}

impl/yaml/src/test/java/config/model/AnyModel.java

@@ -0,0 +1,50 @@
+package config.model;
+
+import cc.carm.lib.configuration.demo.tests.model.AbstractModel;
+import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable;
+import org.bspfsystems.yamlconfiguration.serialization.SerializableAs;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.TestOnly;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.UUID;
+
+@SerializableAs("AnyModel")
+public class AnyModel extends AbstractModel implements ConfigurationSerializable {
+
+    public final boolean bool;
+
+    public AnyModel(@NotNull String name, boolean bool) {
+        super(name);
+        this.bool = bool;
+    }
+
+    @Override
+    public String toString() {
+        return "AnyModel{" +
+                "name='" + name + '\'' +
+                ", bool=" + bool +
+                '}';
+    }
+
+    @Override
+    public @NotNull Map<String, Object> serialize() {
+        Map<String, Object> map = new HashMap<>();
+        map.put("name", name);
+        map.put("state", bool);
+        return map;
+    }
+
+    public static AnyModel random() {
+        return new AnyModel(UUID.randomUUID().toString().substring(0, 5), Math.random() > 0.5);
+    }
+
+
+    @TestOnly
+    public static AnyModel deserialize(Map<String, ?> args) {
+        return new AnyModel((String) args.get("name"), (Boolean) args.get("state"));
+    }
+
+
+}

impl/yaml/src/test/java/config/model/SomeModel.java

@@ -1,5 +1,6 @@
 package config.model;
 
+import cc.carm.lib.configuration.demo.tests.model.AbstractModel;
 import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable;
 import org.bspfsystems.yamlconfiguration.serialization.SerializableAs;
 import org.jetbrains.annotations.NotNull;
@@ -7,6 +8,7 @@ import org.jetbrains.annotations.TestOnly;
 
 import java.util.HashMap;
 import java.util.Map;
+import java.util.UUID;
 
 @SerializableAs("SomeModel")
 public class SomeModel extends AbstractModel implements ConfigurationSerializable {
@@ -34,6 +36,11 @@ public class SomeModel extends AbstractModel implements ConfigurationSerializabl
         return map;
     }
 
+    public static SomeModel random() {
+        return new SomeModel(UUID.randomUUID().toString().substring(0, 5), (int) (Math.random() * 1000));
+    }
+
+
     @TestOnly
     public static SomeModel deserialize(Map<String, ?> args) {
         return new SomeModel((String) args.get("name"), (Integer) args.get("num"));

impl/yaml/src/test/java/config/model/TestModel.java

@@ -1,72 +0,0 @@
-package config.model;
-
-import cc.carm.lib.configuration.core.source.ConfigurationWrapper;
-import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable;
-import org.bspfsystems.yamlconfiguration.serialization.SerializableAs;
-import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.TestOnly;
-
-import java.util.HashMap;
-import java.util.Map;
-import java.util.UUID;
-
-@SerializableAs("TestModel")
-public class TestModel extends AbstractModel implements ConfigurationSerializable {
-
-    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;
-    }
-
-    @Override
-    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));
-    }
-
-    @TestOnly
-    @SuppressWarnings("unchecked")
-    public static TestModel deserialize(Map<String, ?> args) {
-        String name = (String) args.get("name");
-        if (name == null) throw new NullPointerException("name is null");
-        Map<String, ?> map = (Map<String, ?>) args.get("info");
-        String uuidString = (String) map.get("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 +
-                '}';
-    }
-}

impl/yaml/src/test/java/config/offset/FieldOffset.java

@@ -1,64 +0,0 @@
-package config.offset;
-
-import org.jetbrains.annotations.NotNull;
-
-import java.lang.reflect.Field;
-import java.util.List;
-
-/**
- * @author Chris2018998
- */
-public class FieldOffset implements Comparable<FieldOffset> {
-    private final Field field;
-    private Long offsetValue;
-    private List<FieldOffset> subFieldOffsetList;
-
-    public FieldOffset(Field field) {
-        this.field = field;
-    }
-
-    public Long getOffsetValue() {
-        return offsetValue;
-    }
-
-    public void setOffsetValue(Long offsetValue) {
-        this.offsetValue = offsetValue;
-    }
-
-    public String toString() {
-        if (subFieldOffsetList == null)
-            return field.getName();
-        else {
-
-            StringBuilder builder = new StringBuilder();
-            builder.append("[");
-
-            for (int i = 0; i < subFieldOffsetList.size(); i++) {
-                FieldOffset offset = subFieldOffsetList.get(i);
-                if (i > 0) builder.append(",");
-                builder.append(field.getName()).append(".").append(offset.toString());
-            }
-            builder.append("]");
-            return builder.toString();
-        }
-    }
-
-    public List<FieldOffset> getSubFieldOffsetList() {
-        return subFieldOffsetList;
-    }
-
-    public void setSubFieldOffsetList(List<FieldOffset> subFieldOffsetList) {
-        this.subFieldOffsetList = subFieldOffsetList;
-    }
-
-    public Field getField() {
-        return field;
-    }
-
-    @Override
-    public int compareTo(@NotNull FieldOffset that) {
-        return this.offsetValue.compareTo(that.offsetValue);
-    }
-
-
-}

impl/yaml/src/test/java/config/offset/OffsetUtil.java

@@ -1,63 +0,0 @@
-//package config.offset;
-//
-//
-//import sun.misc.Unsafe;
-//
-//import java.lang.reflect.Field;
-//import java.lang.reflect.Modifier;
-//import java.util.Collections;
-//import java.util.LinkedList;
-//import java.util.List;
-//
-///**
-// * @author Chris2018998
-// */
-//public class OffsetUtil {
-//    private static Unsafe unsafe;
-//
-//    static {
-//        try {
-//            // 获取 Unsafe 内部的私有的实例化单例对象
-//            Field field = Unsafe.class.getDeclaredField("theUnsafe");
-//            // 无视权限
-//            field.setAccessible(true);
-//            unsafe = (Unsafe) field.get(null);
-//        } catch (NoSuchFieldException | IllegalAccessException e) {
-//            e.printStackTrace();
-//        }
-////        try {
-////            unsafe = AccessController.doPrivileged((PrivilegedExceptionAction<Unsafe>) () -> {
-////                Field theUnsafe = Unsafe.class.getDeclaredField("theUnsafe");
-////                theUnsafe.setAccessible(true);
-////                return (Unsafe) theUnsafe.get(null);
-////            });
-////        } catch (Throwable e) {
-////            System.err.println("Unable to load unsafe");
-////        }
-//    }
-//
-//    public static List<FieldOffset> getClassMemberOffset(Class<?> beanClass) {
-//        List<FieldOffset> offsetsList = new LinkedList<>();
-//        for (Field field : beanClass.getDeclaredFields()) {
-//            FieldOffset fieldOffset = new FieldOffset(field);
-//            offsetsList.add(fieldOffset);
-//            if (Modifier.isStatic(field.getModifiers()))
-//                fieldOffset.setOffsetValue(unsafe.staticFieldOffset(field));
-//            else
-//                fieldOffset.setOffsetValue(unsafe.objectFieldOffset(field));
-//            Class<?> fieldType = field.getType();
-//            if (!fieldType.getName().startsWith("java")) {
-//                Field[] subfields = fieldType.getDeclaredFields();
-//                if (subfields.length > 0) {
-//                    fieldOffset.setSubFieldOffsetList(getClassMemberOffset(fieldType));
-//                }
-//            }
-//        }
-//
-//        Collections.sort(offsetsList);
-//        return offsetsList;
-//    }
-//
-//
-//}
-//

impl/yaml/src/test/java/config/source/DatabaseConfiguration.java

@@ -1,33 +0,0 @@
-package config.source;
-
-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.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());
-    }
-
-}

impl/yaml/src/test/java/config/source/DemoConfiguration.java

@@ -1,86 +0,0 @@
-package config.source;
-
-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 config.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("impl-test") //支持通过注解修改子配置的主路径，若不修改则以变量名自动生成。
-    @HeaderComment({"", "Something..."}) // 支持给子路径直接打注释
-    @InlineComment("InlineComments for class path")
-    public static final Class<?> IMPL = ImplConfiguration.class;
-
-    // 子配置文件
-    @ConfigPath("database")
-    public static final Class<?> DB_CONFIG = DatabaseConfiguration.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();
-
-        }
-
-    }
-
-
-}

impl/yaml/src/test/java/config/source/ImplConfiguration.java

@@ -1,18 +0,0 @@
-package config.source;
-
-import cc.carm.lib.configuration.core.ConfigurationRoot;
-import cc.carm.lib.configuration.core.annotation.ConfigPath;
-import cc.carm.lib.configuration.core.value.ConfigValue;
-import cc.carm.lib.configuration.yaml.value.ConfiguredSerializable;
-import config.model.AbstractModel;
-import config.model.TestModel;
-
-@ConfigPath(root = true)
-public class ImplConfiguration extends ConfigurationRoot {
-
-    public static final ConfigValue<? extends AbstractModel> TEST = ConfiguredSerializable.of(
-            TestModel.class, TestModel.random()
-    );
-
-
-}

impl/yaml/src/test/java/config/source/ModelConfiguration.java

@@ -0,0 +1,22 @@
+package config.source;
+
+import cc.carm.lib.configuration.core.ConfigurationRoot;
+import cc.carm.lib.configuration.core.annotation.ConfigPath;
+import cc.carm.lib.configuration.core.value.ConfigValue;
+import cc.carm.lib.configuration.demo.tests.model.AbstractModel;
+import cc.carm.lib.configuration.yaml.value.ConfiguredSerializable;
+import config.model.AnyModel;
+import config.model.SomeModel;
+
+@ConfigPath("model-test")
+public class ModelConfiguration extends ConfigurationRoot {
+
+    public static final ConfigValue<? extends AbstractModel> SOME_MODEL = ConfiguredSerializable.of(
+            SomeModel.class, SomeModel.random()
+    );
+
+    public static final ConfigValue<? extends AbstractModel> ANY_MODEL = ConfiguredSerializable.of(
+            AnyModel.class, AnyModel.random()
+    );
+
+}