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

feat(yaml): Finished YAML Provider

Browse Source
This commit is contained in:
Carm Jos
2025-02-13 06:48:58 +08:00
parent 5b95824bb0
commit 47e2a4854c
27 changed files with 357 additions and 426 deletions
Download Patch File Download Diff File Expand all files Collapse all files
providers/gson/pom.xml
+7
View File
@@ -34,6 +34,13 @@
<scope>compile</scope>
</dependency>
<dependency>
<groupId>${project.parent.groupId}</groupId>
<artifactId>easyconfiguration-feature-section</artifactId>
<version>${project.parent.version}</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>${project.parent.groupId}</groupId>
<artifactId>easyconfiguration-demo</artifactId>
providers/gson/src/main/java/cc/carm/lib/configuration/source/json/JSONConfigFactory.java
+5 -6
View File
@@ -28,7 +28,7 @@ public class JSONConfigFactory extends FileConfigFactory<JSONSource, Configurati
}
@Override
public JSONConfigFactory self() {
protected JSONConfigFactory self() {
return this;
}
@@ -37,10 +37,6 @@ public class JSONConfigFactory extends FileConfigFactory<JSONSource, Configurati
return self();
}
public JSONConfigFactory gson(@NotNull Gson gson) {
return gson(() -> gson);
}
public JSONConfigFactory gson(@NotNull Consumer<GsonBuilder> builder) {
return gson(() -> {
GsonBuilder gsonBuilder = new GsonBuilder();
@@ -49,6 +45,9 @@ public class JSONConfigFactory extends FileConfigFactory<JSONSource, Configurati
});
}
public JSONConfigFactory gson(@NotNull Gson gson) {
return gson(() -> gson);
}
@Override
public @NotNull ConfigurationHolder<JSONSource> build() {
@@ -59,7 +58,7 @@ public class JSONConfigFactory extends FileConfigFactory<JSONSource, Configurati
String sourcePath = this.resourcePath;
return new ConfigurationHolder<JSONSource>(this.adapters, this.options, new ConcurrentHashMap<>(), this.initializer) {
final JSONSource source = new JSONSource(this, 0, configFile, sourcePath, gson);
final JSONSource source = new JSONSource(this, configFile, sourcePath, gson);
@Override
public @NotNull JSONSource config() {
providers/gson/src/main/java/cc/carm/lib/configuration/source/json/JSONSection.java
-156
View File
@@ -1,156 +0,0 @@
package cc.carm.lib.configuration.source.json;
import cc.carm.lib.configuration.source.section.ConfigureSection;
import cc.carm.lib.configuration.source.section.ConfigureSource;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.*;
public class JSONSection implements ConfigureSection {
protected final @NotNull ConfigureSource<? extends JSONSection, ?, ?> source;
protected final @NotNull Map<String, Object> data;
protected final @Nullable JSONSection parent;
public JSONSection(@NotNull ConfigureSource<? extends JSONSection, ?, ?> source,
@NotNull Map<?, ?> data, @Nullable JSONSection parent) {
this.source = source;
this.parent = parent;
this.data = new LinkedHashMap<>();
for (Map.Entry<?, ?> entry : data.entrySet()) {
String key = (entry.getKey() == null) ? "null" : entry.getKey().toString();
if (entry.getValue() instanceof Map) {
this.data.put(key, new JSONSection(source, (Map<?, ?>) entry.getValue(), this));
} else if (entry.getValue() instanceof List) {
List<Object> list = new ArrayList<>();
for (Object obj : (List<?>) entry.getValue()) {
if (obj instanceof Map) {
list.add(new JSONSection(source, (Map<?, ?>) obj, this));
} else {
list.add(obj);
}
}
this.data.put(key, list);
} else {
this.data.put(key, entry.getValue());
}
}
}
@Override
public @NotNull ConfigureSource<? extends JSONSection, ?, ?> source() {
return this.source;
}
public @NotNull Map<String, Object> data() {
return this.data;
}
public @Nullable JSONSection parent() {
return this.parent;
}
@Override
public @NotNull Map<String, Object> getValues(boolean deep) {
if (deep) {
Map<String, Object> values = new LinkedHashMap<>();
mapChildrenValues(values, this, null, true);
return Collections.unmodifiableMap(values);
} else return Collections.unmodifiableMap(data());
}
@Override
public void set(@NotNull String path, @Nullable Object value) {
if (value instanceof Map) {
value = new JSONSection(source(), (Map<?, ?>) value, this);
}
JSONSection section = getSectionFor(path);
if (section == this) {
if (value == null) {
this.data.remove(path);
} else {
this.data.put(path, value);
}
} else {
section.set(getChild(path), value);
}
}
@Override
public boolean contains(@NotNull String path) {
return get(path) != null;
}
@Override
public @Nullable Object get(@NotNull String path) {
JSONSection section = getSectionFor(path);
return section == this ? data.get(path) : section.get(getChild(path));
}
@Override
public boolean isList(@NotNull String path) {
return get(path) instanceof List<?>;
}
@Override
public @Nullable List<?> getList(@NotNull String path) {
Object val = get(path);
return (val instanceof List<?>) ? (List<?>) val : null;
}
@Override
public boolean isSection(@NotNull String path) {
return get(path) instanceof JSONSection;
}
@Override
public @Nullable ConfigureSection getSection(@NotNull String path) {
Object val = get(path);
return (val instanceof ConfigureSection) ? (ConfigureSection) val : null;
}
private JSONSection getSectionFor(String path) {
int index = path.indexOf(separator());
if (index == -1) return this;
String root = path.substring(0, index);
Object section = this.data.get(root);
if (section == null) {
section = new JSONSection(source(), new LinkedHashMap<>(), this);
this.data.put(root, section);
}
return (JSONSection) section;
}
private String getChild(String path) {
int index = path.indexOf(separator());
return (index == -1) ? path : path.substring(index + 1);
}
/**
* Map the values of the children of the section to the output map.
*
* @param output The map to map the values to
* @param section The section to map the values from
* @param parent The parent path
* @param deep If the mapping should be deep
* @author md_5, sk89q
*/
protected void mapChildrenValues(@NotNull Map<String, Object> output, @NotNull JSONSection section,
@Nullable String parent, boolean deep) {
for (Map.Entry<String, Object> entry : section.data().entrySet()) {
String path = (parent == null ? "" : parent + separator()) + entry.getKey();
output.remove(path);
output.put(path, entry.getValue());
if (deep && entry.getValue() instanceof JSONSection) {
this.mapChildrenValues(output, (JSONSection) entry.getValue(), path, true);
}
}
}
}
providers/gson/src/main/java/cc/carm/lib/configuration/source/json/JSONSource.java
+22 -21
View File
@@ -2,36 +2,38 @@ package cc.carm.lib.configuration.source.json;
import cc.carm.lib.configuration.source.ConfigurationHolder;
import cc.carm.lib.configuration.source.file.FileConfigSource;
import cc.carm.lib.configuration.source.section.ConfigureSource;
import cc.carm.lib.configuration.source.section.MemorySection;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonSerializer;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.io.*;
import java.util.*;
import java.io.File;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Objects;
public class JSONSource extends FileConfigSource<JSONSection, Map<?, ?>, JSONSource> {
public class JSONSource extends FileConfigSource<MemorySection, Map<?, ?>, JSONSource> {
public static final @NotNull Gson DEFAULT_GSON = new GsonBuilder()
.serializeNulls().disableHtmlEscaping().setPrettyPrinting()
.registerTypeAdapter(
JSONSection.class,
(JsonSerializer<JSONSection>) (src, typeOfSrc, context) -> context.serialize(src.data)
MemorySection.class,
(JsonSerializer<MemorySection>) (src, t, c) -> c.serialize(src.data())
).create();
protected final @NotNull Gson gson;
protected @Nullable JSONSection rootSection;
protected @Nullable MemorySection rootSection;
protected JSONSource(@NotNull ConfigurationHolder<? extends JSONSource> holder, long lastUpdateMillis,
protected JSONSource(@NotNull ConfigurationHolder<? extends JSONSource> holder,
@NotNull File file, @Nullable String resourcePath) {
this(holder, lastUpdateMillis, file, resourcePath, DEFAULT_GSON);
this(holder, file, resourcePath, DEFAULT_GSON);
}
protected JSONSource(@NotNull ConfigurationHolder<? extends JSONSource> holder, long lastUpdateMillis,
protected JSONSource(@NotNull ConfigurationHolder<? extends JSONSource> holder,
@NotNull File file, @Nullable String resourcePath, @NotNull Gson gson) {
super(holder, lastUpdateMillis, file, resourcePath);
super(holder, 0, file, resourcePath);
this.gson = gson;
initialize();
}
@@ -50,19 +52,14 @@ public class JSONSource extends FileConfigSource<JSONSection, Map<?, ?>, JSONSou
return this;
}
@Override
public @NotNull ConfigureSource<?, ?, ?> source() {
return this;
}
@Override
public @NotNull Map<?, ?> original() {
return section().data();
}
@Override
public @NotNull JSONSection section() {
return Objects.requireNonNull(this.rootSection, "Section is not initialized");
public @NotNull MemorySection section() {
return Objects.requireNonNull(this.rootSection, "Root section is not initialized");
}
@Override
@@ -70,11 +67,15 @@ public class JSONSource extends FileConfigSource<JSONSection, Map<?, ?>, JSONSou
fileWriter(writer -> gson.toJson(original(), writer));
}
public @NotNull String saveToString() {
return gson.toJson(original());
}
@Override
protected void onReload() throws Exception {
Map<?, ?> data = fileReader(reader -> gson.fromJson(reader, LinkedHashMap.class));
if (data == null) data = new LinkedHashMap<>();
this.rootSection = new JSONSection(this, data, null);
this.rootSection = MemorySection.root(
this, fileReader(reader -> gson.fromJson(reader, LinkedHashMap.class))
);
this.lastUpdateMillis = System.currentTimeMillis(); // 更新时间
}
}
providers/yaml/pom.xml
+14
View File
@@ -42,6 +42,20 @@
<scope>compile</scope>
</dependency>
<dependency>
<groupId>${project.parent.groupId}</groupId>
<artifactId>easyconfiguration-feature-section</artifactId>
<version>${project.parent.version}</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>${project.parent.groupId}</groupId>
<artifactId>easyconfiguration-feature-commentable</artifactId>
<version>${project.parent.version}</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>org.yaml</groupId>
<artifactId>snakeyaml</artifactId>
providers/yaml/src/main/java/cc/carm/lib/configuration/source/yaml/YAMLSection.java
-76
View File
@@ -1,76 +0,0 @@
package cc.carm.lib.configuration.source.yaml;
import cc.carm.lib.configuration.source.section.ConfigureSection;
import cc.carm.lib.configuration.source.section.ConfigureSource;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.annotations.UnmodifiableView;
import java.util.Collections;
import java.util.List;
import java.util.Map;
public class YAMLSection implements ConfigureSection {
protected final @NotNull ConfigureSource<? extends YAMLSection, ?, ?> source;
protected final @NotNull Map<String, Object> data;
protected final @Nullable YAMLSection parent;
public YAMLSection(@NotNull ConfigureSource<? extends YAMLSection, ?, ?> source,
@NotNull Map<String, Object> data, @Nullable YAMLSection parent) {
this.source = source;
this.data = data;
this.parent = parent;
}
@Override
public @NotNull ConfigureSource<?, ?, ?> source() {
return this.source;
}
@Override
public @Nullable YAMLSection parent() {
return this.parent;
}
@Override
public @NotNull @UnmodifiableView Map<String, Object> getValues(boolean deep) {
return Collections.emptyMap();
}
@Override
public void set(@NotNull String path, @Nullable Object value) {
}
@Override
public boolean contains(@NotNull String path) {
return false;
}
@Override
public boolean isList(@NotNull String path) {
return false;
}
@Override
public @Nullable List<?> getList(@NotNull String path) {
return Collections.emptyList();
}
@Override
public boolean isSection(@NotNull String path) {
return false;
}
@Override
public @Nullable YAMLSection getSection(@NotNull String path) {
return null;
}
@Override
public @Nullable Object get(@NotNull String path) {
return null;
}
}
providers/yaml/src/test/java/sample/Sample.java
-15
View File
@@ -1,15 +0,0 @@
package sample;
public class Sample {
public static void main(String[] args) {
// 1. Make a configuration provider from a file.
ConfigurationProvider<?> provider = EasyConfiguration.from("config.yml");
// 2. Initialize the configuration classes or instances.
provider.initialize(SampleConfig.class);
// 3. Enjoy using the configuration!
SampleConfig.ENABLED.set(false);
System.out.println("Your name is " + SampleConfig.INFO.NAME.getNotNull() + " !");
}
}
providers/yaml/src/test/java/sample/SampleConfig.java
+4 -2
View File
@@ -1,6 +1,6 @@
package sample;
import cc.carm.lib.configuration.source.Configuration;
import cc.carm.lib.configuration.Configuration;
import cc.carm.lib.configuration.annotation.ConfigPath;
import cc.carm.lib.configuration.annotation.HeaderComment;
import cc.carm.lib.configuration.annotation.InlineComment;
@@ -9,6 +9,7 @@ import cc.carm.lib.configuration.value.standard.ConfiguredValue;
import java.util.UUID;
@ConfigPath(root = true)
@HeaderComment("Configurations for sample")
public interface SampleConfig extends Configuration {
@@ -16,12 +17,13 @@ public interface SampleConfig extends Configuration {
ConfiguredValue<Boolean> ENABLED = ConfiguredValue.of(true);
ConfiguredList<UUID> UUIDS = ConfiguredList.builderOf(UUID.class).fromString()
.parseValue(UUID::fromString).serializeValue(UUID::toString)
.parse(UUID::fromString).serialize(UUID::toString)
.defaults(
UUID.fromString("00000000-0000-0000-0000-000000000000"),
UUID.fromString("00000000-0000-0000-0000-000000000001")
).build();
@ConfigPath("info") // Custom path
interface INFO extends Configuration {
@HeaderComment("Configure your name!") // Header comment
providers/yaml/src/test/java/sample/SampleTest.java
+24
View File
@@ -0,0 +1,24 @@
package sample;
import cc.carm.lib.configuration.source.ConfigurationHolder;
import cc.carm.lib.configuration.source.yaml.YAMLConfigFactory;
import org.junit.Test;
public class SampleTest {
@Test
public void test() {
// 1. Make a configuration provider from a file.
ConfigurationHolder<?> holder = YAMLConfigFactory.from("target/config.yml")
.resourcePath("configs/sample.yml")
.indent(4) // Optional: Set the indentation of the configuration file.
.build();
// 2. Initialize the configuration classes or instances.
holder.initialize(SampleConfig.class);
// 3. Enjoy using the configuration!
SampleConfig.ENABLED.set(false);
System.out.println("Your name is " + SampleConfig.INFO.NAME.resolve() + " (age=" + SampleConfig.INFO.AGE.resolve() + ")!");
}
}
providers/yaml/src/test/resources/test/test2/config.yml → providers/yaml/src/test/resources/configs/sample.yml
View File