feat(utils): 独立基本类到单独项目中，便于使用。

2026-06-04 08:38:17 +08:00 · 2022-12-13 00:29:20 +08:00
parent d9b0689e63
commit 437d0ffb32
20 changed files with 83 additions and 29 deletions
@@ -0,0 +1,51 @@
+<?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>easyplugin-parent</artifactId>
+        <groupId>cc.carm.lib</groupId>
+        <version>1.4.18</version>
+        <relativePath>../../pom.xml</relativePath>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+    <properties>
+        <maven.compiler.source>${project.jdk.version}</maven.compiler.source>
+        <maven.compiler.target>${project.jdk.version}</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <maven.compiler.encoding>UTF-8</maven.compiler.encoding>
+    </properties>
+
+    <artifactId>easyplugin-utils</artifactId>
+
+    <name>EasyPlugin-Utils</name>
+    <description>轻松插件工具类模块，该模块中的内容支持在Bungee、Bukkit使用。</description>
+    <url>https://github.com/CarmJos/EasyPlugin</url>
+
+    <developers>
+        <developer>
+            <id>CarmJos</id>
+            <name>Carm Jos</name>
+            <email>carm@carm.cc</email>
+            <url>https://www.carm.cc</url>
+        </developer>
+    </developers>
+
+    <licenses>
+        <license>
+            <name>The MIT License</name>
+            <url>https://opensource.org/licenses/MIT</url>
+        </license>
+    </licenses>
+
+    <issueManagement>
+        <system>GitHub Issues</system>
+        <url>https://github.com/CarmJos/EasyPlugin/issues</url>
+    </issueManagement>
+
+    <ciManagement>
+        <system>GitHub Actions</system>
+        <url>https://github.com/CarmJos/EasyPlugin/actions/workflows/maven.yml</url>
+    </ciManagement>
+
+</project>
@@ -0,0 +1,208 @@
+package cc.carm.lib.easyplugin.utils;
+
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.awt.*;
+import java.util.List;
+import java.util.*;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+import java.util.stream.IntStream;
+
+/**
+ * 颜色解析器。
+ * <br> 普通颜色 格式 {@code &+颜色代码 }，如 {@literal &c} 、{@literal &a}
+ * <br> RGB颜色(版本需要≥1.14) 格式 {@code &(#XXXXXX) }，如 {@literal &(#aaaaaa)}
+ * <br> 渐变RBG颜色(版本需要≥1.14) 格式 {@code &<#XXXXXX>FOOBAR&<#XXXXXX> }
+ * <p> 注意：当使用渐变RGB颜色时，普通颜色代码与RGB颜色代码将失效。
+ */
+public class ColorParser {
+
+    public static final Pattern HEX_PATTERN = Pattern.compile("&\\(&?#([\\da-fA-F]{6})\\)");
+    public static final Pattern GRADIENT_PATTERN = Pattern.compile("&<&?#([\\da-fA-F]{6})>");
+    public static final Pattern COLOR_PATTERN = Pattern.compile("([&§][0-9a-fA-FrRxX])+"); // 会影响颜色的代码
+    public static final Pattern FORMAT_PATTERN = Pattern.compile("([&§][0-9a-fA-Fk-oK-OrRxX])+"); // MC可用的格式化代码
+
+    /**
+     * 清除一条消息中的全部颜色代码 (包括RGB颜色代码与渐变颜色代码)
+     *
+     * @param text 源消息内容
+     * @return 清理颜色后的消息
+     */
+    public static @NotNull String clear(@NotNull String text) {
+        text = HEX_PATTERN.matcher(text).replaceAll("");
+        text = GRADIENT_PATTERN.matcher(text).replaceAll("");
+        text = COLOR_PATTERN.matcher(text).replaceAll("");
+        return text;
+    }
+
+    /**
+     * 对一条消息进行颜色解析，包括普通颜色代码、RGB颜色代码与RBG渐变代码。
+     *
+     * @param text 源消息内容
+     * @return 解析后的消息
+     */
+    public static @NotNull String parse(@NotNull String text) {
+        return parseBaseColor(parseGradientColor(parseHexColor(text)));
+    }
+
+    /**
+     * 对多条消息进行颜色解析，包括普通颜色代码、RGB颜色代码与RBG渐变代码。
+     *
+     * @param texts 源消息内容
+     * @return 解析后的消息
+     */
+    public static @NotNull String[] parse(@NotNull String... texts) {
+        return parse(Arrays.asList(texts)).toArray(new String[0]);
+    }
+
+    /**
+     * 对多条消息进行颜色解析，包括普通颜色代码、RGB颜色代码与RBG渐变代码。
+     *
+     * @param texts 源消息内容
+     * @return 解析后的消息
+     */
+    public static @NotNull List<String> parse(@NotNull Collection<String> texts) {
+        return texts.stream().map(ColorParser::parse).collect(Collectors.toList());
+    }
+
+    /**
+     * 解析消息中的基本颜色代码格式 {@code &+颜色代码 }，如 {@literal &c} 、{@literal &a}
+     *
+     * @param text 消息内容
+     * @return RGB处理后的消息
+     * @see net.md_5.bungee.api.ChatColor
+     */
+    public static String parseBaseColor(final String text) {
+        return text.replaceAll("&", "§").replace("§§", "&");
+    }
+
+    /**
+     * 解析消息中的RGB颜色代码(版本需要≥1.14) 格式 {@code &(#XXXXXX) }，如 {@literal &(#aaaaaa)}
+     *
+     * @param text 消息内容
+     * @return RGB处理后的消息
+     */
+    public static String parseHexColor(String text) {
+        Matcher matcher = HEX_PATTERN.matcher(text);
+        while (matcher.find()) {
+            text = matcher.replaceFirst(buildHexColor(matcher.group(1)).toLowerCase());
+            matcher.reset(text);
+        }
+        return text;
+    }
+
+    /**
+     * 对一条消息进行RGB渐变处理(版本需要≥1.14)，格式 {@code &<#XXXXXX>FOOBAR&<#XXXXXX> }。
+     *
+     * @param text 消息内容
+     * @return RGB渐变处理后的消息
+     */
+    public static @NotNull String parseGradientColor(@NotNull String text) {
+        List<String> colors = new ArrayList<>();
+
+        Matcher matcher = ColorParser.GRADIENT_PATTERN.matcher(text);
+        while (matcher.find()) colors.add(matcher.group(1));
+
+        if (colors.isEmpty()) return text; // 无渐变颜色，直接跳出
+
+        String[] parts = ColorParser.GRADIENT_PATTERN.split(text);
+        StringBuilder builder = new StringBuilder();
+        for (int i = 0; i < parts.length; i++) {
+            String startHex = i - 1 >= 0 && colors.size() > i - 1 ? colors.get(i - 1) : null; // 本条消息的起始颜色
+            String endHex = colors.size() > i ? colors.get(i) : null; // 本条消息的结束颜色
+            builder.append(gradientText(parts[i], startHex, endHex));
+        }
+
+        return builder.toString();
+    }
+
+    public static @NotNull String gradientText(@NotNull String text,
+                                               @Nullable Color startColor, @Nullable Color endColor) {
+        Objects.requireNonNull(text, "Text to be gradient should not be null!");
+        if (startColor == null || endColor == null || text.isEmpty()) {
+            // 起始颜色有任一为空，则不进行渐变上色。
+            // 若有起始颜色，则代表其跟在某个渐变之后，应当添加"&r"阻断前面的渐变。
+            return (startColor != null ? "&r" : "") + text;
+        }
+
+        // 用于记录消息中特殊格式的位置
+        // 在渐变中，允许使用格式字符与颜色字符来改变其中某个字的颜色/格式，以支持更多形式内容。
+        LinkedHashMap<Integer, String> extraFormats = new LinkedHashMap<>();
+        Matcher matcher = ColorParser.FORMAT_PATTERN.matcher(text);
+        while (matcher.find()) {
+            extraFormats.put(matcher.start(), matcher.group());
+            text = matcher.replaceFirst("");
+            matcher.reset(text);
+        }
+
+        if (text.length() == 1) {
+            // 当只有一个实际字符时，无需进行渐变计算，直接返回 中间颜色+起始格式(如果有)+消息 即可。
+            return colorText(text, extraFormats.get(0), buildHexColor(mediumHex(startColor, endColor)));
+        }
+
+        String[] characters = text.split("");
+        int step = characters.length; // 变换次数
+
+        // 决定每种颜色变换的方向
+        int rDirection = startColor.getRed() < endColor.getRed() ? 1 : -1;
+        int gDirection = startColor.getGreen() < endColor.getGreen() ? 1 : -1;
+        int bDirection = startColor.getBlue() < endColor.getBlue() ? 1 : -1;
+
+        // 决定每种颜色每次变换的度
+        int rStep = Math.abs(startColor.getRed() - endColor.getRed()) / (step - 1);
+        int gStep = Math.abs(startColor.getGreen() - endColor.getGreen()) / (step - 1);
+        int bStep = Math.abs(startColor.getBlue() - endColor.getBlue()) / (step - 1);
+
+        String[] hexes = IntStream.range(0, step).mapToObj(i -> colorToHex(
+                startColor.getRed() + rStep * i * rDirection,
+                startColor.getGreen() + gStep * i * gDirection,
+                startColor.getBlue() + bStep * i * bDirection
+        )).toArray(String[]::new);
+
+        return IntStream.range(0, characters.length)
+                .mapToObj(i -> colorText(characters[i], extraFormats.get(i), buildHexColor(hexes[i])))
+                .collect(Collectors.joining());
+    }
+
+    protected static String gradientText(@NotNull String text, @Nullable String startHex, @Nullable String endHex) {
+        return gradientText(text,
+                startHex == null ? null : Color.decode("0x" + startHex),
+                endHex == null ? null : Color.decode("0x" + endHex)
+        );
+    }
+
+    private static String mediumHex(@NotNull Color start, @NotNull Color end) {
+        return colorToHex(
+                Math.abs(start.getRed() - end.getRed()) / 2,
+                Math.abs(start.getGreen() - end.getGreen()) / 2,
+                Math.abs(start.getBlue() - end.getBlue()) / 2
+        );
+    }
+
+    private static String colorText(String message, @Nullable String format, @Nullable String color) {
+        if (format != null && COLOR_PATTERN.matcher(format).find()) {
+            // format中存在影响颜色的内容，则当前消息的颜色会被覆盖。
+            // 为了减少最终消息的长度，故直接返回键入的FORMAT和对应消息的内容。
+            return format + message;
+        }
+        return (color == null ? "" : color) + (format == null ? "" : parseBaseColor(format)) + message;
+    }
+
+    protected static String colorToHex(Color color) {
+        return colorToHex(color.getRed(), color.getGreen(), color.getBlue());
+    }
+
+    protected static String colorToHex(int r, int g, int b) {
+        // 将R、G、B转换为16进制(若非2位则补0)输出
+        return String.format("%02X%02X%02X", r, g, b);
+    }
+
+    protected static String buildHexColor(String hexCode) {
+        return Arrays.stream(hexCode.split("")).map(s -> '§' + s)
+                .collect(Collectors.joining("", '§' + "x", ""));
+    }
+
+}
@@ -0,0 +1,93 @@
+package cc.carm.lib.easyplugin.utils;
+
+import org.jetbrains.annotations.NotNull;
+
+import java.text.NumberFormat;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.function.Consumer;
+import java.util.function.Function;
+
+/**
+ * <a href="https://gist.github.com/CarmJos/402cb5aad0ec14ab25c2fa0d21571703">Easy cooldown time utils.</a>
+ *
+ * @param <P> Cooldown key provider
+ * @param <K> Cooldown key
+ * @author CarmJos
+ */
+public class EasyCooldown<P, K> {
+
+    protected final NumberFormat numberFormatter;
+
+    protected final @NotNull Map<K, Long> cooldown = new HashMap<>();
+    protected final @NotNull Function<P, K> providerToKey;
+
+    protected long defaultDuration;
+
+    public EasyCooldown(@NotNull Function<P, K> providerToKey) {
+        this(defaultFormatter(), providerToKey, 1000L);
+    }
+
+    public EasyCooldown(@NotNull NumberFormat numberFormatter,
+                        @NotNull Function<P, K> providerToKey) {
+        this(numberFormatter, providerToKey, 1000L);
+    }
+
+    public EasyCooldown(@NotNull NumberFormat numberFormatter,
+                        @NotNull Function<P, K> providerToKey,
+                        long defaultDuration) {
+        this.numberFormatter = numberFormatter;
+        this.providerToKey = providerToKey;
+        this.defaultDuration = defaultDuration;
+    }
+
+    public long getCooldown(@NotNull P provider) {
+        Long time = this.cooldown.get(this.providerToKey.apply(provider));
+        if (time == null || time < 0) return 0;
+
+        long duration = getDuration(provider);
+        if (duration <= 0) return 0;
+
+        long past = System.currentTimeMillis() - time;
+        return duration - past;
+    }
+
+    public @NotNull String getCooldownSeconds(@NotNull P provider) {
+        return formatSeconds(getCooldown(provider));
+    }
+
+    public void updateTime(@NotNull P provider) {
+        this.cooldown.put(this.providerToKey.apply(provider), System.currentTimeMillis());
+    }
+
+    public void clear(@NotNull P provider) {
+        clearCooldown(this.providerToKey.apply(provider));
+    }
+
+    public void clearCooldown(@NotNull K key) {
+        this.cooldown.remove(key);
+    }
+
+    public boolean isCoolingDown(@NotNull P provider) {
+        return getCooldown(provider) > 0;
+    }
+
+    public long getDuration(@NotNull P provider) {
+        return this.defaultDuration;
+    }
+
+    public @NotNull String formatSeconds(long cooldownMillis) {
+        return numberFormatter.format((double) cooldownMillis / 1000D);
+    }
+
+    public static NumberFormat createFormatter(@NotNull Consumer<NumberFormat> consumer) {
+        NumberFormat format = NumberFormat.getInstance();
+        consumer.accept(format);
+        return format;
+    }
+
+    public static NumberFormat defaultFormatter() {
+        return createFormatter((f) -> f.setMaximumFractionDigits(2));
+    }
+
+}
@@ -0,0 +1,105 @@
+package cc.carm.lib.easyplugin.utils;
+
+import org.jetbrains.annotations.Nullable;
+
+import java.io.*;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Scanner;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipInputStream;
+
+@SuppressWarnings("ResultOfMethodCallIgnored")
+public class JarResourceUtils {
+    public static final char JAR_SEPARATOR = '/';
+
+    public static @Nullable String[] readResource(@Nullable InputStream resourceStream) {
+        if (resourceStream == null) return null;
+        try (Scanner scanner = new Scanner(resourceStream, "UTF-8")) {
+            List<String> contents = new ArrayList<>();
+            while (scanner.hasNextLine()) {
+                contents.add(scanner.nextLine());
+            }
+            return contents.toArray(new String[0]);
+        } catch (Exception e) {
+            return null;
+        }
+    }
+
+    public static void copyFolderFromJar(String folderName, File destFolder, CopyOption option)
+            throws IOException {
+        copyFolderFromJar(folderName, destFolder, option, null);
+    }
+
+    public static void copyFolderFromJar(String folderName, File destFolder,
+                                         CopyOption option, PathTrimmer trimmer) throws IOException {
+        if (!destFolder.exists())
+            destFolder.mkdirs();
+
+        byte[] buffer = new byte[1024];
+
+        File fullPath;
+        String path = JarResourceUtils.class.getProtectionDomain().getCodeSource().getLocation().getPath();
+        if (trimmer != null)
+            path = trimmer.trim(path);
+        try {
+            if (!path.startsWith("file"))
+                path = "file://" + path;
+
+            fullPath = new File(new URI(path));
+        } catch (URISyntaxException e) {
+            e.printStackTrace();
+            return;
+        }
+
+        ZipInputStream zis = new ZipInputStream(new FileInputStream(fullPath));
+
+        ZipEntry entry;
+        while ((entry = zis.getNextEntry()) != null) {
+            if (!entry.getName().startsWith(folderName + JAR_SEPARATOR))
+                continue;
+
+            String fileName = entry.getName();
+
+            if (fileName.charAt(fileName.length() - 1) == JAR_SEPARATOR) {
+                File file = new File(destFolder + File.separator + fileName);
+                if (file.isFile()) {
+                    file.delete();
+                }
+                file.mkdirs();
+                continue;
+            }
+
+            File file = new File(destFolder + File.separator + fileName);
+            if (option == CopyOption.COPY_IF_NOT_EXIST && file.exists())
+                continue;
+
+            if (!file.getParentFile().exists())
+                file.getParentFile().mkdirs();
+
+            if (!file.exists())
+                file.createNewFile();
+            FileOutputStream fos = new FileOutputStream(file);
+
+            int len;
+            while ((len = zis.read(buffer)) > 0) {
+                fos.write(buffer, 0, len);
+            }
+            fos.close();
+        }
+
+        zis.closeEntry();
+        zis.close();
+    }
+
+    public enum CopyOption {
+        COPY_IF_NOT_EXIST, REPLACE_IF_EXIST
+    }
+
+    @FunctionalInterface
+    public interface PathTrimmer {
+        String trim(String original);
+    }
+}
@@ -0,0 +1,50 @@
+import cc.carm.lib.easyplugin.utils.ColorParser;
+import org.junit.Test;
+
+import java.util.LinkedHashMap;
+import java.util.regex.Matcher;
+
+import static cc.carm.lib.easyplugin.utils.ColorParser.*;
+
+public class ColorParseTest {
+
+
+    @Test
+    public void test() {
+        System.out.println(" ");
+        System.out.println(parseGradientColor("&<#AAAAAA>我真的&<#BBBBBB>爱死&<#111111>你&<#FFFFFF>！"));
+
+        // 测试穿插
+        System.out.println(parse("&<#AAAAAA>&l我&r真&b的&<#BBBBBB>&o爱死&<#111111>你&<#FFFFFF>了&r！"));
+        System.out.println(parse("&<#AAAAAA>&l我&r真&(#666666)的&<#BBBBBB>&o爱死&<#111111>你&<#FFFFFF>了&r！"));
+        System.out.println(parse("&r正常的颜色理应&c&l不受影响&r。"));
+
+        System.out.println(clear("&f测试&<#AAAAAA>清理颜色代码&<#111111> &&这样应该&(#666666)不被影响 &f。"));
+    }
+
+    @Test
+    public void formatReadTest() {
+        LinkedHashMap<Integer, String> formats = new LinkedHashMap<>();
+        String text = "&k&l &m&1我&k爱你爱你爱你&o吗？";
+        Matcher matcher = ColorParser.FORMAT_PATTERN.matcher(text);
+        while (matcher.find()) {
+            String code = matcher.group();
+            formats.put(matcher.start(), code);
+            text = matcher.replaceFirst("");
+            matcher.reset(text);
+        }
+
+        formats.forEach((index, code) -> System.out.println(index + " -> " + code));
+
+        String[] parts = text.split("");
+        StringBuilder builder = new StringBuilder();
+        for (int i = 0; i < parts.length; i++) {
+            String format = formats.get(i);
+            if (format != null) builder.append(ColorParser.parseBaseColor(format));
+            builder.append(parts[i]);
+        }
+
+        System.out.println(builder);
+    }
+
+}