首页
/ Ash项目中的动作调用选项全解析

Ash项目中的动作调用选项全解析

2025-07-08 00:27:48作者:谭伦延

概述

在Ash框架中,通过代码接口调用动作时,开发者可以使用多种选项来定制行为。这些选项提供了强大的灵活性,但同时也带来了发现和理解上的挑战。本文将全面解析Ash资源动作调用时可用的各种选项,帮助开发者充分利用框架提供的功能。

基本动作类型与选项

Ash框架支持多种基本动作类型,每种类型都有其特定的选项集:

  1. 读取动作(Read):用于查询数据
  2. 创建动作(Create):用于新建记录
  3. 更新动作(Update):用于修改现有记录
  4. 销毁动作(Destroy):用于删除记录
  5. 自定义动作(Action):开发者定义的特殊操作

通用选项详解

所有动作类型都支持以下通用选项:

  • :api:指定要使用的Ash API模块
  • :timeout:设置操作超时时间
  • :tracer:用于跟踪操作的模块
  • :verbose?:启用详细日志记录
  • :actor:设置执行操作的当前用户
  • :authorize?:是否执行授权检查
  • :return_notifications?:是否返回操作产生的通知
  • :tenant:多租户环境下的租户标识

读取动作特有选项

读取动作(read)除了通用选项外,还支持以下特殊选项:

  • :query:接受关键字列表形式的查询参数,可包含:

    • :filter:数据过滤条件
    • :sort:结果排序规则
    • :limit:返回结果数量限制
    • :offset:结果偏移量
    • :select:指定返回字段
    • :load:预加载关联关系
    • :distinct:去重设置
  • :page:分页相关参数

  • :count:是否返回总数统计

  • :after:分页游标(用于基于游标的分页)

  • :before:分页游标(用于基于游标的分页)

变更动作选项

创建(create)、更新(update)和销毁(destroy)动作共享以下选项:

  • :changeset:预构建的变更集
  • :params:原始参数(自动转换为变更集)
  • :select:指定返回字段
  • :load:操作后预加载关联关系
  • :return_changeset?:是否返回变更集而非结果

创建和更新动作特有选项:

  • :upsert?:是否执行upsert操作
  • :upsert_identity:upsert操作使用的唯一标识

查询构建选项

当通过query参数传递选项时,可以使用Ash.Query.build/3支持的所有选项,包括:

  • 复杂过滤条件构建
  • 聚合计算配置
  • 子查询设置
  • 计算字段定义
  • 高级排序规则

最佳实践建议

  1. 性能优化:合理使用:select:load选项避免过度获取数据
  2. 安全考虑:始终设置:actor并启用:authorize?选项
  3. 调试技巧:在开发时启用:verbose?选项查看详细执行过程
  4. 分页策略:根据数据量选择合适的:page或游标分页方式
  5. 变更控制:利用:return_changeset?在复杂操作中获取中间状态

总结

Ash框架提供了丰富的动作调用选项,这些选项共同构成了框架灵活性的基础。理解并合理使用这些选项,可以显著提高开发效率和应用程序性能。开发者应当根据具体场景选择合适的选项组合,并在项目文档中记录重要的选项使用决策。

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

热门内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8