1
mirror of https://github.com/CarmJos/EasyConfiguration.git synced 2024-09-19 20:25:51 +00:00

[1.1.0] 实现 ConfigurationSerializable 相关数据的加载、获取与写入。

This commit is contained in:
Carm Jos 2022-04-18 05:19:06 +08:00
parent a13ea7569c
commit 0bda97d82a
43 changed files with 575 additions and 110 deletions

View File

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

View File

@ -11,13 +11,19 @@ import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
import java.util.Optional;
public class ConfigInitializer {
public class ConfigInitializer<T extends ConfigurationProvider<?>> {
public static void initialize(ConfigurationProvider source, Class<? extends ConfigurationRoot> rootClazz) {
initialize(source, rootClazz, true);
protected final @NotNull T provider;
public ConfigInitializer(@NotNull T provider) {
this.provider = provider;
}
public static void initialize(ConfigurationProvider provider, Class<? extends ConfigurationRoot> rootClazz, boolean saveDefault) {
public void initialize(Class<? extends ConfigurationRoot> rootClazz) {
initialize(rootClazz, true);
}
public void initialize(Class<? extends ConfigurationRoot> rootClazz, boolean saveDefault) {
String rootSection = null;
ConfigPath sectionAnnotation = rootClazz.getAnnotation(ConfigPath.class);
@ -34,11 +40,11 @@ public class ConfigInitializer {
}
for (Class<?> innerClass : rootClazz.getDeclaredClasses()) {
initSection(provider, rootSection, innerClass, saveDefault);
initSection(rootSection, innerClass, saveDefault);
}
for (Field field : rootClazz.getDeclaredFields()) {
initValue(provider, rootSection, rootClazz, field, saveDefault);
initValue(rootSection, rootClazz, field, saveDefault);
}
if (saveDefault) {
@ -51,7 +57,7 @@ public class ConfigInitializer {
}
private static void initSection(ConfigurationProvider provider, String parentSection, Class<?> clazz, boolean saveDefault) {
private void initSection(String parentSection, Class<?> clazz, boolean saveDefault) {
if (!Modifier.isStatic(clazz.getModifiers()) || !Modifier.isPublic(clazz.getModifiers())) return;
String section = getSectionPath(clazz.getSimpleName(), parentSection, clazz.getAnnotation(ConfigPath.class));
@ -60,18 +66,18 @@ public class ConfigInitializer {
provider.setComments(parentSection, comments.value());
}
for (Field field : clazz.getDeclaredFields()) initValue(provider, section, clazz, field, saveDefault);
for (Class<?> innerClass : clazz.getDeclaredClasses()) initSection(provider, section, innerClass, saveDefault);
for (Field field : clazz.getDeclaredFields()) initValue(section, clazz, field, saveDefault);
for (Class<?> innerClass : clazz.getDeclaredClasses()) initSection(section, innerClass, saveDefault);
}
private static void initValue(ConfigurationProvider provider, String parentSection, Class<?> clazz, Field field, boolean saveDefault) {
private void initValue(String parentSection, Class<?> clazz, Field field, boolean saveDefault) {
try {
field.setAccessible(true);
Object object = field.get(clazz);
if (object instanceof ConfigValue<?>) {
initializeValue(
provider, (ConfigValue<?>) object, saveDefault,
(ConfigValue<?>) object, saveDefault,
getSectionPath(field.getName(), parentSection, field.getAnnotation(ConfigPath.class)),
Optional.ofNullable(field.getAnnotation(ConfigComment.class))
.map(ConfigComment::value).orElse(new String[0])
@ -82,8 +88,8 @@ public class ConfigInitializer {
}
public static void initializeValue(@NotNull ConfigurationProvider provider, @NotNull ConfigValue<?> value,
boolean saveDefault, @NotNull String path, @NotNull String[] comments) {
public void initializeValue(@NotNull ConfigValue<?> value, boolean saveDefault,
@NotNull String path, @NotNull String[] comments) {
value.initialize(provider, path, comments);
if (saveDefault && value.getDefaultValue() != null && !provider.getConfiguration().contains(path)) {
value.setDefault();

View File

@ -5,20 +5,25 @@ import cc.carm.lib.configuration.core.value.ConfigValue;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
public abstract class AbstractConfigBuilder<B extends AbstractConfigBuilder<B, T>, T> {
public abstract class AbstractConfigBuilder<T, B extends AbstractConfigBuilder<T, B, P>, P extends ConfigurationProvider<?>> {
protected final Class<? super P> providerClass;
protected @Nullable ConfigurationProvider provider;
protected @Nullable P provider;
protected @Nullable String path;
protected @NotNull String[] comments = new String[0];
protected @Nullable T defaultValue;
public AbstractConfigBuilder(Class<? super P> providerClass) {
this.providerClass = providerClass;
}
protected abstract @NotNull B getThis();
public abstract @NotNull ConfigValue<?> build();
public @NotNull B from(@Nullable ConfigurationProvider provider) {
public @NotNull B from(@Nullable P provider) {
this.provider = provider;
return getThis();
}

View File

@ -0,0 +1,46 @@
package cc.carm.lib.configuration.core.builder;
import cc.carm.lib.configuration.core.source.ConfigurationProvider;
import cc.carm.lib.configuration.core.value.ConfigValue;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
public abstract class CommonConfigBuilder<T, B extends CommonConfigBuilder<T, B>>
extends AbstractConfigBuilder<T, B, ConfigurationProvider<?>> {
protected @Nullable ConfigurationProvider<?> provider;
protected @Nullable String path;
protected @NotNull String[] comments = new String[0];
protected @Nullable T defaultValue;
public CommonConfigBuilder() {
super(ConfigurationProvider.class);
}
protected abstract @NotNull B getThis();
public abstract @NotNull ConfigValue<?> build();
public @NotNull B from(@Nullable ConfigurationProvider<?> provider) {
this.provider = provider;
return getThis();
}
public @NotNull B path(@Nullable String path) {
this.path = path;
return getThis();
}
public @NotNull B comments(@NotNull String... comments) {
this.comments = comments;
return getThis();
}
public @NotNull B defaults(@Nullable T defaultValue) {
this.defaultValue = defaultValue;
return getThis();
}
}

View File

@ -1,14 +1,13 @@
package cc.carm.lib.configuration.core.builder.list;
import cc.carm.lib.configuration.core.builder.AbstractConfigBuilder;
import cc.carm.lib.configuration.core.builder.CommonConfigBuilder;
import cc.carm.lib.configuration.core.function.ConfigDataFunction;
import cc.carm.lib.configuration.core.value.type.ConfiguredList;
import org.jetbrains.annotations.NotNull;
import java.util.List;
public class SourceListBuilder<S, V>
extends AbstractConfigBuilder<SourceListBuilder<S, V>, List<V>> {
public class SourceListBuilder<S, V> extends CommonConfigBuilder<List<V>, SourceListBuilder<S, V>> {
protected final @NotNull Class<S> sourceClass;
protected @NotNull ConfigDataFunction<Object, S> sourceParser;

View File

@ -1,6 +1,6 @@
package cc.carm.lib.configuration.core.builder.map;
import cc.carm.lib.configuration.core.builder.AbstractConfigBuilder;
import cc.carm.lib.configuration.core.builder.CommonConfigBuilder;
import cc.carm.lib.configuration.core.function.ConfigDataFunction;
import cc.carm.lib.configuration.core.value.type.ConfiguredMap;
import org.jetbrains.annotations.NotNull;
@ -8,8 +8,7 @@ import org.jetbrains.annotations.NotNull;
import java.util.Map;
import java.util.function.Supplier;
public class SourceMapBuilder<M extends Map<K, V>, S, K, V>
extends AbstractConfigBuilder<SourceMapBuilder<M, S, K, V>, M> {
public class SourceMapBuilder<M extends Map<K, V>, S, K, V> extends CommonConfigBuilder<M, SourceMapBuilder<M, S, K, V>> {
protected final @NotNull Supplier<@NotNull M> supplier;

View File

@ -1,6 +1,6 @@
package cc.carm.lib.configuration.core.builder.value;
import cc.carm.lib.configuration.core.builder.AbstractConfigBuilder;
import cc.carm.lib.configuration.core.builder.CommonConfigBuilder;
import cc.carm.lib.configuration.core.function.ConfigDataFunction;
import cc.carm.lib.configuration.core.function.ConfigValueParser;
import cc.carm.lib.configuration.core.source.ConfigurationWrapper;
@ -10,7 +10,7 @@ import org.jetbrains.annotations.NotNull;
import java.util.Map;
public class SectionValueBuilder<V>
extends AbstractConfigBuilder<SectionValueBuilder<V>, V> {
extends CommonConfigBuilder<V, SectionValueBuilder<V>> {
protected final @NotNull Class<V> valueClass;

View File

@ -1,12 +1,12 @@
package cc.carm.lib.configuration.core.builder.value;
import cc.carm.lib.configuration.core.builder.AbstractConfigBuilder;
import cc.carm.lib.configuration.core.builder.CommonConfigBuilder;
import cc.carm.lib.configuration.core.function.ConfigDataFunction;
import cc.carm.lib.configuration.core.function.ConfigValueParser;
import cc.carm.lib.configuration.core.value.type.ConfiguredValue;
import org.jetbrains.annotations.NotNull;
public class SourceValueBuilder<S, V> extends AbstractConfigBuilder<SourceValueBuilder<S, V>, V> {
public class SourceValueBuilder<S, V> extends CommonConfigBuilder<V, SourceValueBuilder<S, V>> {
protected final @NotNull Class<S> sourceClass;
protected @NotNull ConfigDataFunction<Object, S> sourceParser;

View File

@ -5,7 +5,7 @@ import cc.carm.lib.configuration.core.ConfigurationRoot;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
public abstract class ConfigurationProvider {
public abstract class ConfigurationProvider<W extends ConfigurationWrapper> {
protected long updateTime;
@ -21,7 +21,7 @@ public abstract class ConfigurationProvider {
return this.updateTime > time;
}
public abstract @NotNull ConfigurationWrapper getConfiguration();
public abstract @NotNull W getConfiguration();
public abstract void reload() throws Exception;
@ -31,8 +31,10 @@ public abstract class ConfigurationProvider {
public abstract @Nullable String[] getComments(@NotNull String path);
public abstract @NotNull ConfigInitializer<? extends ConfigurationProvider<W>> getInitializer();
public void initialize(Class<? extends ConfigurationRoot> configClazz) {
ConfigInitializer.initialize(this, configClazz, true);
getInitializer().initialize(configClazz, true);
}
}

View File

@ -9,7 +9,7 @@ import java.util.List;
import java.util.Map;
import java.util.Set;
public interface ConfigurationWrapper extends ConfigurationReader{
public interface ConfigurationWrapper extends ConfigurationReader {
@Override
default ConfigurationWrapper getWrapper() {
@ -68,5 +68,4 @@ public interface ConfigurationWrapper extends ConfigurationReader{
@Nullable
ConfigurationWrapper getConfigurationSection(@NotNull String path);
}

View File

@ -1,6 +1,7 @@
package cc.carm.lib.configuration.core.source.impl;
import cc.carm.lib.configuration.core.source.ConfigurationProvider;
import cc.carm.lib.configuration.core.source.ConfigurationWrapper;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@ -9,7 +10,7 @@ import java.net.URL;
import java.net.URLConnection;
import java.util.Objects;
public abstract class FileConfigProvider extends ConfigurationProvider {
public abstract class FileConfigProvider<W extends ConfigurationWrapper> extends ConfigurationProvider<W> {
protected final @NotNull File file;

View File

@ -15,23 +15,21 @@ public abstract class ConfigValue<T> {
return new ConfigBuilder();
}
protected @Nullable T defaultValue;
protected @Nullable ConfigurationProvider provider;
protected @Nullable ConfigurationProvider<?> provider;
protected @Nullable String configPath;
protected @NotNull String[] comments;
public ConfigValue(@Nullable ConfigurationProvider provider, @Nullable String configPath,
@NotNull String[] comments, @Nullable T defaultValue) {
protected @Nullable T defaultValue;
public ConfigValue(@Nullable ConfigurationProvider<?> provider,
@Nullable String configPath, @NotNull String[] comments, @Nullable T defaultValue) {
this.provider = provider;
this.configPath = configPath;
this.comments = comments;
this.defaultValue = defaultValue;
}
public void initialize(@NotNull ConfigurationProvider provider, @NotNull String configPath,
@NotNull String... comments) {
public void initialize(@NotNull ConfigurationProvider<?> provider, @NotNull String configPath, @NotNull String... comments) {
if (this.provider == null) this.provider = provider;
if (this.configPath == null) this.configPath = configPath;
if (this.comments.length == 0) this.comments = comments;
@ -68,7 +66,15 @@ public abstract class ConfigValue<T> {
Optional.ofNullable(getDefaultValue()).ifPresent(this::set);
}
public @NotNull ConfigurationProvider getProvider() {
public boolean isDefault() {
T defaultValue = getDefaultValue();
T value = get();
if (defaultValue == null && value == null) return true;
else if (defaultValue != null && value != null) return defaultValue.equals(value);
else return false;
}
public @NotNull ConfigurationProvider<?> getProvider() {
return Optional.ofNullable(this.provider)
.orElseThrow(() -> new IllegalStateException("Value(" + configPath + ") does not have a provider."));
}

View File

@ -1,6 +1,7 @@
package cc.carm.lib.configuration.core.value;
package cc.carm.lib.configuration.core.value.impl;
import cc.carm.lib.configuration.core.source.ConfigurationProvider;
import cc.carm.lib.configuration.core.value.ConfigValue;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@ -10,7 +11,7 @@ public abstract class CachedConfigValue<T> extends ConfigValue<T> {
protected @Nullable T cachedValue;
protected long parsedTime = -1;
public CachedConfigValue(@Nullable ConfigurationProvider provider, @Nullable String sectionPath,
public CachedConfigValue(@Nullable ConfigurationProvider<?> provider, @Nullable String sectionPath,
@NotNull String[] comments, @Nullable T defaultValue) {
super(provider, sectionPath, comments, defaultValue);
}

View File

@ -3,7 +3,7 @@ package cc.carm.lib.configuration.core.value.type;
import cc.carm.lib.configuration.core.builder.list.ConfigListBuilder;
import cc.carm.lib.configuration.core.function.ConfigDataFunction;
import cc.carm.lib.configuration.core.source.ConfigurationProvider;
import cc.carm.lib.configuration.core.value.CachedConfigValue;
import cc.carm.lib.configuration.core.value.impl.CachedConfigValue;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@ -21,7 +21,7 @@ public class ConfiguredList<V> extends CachedConfigValue<List<V>> {
protected final @NotNull ConfigDataFunction<Object, V> parser;
protected final @NotNull ConfigDataFunction<V, Object> serializer;
public ConfiguredList(@Nullable ConfigurationProvider provider,
public ConfiguredList(@Nullable ConfigurationProvider<?> provider,
@Nullable String sectionPath, @NotNull String[] comments,
@NotNull Class<V> valueClass, @Nullable List<V> defaultValue,
@NotNull ConfigDataFunction<Object, V> parser,
@ -34,6 +34,9 @@ public class ConfiguredList<V> extends CachedConfigValue<List<V>> {
@Override
public @NotNull List<V> get() {
if (isExpired()) { // 已过时的数据需要重新解析一次
List<V> list = new ArrayList<>();

View File

@ -1,11 +1,10 @@
package cc.carm.lib.configuration.core.value.type;
import cc.carm.lib.configuration.core.builder.ConfigBuilder;
import cc.carm.lib.configuration.core.builder.map.ConfigMapBuilder;
import cc.carm.lib.configuration.core.function.ConfigDataFunction;
import cc.carm.lib.configuration.core.source.ConfigurationProvider;
import cc.carm.lib.configuration.core.source.ConfigurationWrapper;
import cc.carm.lib.configuration.core.value.CachedConfigValue;
import cc.carm.lib.configuration.core.value.impl.CachedConfigValue;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@ -32,7 +31,7 @@ public class ConfiguredMap<K, V> extends CachedConfigValue<Map<K, V>> {
protected final @NotNull ConfigDataFunction<K, String> keySerializer;
protected final @NotNull ConfigDataFunction<V, Object> valueSerializer;
public ConfiguredMap(@Nullable ConfigurationProvider provider,
public ConfiguredMap(@Nullable ConfigurationProvider<?> provider,
@Nullable String sectionPath, @NotNull String[] comments,
@Nullable Map<K, V> defaultValue, @NotNull Supplier<? extends Map<K, V>> supplier,
@NotNull Class<K> keyClass, @NotNull ConfigDataFunction<String, K> keyParser,

View File

@ -1,12 +1,11 @@
package cc.carm.lib.configuration.core.value.type;
import cc.carm.lib.configuration.core.builder.ConfigBuilder;
import cc.carm.lib.configuration.core.builder.value.SectionValueBuilder;
import cc.carm.lib.configuration.core.function.ConfigDataFunction;
import cc.carm.lib.configuration.core.function.ConfigValueParser;
import cc.carm.lib.configuration.core.source.ConfigurationProvider;
import cc.carm.lib.configuration.core.source.ConfigurationWrapper;
import cc.carm.lib.configuration.core.value.CachedConfigValue;
import cc.carm.lib.configuration.core.value.impl.CachedConfigValue;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@ -24,7 +23,7 @@ public class ConfiguredSection<V> extends CachedConfigValue<V> {
protected final @NotNull ConfigValueParser<ConfigurationWrapper, V> parser;
protected final @NotNull ConfigDataFunction<V, ? extends Map<String, Object>> serializer;
public ConfiguredSection(@Nullable ConfigurationProvider provider,
public ConfiguredSection(@Nullable ConfigurationProvider<?> provider,
@Nullable String sectionPath, @NotNull String[] comments,
@NotNull Class<V> valueClass, @Nullable V defaultValue,
@NotNull ConfigValueParser<ConfigurationWrapper, V> parser,

View File

@ -1,11 +1,10 @@
package cc.carm.lib.configuration.core.value.type;
import cc.carm.lib.configuration.core.builder.ConfigBuilder;
import cc.carm.lib.configuration.core.builder.value.ConfigValueBuilder;
import cc.carm.lib.configuration.core.function.ConfigDataFunction;
import cc.carm.lib.configuration.core.function.ConfigValueParser;
import cc.carm.lib.configuration.core.source.ConfigurationProvider;
import cc.carm.lib.configuration.core.value.CachedConfigValue;
import cc.carm.lib.configuration.core.value.impl.CachedConfigValue;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@ -30,7 +29,7 @@ public class ConfiguredValue<V> extends CachedConfigValue<V> {
protected final @NotNull ConfigValueParser<Object, V> parser;
protected final @NotNull ConfigDataFunction<V, Object> serializer;
public ConfiguredValue(@Nullable ConfigurationProvider provider,
public ConfiguredValue(@Nullable ConfigurationProvider<?> provider,
@Nullable String sectionPath, @NotNull String[] comments,
@NotNull Class<V> valueClass, @Nullable V defaultValue,
@NotNull ConfigValueParser<Object, V> parser,

View File

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

View File

@ -0,0 +1,32 @@
package cc.carm.lib.configuration.yaml;
import cc.carm.lib.configuration.core.source.ConfigurationProvider;
import cc.carm.lib.configuration.core.value.impl.CachedConfigValue;
import cc.carm.lib.configuration.yaml.YamlConfigProvider;
import cc.carm.lib.configuration.yaml.YamlSectionWrapper;
import cc.carm.lib.configuration.yaml.builder.YamlConfigBuilder;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
public abstract class YAMLValue<T> extends CachedConfigValue<T> {
public static @NotNull YamlConfigBuilder builder() {
return new YamlConfigBuilder();
}
public YAMLValue(@Nullable YamlConfigProvider provider,
@Nullable String configPath, @NotNull String[] comments, @Nullable T defaultValue) {
super(provider, configPath, comments, defaultValue);
}
public YamlConfigProvider getYAMLProvider() {
ConfigurationProvider<?> provider = getProvider();
if (provider instanceof YamlConfigProvider) return (YamlConfigProvider) getProvider();
else throw new IllegalStateException("Provider is not a SpigotConfigProvider");
}
public YamlSectionWrapper getYAMLConfig() {
return getYAMLProvider().getConfiguration();
}
}

View File

@ -1,6 +1,6 @@
package cc.carm.lib.configuration.yaml;
import cc.carm.lib.configuration.core.source.ConfigurationWrapper;
import cc.carm.lib.configuration.core.ConfigInitializer;
import cc.carm.lib.configuration.core.source.impl.FileConfigProvider;
import org.bspfsystems.yamlconfiguration.commented.CommentedYamlConfiguration;
import org.jetbrains.annotations.NotNull;
@ -8,10 +8,11 @@ import org.jetbrains.annotations.Nullable;
import java.io.File;
public class YamlConfigProvider extends FileConfigProvider {
public class YamlConfigProvider extends FileConfigProvider<YamlSectionWrapper> {
YamlComments comments = new YamlComments();
CommentedYamlConfiguration configuration;
protected final @NotNull YamlComments comments = new YamlComments();
protected CommentedYamlConfiguration configuration;
protected ConfigInitializer<YamlConfigProvider> initializer;
public YamlConfigProvider(@NotNull File file) {
super(file);
@ -19,10 +20,11 @@ public class YamlConfigProvider extends FileConfigProvider {
public void initializeConfig() {
this.configuration = CommentedYamlConfiguration.loadConfiguration(comments, file);
this.initializer = new ConfigInitializer<>(this);
}
@Override
public @NotNull ConfigurationWrapper getConfiguration() {
public @NotNull YamlSectionWrapper getConfiguration() {
return YamlSectionWrapper.of(configuration);
}
@ -46,4 +48,9 @@ public class YamlConfigProvider extends FileConfigProvider {
return this.comments.get(path);
}
@Override
public @NotNull ConfigInitializer<YamlConfigProvider> getInitializer() {
return this.initializer;
}
}

View File

@ -2,6 +2,7 @@ package cc.carm.lib.configuration.yaml;
import cc.carm.lib.configuration.core.source.ConfigurationWrapper;
import org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection;
import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@ -68,4 +69,16 @@ public class YamlSectionWrapper implements ConfigurationWrapper {
public @Nullable ConfigurationWrapper getConfigurationSection(@NotNull String path) {
return of(this.section.getConfigurationSection(path));
}
@Nullable
public <T extends ConfigurationSerializable> T getSerializable(@NotNull String path, @NotNull Class<T> clazz) {
return getSerializable(path, clazz, null);
}
@Nullable
@Contract("_, _, !null -> !null")
public <T extends ConfigurationSerializable> T getSerializable(@NotNull String path, @NotNull Class<T> clazz, @Nullable T defaultValue) {
return this.section.getSerializable(path, clazz, defaultValue);
}
}

View File

@ -0,0 +1,13 @@
package cc.carm.lib.configuration.yaml.builder;
import cc.carm.lib.configuration.core.builder.AbstractConfigBuilder;
import cc.carm.lib.configuration.yaml.YamlConfigProvider;
public abstract class AbstractYAMLBuilder<T, B extends AbstractYAMLBuilder<T, B>>
extends AbstractConfigBuilder<T, B, YamlConfigProvider> {
public AbstractYAMLBuilder() {
super(YamlConfigProvider.class);
}
}

View File

@ -0,0 +1,14 @@
package cc.carm.lib.configuration.yaml.builder;
import cc.carm.lib.configuration.core.builder.ConfigBuilder;
import cc.carm.lib.configuration.yaml.builder.serializable.SerializableBuilder;
import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable;
import org.jetbrains.annotations.NotNull;
public class YamlConfigBuilder extends ConfigBuilder {
public <V extends ConfigurationSerializable> @NotNull SerializableBuilder<V> ofSerializable(@NotNull Class<V> valueClass) {
return new SerializableBuilder<>(valueClass);
}
}

View File

@ -0,0 +1,29 @@
package cc.carm.lib.configuration.yaml.builder.serializable;
import cc.carm.lib.configuration.yaml.builder.AbstractYAMLBuilder;
import cc.carm.lib.configuration.yaml.value.ConfiguredSerializable;
import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable;
import org.jetbrains.annotations.NotNull;
public class SerializableBuilder<T extends ConfigurationSerializable>
extends AbstractYAMLBuilder<T, SerializableBuilder<T>> {
protected final @NotNull Class<T> valueClass;
public SerializableBuilder(@NotNull Class<T> valueClass) {
this.valueClass = valueClass;
}
@Override
protected @NotNull SerializableBuilder<T> getThis() {
return this;
}
@Override
public @NotNull ConfiguredSerializable<T> build() {
return new ConfiguredSerializable<>(this.provider, this.path, this.comments, this.valueClass, this.defaultValue);
}
}

View File

@ -0,0 +1,52 @@
package cc.carm.lib.configuration.yaml.value;
import cc.carm.lib.configuration.yaml.YAMLValue;
import cc.carm.lib.configuration.yaml.YamlConfigProvider;
import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Optional;
public class ConfiguredSerializable<T extends ConfigurationSerializable> extends YAMLValue<T> {
public static <V extends ConfigurationSerializable> ConfiguredSerializable<V> of(@NotNull Class<V> valueClass) {
return of(valueClass, null);
}
public static <V extends ConfigurationSerializable> ConfiguredSerializable<V> of(@NotNull Class<V> valueClass,
@Nullable V defaultValue) {
return builder().ofSerializable(valueClass).defaults(defaultValue).build();
}
protected final @NotNull Class<T> valueClass;
public ConfiguredSerializable(@Nullable YamlConfigProvider provider,
@Nullable String configPath, @NotNull String[] comments,
@NotNull Class<T> valueClass, @Nullable T defaultValue) {
super(provider, configPath, comments, defaultValue);
this.valueClass = valueClass;
}
@Override
public @Nullable T get() {
if (isExpired()) { // 已过时的数据需要重新解析一次
try {
// 若未出现错误则直接更新缓存并返回
return updateCache(getYAMLConfig().getSerializable(getConfigPath(), valueClass, getDefaultValue()));
} catch (Exception e) {
// 出现了解析错误提示并返回默认值
e.printStackTrace();
return useDefault();
}
} else return Optional.ofNullable(getCachedValue()).orElse(defaultValue);
}
@Override
public void set(@Nullable T value) {
updateCache(value);
setValue(value);
}
}

View File

@ -2,9 +2,11 @@ package config;
import cc.carm.lib.configuration.EasyConfiguration;
import cc.carm.lib.configuration.yaml.YamlConfigProvider;
import config.misc.TestUser;
import config.source.DemoConfiguration;
import config.model.TestModel;
import config.source.ComplexConfiguration;
import config.source.DemoConfiguration;
import config.source.ImplConfiguration;
import org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerialization;
import org.junit.Test;
import java.util.LinkedHashMap;
@ -15,32 +17,16 @@ import java.util.stream.IntStream;
public class ConfigTester {
@Test
public void onTest() {
ConfigurationSerialization.registerClass(TestModel.class);
YamlConfigProvider provider = EasyConfiguration.from("target/config.yml", "config.yml");
provider.initialize(DemoConfiguration.class);
provider.initialize(ComplexConfiguration.class);
System.out.println("before: " + ComplexConfiguration.Sub.UUID_CONFIG_VALUE.get());
ComplexConfiguration.Sub.UUID_CONFIG_VALUE.set(UUID.randomUUID());
System.out.println("after: " + ComplexConfiguration.Sub.UUID_CONFIG_VALUE.get());
ComplexConfiguration.Sub.That.Operators.getNotNull().forEach(System.out::println);
List<UUID> operators = IntStream.range(0, 5).mapToObj(i -> UUID.randomUUID()).collect(Collectors.toList());
ComplexConfiguration.Sub.That.Operators.set(operators);
System.out.println(ComplexConfiguration.USER.get());
TestUser b = new TestUser(UUID.randomUUID().toString().substring(0, 3), UUID.randomUUID());
ComplexConfiguration.USER.set(b);
ComplexConfiguration.USERS.getNotNull().forEach((k, v) -> System.out.println(k + ": " + v));
LinkedHashMap<Integer, UUID> data = new LinkedHashMap<>();
for (int i = 0; i < 5; i++) {
data.put((int) (1000 * Math.random()), UUID.randomUUID());
}
ComplexConfiguration.USERS.set(data);
testDemo(provider);
testComplex(provider);
testSerialization(provider);
try {
provider.save();
@ -50,5 +36,45 @@ public class ConfigTester {
}
public static void testSerialization(YamlConfigProvider provider) {
System.out.println("----------------------------------------------------");
provider.initialize(ImplConfiguration.class);
System.out.println(ImplConfiguration.TEST.get());
ImplConfiguration.TEST.set(TestModel.random());
System.out.println("----------------------------------------------------");
}
public static void testDemo(YamlConfigProvider provider) {
provider.initialize(DemoConfiguration.class);
}
public static void testComplex(YamlConfigProvider provider) {
System.out.println("----------------------------------------------------");
provider.initialize(ComplexConfiguration.class);
System.out.println("> Test Value:");
System.out.println("before: " + ComplexConfiguration.Sub.UUID_CONFIG_VALUE.get());
ComplexConfiguration.Sub.UUID_CONFIG_VALUE.set(UUID.randomUUID());
System.out.println("after: " + ComplexConfiguration.Sub.UUID_CONFIG_VALUE.get());
System.out.println("> Test List:");
ComplexConfiguration.Sub.That.Operators.getNotNull().forEach(System.out::println);
List<UUID> operators = IntStream.range(0, 5).mapToObj(i -> UUID.randomUUID()).collect(Collectors.toList());
ComplexConfiguration.Sub.That.Operators.set(operators);
System.out.println("> Test Section:");
System.out.println(ComplexConfiguration.USER.get());
ComplexConfiguration.USER.set(TestModel.random());
System.out.println("> Test Maps:");
ComplexConfiguration.USERS.getNotNull().forEach((k, v) -> System.out.println(k + ": " + v));
LinkedHashMap<Integer, UUID> data = new LinkedHashMap<>();
for (int i = 0; i < 5; i++) {
data.put((int) (1000 * Math.random()), UUID.randomUUID());
}
ComplexConfiguration.USERS.set(data);
System.out.println("----------------------------------------------------");
}
}

View File

@ -1,18 +1,22 @@
package config.misc;
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;
public class TestUser {
@SerializableAs("TestModel")
public class TestModel implements ConfigurationSerializable {
public String name;
public UUID uuid;
public TestUser(String name, UUID uuid) {
public TestModel(String name, UUID uuid) {
this.name = name;
this.uuid = uuid;
}
@ -33,6 +37,7 @@ public class TestUser {
return uuid;
}
@Override
public @NotNull Map<String, Object> serialize() {
Map<String, Object> map = new HashMap<>();
map.put("name", name);
@ -42,14 +47,30 @@ public class TestUser {
return map;
}
public static TestUser deserialize(ConfigurationWrapper section) throws Exception {
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 TestUser(name, UUID.fromString(uuidString));
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{" +

View File

@ -8,7 +8,7 @@ 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.misc.TestUser;
import config.model.TestModel;
import java.util.List;
import java.util.Map;
@ -18,11 +18,11 @@ import java.util.UUID;
public class ComplexConfiguration extends ConfigurationRoot {
@ConfigComment({"User测试"})
public static final ConfigValue<TestUser> USER = ConfiguredSection
.builder(TestUser.class)
.defaults(new TestUser("Carm", UUID.randomUUID()))
.parseValue((section, defaultValue) -> TestUser.deserialize(section))
.serializeValue(TestUser::serialize).build();
public static final ConfigValue<TestModel> USER = ConfiguredSection
.builder(TestModel.class)
.defaults(new TestModel("Carm", UUID.randomUUID()))
.parseValue((section, defaultValue) -> TestModel.deserialize(section))
.serializeValue(TestModel::serialize).build();
@ConfigComment({"[ID-UUID] 对照表", "", "用于测试Map类型的解析与序列化保存"})
public static final ConfigValue<Map<Integer, UUID>> USERS = ConfiguredMap

View File

@ -0,0 +1,14 @@
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.TestModel;
@ConfigPath("ImplConfiguration")
public class ImplConfiguration extends ConfigurationRoot {
public static final ConfigValue<TestModel> TEST = ConfiguredSerializable.of(TestModel.class);
}

View File

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

View File

@ -1,6 +1,6 @@
package cc.carm.lib.configuration.bungee;
import cc.carm.lib.configuration.core.source.ConfigurationWrapper;
import cc.carm.lib.configuration.core.ConfigInitializer;
import cc.carm.lib.configuration.core.source.impl.FileConfigProvider;
import net.md_5.bungee.config.Configuration;
import net.md_5.bungee.config.ConfigurationProvider;
@ -11,9 +11,10 @@ import org.jetbrains.annotations.Nullable;
import java.io.File;
import java.io.IOException;
public class BungeeConfigProvider extends FileConfigProvider {
public class BungeeConfigProvider extends FileConfigProvider<BungeeSectionWrapper> {
Configuration configuration;
protected Configuration configuration;
protected ConfigInitializer<BungeeConfigProvider> initializer;
public BungeeConfigProvider(@NotNull File file) {
super(file);
@ -21,10 +22,11 @@ public class BungeeConfigProvider extends FileConfigProvider {
public void initializeConfig() throws IOException {
this.configuration = getLoader().load(file);
this.initializer = new ConfigInitializer<>(this);
}
@Override
public @NotNull ConfigurationWrapper getConfiguration() {
public @NotNull BungeeSectionWrapper getConfiguration() {
return BungeeSectionWrapper.of(configuration);
}
@ -47,6 +49,11 @@ public class BungeeConfigProvider extends FileConfigProvider {
return null;
}
@Override
public @NotNull ConfigInitializer<BungeeConfigProvider> getInitializer() {
return this.initializer;
}
public static ConfigurationProvider getLoader() {
return ConfigurationProvider.getProvider(YamlConfiguration.class);
}

View File

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

View File

@ -17,7 +17,7 @@ import java.util.Iterator;
import java.util.List;
/**
* An hacky extension of {@link Yaml} that allows to write comments when dumping.
* A hacky extension of {@link Yaml} that allows to write comments when dumping.
*/
public class CommentedYaml extends Yaml {

View File

@ -1,17 +1,18 @@
package cc.carm.lib.configuration.spigot;
import cc.carm.lib.configuration.commented.CommentedYamlConfiguration;
import cc.carm.lib.configuration.core.source.ConfigurationWrapper;
import cc.carm.lib.configuration.core.ConfigInitializer;
import cc.carm.lib.configuration.core.source.impl.FileConfigProvider;
import cc.carm.lib.configuration.commented.CommentedYamlConfiguration;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.io.File;
public class SpigotConfigProvider extends FileConfigProvider {
public class SpigotConfigProvider extends FileConfigProvider<SpigotSectionWrapper> {
ConfigComments comments = new ConfigComments();
CommentedYamlConfiguration configuration;
protected final ConfigComments comments = new ConfigComments();
protected ConfigInitializer<SpigotConfigProvider> initializer;
protected CommentedYamlConfiguration configuration;
public SpigotConfigProvider(@NotNull File file) {
super(file);
@ -19,10 +20,15 @@ public class SpigotConfigProvider extends FileConfigProvider {
public void initializeConfig() {
this.configuration = CommentedYamlConfiguration.loadConfiguration(comments, file);
this.initializer = new ConfigInitializer<>(this);
}
public void say() {
System.out.println("Hello");
}
@Override
public @NotNull ConfigurationWrapper getConfiguration() {
public @NotNull SpigotSectionWrapper getConfiguration() {
return SpigotSectionWrapper.of(configuration);
}
@ -46,4 +52,9 @@ public class SpigotConfigProvider extends FileConfigProvider {
return this.comments.get(path);
}
@Override
public @NotNull ConfigInitializer<SpigotConfigProvider> getInitializer() {
return this.initializer;
}
}

View File

@ -2,6 +2,7 @@ package cc.carm.lib.configuration.spigot;
import cc.carm.lib.configuration.core.source.ConfigurationWrapper;
import org.bukkit.configuration.ConfigurationSection;
import org.bukkit.configuration.serialization.ConfigurationSerializable;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@ -68,4 +69,17 @@ public class SpigotSectionWrapper implements ConfigurationWrapper {
public @Nullable ConfigurationWrapper getConfigurationSection(@NotNull String path) {
return of(this.section.getConfigurationSection(path));
}
@Nullable
public <T extends ConfigurationSerializable> T getSerializable(@NotNull String path, @NotNull Class<T> clazz) {
return getSerializable(path, clazz, null);
}
@Nullable
@Contract("_, _, !null -> !null")
public <T extends ConfigurationSerializable> T getSerializable(@NotNull String path, @NotNull Class<T> clazz, @Nullable T defaultValue) {
return this.section.getSerializable(path, clazz, defaultValue);
}
}

View File

@ -0,0 +1,32 @@
package cc.carm.lib.configuration.spigot;
import cc.carm.lib.configuration.core.source.ConfigurationProvider;
import cc.carm.lib.configuration.core.value.impl.CachedConfigValue;
import cc.carm.lib.configuration.spigot.builder.SpigotConfigBuilder;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
public abstract class SpigotValue<T> extends CachedConfigValue<T> {
public static @NotNull SpigotConfigBuilder builder() {
return new SpigotConfigBuilder();
}
public SpigotValue(@Nullable SpigotConfigProvider provider,
@Nullable String configPath, @NotNull String[] comments, @Nullable T defaultValue) {
super(provider, configPath, comments, defaultValue);
}
public SpigotConfigProvider getSpigotProvider() {
ConfigurationProvider<?> provider = getProvider();
if (provider instanceof SpigotConfigProvider) return (SpigotConfigProvider) getProvider();
else throw new IllegalStateException("Provider is not a SpigotConfigProvider");
}
public SpigotSectionWrapper getSpigotConfig() {
return getSpigotProvider().getConfiguration();
}
}

View File

@ -0,0 +1,13 @@
package cc.carm.lib.configuration.spigot.builder;
import cc.carm.lib.configuration.core.builder.AbstractConfigBuilder;
import cc.carm.lib.configuration.spigot.SpigotConfigProvider;
public abstract class AbstractSpigotBuilder<T, B extends AbstractSpigotBuilder<T, B>>
extends AbstractConfigBuilder<T, B, SpigotConfigProvider> {
public AbstractSpigotBuilder() {
super(SpigotConfigProvider.class);
}
}

View File

@ -0,0 +1,14 @@
package cc.carm.lib.configuration.spigot.builder;
import cc.carm.lib.configuration.core.builder.ConfigBuilder;
import cc.carm.lib.configuration.spigot.builder.serializable.SerializableBuilder;
import org.bukkit.configuration.serialization.ConfigurationSerializable;
import org.jetbrains.annotations.NotNull;
public class SpigotConfigBuilder extends ConfigBuilder {
public <V extends ConfigurationSerializable> @NotNull SerializableBuilder<V> ofSerializable(@NotNull Class<V> valueClass) {
return new SerializableBuilder<>(valueClass);
}
}

View File

@ -0,0 +1,29 @@
package cc.carm.lib.configuration.spigot.builder.serializable;
import cc.carm.lib.configuration.spigot.builder.AbstractSpigotBuilder;
import cc.carm.lib.configuration.spigot.value.ConfiguredSerializable;
import org.bukkit.configuration.serialization.ConfigurationSerializable;
import org.jetbrains.annotations.NotNull;
public class SerializableBuilder<T extends ConfigurationSerializable>
extends AbstractSpigotBuilder<T, SerializableBuilder<T>> {
protected final @NotNull Class<T> valueClass;
public SerializableBuilder(@NotNull Class<T> valueClass) {
this.valueClass = valueClass;
}
@Override
protected @NotNull SerializableBuilder<T> getThis() {
return this;
}
@Override
public @NotNull ConfiguredSerializable<T> build() {
return new ConfiguredSerializable<>(this.provider, this.path, this.comments, this.valueClass, this.defaultValue);
}
}

View File

@ -0,0 +1,4 @@
package cc.carm.lib.configuration.spigot.item;
public class ItemConfiguration {
}

View File

@ -0,0 +1,4 @@
package cc.carm.lib.configuration.spigot.value;
public class ConfiguredItem {
}

View File

@ -0,0 +1,52 @@
package cc.carm.lib.configuration.spigot.value;
import cc.carm.lib.configuration.spigot.SpigotConfigProvider;
import cc.carm.lib.configuration.spigot.SpigotValue;
import org.bukkit.configuration.serialization.ConfigurationSerializable;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Optional;
public class ConfiguredSerializable<T extends ConfigurationSerializable> extends SpigotValue<T> {
public static <V extends ConfigurationSerializable> ConfiguredSerializable<V> of(@NotNull Class<V> valueClass) {
return of(valueClass, null);
}
public static <V extends ConfigurationSerializable> ConfiguredSerializable<V> of(@NotNull Class<V> valueClass,
@Nullable V defaultValue) {
return builder().ofSerializable(valueClass).defaults(defaultValue).build();
}
protected final @NotNull Class<T> valueClass;
public ConfiguredSerializable(@Nullable SpigotConfigProvider provider,
@Nullable String configPath, @NotNull String[] comments,
@NotNull Class<T> valueClass, @Nullable T defaultValue) {
super(provider, configPath, comments, defaultValue);
this.valueClass = valueClass;
}
@Override
public @Nullable T get() {
if (isExpired()) { // 已过时的数据需要重新解析一次
try {
// 若未出现错误则直接更新缓存并返回
return updateCache(getSpigotConfig().getSerializable(getConfigPath(), valueClass, getDefaultValue()));
} catch (Exception e) {
// 出现了解析错误提示并返回默认值
e.printStackTrace();
return useDefault();
}
} else return Optional.ofNullable(getCachedValue()).orElse(defaultValue);
}
@Override
public void set(@Nullable T value) {
updateCache(value);
setValue(value);
}
}

View File

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