Discord.py 交互按钮超时与持久化解决方案

理解交互按钮超时机制

在使用Discord.py开发机器人时，交互按钮是提升用户体验的重要组成部分。然而，开发者常会遇到按钮在部署一段时间后失效，并显示“This Interaction Failed”的错误。这通常由以下两个主要原因造成：

1. Discord API的交互响应时限： Discord对所有交互（包括按钮点击）都有严格的时限要求。机器人必须在收到交互后的3秒内发送初始响应（例如，interaction.response.send_message()）。如果处理时间超过3秒，则需要先使用interaction.response.defer()进行延迟响应，然后在15分钟内发送后续消息或编辑原始消息。
2. discord.ui.View自身的超时管理： discord.ui.View是Discord.py中用于管理组件（如按钮）的容器。默认情况下，View实例会有一个内置的超时机制。如果在一个View实例创建后，在特定时间内没有任何交互发生，该View将自动失效，其上的按钮也将不再响应。

防止视图级别超时

为了防止discord.ui.View自身因长时间未交互而失效，我们需要在创建View时明确设置其超时参数。View的超时行为通过其构造函数中的timeout参数控制。

默认情况下，timeout参数有一个预设值（通常是180秒，即3分钟）。要使View永久保持活动状态，除非手动停止，应将其设置为None。

正确设置timeout=None：

timeout=None应该在您的自定义View类的__init__方法中，通过调用super().__init__(timeout=None)来设置。

import discord

class PersistentMenu(discord.ui.View):
  def __init__(self):
    # 关键：在这里设置timeout=None，使视图永不超时
    super().__init__(timeout=None) 
    self.value = None

  @discord.ui.button(label="脚本", style=discord.ButtonStyle.green, emoji="❓", custom_id="my_script_button")
  async def script(self, interaction: discord.Interaction, button: discord.ui.Button):
    # 按钮回调函数
    await interaction.response.send_message("你好世界！", ephemeral=True)

# 示例斜杠命令
@client.tree.command(name="deploy_menu", description="部署一个带有持久化按钮的菜单")
async def deploy_menu(interaction: discord.Interaction):
  if not interaction.user.guild_permissions.administrator:
    return await interaction.response.send_message("您不是管理员。", ephemeral=True)
  else:
    view = PersistentMenu()
    embed = discord.Embed(title="测试菜单", description="点击下面的按钮。", color=0xfed9ff)
    await interaction.response.send_message(embed=embed, view=view)

为什么直接view = Menu(timeout=None)可能失败？

在原始问题中，用户尝试了view = Menu(timeout=None)，但报告了错误。这通常是因为Menu类的__init__方法没有正确地接收或处理这个timeout参数，或者没有将其传递给super().__init__()。timeout参数是discord.ui.View构造函数的一部分，必须通过super().__init__()来初始化父类。上述示例中的super().__init__(timeout=None)是正确的做法。

实现按钮的持久化

仅仅设置timeout=None可以防止View在运行期间因不活跃而失效，但它不能解决机器人重启后按钮失效的问题。当机器人重启时，所有在内存中创建的View实例都会丢失。为了使按钮在机器人重启后依然能够响应，我们需要实现持久化视图。

Starry.ai

AI艺术绘画生成器

35

查看详情

持久化视图需要两个关键要素：

1. custom_id： 您的按钮必须拥有一个唯一的custom_id。Discord API使用这个custom_id来识别按钮，即使机器人重启后，当用户点击按钮时，Discord也会将这个custom_id发送给机器人。
2. bot.add_view()： 在机器人启动时（通常在on_ready()事件中），您需要调用bot.add_view()方法，将您的持久化View类的实例注册到机器人中。这样，当Discord发送带有已知custom_id的按钮交互时，机器人就知道应该将这个交互路由到哪个View实例的相应回调方法。

完整示例代码：

这个示例展示了如何创建一个持久化视图，并在机器人启动时注册它，确保按钮在机器人重启后依然有效。

import discord
from discord.ext import commands

# 替换为您的机器人Token
TOKEN = 'YOUR_BOT_TOKEN' 

