carm/EasyConfiguration
carm/EasyConfiguration
1
Fork 0
mirror of https://github.com/CarmJos/EasyConfiguration.git synced 2024-09-19 20:25:51 +00: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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
core/pom.xml
View File

@ -5,7 +5,7 @@
<parent>
<artifactId>easyconfiguration-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>3.6.0</version>
<version>3.7.0</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<properties>

5
core/src/main/java/cc/carm/lib/configuration/core/builder/value/ConfigValueBuilder.java
View File

@ -46,7 +46,10 @@ public class ConfigValueBuilder<V> {
return from(
Object.class, ConfigDataFunction.identity(),
ConfigValueParser.castObject(valueClass),
ConfigDataFunction.toObject(), ConfigDataFunction.toObject()
s -> {
if (s instanceof Enum<?>) return ((Enum<?>) s).name();
else return s;
}, ConfigDataFunction.toObject()
);
}

35
core/src/main/java/cc/carm/lib/configuration/core/function/ConfigDataFunction.java
View File

@ -13,34 +13,34 @@ public interface ConfigDataFunction<T, R> {
default <V> @NotNull ConfigDataFunction<T, V> andThen(@NotNull ConfigDataFunction<? super R, V> after) {
Objects.requireNonNull(after);
return ((data) -> after.parse(parse(data)));
return data -> after.parse(parse(data));
}
@Contract(pure = true)
static <T> @NotNull ConfigDataFunction<T, T> identity() {
return (input) -> input;
return input -> input;
}
@Contract(pure = true)
static <T> @NotNull ConfigDataFunction<T, T> identity(Class<T> type) {
return (input) -> input;
return input -> input;
}
@Contract(pure = true)
static <T, V> @NotNull ConfigDataFunction<T, V> required() {
return (input) -> {
return input -> {
throw new IllegalArgumentException("Please specify the value parser.");
};
}
@Contract(pure = true)
static <T> @NotNull ConfigDataFunction<T, Object> toObject() {
return (input) -> input;
return input -> input;
}
@Contract(pure = true)
static <V> @NotNull ConfigDataFunction<Object, V> castObject(Class<V> valueClass) {
return (input) -> {
return input -> {
if (valueClass.isInstance(input)) return valueClass.cast(input);
else throw new IllegalArgumentException("Cannot cast value to " + valueClass.getName());
};
@ -48,7 +48,7 @@ public interface ConfigDataFunction<T, R> {
@Contract(pure = true)
static <V> @NotNull ConfigDataFunction<String, V> castFromString(Class<V> valueClass) {
return (input) -> {
return input -> {
if (valueClass.isInstance(input)) return valueClass.cast(input);
else throw new IllegalArgumentException("Cannot cast string to " + valueClass.getName());
};
@ -56,15 +56,16 @@ public interface ConfigDataFunction<T, R> {
@Contract(pure = true)
static <T> @NotNull ConfigDataFunction<T, String> castToString() {
return (input) -> {
return input -> {
if (input instanceof String) return (String) input;
else if (input instanceof Enum<?>) return ((Enum<?>) input).name();
else return input.toString();
};
}
@Contract(pure = true)
static <V> @NotNull ConfigDataFunction<String, V> parseString(Class<V> valueClass) {
return (input) -> {
return input -> {
if (valueClass.isInstance(input)) return valueClass.cast(input);
else throw new IllegalArgumentException("Cannot cast string to " + valueClass.getName());
};
@ -72,7 +73,7 @@ public interface ConfigDataFunction<T, R> {
@Contract(pure = true)
static @NotNull ConfigDataFunction<Object, Integer> intValue() {
return (input) -> {
return input -> {
if (input instanceof Integer) {
return (Integer) input;
} else if (input instanceof Number) {
@ -83,7 +84,7 @@ public interface ConfigDataFunction<T, R> {
@Contract(pure = true)
static @NotNull ConfigDataFunction<Object, Short> shortValue() {
return (input) -> {
return input -> {
if (input instanceof Short) {
return (Short) input;
} else if (input instanceof Number) {
@ -94,7 +95,7 @@ public interface ConfigDataFunction<T, R> {
@Contract(pure = true)
static @NotNull ConfigDataFunction<Object, Double> doubleValue() {
return (input) -> {
return input -> {
if (input instanceof Double) {
return (Double) input;
} else if (input instanceof Number) {
@ -105,7 +106,7 @@ public interface ConfigDataFunction<T, R> {
@Contract(pure = true)
static @NotNull ConfigDataFunction<Object, Byte> byteValue() {
return (input) -> {
return input -> {
if (input instanceof Byte) {
return (Byte) input;
} else if (input instanceof Number) {
@ -116,7 +117,7 @@ public interface ConfigDataFunction<T, R> {
@Contract(pure = true)
static @NotNull ConfigDataFunction<Object, Float> floatValue() {
return (input) -> {
return input -> {
if (input instanceof Float) {
return (Float) input;
} else if (input instanceof Number) {
@ -127,7 +128,7 @@ public interface ConfigDataFunction<T, R> {
@Contract(pure = true)
static @NotNull ConfigDataFunction<Object, Long> longValue() {
return (input) -> {
return input -> {
if (input instanceof Long) {
return (Long) input;
} else if (input instanceof Number) {
@ -138,14 +139,14 @@ public interface ConfigDataFunction<T, R> {
@Contract(pure = true)
static @NotNull ConfigDataFunction<Object, Boolean> booleanValue() {
return (input) -> {
return input -> {
if (input instanceof Boolean) {
return (Boolean) input;
} else if (input instanceof String) {
String s = (String) input;
return Boolean.parseBoolean(s) || "yes".equalsIgnoreCase(s);
} else if (input instanceof Integer) {
return ((Integer) input) == 1;
return (Integer) input == 1;
} else throw new IllegalArgumentException("Cannot cast value to " + Boolean.class.getName());
};
}

18
core/src/main/java/cc/carm/lib/configuration/core/function/ConfigValueParser.java
View File

@ -67,6 +67,9 @@ public interface ConfigValueParser<T, R> {
}
} else if (Boolean.class.isAssignableFrom(valueClass)) {
input = booleanValue().parse(input, (Boolean) defaultValue);
} else if (Enum.class.isAssignableFrom(valueClass) && input instanceof String) {
String enumName = (String) input;
input = valueClass.getDeclaredMethod("valueOf", String.class).invoke(null, enumName);
}
if (valueClass.isInstance(input)) return valueClass.cast(input);
@ -125,6 +128,21 @@ public interface ConfigValueParser<T, R> {
return (input, defaultValue) -> ConfigDataFunction.booleanValue().parse(input);
}
@Contract(pure = true)
static @NotNull <E extends Enum<E>> ConfigValueParser<Object, E> enumValue(Class<E> enumClass) {
return (input, defaultValue) -> {
if (input instanceof Enum) {
return enumClass.cast(input);
} else if (input instanceof String) {
return Enum.valueOf(enumClass, (String) input);
} else if (input instanceof Number) {
return enumClass.getEnumConstants()[((Number) input).intValue()];
} else {
throw new IllegalArgumentException("Cannot cast value to " + enumClass.getName());
}
};
}
}

2
demo/pom.xml
View File

@ -5,7 +5,7 @@
<parent>
<artifactId>easyconfiguration-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>3.6.0</version>
<version>3.7.0</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<properties>

3
demo/src/main/java/cc/carm/lib/configuration/demo/tests/conf/DemoConfiguration.java
View File

@ -12,6 +12,7 @@ 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.time.temporal.ChronoUnit;
import java.util.Objects;
import java.util.UUID;
@ -25,6 +26,8 @@ public class DemoConfiguration extends ConfigurationRoot {
@ConfigPath(root = true)
public static final ConfigValue<Long> TEST_NUMBER = ConfiguredValue.of(Long.class, 1000000L);
public static final ConfigValue<ChronoUnit> TEST_ENUM = ConfiguredValue.of(ChronoUnit.class, ChronoUnit.DAYS);
// 支持通过 Class<?> 变量标注子配置，一并注册。
// 注意： 若对应类也有注解，则优先使用类的注解。
@ConfigPath("other-class-config") //支持通过注解修改子配置的主路径，若不修改则以变量名自动生成。

52
impl/hocon/pom.xml
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>

5
impl/hocon/src/main/java/cc/carm/lib/configuration/EasyConfiguration.java
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);
}
}

26
impl/hocon/src/main/java/cc/carm/lib/configuration/hocon/CommentedHOCON.java
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);
}

17
impl/hocon/src/main/java/cc/carm/lib/configuration/hocon/HOCONFileConfigProvider.java
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);
}

23
impl/hocon/src/main/java/cc/carm/lib/configuration/hocon/source/StringConfigProvider.java
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;
}
}

13
impl/hocon/src/main/java/cc/carm/lib/configuration/hocon/util/HOCONUtils.java
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 保存的字符串
*/

3
impl/hocon/src/test/java/online/flowerinsnow/test/easyconfiguration/HOCONTest.java
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) {

2
impl/json/pom.xml
View File

@ -5,7 +5,7 @@
<parent>
<artifactId>easyconfiguration-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>3.6.0</version>
<version>3.7.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>

3
impl/json/src/main/java/cc/carm/lib/configuration/EasyConfiguration.java
View File

@ -7,6 +7,9 @@ import java.io.IOException;
public class EasyConfiguration {
private EasyConfiguration() {
}
public static JSONConfigProvider from(File file, String source) {
JSONConfigProvider provider = new JSONConfigProvider(file);
try {

2
impl/sql/pom.xml
View File

@ -5,7 +5,7 @@
<parent>
<artifactId>easyconfiguration-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>3.6.0</version>
<version>3.7.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>

4
impl/sql/src/main/java/cc/carm/lib/configuration/EasyConfiguration.java
View File

@ -1,6 +1,8 @@
package cc.carm.lib.configuration;
public class EasyConfiguration {
private EasyConfiguration() {
}
}

2
impl/yaml/pom.xml
View File

@ -5,7 +5,7 @@
<parent>
<artifactId>easyconfiguration-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>3.6.0</version>
<version>3.7.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>

3
impl/yaml/src/main/java/cc/carm/lib/configuration/EasyConfiguration.java
View File

@ -6,6 +6,9 @@ import java.io.File;
import java.io.IOException;
public class EasyConfiguration {
private EasyConfiguration() {
}
public static YAMLConfigProvider from(File file, String source) {
YAMLConfigProvider provider = new YAMLConfigProvider(file);

2
pom.xml
View File

@ -15,7 +15,7 @@
<groupId>cc.carm.lib</groupId>
<artifactId>easyconfiguration-parent</artifactId>
<packaging>pom</packaging>
<version>3.6.0</version>
<version>3.7.0</version>
<modules>
<module>core</module>
<module>demo</module>