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

CarmJos · Dec 10, 2022 · 35398ab · 35398ab
1 parent 6f97166
commit 35398ab
Show file tree

Hide file tree

Showing 31 changed files with 447 additions and 375 deletions.
diff --git a/README.md b/README.md
@@ -30,7 +30,7 @@
 
 ### 示例代码
 
-您可以 [点击这里](impl/yaml/src/test/java/config/source/DemoConfiguration.java) 查看部分代码演示，更多演示详见 [开发介绍](.documentation/README.md) 。
+您可以 [点击这里](demo/src/main/java/cc/carm/lib/configuration/demo/DatabaseConfiguration.java) 查看部分代码演示，更多演示详见 [开发介绍](.documentation/README.md) 。
 
 ### 依赖方式
 

diff --git a/core/pom.xml b/core/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>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <properties>

diff --git a/core/src/main/java/cc/carm/lib/configuration/core/ConfigInitializer.java b/core/src/main/java/cc/carm/lib/configuration/core/ConfigInitializer.java
@@ -60,12 +60,84 @@ public void initialize(@NotNull Class<? extends ConfigurationRoot> clazz,
         }
     }
 
+    /**
+     * 初始化指定实例的所有 {@link ConfigValue} 与内部 {@link ConfigurationRoot} 对象。
+     *
+     * @param config 配置文件实例类，须实现 {@link ConfigurationRoot} 。
+     */
+    public void initialize(@NotNull ConfigurationRoot config) {
+        initialize(config, true);
+    }
+
+    /**
+     * 初始化指定实例的所有 {@link ConfigValue} 与内部 {@link ConfigurationRoot} 对象。
+     *
+     * @param config       配置文件实例类，须实现 {@link ConfigurationRoot} 。
+     * @param saveDefaults 是否写入默认值(默认为 true)。
+     */
+    public void initialize(@NotNull ConfigurationRoot config, boolean saveDefaults) {
+        initializeClass(
+                config, null, null,
+                null, null, null,
+                saveDefaults
+        );
+        if (saveDefaults) {
+            try {
+                provider.save();
+            } catch (Exception e) {
+                e.printStackTrace();
+            }
+        }
+    }
+
+    protected void initializeClass(@NotNull ConfigurationRoot root,
+                                   @Nullable String parentPath, @Nullable String fieldName,
+                                   @Nullable ConfigPath fieldPath,
+                                   @Nullable HeaderComment fieldHeaderComments,
+                                   @Nullable InlineComment fieldInlineComments,
+                                   boolean saveDefaults) {
+        String path = getClassPath(root.getClass(), parentPath, fieldName, fieldPath);
+        this.provider.setHeaderComment(path, getClassHeaderComments(root.getClass(), fieldHeaderComments));
+        if (path != null) this.provider.setInlineComment(path, readInlineComments(fieldInlineComments));
+
+        for (Field field : root.getClass().getDeclaredFields()) {
+            initializeField(root, field, path, saveDefaults);
+        }
+    }
+
+    private void initializeField(@NotNull ConfigurationRoot root,
+                                 @NotNull Field field, @Nullable String parent,
+                                 boolean saveDefaults) {
+        try {
+            field.setAccessible(true);
+            Object object = field.get(root);
+            if (object instanceof ConfigValue<?>) {
+                initializeValue(
+                        (ConfigValue<?>) object, getFieldPath(field, parent),
+                        field.getAnnotation(HeaderComment.class),
+                        field.getAnnotation(InlineComment.class),
+                        saveDefaults
+                );
+            } else if (object instanceof ConfigurationRoot) {
+                initializeClass(
+                        (ConfigurationRoot) object, parent, field.getName(),
+                        field.getAnnotation(ConfigPath.class),
+                        field.getAnnotation(HeaderComment.class),
+                        field.getAnnotation(InlineComment.class),
+                        saveDefaults
+                );
+            }
+        } catch (IllegalAccessException ignored) {
+        }
+    }
+
     protected void initializeClass(@NotNull Class<?> clazz,
                                    @Nullable String parentPath, @Nullable String fieldName,
                                    @Nullable ConfigPath fieldPath,
                                    @Nullable HeaderComment fieldHeaderComments,
                                    @Nullable InlineComment fieldInlineComments,
                                    boolean saveDefaults, boolean loadSubClasses) {
+        if (!ConfigurationRoot.class.isAssignableFrom(clazz)) return; // 只解析继承了 ConfigurationRoot 的类
         String path = getClassPath(clazz, parentPath, fieldName, fieldPath);
         this.provider.setHeaderComment(path, getClassHeaderComments(clazz, fieldHeaderComments));
         if (path != null) this.provider.setInlineComment(path, readInlineComments(fieldInlineComments));
@@ -142,19 +214,21 @@ protected static List<String> readHeaderComments(@Nullable HeaderComment annotat
         return value.length() > 0 ? value : null;
     }
 
-    protected static @Nullable String getClassPath(@NotNull Class<?> clazz,
+    protected static @Nullable String getClassPath(@Nullable Class<?> clazz,
                                                    @Nullable String parentPath,
                                                    @Nullable String filedName,
                                                    @Nullable ConfigPath fieldAnnotation) {
         @NotNull String parent = parentPath != null ? parentPath + "." : "";
         boolean fromRoot = false;
 
         // 先获取 Class 对应的路径注解 其优先度最高。
-        ConfigPath clazzAnnotation = clazz.getAnnotation(ConfigPath.class);
-        if (clazzAnnotation != null) {
-            fromRoot = clazzAnnotation.root();
-            if (clazzAnnotation.value().length() > 0) {
-                return (fromRoot ? "" : parent) + clazzAnnotation.value();
+        if (clazz != null) {
+            ConfigPath clazzAnnotation = clazz.getAnnotation(ConfigPath.class);
+            if (clazzAnnotation != null) {
+                fromRoot = clazzAnnotation.root();
+                if (clazzAnnotation.value().length() > 0) {
+                    return (fromRoot ? "" : parent) + clazzAnnotation.value();
+                }
             }
         }
 

diff --git a/core/src/main/java/cc/carm/lib/configuration/core/function/ConfigValueParser.java b/core/src/main/java/cc/carm/lib/configuration/core/function/ConfigValueParser.java
@@ -53,18 +53,20 @@ default <V> ConfigValueParser<V, R> compose(@NotNull ConfigDataFunction<? super
 
             if (Number.class.isAssignableFrom(valueClass)) {
                 if (Long.class.isAssignableFrom(valueClass)) {
-                    input = longValue().parse(input, null);
+                    input = longValue().parse(input, (Long) defaultValue);
                 } else if (Integer.class.isAssignableFrom(valueClass)) {
-                    input = intValue().parse(input, null);
+                    input = intValue().parse(input, (Integer) defaultValue);
                 } else if (Float.class.isAssignableFrom(valueClass)) {
-                    input = floatValue().parse(input, null);
+                    input = floatValue().parse(input, (Float) defaultValue);
                 } else if (Double.class.isAssignableFrom(valueClass)) {
-                    input = doubleValue().parse(input, null);
+                    input = doubleValue().parse(input, (Double) defaultValue);
                 } else if (Byte.class.isAssignableFrom(valueClass)) {
-                    input = byteValue().parse(input, null);
+                    input = byteValue().parse(input, (Byte) defaultValue);
                 } else if (Short.class.isAssignableFrom(valueClass)) {
-                    input = shortValue().parse(input, null);
+                    input = shortValue().parse(input, (Short) defaultValue);
                 }
+            } else if (Boolean.class.isAssignableFrom(valueClass)) {
+                input = booleanValue().parse(input, (Boolean) defaultValue);
             }
 
             if (valueClass.isInstance(input)) return valueClass.cast(input);

diff --git a/core/src/main/java/cc/carm/lib/configuration/core/source/ConfigurationProvider.java b/core/src/main/java/cc/carm/lib/configuration/core/source/ConfigurationProvider.java
@@ -2,6 +2,8 @@
 
 import cc.carm.lib.configuration.core.ConfigInitializer;
 import cc.carm.lib.configuration.core.ConfigurationRoot;
+import cc.carm.lib.configuration.core.value.ConfigValue;
+import cc.carm.lib.configuration.core.value.impl.CachedConfigValue;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.jetbrains.annotations.Unmodifiable;
@@ -17,23 +19,54 @@ public ConfigurationProvider() {
         this.updateTime = System.currentTimeMillis();
     }
 
+    /**
+     * 得到配置文件的更新(最后加载)时间。
+     *
+     * @return 更新时间
+     */
     public long getUpdateTime() {
         return updateTime;
     }
 
+    /**
+     * 用于 {@link CachedConfigValue} 判断缓存值是否过期(即缓存的时间早于配置文件的最后加载时间)。
+     *
+     * @param time 缓存值时的时间戳
+     * @return 缓存值是否过期
+     */
     public boolean isExpired(long time) {
         return getUpdateTime() > time;
     }
 
+    /**
+     * 得到配置文件的原生功能类。
+     *
+     * @return 原生类
+     */
     public abstract @NotNull W getConfiguration();
 
+    /**
+     * 重载当前配置文件。(将不会保存已修改的内容)
+     *
+     * @throws Exception 当重载出现错误时抛出
+     */
     public void reload() throws Exception {
         onReload(); // 调用重写的Reload方法
         this.updateTime = System.currentTimeMillis();
     }
 
+    /**
+     * 将当前对配置文件的更改进行保存。
+     *
+     * @throws Exception 当保存出现错误时抛出
+     */
     public abstract void save() throws Exception;
 
+    /**
+     * 针对于不同配置文件类型所执行的重载操作。
+     *
+     * @throws Exception 当操作出现错误时抛出。
+     */
     protected abstract void onReload() throws Exception;
 
     public abstract @Nullable ConfigurationComments getComments();
@@ -60,16 +93,53 @@ public List<String> getHeaderComment(@Nullable String path) {
 
     public abstract @NotNull ConfigInitializer<? extends ConfigurationProvider<W>> getInitializer();
 
+    /**
+     * 初始化指定类以及其子类的所有 {@link ConfigValue} 对象。
+     *
+     * @param configClazz 配置文件类，须继承于 {@link ConfigurationRoot} 。
+     */
     public void initialize(Class<? extends ConfigurationRoot> configClazz) {
         initialize(configClazz, true);
     }
 
+    /**
+     * 初始化指定类以及其子类的所有 {@link ConfigValue} 对象。
+     *
+     * @param configClazz  配置文件类，须继承于 {@link ConfigurationRoot} 。
+     * @param saveDefaults 是否写入默认值(默认为 true)。
+     */
     public void initialize(Class<? extends ConfigurationRoot> configClazz, boolean saveDefaults) {
-        getInitializer().initialize(configClazz, saveDefaults);
+        this.getInitializer().initialize(configClazz, saveDefaults);
     }
 
+    /**
+     * 初始化指定类的所有 {@link ConfigValue} 对象。
+     *
+     * @param configClazz    配置文件类，须继承于 {@link ConfigurationRoot} 。
+     * @param saveDefaults   是否写入默认值(默认为 true)。
+     * @param loadSubClasses 是否加载内部子类(默认为 true)。
+     */
     public void initialize(Class<? extends ConfigurationRoot> configClazz, boolean saveDefaults, boolean loadSubClasses) {
-        getInitializer().initialize(configClazz, saveDefaults, loadSubClasses);
+        this.getInitializer().initialize(configClazz, saveDefaults, loadSubClasses);
+    }
+
+    /**
+     * 初始化指定实例的所有 {@link ConfigValue} 与内部 {@link ConfigurationRoot} 对象。
+     *
+     * @param config 配置文件实例类，须实现 {@link ConfigurationRoot} 。
+     */
+    public void initialize(@NotNull ConfigurationRoot config) {
+        this.getInitializer().initialize(config, true);
+    }
+
+    /**
+     * 初始化指定实例的所有 {@link ConfigValue} 与内部 {@link ConfigurationRoot} 对象。
+     *
+     * @param config       配置文件实例类，须实现 {@link ConfigurationRoot} 。
+     * @param saveDefaults 是否写入默认值(默认为 true)。
+     */
+    public void initialize(@NotNull ConfigurationRoot config, boolean saveDefaults) {
+        this.getInitializer().initialize(config, saveDefaults);
     }
 
 }
diff --git a/.../test/java/config/offset/FieldOffset.java → .../carm/test/config/offset/FieldOffset.java b/.../test/java/config/offset/FieldOffset.java → .../carm/test/config/offset/FieldOffset.java
@@ -1,4 +1,4 @@
-package config.offset;
+package cc.carm.test.config.offset;
 
 import org.jetbrains.annotations.NotNull;
 

diff --git a/...c/test/java/config/offset/OffsetUtil.java → ...c/carm/test/config/offset/OffsetUtil.java b/...c/test/java/config/offset/OffsetUtil.java → ...c/carm/test/config/offset/OffsetUtil.java
diff --git a/demo/pom.xml b/demo/pom.xml
@@ -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>
diff --git a/.../config/source/DatabaseConfiguration.java → ...iguration/demo/DatabaseConfiguration.java b/.../config/source/DatabaseConfiguration.java → ...iguration/demo/DatabaseConfiguration.java
@@ -1,4 +1,4 @@
-package config.source;
+package cc.carm.lib.configuration.demo;
 
 import cc.carm.lib.configuration.core.ConfigurationRoot;
 import cc.carm.lib.configuration.core.annotation.ConfigPath;
@@ -12,7 +12,8 @@ public class DatabaseConfiguration extends ConfigurationRoot {
     @ConfigPath("driver")
     @HeaderComment({
             "数据库驱动配置，请根据数据库类型设置。",
-            "- MySQL: com.mysql.cj.jdbc.Driver",
+            "- 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(