首页
/ AdminJS中resourceAction查询参数的正确使用方法

AdminJS中resourceAction查询参数的正确使用方法

2025-05-27 13:59:34作者:殷蕙予

在使用AdminJS进行自定义组件开发时,resourceAction是一个非常有用的API方法,它允许开发者直接调用资源上的特定操作。然而,很多开发者在处理查询参数时会遇到一个常见问题:参数被错误地拼接为路径而非查询字符串。

问题现象

当开发者尝试使用resourceAction方法并传入query参数时,例如:

const { data: recipeItemsAPI } = await api.resourceAction({
  resourceId: "recipe_items",
  actionName: "list",
  query: `filters[recipeId]=${record.id}`
})

生成的URL会变成类似这样的格式:

http://localhost:3000/admin/api/resources/recipe_items/actions/list/filters[recipeId]=2

而实际上期望的应该是:

http://localhost:3000/admin/api/resources/recipe_items/actions/list?filters[recipeId]=2

这种差异导致过滤器无法正常工作,API会返回所有记录而非过滤后的结果。

问题原因

这个问题的根本原因在于AdminJS API设计中对参数处理的方式。resourceAction方法实际上期望开发者使用params参数而非query参数来传递查询条件。当使用query参数时,AdminJS会错误地将其作为路径的一部分而非查询字符串处理。

正确解决方案

正确的做法是使用params参数对象来传递查询条件:

const { data: recipeItemsAPI } = await api.resourceAction({
  resourceId: "recipe_items",
  actionName: "list",
  params: {
    "filters[recipeId]": record.id,
  },
});

这种写法会生成正确的URL格式,查询参数会被正确地作为查询字符串附加在URL后面。

技术细节

AdminJS的resourceAction方法内部处理参数时,有以下特点:

  1. params参数会被序列化为标准的查询字符串
  2. 参数名称需要保持原样,包括方括号等特殊字符
  3. 参数值会被自动编码,开发者不需要手动处理URL编码

最佳实践

  1. 对于简单查询,直接使用params对象
  2. 对于复杂查询条件,可以构建完整的params对象结构
  3. 避免手动拼接查询字符串,让AdminJS处理URL编码
  4. 当需要传递数组参数时,保持参数名称的格式一致

总结

理解AdminJS API的设计意图对于正确使用其功能至关重要。resourceAction方法提供了params参数专门用于处理查询条件,开发者应该遵循这一设计模式而非尝试手动拼接查询字符串。这种规范化的使用方式不仅能解决问题,还能确保代码的一致性和可维护性。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
52
461
kernelkernel
deepin linux kernel
C
22
5
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
349
381
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
7
0
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
131
185
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
873
517
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
336
1.09 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
179
264
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
607
59
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4