ruby-optimise

Ruby 社区最佳实践

Ruby 应用的全面性能优化指南，由社区维护。包含 8 个类别中的 42 条规则，按影响程度排序，为自动重构和代码生成提供指导。

适用场景

在以下情况下参考这些指南：

• 编写新的 Ruby 代码或 gem
• 优化 ActiveRecord 查询和数据库访问模式
• 处理大型集合或构建数据管道
• 审查代码中的内存膨胀和 GC 压力
• 配置生产环境的 Ruby 运行时设置

按优先级划分的规则类别

优先级	类别	影响	前缀
1	对象分配	CRITICAL	alloc-
2	集合与枚举	CRITICAL	enum-
3	I/O 与数据库	HIGH	io-
4	字符串处理	HIGH	str-
5	方法与分派	MEDIUM-HIGH	meth-
6	数据结构	MEDIUM	ds-
7	并发	MEDIUM	conc-
8	运行时与配置	LOW-MEDIUM	runtime-

快速参考

1. 对象分配（CRITICAL）

• alloc-avoid-unnecessary-dup - 避免不必要的对象复制
• alloc-freeze-constants - 冻结常量集合
• alloc-lazy-initialization - 对开销较大的对象使用延迟初始化
• alloc-avoid-temp-arrays - 避免创建临时数组
• alloc-reuse-buffers - 在循环中复用缓冲区
• alloc-avoid-implicit-conversions - 避免在热点路径中重复计算

2. 集合与枚举（CRITICAL）

• enum-single-pass - 使用单次遍历完成集合转换
• enum-lazy-large-collections - 对大型集合使用惰性枚举器
• enum-flat-map - 使用 flat_map 替代 map.flatten
• enum-each-with-object - 构建集合时使用 each_with_object 而非 inject
• enum-avoid-count-in-loops - 避免在循环条件中重复计算集合大小
• enum-chunk-batch-processing - 使用 each_slice 进行批处理

3. I/O 与数据库（HIGH）

• io-eager-load-associations - 预加载 ActiveRecord 关联
• io-select-only-needed-columns - 仅选择需要的列
• io-batch-find-each - 对大型记录集使用 find_each
• io-avoid-queries-in-loops - 避免在循环中执行数据库查询
• io-stream-large-files - 逐行流式处理大型文件
• io-connection-pool-sizing - 根据线程数设置连接池大小
• io-cache-expensive-queries - 缓存开销较大的数据库查询结果

4. 字符串处理（HIGH）

• str-frozen-literals - 启用冻结字符串字面量
• str-shovel-over-plus - 构建字符串时使用 shovel 运算符
• str-interpolation-over-concatenation - 使用字符串插值而非拼接
• str-avoid-repeated-gsub - 将多个 gsub 调用合并为一次替换
• str-symbol-for-identifiers - 将符号用于标识符和哈希键

5. 方法与分派（中高）

• meth-avoid-method-missing-hot-paths - 避免在热点路径中使用 method_missing
• meth-cache-method-references - 缓存方法引用以供重复调用
• meth-block-vs-proc - 直接传递块，而不是将其转换为 Proc
• meth-avoid-dynamic-send - 避免在性能关键代码中使用动态 send
• meth-reduce-method-chain-depth - 减少热点循环中的方法链深度

6. 数据结构（中）

• ds-set-for-membership - 使用 Set 进行成员资格测试
• ds-struct-over-openstruct - 使用 Struct 替代 OpenStruct
• ds-sort-by-over-sort - 使用 sort_by，而不是带块的 sort
• ds-array-preallocation - 已知大小时预分配数组
• ds-hash-default-value - 使用 Hash 默认值，而不是条件赋值

7. 并发（中）

• conc-fiber-for-io - 使用 Fiber 实现 I/O 密集型并发
• conc-thread-pool-sizing - 根据工作负载设置线程池大小
• conc-ractor-cpu-bound - 使用 Ractor 实现 CPU 密集型并行处理
• conc-avoid-shared-mutable-state - 避免线程间共享可变状态

8. 运行时与配置（低中）

• runtime-enable-yjit - 为生产环境启用 YJIT
• runtime-tune-gc-parameters - 根据工作负载调整 GC 参数
• runtime-frozen-string-literal-default - 将冻结字符串字面量设为项目默认值
• runtime-optimize-require - 优化 require 加载顺序

使用方法

阅读各个参考文件，了解详细说明和代码示例：

• 章节定义 - 类别结构和影响级别
• 规则模板 - 添加新规则的模板

参考文件

文件	说明
references/_sections.md	类别定义和排序
assets/templates/_template.md	新规则模板
metadata.json	版本和参考信息