17370845950

本文将指导bukkit插件开发者如何高效地管理和取消与特定玩家关联的重复任务。针对玩家登录和退出场景，我们将探讨如何利用`hashmap`存储`bukkittask`对象，并通过玩家的唯一标识符（uuid）精确控制任务的生命周期，避免资源浪费和潜在的任务冲突，确保每个玩家的任务独立且可控。

理解问题：单一任务管理器的局限性

在Bukkit插件开发中，我们经常需要为每个在线玩家执行周期性的后台任务，例如记录玩家坐标、更新状态或发送消息。一个常见的误区是尝试使用一个全局变量（如布尔标志或单个任务ID）来控制所有玩家的重复任务。

例如，以下代码片段展示了一种不推荐的实现方式：

public class MyPlugin extends JavaPlugin implements Listener {
    private boolean stopRepeater = true; // 全局标志
    private int taskID; // 全局任务ID

    @Override
    public void onEnable() {
        getServer().getPluginManager().registerEvents(this, this);
    }

    @EventHandler
    public void onLogin(final PlayerJoinEvent event) {
        final Player thePlayer = event.getPlayer();
        this.stopRepeater = true; // 每次登录都会重置此标志
        getLogger().info(String.valueOf(thePlayer.getName()) + " is logging in!");

        // 此处创建的任务ID会覆盖上一个玩家的任务ID
        taskID = Bukkit.getServer().getScheduler().scheduleSyncRepeatingTask(this, () -> {
            if(this.stopRepeater) { // 这个条件判断对所有任务都有效
                // 记录玩家位置的逻辑
                getLogger().info(thePlayer.getName() + " current position: " + thePlayer.getLocation());
            }
        }, 0L, 20L); // 每秒执行一次
    }

    @EventHandler
    public void onQuit(final PlayerQuitEvent event) {
        Player thePlayer = event.getPlayer(); 
        // 注意：此条件在PlayerQuitEvent中通常为false，因为玩家已经离线
        if(!thePlayer.isOnline()) { 
            this.stopRepeater = false; // 停止所有任务的标志
            Bukkit.getScheduler().cancelTask(taskID); // 仅取消最后创建的任务
            getLogger().info(String.valueOf(event.getPlayer().getName()) + " has left the game");
        }
    }
}

上述代码存在严重问题：

1. 全局状态冲突： stopRepeater 和 taskID 是插件级别的全局变量。当多个玩家登录时，taskID 会被新任务覆盖，导致只有最后一个登录玩家的任务ID被记录。而 stopRepeater 标志的改变会影响所有正在运行的任务，而不是特定玩家的任务。
2. 任务泄露： 当玩家退出时，Bukkit.getScheduler().cancelTask(taskID) 只能取消由 taskID 当前值所代表的那个任务。如果多个玩家的任务都在运行，其他任务将无法被取消，从而造成资源泄露。
3. 逻辑不严谨： 在 PlayerQuitEvent 触发时，thePlayer.isOnline() 通常为 false，因为玩家已经离线。这个条件判断是多余的，且可能导致误解。

解决方案：利用HashMap和BukkitTask实现任务隔离

为了为每个玩家独立管理和取消重复任务，我们需要一种机制来将每个任务与特定的玩家关联起来。HashMap 是实现这一目标的理想选择，它允许我们将玩家的唯一标识符（UUID）作为键，将对应的BukkitTask实例作为值存储起来。

核心思想

• 使用 java.util.UUID 作为 HashMap 的键，因为 UUID 是每个玩家在Minecraft服务器上的唯一且不变的标识符。
• 使用 org.bukkit.scheduler.BukkitTask 作为 HashMap 的值。BukkitTask 对象是 BukkitScheduler 返回的任务句柄，通过它我们可以控制任务的生命周期（例如取消任务）。

完整示例代码

以下是一个完整的Bukkit插件示例，演示了如何使用HashMap来管理和取消玩家专属的重复任务：

package com.example.myplugin;

import org.bukkit.Bukkit;
import org.bukkit.entity.Player;
import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.event.player.PlayerJoinEvent;
import org.bukkit.event.player.PlayerQuitEvent;
import org.bukkit.plugin.java.JavaPlugin;
import org.bukkit.scheduler.BukkitTask;

import java.util.HashMap;
import java.util.UUID;

public class PlayerTrackingPlugin extends JavaPlugin implements Listener {

    // 存储玩家UUID到其对应任务的映射
    private final HashMap playerTrackingTasks = new HashMap<>();