# 定义一个 Intents 对象，至少需要 message_content (如果需要读取消息内容) 和 interactions
intents = discord.Intents.default()
intents.message_content = True # 如果你的机器人需要读取消息内容，请设置为 True

# 创建机器人实例
bot = commands.Bot(command_prefix="!", intents=intents)

# 定义一个持久化视图类
class MyPersistentView(discord.ui.View):
    def __init__(self):
        # 关键：设置timeout=None，使视图永不超时
        super().__init__(timeout=None)

    # 定义一个按钮，并赋予唯一的 custom_id
    @discord.ui.button(label="点击我", style=discord.ButtonStyle.green, custom_id="my_unique_persistent_button")
    async def test_button_callback(self, interaction: discord.Interaction, button: discord.ui.Button):
        # 按钮回调函数
        await interaction.response.send_message("你点击了持久化按钮！", ephemeral=True)

# 机器人启动事件
@bot.event
async def on_ready():
    print(f'机器人已上线：{bot.user}')
    # 关键：在机器人准备就绪时注册持久化视图
    # 传入 View 类的实例，而不是类本身
    bot.add_view(MyPersistentView()) 

    # 同步斜杠命令到 Discord
    await bot.tree.sync()
    print("斜杠命令已同步。")

# 定义一个斜杠命令来部署带有持久化按钮的消息
@bot.tree.command(name='deploy_persistent_button', description='部署一个带有持久化按钮的消息')
async def deploy_persistent_button(interaction: discord.Interaction):
    # 创建 MyPersistentView 的实例并发送
    await interaction.response.send_message("这是一个持久化按钮：", view=MyPersistentView())

# 运行机器人
bot.run(TOKEN)

代码解析：

1. MyPersistentView类：
   • super().__init__(timeout=None)确保这个View实例本身不会超时。
   • @discord.ui.button(...)装饰器中的custom_id="my_unique_persistent_button"为按钮提供了一个唯一的标识符。这是实现持久化的关键。
2. on_ready()事件：
   • bot.add_view(MyPersistentView())：在机器人上线时，我们创建MyPersistentView的一个实例并将其添加到机器人中。Discord.py会检查所有注册的持久化视图，并根据custom_id来路由传入的按钮交互。
3. /deploy_persistent_button命令：
   • 这个斜杠命令用于首次发送包含持久化按钮的消息。它同样创建MyPersistentView的一个新实例并将其附加到消息上。

注意事项与最佳实践

• custom_id的唯一性和一致性： 每个持久化按钮的custom_id必须在其生命周期内保持唯一且一致。如果您更改了custom_id，旧的按钮将不再响应。
• bot.add_view()的调用时机： 务必在on_ready()事件中调用bot.add_view()。如果机器人重启，on_ready()会重新执行，确保持久化视图被重新注册。
• 处理长时间运行的交互： 如果按钮回调函数中的操作需要超过3秒，请务必在执行耗时操作之前调用await interaction.response.defer()。这会立即向Discord发送一个“机器人正在思考”的响应，避免“This Interaction Failed”错误。之后，您可以使用await interaction.followup.send()或await interaction.edit_original_response()来发送最终结果。
• 错误处理： 在按钮回调函数中加入try...except块，以优雅地处理可能发生的错误，并向用户提供有用的反馈。
• ephemeral消息： 对于只应由触发交互的用户看到的消息，可以使用ephemeral=True参数。这在处理权限不足或个人反馈时非常有用。

总结

通过本教程，我们了解了Discord.py交互按钮出现“This Interaction Failed”错误的原因，并掌握了两种关键的解决方案：

1. 设置super().__init__(timeout=None)：确保discord.ui.View实例本身不会因不活跃而超时。
2. 结合custom_id和bot.add_view()：实现按钮的持久化，使其在机器人重启后依然能够正常工作。

遵循这些最佳实践，您将能够构建出更加稳定、可靠且用户友好的Discord机器人交互功能。

以上就是Discord.py 交互按钮超时与持久化解决方案的详细内容，更多请关注php中文网其它相关文章！