carm/EasyConfiguration
1
Fork 0
mirror of https://github.com/CarmJos/EasyConfiguration.git synced 2026-06-04 18:48:20 +08:00
Code Issues Releases Activity

feat(value): 支持对Enum对象的快速解析

Browse Source
This commit is contained in:
Carm Jos
2023-06-23 14:06:56 +08:00
parent 3a0a8e79b9
commit eee4a278d9
20 changed files with 111 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files
impl/hocon/pom.xml
+26 -26
View File
@@ -6,40 +6,17 @@
<parent>
<groupId>cc.carm.lib</groupId>
<artifactId>easyconfiguration-parent</artifactId>
<version>3.6.0</version>
<version>3.7.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<artifactId>easyconfiguration-hocon</artifactId>
<packaging>jar</packaging>
<properties>
<maven.compiler.source>${project.jdk.version}</maven.compiler.source>
<maven.compiler.target>${project.jdk.version}</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.encoding>UTF-8</maven.compiler.encoding>
</properties>
<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-source-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
</plugins>
</build>
<artifactId>easyconfiguration-hocon</artifactId>
<packaging>jar</packaging>
<dependencies>
<dependency>
@@ -63,4 +40,27 @@
<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-source-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
impl/hocon/src/main/java/cc/carm/lib/configuration/EasyConfiguration.java
+5
View File
@@ -6,6 +6,10 @@ import java.io.File;
import java.io.IOException;
public class EasyConfiguration {
private EasyConfiguration() {
}
public static HOCONFileConfigProvider from(File file, String source) {
HOCONFileConfigProvider provider = new HOCONFileConfigProvider(file);
try {
@@ -28,4 +32,5 @@ public class EasyConfiguration {
public static HOCONFileConfigProvider from(String fileName, String source) {
return from(new File(fileName), source);
}
}
impl/hocon/src/main/java/cc/carm/lib/configuration/hocon/CommentedHOCON.java
-26
View File
@@ -1,26 +0,0 @@
package cc.carm.lib.configuration.hocon;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.List;
import java.util.Set;
public interface CommentedHOCON {
default @NotNull Set<String> getKeys() {
return getKeys(null, true);
}
String serializeValue(@NotNull String key, @NotNull Object value);
@Contract("null,_ -> !null;!null,_ -> _")
@Nullable Set<String> getKeys(@Nullable String sectionKey, boolean deep);
@Nullable Object getValue(@NotNull String key);
@Nullable String getInlineComment(@NotNull String key);
@Nullable
List<String> getHeaderComments(@Nullable String key);
}
impl/hocon/src/main/java/cc/carm/lib/configuration/hocon/HOCONFileConfigProvider.java
+10 -7
View File
@@ -6,6 +6,7 @@ import cc.carm.lib.configuration.core.source.impl.FileConfigProvider;
import cc.carm.lib.configuration.hocon.exception.HOCONGetValueException;
import cc.carm.lib.configuration.hocon.util.HOCONUtils;
import com.typesafe.config.*;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@@ -16,7 +17,7 @@ import java.nio.file.Files;
import java.util.List;
import java.util.Set;
public class HOCONFileConfigProvider extends FileConfigProvider<HOCONConfigWrapper> implements CommentedHOCON {
public class HOCONFileConfigProvider extends FileConfigProvider<HOCONConfigWrapper> {
protected final @NotNull ConfigurationComments comments = new ConfigurationComments();
protected HOCONConfigWrapper configuration;
protected ConfigInitializer<HOCONFileConfigProvider> initializer;
@@ -48,9 +49,10 @@ public class HOCONFileConfigProvider extends FileConfigProvider<HOCONConfigWrapp
@Override
protected void onReload() throws ConfigException {
this.configuration = new HOCONConfigWrapper(ConfigFactory.parseFile(this.file, ConfigParseOptions.defaults()
ConfigObject conf = ConfigFactory.parseFile(this.file, ConfigParseOptions.defaults()
.setSyntax(ConfigSyntax.CONF)
.setAllowMissing(false)).root());
.setAllowMissing(false)).root();
this.configuration = new HOCONConfigWrapper(conf);
}
@Override
@@ -63,7 +65,6 @@ public class HOCONFileConfigProvider extends FileConfigProvider<HOCONConfigWrapp
return this.initializer;
}
@Override
public String serializeValue(@NotNull String key, @NotNull Object value) {
// 带有 key=value 的新空对象
return ConfigFactory.empty()
@@ -71,7 +72,11 @@ public class HOCONFileConfigProvider extends FileConfigProvider<HOCONConfigWrapp
.root().render();
}
@Override
public @NotNull Set<String> getKeys() {
return getKeys(null, true);
}
@Contract("null,_->!null")
public @Nullable Set<String> getKeys(@Nullable String sectionKey, boolean deep) {
if (sectionKey == null) { // 当前路径
return HOCONUtils.getKeysFromObject(this.configuration, deep, "");
@@ -91,12 +96,10 @@ public class HOCONFileConfigProvider extends FileConfigProvider<HOCONConfigWrapp
return HOCONUtils.getKeysFromObject(section, deep, "");
}
@Override
public @Nullable Object getValue(@NotNull String key) {
return this.configuration.get(key);
}
@Override
public @Nullable List<String> getHeaderComments(@Nullable String key) {
return this.comments.getHeaderComment(key);
}
impl/hocon/src/main/java/cc/carm/lib/configuration/hocon/source/StringConfigProvider.java
-23
View File
@@ -1,23 +0,0 @@
package cc.carm.lib.configuration.hocon.source;
import cc.carm.lib.configuration.core.source.ConfigurationProvider;
import cc.carm.lib.configuration.core.source.ConfigurationWrapper;
import org.jetbrains.annotations.NotNull;
/**
* 暂时未实现，原因是如果要实现，就需要修改部分代码
* @see ConfigurationProvider#save()
* @see ConfigurationProvider#reload()
* 等一系列代码
*/
public abstract class StringConfigProvider<W extends ConfigurationWrapper<?>> extends ConfigurationProvider<W> {
protected final @NotNull String source;
protected StringConfigProvider(@NotNull String source) {
this.source = source;
}
public @NotNull String getSource() {
return this.source;
}
}
impl/hocon/src/main/java/cc/carm/lib/configuration/hocon/util/HOCONUtils.java
+9 -4
View File
@@ -8,9 +8,14 @@ import org.jetbrains.annotations.NotNull;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;
public abstract class HOCONUtils {
public class HOCONUtils {
private HOCONUtils() {
}
public static String getSimplePath(String path, char separator) {
int index = path.lastIndexOf(separator);
return (index == -1) ? path : path.substring(index + 1);
@@ -45,11 +50,11 @@ public abstract class HOCONUtils {
* 下一次键名就是 "deep.key"
*
* @param parent Object
* @param deep 是否更深层获取
* @param deep 是否更深层获取
* @param prefix 当前 Object 键名前缀
* @return Object 中的所有键
*/
public static LinkedHashSet<String> getKeysFromObject(HOCONConfigWrapper parent, boolean deep, String prefix) {
public static Set<String> getKeysFromObject(HOCONConfigWrapper parent, boolean deep, String prefix) {
return parent.getSource().entrySet().stream().collect(
LinkedHashSet::new,
(set, entry) -> {
@@ -68,7 +73,7 @@ public abstract class HOCONUtils {
* 将 Object 保存为字符串
* 并使用注释器打上注释
*
* @param object Object
* @param object Object
* @param commenter 注释器
* @return 保存的字符串
*/
impl/hocon/src/test/java/online/flowerinsnow/test/easyconfiguration/HOCONTest.java
+3
View File
@@ -1,6 +1,8 @@
package online.flowerinsnow.test.easyconfiguration;
import cc.carm.lib.configuration.EasyConfiguration;
import cc.carm.lib.configuration.demo.DatabaseConfiguration;
import cc.carm.lib.configuration.demo.tests.conf.DemoConfiguration;
import cc.carm.lib.configuration.hocon.HOCONFileConfigProvider;
import online.flowerinsnow.test.easyconfiguration.config.Config;
import org.junit.Test;
@@ -12,6 +14,7 @@ public class HOCONTest {
public void onTest() {
HOCONFileConfigProvider provider = EasyConfiguration.from(new File("target/hocon.conf"));
provider.initialize(Config.class);
provider.initialize(DatabaseConfiguration.class);
try {
provider.reload();
} catch (Exception e) {