Ruby中处理多个布尔选项时保持代码可读性的方案咨询

问题描述 #

我需要处理若干布尔选项，最初参考C语言的常规实现方式，通过位掩码定义如下选项常量：

DICT    = 0x000020000
  FILTER  = 0x000040000
  HIGH    = 0x000080000
  KEEP    = 0x000100000
  NEXT    = 0x000200000

初始实现中，可将任意组合的选项赋值给Integer类型变量，再通过位运算判断指定选项是否存在：

action if (opts & HIGH|KEEP) != 0

但该写法可读性较差，期望实现更直观的调用形式：

action if opts.have HIGH|KEEP

核心待解决问题：

• 如何定义have实例方法，将其作用域限定在使用选项的模块、以及包含该模块的类范围内，避免全局修改Integer类引发的命名冲突
• 这类多布尔选项处理场景是否有更优实现，单独封装Options类是否属于过度设计

解决方案 #

1. 限定作用域的have方法实现 #

不要直接全局重开Integer类添加方法，使用语言原生的细化（Refinements）特性即可实现方法的作用域生效，完全不会污染全局环境：

• 在定义选项常量的模块内，通过refine为Integer添加have方法，该方法默认不会在全局生效
• 仅在主动调用using 对应模块的代码作用域内，Integer实例才可以调用have方法，超出作用域后方法自动失效，不会和其他位置的同名方法产生冲突
  参考实现：

module OptionConstants
  DICT    = 0x000020000
  FILTER  = 0x000040000
  HIGH    = 0x000080000
  KEEP    = 0x000100000
  NEXT    = 0x000200000

  refine Integer do
    # 支持传入多个选项，判断是否同时包含所有传入选项
    def have(*flags)
      combined_mask = flags.reduce(:|)
      (self & combined_mask) == combined_mask
    end
  end
end

使用时仅需在需要该语法的类/模块顶部声明using OptionConstants即可：

class BusinessProcessor
  # 仅在当前类作用域内生效
  using OptionConstants
  def process(opts)
    # 可以正常调用have方法
    run_action if opts.have(HIGH, KEEP)
  end
end

# 类外部、其他未using的模块中调用 1.have(HIGH) 会直接抛出NoMethodError，无冲突风险

注意：原始写法(opts & HIGH|KEEP) != 0存在位运算优先级问题，会先计算opts & HIGH再和KEEP做或运算，判断逻辑不符合预期，have方法内先合并所有传入的掩码再做位运算，可规避该问题。如果需要判断「包含任意一个传入选项」，将判断条件改为(self & combined_mask) != 0即可。

2. 多布尔选项的方案选型 #

单独封装轻量Options类不属于过度设计，是否封装完全取决于使用场景：

• 如果选项仅在几十行以内的简单脚本中使用，不会跨模块传递、后续也没有迭代调整的需求，用上述Refinements+位掩码的实现足够，轻量无额外负担
• 如果选项需要跨多个模块传递、后续会新增/调整选项，封装Options类的成本极低，还能从根源上避免裸位运算的优先级错误、魔法值散落在代码中的问题，可维护性远高于直接用整数存储掩码
  极简Options类参考实现：

class OptionSet
  # 选项定义统一收口，后续调整仅需修改此处
  FLAGS = {
    dict:   0x000020000,
    filter: 0x000040000,
    high:   0x000080000,
    keep:   0x000100000,
    next:   0x000200000
  }

  attr_reader :value
  def initialize(initial_value = 0)
    @value = initial_value
  end

  # 判断是否同时包含所有传入选项
  def have?(*flag_names)
    combined = flag_names.map { |name| FLAGS.fetch(name) }.reduce(:|)
    (@value & combined) == combined
  end

  # 可按需扩展添加选项、移除选项等方法，比直接操作整数位更直观
  def add(*flag_names)
    combined = flag_names.map { |name| FLAGS.fetch(name) }.reduce(:|)
    @value |= combined
  end
end

# 调用方式
opts = OptionSet.new(HIGH | KEEP)
run_action if opts.have?(:high, :keep)

该实现将位运算逻辑完全封装在类内部，调用方不需要感知底层掩码的具体值，后续调整选项、新增逻辑都不需要修改调用侧代码。

内容的提问来源于stack exchange，提问作者PMc