[1.2.0]

- [A] 令 ConfiguredMessage 同时支持Bungee、Bukkit平台。 - [A] 为Bukkit相关平台原生支持PlaceholderAPI。
2026-06-04 13:55:03 +08:00 · 2022-04-29 04:17:38 +08:00
parent 4850514a8a
commit 0cd61842e5
36 changed files with 1054 additions and 380 deletions
@@ -0,0 +1,65 @@
+<?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>mineconfiguration-parent</artifactId>
+        <groupId>cc.carm.lib</groupId>
+        <version>1.2.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>
+    </properties>
+    <artifactId>mineconfiguration-common</artifactId>
+
+    <dependencies>
+
+        <dependency>
+            <groupId>${project.parent.groupId}</groupId>
+            <artifactId>easyconfiguration-core</artifactId>
+            <version>${easyconfiguration.version}</version>
+            <scope>compile</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>de.themoep</groupId>
+            <artifactId>minedown</artifactId>
+            <version>1.7.1-SNAPSHOT</version>
+            <scope>compile</scope>
+            <optional>true</optional>
+        </dependency>
+
+        <dependency>
+            <groupId>net.md-5</groupId>
+            <artifactId>bungeecord-chat</artifactId>
+            <version>1.16-R0.4</version>
+            <scope>provided</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>
@@ -0,0 +1,45 @@
+package cc.carm.lib.configuration.common.builder.message;
+
+import cc.carm.lib.configuration.common.data.AbstractText;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.function.BiFunction;
+import java.util.function.Function;
+
+public abstract class MessageConfigBuilder<R, T extends AbstractText<R>> {
+
+    /**
+     * 默认的变量格式为 {@code %(变量名)}。
+     */
+    public static Function<@NotNull String, @NotNull String> DEFAULT_PARAM_FORMATTER = (s) -> "%(" + s + ")";
+
+    protected final @NotNull Class<R> receiverClazz;
+    protected final @NotNull Class<T> textClazz;
+
+    public MessageConfigBuilder(@NotNull Class<R> receiverClazz,
+                                @NotNull Class<T> textClazz) {
+        this.receiverClazz = receiverClazz;
+        this.textClazz = textClazz;
+    }
+
+    /**
+     * 以单条消息为目标，构建一个消息配置。
+     *
+     * @param parser 消息解析器，负责将String转换为目标消息类型。
+     * @param <M>    消息类型
+     * @return 单条消息构建器
+     */
+    public abstract <M> @NotNull MessageValueBuilder<M, R, T, ?> asValue(@NotNull BiFunction<@Nullable R, @NotNull String, @Nullable M> parser);
+
+    /**
+     * 以多行消息为目标，构建一个消息配置。
+     *
+     * @param parser 消息解析器
+     * @param <M>    消息类型
+     * @return 多行消息构建器
+     */
+    public abstract <M> @NotNull MessageListBuilder<M, R, T, ?> asList(@NotNull BiFunction<@Nullable R, @NotNull String, @Nullable M> parser);
+
+
+}
@@ -0,0 +1,75 @@
+package cc.carm.lib.configuration.common.builder.message;
+
+
+import cc.carm.lib.configuration.common.data.AbstractText;
+import cc.carm.lib.configuration.common.value.ConfigMessageList;
+import cc.carm.lib.configuration.core.builder.CommonConfigBuilder;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.function.BiConsumer;
+import java.util.function.BiFunction;
+import java.util.function.Function;
+import java.util.stream.Collectors;
+
+import static cc.carm.lib.configuration.common.builder.message.MessageConfigBuilder.DEFAULT_PARAM_FORMATTER;
+
+public abstract class MessageListBuilder<M, R, T extends AbstractText<R>, B extends MessageListBuilder<M, R, T, B>>
+        extends CommonConfigBuilder<List<T>, B> {
+
+    protected final @NotNull Class<R> receiverClazz;
+
+    protected @NotNull String[] params;
+    protected @NotNull BiFunction<@Nullable R, @NotNull String, @Nullable M> messageParser;
+    protected @NotNull BiConsumer<@NotNull R, @NotNull List<M>> sendFunction;
+
+    protected @NotNull Function<@NotNull String, @NotNull String> paramFormatter;
+    protected final @NotNull Function<String, T> textBuilder;
+
+    public MessageListBuilder(@NotNull Class<R> receiverClazz,
+                              @NotNull Function<String, T> textBuilder,
+                              @NotNull BiFunction<@Nullable R, @NotNull String, @Nullable M> parser) {
+        this.receiverClazz = receiverClazz;
+        this.textBuilder = textBuilder;
+        this.params = new String[0];
+        this.messageParser = parser;
+        this.paramFormatter = DEFAULT_PARAM_FORMATTER;
+        this.sendFunction = (sender, M) -> {
+        };
+    }
+
+    public B defaults(@NotNull String... messages) {
+        return defaults(new ArrayList<>(Arrays.stream(messages).map(textBuilder).collect(Collectors.toList())));
+    }
+
+    public B params(@NotNull String... params) {
+        this.params = params;
+        return getThis();
+    }
+
+    public B params(@NotNull List<String> params) {
+        this.params = params.toArray(new String[0]);
+        return getThis();
+    }
+
+    public B formatParam(@NotNull Function<@NotNull String, @NotNull String> paramFormatter) {
+        this.paramFormatter = paramFormatter;
+        return getThis();
+    }
+
+    public B whenSend(@NotNull BiConsumer<@NotNull R, @NotNull List<M>> sendFunction) {
+        this.sendFunction = sendFunction;
+        return getThis();
+    }
+
+    @Override
+    public abstract @NotNull ConfigMessageList<M, T, R> build();
+
+    protected final String[] buildParams() {
+        return Arrays.stream(params).map(param -> paramFormatter.apply(param)).toArray(String[]::new);
+    }
+
+}
@@ -0,0 +1,73 @@
+package cc.carm.lib.configuration.common.builder.message;
+
+import cc.carm.lib.configuration.common.data.AbstractText;
+import cc.carm.lib.configuration.common.value.ConfigMessage;
+import cc.carm.lib.configuration.core.builder.CommonConfigBuilder;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Arrays;
+import java.util.List;
+import java.util.function.BiConsumer;
+import java.util.function.BiFunction;
+import java.util.function.Function;
+
+import static cc.carm.lib.configuration.common.builder.message.MessageConfigBuilder.DEFAULT_PARAM_FORMATTER;
+
+public abstract class MessageValueBuilder<M, R, T extends AbstractText<R>, B extends MessageValueBuilder<M, R, T, B>>
+        extends CommonConfigBuilder<T, B> {
+
+
+    protected final @NotNull Class<R> receiverClazz;
+    protected @NotNull String[] params;
+    protected @NotNull BiFunction<@Nullable R, @NotNull String, @Nullable M> messageParser;
+    protected @NotNull BiConsumer<@NotNull R, @NotNull M> sendHandler;
+
+    protected @NotNull Function<@NotNull String, @NotNull String> paramFormatter;
+
+    protected final @NotNull Function<String, T> textBuilder;
+
+    public MessageValueBuilder(@NotNull Class<R> receiverClazz,
+                               @NotNull Function<String, T> textBuilder,
+                               @NotNull BiFunction<@Nullable R, @NotNull String, @Nullable M> parser) {
+        this.receiverClazz = receiverClazz;
+        this.params = new String[0];
+        this.paramFormatter = DEFAULT_PARAM_FORMATTER;
+        this.textBuilder = textBuilder;
+        this.messageParser = parser;
+        this.sendHandler = (receiver, M) -> {
+        };
+    }
+
+    public B defaults(@NotNull String message) {
+        return defaults(this.textBuilder.apply(message));
+    }
+
+    public B params(@NotNull String... params) {
+        this.params = params;
+        return getThis();
+    }
+
+    public B params(@NotNull List<String> params) {
+        this.params = params.toArray(new String[0]);
+        return getThis();
+    }
+
+    public B formatParam(@NotNull Function<@NotNull String, @NotNull String> paramFormatter) {
+        this.paramFormatter = paramFormatter;
+        return getThis();
+    }
+
+    public B whenSend(@NotNull BiConsumer<@NotNull R, @NotNull M> sendFunction) {
+        this.sendHandler = sendFunction;
+        return getThis();
+    }
+
+    @Override
+    public abstract @NotNull ConfigMessage<M, T, R> build();
+
+    protected final String[] buildParams() {
+        return Arrays.stream(params).map(param -> paramFormatter.apply(param)).toArray(String[]::new);
+    }
+
+}
@@ -0,0 +1,65 @@
+package cc.carm.lib.configuration.common.data;
+
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.function.BiFunction;
+
+/**
+ * @param <R> Receiver type
+ */
+public abstract class AbstractText<R> {
+
+    private final @NotNull Class<R> receiverClazz;
+    protected @NotNull String message;
+
+    public AbstractText(@NotNull Class<R> receiverClazz, @NotNull String message) {
+        this.receiverClazz = receiverClazz;
+        this.message = message;
+    }
+
+    public @NotNull Class<R> getReceiverClazz() {
+        return receiverClazz;
+    }
+
+    public @NotNull String getMessage() {
+        return this.message;
+    }
+
+    public <M> @Nullable M parse(@NotNull BiFunction<@Nullable R, @NotNull String, @NotNull M> parser,
+                                 @Nullable R receiver, @Nullable String[] params, @Nullable Object[] values) {
+        return parse(parser, receiver, buildParams(params, values));
+    }
+
+    public <M> @Nullable M parse(@NotNull BiFunction<@Nullable R, @NotNull String, @NotNull M> parser,
+                                 @Nullable R receiver, @NotNull Map<String, Object> placeholders) {
+        String message = getMessage();
+        if (message.isEmpty()) return null; // No further processing
+        else return parser.apply(receiver, setPlaceholders(message, placeholders));
+    }
+
+    public static Map<String, Object> buildParams(@Nullable String[] params, @Nullable Object[] values) {
+        Map<String, Object> map = new HashMap<>();
+        if (params == null || params.length == 0) return map;
+        for (int i = 0; i < params.length; i++) {
+            map.put(params[i], values.length > i ? values[i] : "?");
+        }
+        return map;
+    }
+
+    public static String setPlaceholders(@NotNull String messages, @NotNull Map<String, Object> placeholders) {
+        if (messages.isEmpty()) return messages;
+
+        String parsed = messages;
+        for (Map.Entry<String, Object> entry : placeholders.entrySet()) {
+            Object value = entry.getValue();
+            parsed = parsed.replace(entry.getKey(), value == null ? "" : value.toString());
+        }
+
+        return parsed;
+    }
+
+
+}
@@ -0,0 +1,48 @@
+package cc.carm.lib.configuration.common.utils;
+
+import java.util.Arrays;
+import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+
+public class ColorParser {
+
+    public static String parse(String text) {
+        return parseBaseColor(parseHexColor(text));
+    }
+
+    public static String[] parse(String... texts) {
+        return parse(Arrays.asList(texts)).toArray(new String[0]);
+    }
+
+    public static List<String> parse(List<String> texts) {
+        return texts.stream().map(ColorParser::parse).collect(Collectors.toList());
+    }
+
+    public static String parseBaseColor(final String text) {
+        return text.replaceAll("&", "§").replace("§§", "&");
+    }
+
+    /**
+     * Parse HEXColor code like <blockquote><pre>&amp;(#000000)</pre></blockquote> to minecraft colored text.
+     *
+     * @param text the text to parse
+     * @return color parsed
+     */
+    public static String parseHexColor(String text) {
+        Pattern pattern = Pattern.compile("&\\((&?#[0-9a-fA-F]{6})\\)");
+        Matcher matcher = pattern.matcher(text);
+        while (matcher.find()) {
+            String hexColor = text.substring(matcher.start() + 2, matcher.end() - 1);
+            hexColor = hexColor.replace("&", "");
+            StringBuilder bukkitColorCode = new StringBuilder('§' + "x");
+            for (int i = 1; i < hexColor.length(); i++) {
+                bukkitColorCode.append('§').append(hexColor.charAt(i));
+            }
+            text = text.replaceAll("&\\(" + hexColor + "\\)", bukkitColorCode.toString().toLowerCase());
+            matcher.reset(text);
+        }
+        return text;
+    }
+}
@@ -0,0 +1,74 @@
+package cc.carm.lib.configuration.common.value;
+
+import cc.carm.lib.configuration.common.data.AbstractText;
+import cc.carm.lib.configuration.core.function.ConfigValueParser;
+import cc.carm.lib.configuration.core.source.ConfigCommentInfo;
+import cc.carm.lib.configuration.core.source.ConfigurationProvider;
+import cc.carm.lib.configuration.core.value.type.ConfiguredValue;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Map;
+import java.util.function.BiConsumer;
+import java.util.function.BiFunction;
+import java.util.function.Function;
+
+public abstract class ConfigMessage<M, T extends AbstractText<R>, R>
+        extends ConfiguredValue<T> {
+
+    protected final @NotNull String[] params;
+    protected final @NotNull BiFunction<@Nullable R, @NotNull String, @Nullable M> messageParser;
+    protected final @NotNull BiConsumer<@NotNull R, @NotNull M> sendFunction;
+
+    protected final @NotNull Function<String, T> textBuilder;
+
+    public ConfigMessage(@Nullable ConfigurationProvider<?> provider,
+                         @Nullable String sectionPath, @Nullable ConfigCommentInfo comments,
+                         @NotNull Class<T> textClazz, @NotNull T defaultMessage, @NotNull String[] params,
+                         @NotNull BiFunction<@Nullable R, @NotNull String, @Nullable M> messageParser,
+                         @NotNull BiConsumer<@NotNull R, @NotNull M> sendFunction,
+                         @NotNull Function<String, T> textBuilder) {
+        super(provider, sectionPath, comments, textClazz, defaultMessage,
+                ConfigValueParser.castToString().andThen((s, d) -> textBuilder.apply(s)), AbstractText::getMessage
+        );
+        this.params = params;
+        this.messageParser = messageParser;
+        this.sendFunction = sendFunction;
+        this.textBuilder = textBuilder;
+    }
+
+    public @Nullable M parse(@Nullable R sender, @Nullable Object... values) {
+        return parse(sender, AbstractText.buildParams(params, values));
+    }
+
+    public @Nullable M parse(@Nullable R sender, @NotNull Map<String, Object> placeholders) {
+        T value = get();
+        if (value == null || value.getMessage().isEmpty()) return null;
+        else return value.parse(this.messageParser, sender, placeholders);
+    }
+
+    public void send(@Nullable R receiver, @Nullable Object... values) {
+        send(receiver, AbstractText.buildParams(params, values));
+    }
+
+    public void send(@Nullable R receiver, @NotNull Map<String, Object> placeholders) {
+        if (receiver == null) return;
+        M parsed = parse(receiver, placeholders);
+        if (parsed == null) return;
+        sendFunction.accept(receiver, parsed);
+    }
+
+    public void broadcast(@Nullable Object... values) {
+        broadcast(AbstractText.buildParams(params, values));
+    }
+
+    public abstract void broadcast(@NotNull Map<String, Object> placeholders);
+
+    public void set(@Nullable String value) {
+        this.set(value == null ? null : buildText(value));
+    }
+
+    protected T buildText(String value) {
+        return textBuilder.apply(value);
+    }
+}
@@ -0,0 +1,93 @@
+package cc.carm.lib.configuration.common.value;
+
+import cc.carm.lib.configuration.common.data.AbstractText;
+import cc.carm.lib.configuration.core.function.ConfigDataFunction;
+import cc.carm.lib.configuration.core.source.ConfigCommentInfo;
+import cc.carm.lib.configuration.core.source.ConfigurationProvider;
+import cc.carm.lib.configuration.core.value.type.ConfiguredList;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+import java.util.function.BiConsumer;
+import java.util.function.BiFunction;
+import java.util.function.Function;
+import java.util.stream.Collectors;
+
+public abstract class ConfigMessageList<M, T extends AbstractText<R>, R> extends ConfiguredList<T> {
+
+    protected final @NotNull String[] params;
+    protected final @NotNull BiFunction<@Nullable R, @NotNull String, @Nullable M> messageParser;
+    protected final @NotNull BiConsumer<@NotNull R, @NotNull List<M>> sendFunction;
+
+    protected final @NotNull Function<String, T> textBuilder;
+
+    @SuppressWarnings("NullableProblems")
+    public ConfigMessageList(@Nullable ConfigurationProvider<?> provider,
+                             @Nullable String sectionPath, @Nullable ConfigCommentInfo comments,
+                             @NotNull Class<T> textClazz, @NotNull List<T> messages, @NotNull String[] params,
+                             @NotNull BiFunction<@Nullable R, @NotNull String, @Nullable M> messageParser,
+                             @NotNull BiConsumer<@NotNull R, @NotNull List<M>> sendFunction,
+                             @NotNull Function<String, @NotNull T> textBuilder) {
+        super(
+                provider, sectionPath, comments, textClazz, messages,
+                ConfigDataFunction.castToString().andThen(textBuilder::apply), AbstractText::getMessage
+        );
+        this.params = params;
+        this.messageParser = messageParser;
+        this.sendFunction = sendFunction;
+        this.textBuilder = textBuilder;
+    }
+
+    public @Nullable List<M> parse(@Nullable R sender, @Nullable Object... values) {
+        return parse(sender, T.buildParams(params, values));
+    }
+
+    public @Nullable List<M> parse(@Nullable R sender, @NotNull Map<String, Object> placeholders) {
+        List<T> list = get();
+        if (list.isEmpty()) return null;
+
+        List<String> messages = list.stream().map(T::getMessage).collect(Collectors.toList());
+        if (String.join("", messages).isEmpty()) return null;
+
+        return list.stream().map(value -> value.parse(this.messageParser, sender, placeholders))
+                .collect(Collectors.toList());
+    }
+
+    public void send(@Nullable R receiver, @Nullable Object... values) {
+        send(receiver, T.buildParams(params, values));
+    }
+
+    public void send(@Nullable R receiver, @NotNull Map<String, Object> placeholders) {
+        if (receiver == null) return;
+        List<M> parsed = parse(receiver, placeholders);
+        if (parsed == null) return;
+        sendFunction.accept(receiver, parsed);
+    }
+
+    public void broadcast(@Nullable Object... values) {
+        broadcast(T.buildParams(params, values));
+    }
+
+    public abstract void broadcast(@NotNull Map<String, Object> placeholders);
+
+    public void setMessages(@NotNull String... values) {
+        setMessages(values.length == 0 ? null : Arrays.asList(values));
+    }
+
+    public void setMessages(@Nullable List<String> values) {
+        if (values == null || values.isEmpty()) {
+            set(null);
+        } else {
+            set(buildText(values));
+        }
+
+    }
+
+    protected List<T> buildText(List<String> values) {
+        return values.stream().map(textBuilder).collect(Collectors.toList());
+    }
+
+}