Ruby Mixin/Rails Concern跨包含类共享变量的问题及优化方案

核心思路 #

用模块实例变量存储全局所有类的字段映射表，同时给每个包含Concern的类分配独立的类实例变量保存自身字段配置，既解决开发环境未预加载类导致的映射丢失问题，又满足Rubocop对类变量的规范要求，全程无需数据库存储声明式规则。

完整实现代码 #

module TrackMissingFields
  extend ActiveSupport::Concern

  # 模块实例变量：存储所有包含类的字段映射表
  @global_field_mappings = {}

  class_methods do
    # 声明字段及填充判断逻辑
    def add_fields(field_rules)
      # 类实例变量：当前类专属的字段配置
      @local_field_rules ||= {}
      @local_field_rules.merge!(field_rules)

      # 同步到模块全局映射
      TrackMissingFields.register_class_rules(self.name, @local_field_rules)
    end

    # 获取当前类的字段规则
    def field_rules
      @local_field_rules || {}
    end
  end

  included do
    # 类被包含时自动注册到全局映射
    TrackMissingFields.register_class_rules(self.name, self.field_rules)
  end

  # 模块级方法：管理全局映射
  class << self
    def register_class_rules(class_name, rules)
      @global_field_mappings[class_name] = rules
    end

    # 获取所有类的字段映射（开发环境自动预加载）
    def all_field_mappings
      if Rails.env.development?
        Rails.application.eager_load!
      end
      @global_field_mappings
    end

    # 示例：批量检查用户的缺失字段
    def collect_missing_fields(user)
      all_field_mappings.flat_map do |class_name, rules|
        klass = class_name.constantize
        record = klass.find_by(user: user)
        next [] unless record

        rules.reject { |_, check_proc| check_proc.call(record) }.keys.map do |field|
          "#{klass.model_name.human}.#{field}"
        end
      end
    end
  end
end

关键细节说明 #

• 模块实例变量@global_field_mappings：替代原类变量，仅属于TrackMissingFields模块，避免类变量的继承共享风险。
• 类实例变量@local_field_rules：每个包含Concern的类拥有独立的变量存储自身字段规则，完全符合Rubocop的规范要求。
• 开发环境预加载：在all_field_mappings中调用Rails.application.eager_load!，强制加载所有模型类，确保字段规则被初始化。
• 声明式配置示例：在模型中直接定义字段规则：

  class UserProfile < ApplicationRecord
    include TrackMissingFields
  
    add_fields(
      bio: ->(profile) { profile.bio.present? },
      avatar: ->(profile) { profile.avatar.attached? },
      phone: ->(profile) { profile.phone.match?(/^\d{11}$/) }
    )
  end
  

使用方式 #

获取当前用户的所有缺失字段：

user_missing_fields = TrackMissingFields.collect_missing_fields(current_user)
# 返回示例：["用户资料.bio", "用户资料.phone"]

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