Apache APISIX 自定义插件加载问题排查与解决方案

问题背景

在使用 Apache APISIX 网关系统时，开发者经常会遇到需要开发和使用自定义插件的情况。本文以一个典型场景为例，详细分析如何正确加载自定义插件并解决常见问题。

问题现象

开发者在 APISIX 中创建了两个自定义插件：authz-casbin 和 jwt-extractor，并按照官方文档进行了配置。插件文件已正确放置在容器内的 /usr/local/apisix/custom-plugin/apisix/plugins 目录下，但在通过 API 创建路由时，系统返回错误信息"unknown plugin [jwt-extractor]"。

问题分析

经过深入排查，发现问题的根源在于配置文件的设置不完整。虽然开发者在 APISIX Dashboard 的配置文件中添加了插件列表：

plugins:
  - authz-casbin
  - jwt-extractor
  - jwt-auth

但这仅对 Dashboard 有效，APISIX 核心服务并未加载这些插件。APISIX 需要在其主配置文件中明确声明要加载的插件列表。

解决方案

1. 修改 APISIX 主配置文件

需要在 apisix_conf/config.yaml 中添加 plugins 部分，列出所有需要启用的插件。需要注意的是，这会覆盖默认的插件列表，因此建议从官方示例配置中复制完整列表，再添加自定义插件。

plugins:
  - real-ip
  - client-control
  - request-id
  # ... 其他默认插件
  - authz-casbin
  - jwt-extractor
  - jwt-auth
  # ... 其他默认插件

2. 插件优先级考虑

APISIX 插件是按优先级顺序执行的。自定义插件通常建议使用 0-100 之间的优先级值，以确保它们在适当的位置执行。例如：

plugins:
  # ... 其他插件
  - jwt-extractor  # 优先级默认为0
  - example-plugin # 优先级0
  # ... 其他插件

3. 配置文件验证

修改配置后，建议执行以下验证步骤：

1. 检查 APISIX 日志文件 /usr/local/apisix/logs/error.log 是否有加载插件的相关信息
2. 通过管理API查询已加载的插件列表
3. 重启 APISIX 服务使配置生效

最佳实践

1. 插件开发规范：自定义插件应遵循 APISIX 插件开发规范，包括必要的生命周期方法和元数据定义。

2. 配置管理：建议使用版本控制系统管理配置文件，特别是当添加多个自定义插件时。

3. 测试环境验证：在将新插件部署到生产环境前，应在测试环境中充分验证其功能。

4. 监控与日志：确保正确配置日志级别，以便调试插件加载和执行过程中的问题。

总结

在 APISIX 中使用自定义插件时，必须同时在主配置文件中声明插件列表。仅修改 Dashboard 的配置是不够的。通过正确配置和遵循最佳实践，可以确保自定义插件按预期工作，充分发挥 APISIX 的灵活性和扩展性优势。