feat(papi): 提供便捷的PlaceholderAPI变量实现类。

2026-06-04 16:48:16 +08:00 · 2023-02-19 02:59:05 +08:00
parent 01250a65d1
commit 3019216801
11 changed files with 588 additions and 36 deletions
@@ -0,0 +1,183 @@
+package cc.carm.lib.easyplugin.papi;
+
+import cc.carm.lib.easyplugin.papi.expansion.SectionExpansion;
+import cc.carm.lib.easyplugin.papi.expansion.SubExpansion;
+import cc.carm.lib.easyplugin.papi.handler.PlaceholderHandler;
+import me.clip.placeholderapi.expansion.PlaceholderExpansion;
+import org.bukkit.OfflinePlayer;
+import org.bukkit.plugin.java.JavaPlugin;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.List;
+import java.util.function.Consumer;
+
+public class EasyPlaceholder extends PlaceholderExpansion {
+
+    protected final @NotNull String plugin;
+    protected final @NotNull SectionExpansion rootExpansion;
+
+    protected final @NotNull String name;
+    protected final @NotNull String author;
+    protected final @NotNull String version;
+
+    protected final boolean persistent;
+
+    public EasyPlaceholder(@NotNull JavaPlugin plugin, @NotNull String rootIdentifier) {
+        this(
+                plugin.getName(), true, rootIdentifier,
+                plugin.getName(), plugin.getDescription().getVersion(),
+                String.join(", ", plugin.getDescription().getAuthors())
+        );
+    }
+
+    public EasyPlaceholder(@NotNull JavaPlugin plugin, @NotNull SectionExpansion rootExpansion) {
+        this(
+                plugin.getName(), true, rootExpansion,
+                plugin.getName(), plugin.getDescription().getVersion(),
+                String.join(", ", plugin.getDescription().getAuthors())
+        );
+    }
+
+    public EasyPlaceholder(@NotNull String plugin, boolean persistent, @NotNull String rootIdentifier,
+                           @NotNull String name, @NotNull String version, @NotNull String author) {
+        super();
+        this.plugin = plugin;
+        this.name = name;
+        this.author = author;
+        this.version = version;
+        this.persistent = persistent;
+        this.rootExpansion = new SectionExpansion(this, rootIdentifier);
+    }
+
+    public EasyPlaceholder(@NotNull String plugin, boolean persistent,
+                           @NotNull SectionExpansion rootExpansion,
+                           @NotNull String name, @NotNull String version, @NotNull String author) {
+        super();
+        this.plugin = plugin;
+        this.name = name;
+        this.author = author;
+        this.version = version;
+        this.persistent = persistent;
+        this.rootExpansion = rootExpansion;
+    }
+
+    /**
+     * 得到根变量解析器
+     *
+     * @return 根变量解析器
+     */
+    public @NotNull SectionExpansion getRootExpansion() {
+        return rootExpansion;
+    }
+
+    /**
+     * 当未找到对应变量处理器时调用
+     *
+     * @param player 变量解析时的目标玩家，可能为空或不在线。
+     * @return 返回给玩家的内容
+     */
+    public String onErrorParams(@Nullable OfflinePlayer player) {
+        return "Wrong params";
+    }
+
+    /**
+     * 当变量处理器返回 NULL 值时调用
+     *
+     * @param player 变量解析时的目标玩家，可能为空或不在线。
+     * @return 返回给玩家的内容
+     */
+    public String onNullResponse(@Nullable OfflinePlayer player) {
+        return "";
+    }
+
+    /**
+     * 当变量处理器抛出异常时调用
+     *
+     * @param player    变量解析时的目标玩家，可能为空或不在线。
+     * @param expansion 抛出异常的变量处理器
+     * @param exception 异常内容
+     * @return 返回给玩家的内容
+     */
+    public String onException(@Nullable OfflinePlayer player, @NotNull SubExpansion<?> expansion, @NotNull Exception exception) {
+        exception.printStackTrace();
+        return "Error \"" + expansion.getIdentifier() + "\"";
+    }
+
+    /**
+     * 处理变量并返回对应内容。
+     *
+     * @param identifier 该变量的标识符
+     * @param handler    该组变量的处理器，返回值将会被转换为字符串。
+     * @param aliases    该变量的别称
+     * @return {@link  EasyPlaceholder}
+     */
+    public final EasyPlaceholder handle(String identifier, @NotNull PlaceholderHandler handler, @NotNull String... aliases) {
+        this.rootExpansion.handle(identifier, handler, aliases);
+        return this;
+    }
+
+    /**
+     * 处理一组变量。
+     *
+     * @param section  该组变量的标识符
+     * @param consumer 该组变量的处理器
+     *                 <br> 在其中可调用 {@link SectionExpansion#handle(String, PlaceholderHandler, String...)} 方法处理子变量,
+     *                 <br> 或者调用 {@link SectionExpansion#handleSection(String, Consumer, String...)} 方法处理下一层组变量
+     * @param aliases  该变量的别称
+     * @return {@link  EasyPlaceholder}
+     */
+    public final EasyPlaceholder handleSection(@NotNull String section,
+                                               @NotNull Consumer<SectionExpansion> consumer,
+                                               @NotNull String... aliases) {
+        this.rootExpansion.handleSection(section, consumer, aliases);
+        return this;
+    }
+
+    @Override
+    public String onRequest(@Nullable OfflinePlayer player, @NotNull String params) {
+        String[] args = params.split("_");
+        if (args.length == 0) return onErrorParams(player);
+
+        Object response = rootExpansion.handleRequest(player, args);
+        if (response == null) return onNullResponse(player);
+        else return response.toString();
+    }
+
+    @Override
+    public @Nullable String getRequiredPlugin() {
+        return this.plugin;
+    }
+
+    @Override
+    public @NotNull String getIdentifier() {
+        return this.rootExpansion.getIdentifier();
+    }
+
+    @Override
+    public @NotNull String getAuthor() {
+        return this.author;
+    }
+
+    @Override
+    public @NotNull String getVersion() {
+        return this.version;
+    }
+
+    @Override
+    public @NotNull String getName() {
+        return this.name;
+    }
+
+    @Override
+    public @NotNull List<String> getPlaceholders() {
+        return this.rootExpansion.listPlaceholders();
+    }
+
+    @Override
+    public boolean persist() {
+        return this.persistent;
+    }
+
+
+}
@@ -0,0 +1,13 @@
+package cc.carm.lib.easyplugin.papi.expansion;
+
+import org.jetbrains.annotations.NotNull;
+
+import java.util.List;
+
+public interface EasyExpansion {
+    
+    @NotNull String getIdentifier();
+
+    @NotNull List<String> getAliases();
+
+}
@@ -0,0 +1,179 @@
+package cc.carm.lib.easyplugin.papi.expansion;
+
+import cc.carm.lib.easyplugin.papi.EasyPlaceholder;
+import cc.carm.lib.easyplugin.papi.handler.PlaceholderHandler;
+import org.bukkit.OfflinePlayer;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.*;
+import java.util.function.Consumer;
+import java.util.function.Supplier;
+
+public class SectionExpansion implements EasyExpansion {
+
+    protected final EasyPlaceholder root;
+
+    protected final @NotNull String identifier;
+    protected final @NotNull List<String> aliases;
+
+    protected final @NotNull Map<String, SectionExpansion> registeredSections = new HashMap<>();
+    protected final @NotNull Map<String, SubExpansion<?>> registeredExpansions = new HashMap<>();
+
+    protected final @NotNull Map<String, String> aliasesMap = new HashMap<>();
+
+    public SectionExpansion(@NotNull EasyPlaceholder root,
+                            @NotNull String identifier, @NotNull String... aliases) {
+        this(root, identifier, Arrays.asList(aliases));
+    }
+
+    public SectionExpansion(@NotNull EasyPlaceholder root,
+                            @NotNull String identifier, @NotNull List<String> aliases) {
+        this.root = root;
+        this.identifier = identifier;
+        this.aliases = aliases;
+    }
+
+    public EasyPlaceholder getRoot() {
+        return root;
+    }
+
+    @NotNull
+    @Override
+    public String getIdentifier() {
+        return identifier;
+    }
+
+    @Override
+    public @NotNull List<String> getAliases() {
+        return this.aliases;
+    }
+
+    public void register(@NotNull SubExpansion<?> placeholder) {
+        String name = placeholder.getIdentifier().toLowerCase();
+        this.registeredExpansions.put(name, placeholder);
+        placeholder.getAliases().forEach(alias -> this.aliasesMap.put(alias.toLowerCase(), name));
+    }
+
+    public final void register(@NotNull SectionExpansion placeholder) {
+        String name = placeholder.getIdentifier().toLowerCase();
+        this.registeredSections.put(name, placeholder);
+        placeholder.getAliases().forEach(alias -> this.aliasesMap.put(alias.toLowerCase(), name));
+    }
+
+    public final void handle(@NotNull String identifier, @NotNull PlaceholderHandler handler,
+                             @NotNull String... aliases) {
+        handle(identifier, handler, Collections.emptyList(), aliases);
+    }
+
+    public final void handle(@NotNull String identifier, @NotNull PlaceholderHandler handler,
+                             @NotNull Consumer<ArrayList<String>> paramsConsumer, @NotNull String... aliases) {
+        handle(identifier, handler, () -> {
+            ArrayList<String> params = new ArrayList<>();
+            paramsConsumer.accept(params);
+            return params;
+        }, aliases);
+    }
+
+    public final void handle(@NotNull String identifier, @NotNull PlaceholderHandler handler,
+                             @NotNull List<String> availableParams, @NotNull String... aliases) {
+        handle(identifier, handler, () -> availableParams, aliases);
+    }
+
+    public final void handle(@NotNull String identifier, @NotNull PlaceholderHandler handler,
+                             @NotNull Supplier<List<String>> availableParams, @NotNull String... aliases) {
+        register(new SubExpansion<SectionExpansion>(this, identifier, aliases) {
+            @Override
+            public Object handle(@Nullable OfflinePlayer player, @NotNull String[] args) throws Exception {
+                return handler.handle(player, args);
+            }
+
+            @Override
+            public List<String> listAvailableParams() {
+                return availableParams.get();
+            }
+        });
+    }
+
+    public final void handleSection(@NotNull String section, @NotNull Consumer<SectionExpansion> consumer,
+                                    @NotNull String... aliases) {
+        SectionExpansion sectionExpansion = new SectionExpansion(getRoot(), section, aliases);
+        consumer.accept(sectionExpansion);
+        register(sectionExpansion);
+    }
+
+    public final @Nullable Object handleRequest(@Nullable OfflinePlayer player, @NotNull String[] args) {
+        if (args.length == 0) return getRoot().onErrorParams(player);
+        String input = args[0].toLowerCase();
+
+        SectionExpansion group = getHandler(input);
+        if (group != null) return group.handleRequest(player, this.shortenArgs(args));
+
+        SubExpansion<?> sub = getSubPlaceholder(input);
+        if (sub == null) return getRoot().onErrorParams(player);
+
+        try {
+            return sub.handle(player, this.shortenArgs(args));
+        } catch (Exception ex) {
+            return getRoot().onException(player, sub, ex);
+        }
+    }
+
+    public List<String> listPlaceholders() {
+        List<String> placeholders = new ArrayList<>();
+
+        String currentID = getIdentifier();
+
+        for (SectionExpansion section : this.registeredSections.values()) {
+            for (String groupID : section.listPlaceholders()) {
+                placeholders.add(currentID + "_" + groupID);
+            }
+        }
+
+        for (SubExpansion<?> placeholder : this.registeredExpansions.values()) {
+            String identifier = placeholder.getIdentifier();
+
+            List<String> params = placeholder.listAvailableParams();
+            if (params.isEmpty()) {
+                placeholders.add(currentID + "_" + identifier);
+                continue;
+            }
+
+            for (String param : params) {
+                placeholders.add(currentID + "_" + identifier + "_" + param);
+            }
+
+        }
+
+        return placeholders;
+    }
+
+
+    protected @Nullable SectionExpansion getHandler(@NotNull String name) {
+        SectionExpansion fromName = this.registeredSections.get(name);
+        if (fromName != null) return fromName;
+
+        String nameFromAlias = this.aliasesMap.get(name);
+        if (nameFromAlias == null) return null;
+        else return this.registeredSections.get(nameFromAlias);
+    }
+
+    protected @Nullable SubExpansion<?> getSubPlaceholder(@NotNull String name) {
+        SubExpansion<?> fromName = this.registeredExpansions.get(name);
+        if (fromName != null) return fromName;
+
+        String nameFromAlias = this.aliasesMap.get(name);
+        if (nameFromAlias == null) return null;
+        else return this.registeredExpansions.get(nameFromAlias);
+    }
+
+    protected String[] shortenArgs(String[] args) {
+        if (args.length == 0) {
+            return args;
+        } else {
+            List<String> argList = new ArrayList<>(Arrays.asList(args).subList(1, args.length));
+            return argList.toArray(new String[0]);
+        }
+    }
+
+}
@@ -0,0 +1,44 @@
+package cc.carm.lib.easyplugin.papi.expansion;
+
+import org.bukkit.OfflinePlayer;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+
+public abstract class SubExpansion<PARENT extends SectionExpansion> implements EasyExpansion {
+
+    protected final @NotNull PARENT parent;
+    protected final @NotNull String identifier;
+    protected final @NotNull List<String> aliases;
+
+    public SubExpansion(@NotNull PARENT parent,
+                        @NotNull String identifier, @NotNull String... aliases) {
+        this.parent = parent;
+        this.identifier = identifier;
+        this.aliases = Arrays.asList(aliases);
+    }
+
+    public abstract Object handle(@Nullable OfflinePlayer player, @NotNull String[] args) throws Exception;
+
+    /**
+     * 用于提示此子变量的全部可用参数
+     *
+     * @return 该子变量的全部可用参数
+     */
+    public List<String> listAvailableParams() {
+        return Collections.emptyList();
+    }
+
+    @Override
+    public @NotNull String getIdentifier() {
+        return this.identifier;
+    }
+
+    @Override
+    public @NotNull List<String> getAliases() {
+        return this.aliases;
+    }
+}
@@ -0,0 +1,12 @@
+package cc.carm.lib.easyplugin.papi.handler;
+
+import org.bukkit.OfflinePlayer;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+@FunctionalInterface
+public interface PlaceholderHandler {
+
+    @Nullable Object handle(@Nullable OfflinePlayer player, @NotNull String[] args) throws Exception;
+
+}
@@ -0,0 +1,77 @@
+package cc.carm.tests.easyplugin.papi;
+
+import cc.carm.lib.easyplugin.papi.EasyPlaceholder;
+import cc.carm.lib.easyplugin.papi.expansion.SubExpansion;
+import org.bukkit.OfflinePlayer;
+import org.bukkit.entity.Player;
+import org.bukkit.inventory.ItemStack;
+import org.bukkit.inventory.PlayerInventory;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Arrays;
+import java.util.Objects;
+
+public class DemoPlaceholder extends EasyPlaceholder {
+
+    public DemoPlaceholder() {
+        super(
+                "TestPlugin", true, "TestPlaceholder",
+                "TestPlugin", "1.0.0", "Carm"
+        );
+
+        handle("version", (player, args) -> "1.0.0", "ver", "v");
+        handleSection("game", (section) -> {
+
+            // 即处理 %TestPlaceholder_game_items%
+            section.handle("items", ((player, args) -> {
+                if (player == null || !player.isOnline() || !(player instanceof Player)) return -1;
+                PlayerInventory inv = ((Player) player).getInventory();
+                return Arrays.stream(inv.getContents())
+                        .filter(Objects::nonNull)
+                        .mapToInt(ItemStack::getAmount)
+                        .count();
+            }));
+
+            // 即处理 %TestPlaceholder_game_location% 或 %TestPlaceholder_game_loc%
+            section.handle("location", (player, args) -> {
+                if (player == null || !player.isOnline() || !(player instanceof Player)) return "Unknown";
+                return ((Player) player).getLocation();
+            }, "loc" /* 声明此变量的别称*/);
+
+            // 即处理 %TestPlaceholder_game_time%
+            section.handle("time", (player, args) -> System.currentTimeMillis());
+
+            section.handle("random",
+                    (player, args) -> {
+                        if (args.length == 0) return Math.random();
+                        else if (args.length == 1) return Math.random() * Double.parseDouble(args[0]);
+                        else if (args.length == 2) {
+                            return Math.random() * (Double.parseDouble(args[1]) - Double.parseDouble(args[0])) + Double.parseDouble(args[0]);
+                        } else return onErrorParams(player);
+                    },
+                    (params) -> {
+                        params.add("<最小值>_<最大值>");
+                        params.add("<基础值(乘随机数)>");
+                    });
+
+        }, "g");
+
+    }
+
+    @Override
+    public String onErrorParams(@Nullable OfflinePlayer player) {
+        return super.onErrorParams(player);
+    }
+
+    @Override
+    public String onNullResponse(@Nullable OfflinePlayer player) {
+        return super.onNullResponse(player);
+    }
+
+    @Override
+    public String onException(@Nullable OfflinePlayer player, @NotNull SubExpansion<?> expansion, @NotNull Exception exception) {
+        return super.onException(player, expansion, exception);
+    }
+
+}
@@ -0,0 +1,37 @@
+package cc.carm.tests.easyplugin.papi;
+
+import cc.carm.lib.easyplugin.papi.EasyPlaceholder;
+import org.junit.Test;
+
+public class PlaceholderTest {
+
+
+    @Test
+    public void onTest() {
+        DemoPlaceholder placeholder = new DemoPlaceholder();
+
+        System.out.println("# Placeholders");
+        placeholder.getPlaceholders().forEach(s -> System.out.println(" -> " + s));
+
+        System.out.println();
+        System.out.println("# Request tests");
+
+        test(placeholder, "game_items");
+        test(placeholder, "g_time");
+        test(placeholder, "game_loc");
+        test(placeholder, "ver");
+
+        test(placeholder, "game_random");
+        test(placeholder, "game_random_0_5");
+        test(placeholder, "game_random_100");
+
+        System.out.println("# Error tests");
+        test(placeholder, "game_random_try");
+    }
+
+    private void test(EasyPlaceholder placeholder, String input) {
+        System.out.println(" " + input + " -> " + placeholder.onRequest(null, input));
+    }
+
+
+}