用途:这是一份社区维护的 Ruby on Rails 开发最佳实践规则集,用于在编写 Rails 控制器、模型、视图,优化 ActiveRecord 查询与数据库访问,实现缓存策略,构建或重构 API 端点,引入 Turbo Frames/Streams,审查 N+1 查询与安全漏洞,设计后台任务,以及编写数据库迁移时作为参考。
主要能力:包含 45 条规则,按优先级分为 8 类。数据库与 ActiveRecord(CRITICAL,db-):预加载关联消除 N+1、添加索引、只选所需列、find_each 批处理、避免循环内查询、使用 scope、可逆的零停机迁移、用 exists? 代替 count。控制器与路由(CRITICAL,ctrl-):瘦控制器、强参数、RESTful 路由、限定 before_action、respond_to 多格式、rescue_from 错误处理。安全(HIGH,sec-):参数化查询、白名单强参数、先认证后授权、CSRF 保护、按用户限定查询。模型与业务逻辑(HIGH,model-):模型级校验、避免回调副作用、服务对象、scope 优于类方法、枚举、concern 共享行为、查询对象。缓存与性能(HIGH,cache-):片段缓存、俄罗斯套娃缓存、Rails.cache.fetch、计数缓存、stale? 条件 GET。视图与前端(MEDIUM-HIGH,view-):集合渲染、Turbo Frames、Turbo Streams、form_with、避免视图内逻辑。API 设计(MEDIUM,api-):序列化器、分页、版本化、结构化错误、避免 Jbuilder 热路径。后台任务(LOW-MEDIUM,job-):幂等设计、小负载传 ID、重试与错误处理、去重任务。
使用方式:按需阅读各类别的参考文件获取详细说明与代码示例,包括 references/_sections.md(类别定义与顺序)、assets/templates/_template.md(新增规则模板)、metadata.json(版本与引用信息)。
适用场景:Rails 后端 API 与前端 Web 应用的开发、审查与重构。
限制:资料未提供具体安装命令、许可证或适用范围限制;规则的具体代码示例需查阅对应参考文件。