    @Override
    public void onEnable() {
        // 注册事件监听器
        getServer().getPluginManager().registerEvents(this, this);
        getLogger().info("PlayerTrackingPlugin has been enabled!");
    }

    @Override
    public void onDisable() {
        // 插件禁用时，取消所有由本插件创建的Bukkit任务
        // 这将确保所有玩家的跟踪任务都被停止，避免资源泄露
        Bukkit.getScheduler().cancelTasks(this); 
        playerTrackingTasks.clear(); // 清空HashMap
        getLogger().info("PlayerTrackingPlugin has been disabled! All tasks cancelled.");
    }

    @EventHandler
    public void onPlayerJoin(final PlayerJoinEvent event) {
        final Player player = event.getPlayer();
        getLogger().info(player.getName() + " 已登录！开始跟踪其位置。");

        // 使用 runTaskTimer 而非 scheduleSyncRepeatingTask，因为它直接返回 BukkitTask
        // 这是一个同步重复任务，每秒执行一次（20 tick = 1秒）
        BukkitTask task = Bukkit.getScheduler().runTaskTimer(this, () -> {
            // 这是玩家专属的重复任务逻辑
            // 例如：记录玩家位置到日志或数据库
            getLogger().info(player.getName() + " 当前位置: " + player.getLocation().getBlockX() + ", " 
                               + player.getLocation().getBlockY() + ", " + player.getLocation().getBlockZ());
            // 注意：此处 lambda 表达式捕获了 'player' 变量，每个任务实例都关联到特定的玩家
        }, 0L, 20L); // 0L 延迟，20L 周期 (1秒)

        // 将任务添加到HashMap中，键为玩家的UUID
        playerTrackingTasks.put(player.getUniqueId(), task);
        getLogger().info("为玩家 " + player.getName() + " 启动了跟踪任务 (Task ID: " + task.getTaskId() + ").");
    }

    @EventHandler
    public void onPlayerQuit(final PlayerQuitEvent event) {
        Player player = event.getPlayer();
        getLogger().info(player.getName() + " 已退出游戏。尝试取消其跟踪任务。");

        // 从HashMap中移除并获取对应的BukkitTask
        BukkitTask task = playerTrackingTasks.remove(player.getUniqueId());

        if (task != null) { // 检查任务是否存在，防止空指针异常
            task.cancel(); // 取消该玩家的重复任务
            getLogger().info("成功取消了玩家 " + player.getName() + " 的跟踪任务 (Task ID: " + task.getTaskId() + ").");
        } else {
            getLogger().warning("未找到玩家 " + player.getName() + " 的跟踪任务。可能任务已取消或未启动。");
        }
    }
}

代码解释：

• playerTrackingTasks HashMap： 声明了一个 HashMap，其键是 UUID（玩家的唯一标识符），值是 BukkitTask（Bukkit调度器返回的任务对象）。
• onPlayerJoin 事件：
  • 当玩家登录时，通过 Bukkit.getScheduler().runTaskTimer() 创建一个同步的重复任务。这个方法会返回一个 BukkitTask 实例。
  • Lambda 表达式 () -> { ... } 定义了任务的具体逻辑，例如记录玩家位置。
  • playerTrackingTasks.put(player.getUniqueId(), task) 将新创建的任务与玩家的 UUID 关联起来并存储在 HashMap 中。
• onPlayerQuit 事件：
  • 当玩家退出时，通过 playerTrackingTasks.remove(player.getUniqueId()) 尝试从 HashMap 中移除并获取该玩家对应的 BukkitTask。remove() 方法在获取值的同时将其从 HashMap 中删除，有助于清理资源。
  • if (task != null) 检查确保在任务存在时才调用 task.cancel() 方法，避免 NullPointerException。
  • task.cancel() 方法用于停止指定任务的执行。
• onDisable 方法： 在插件禁用时，Bukkit.getScheduler().cancelTasks(this) 会取消所有由当前插件实例创建的Bukkit任务，这是一种重要的资源清理机制，防止服务器关闭或插件重载时留下幽灵任务。同时，清空 playerTrackingTasks HashMap 确保内存被释放。

注意事项与最佳实践

1. 使用UUID作为键： 始终使用玩家的 UUID 作为 HashMap 的键，而不是玩家名称。玩家名称可以更改，但 UUID 保持不变，这确保了任务与玩家的正确关联。
2. Null检查： 在尝试取消任务之前，