如何在Ruby on Rails中确定控制器处理的路由？含继承场景

核心思路 #

Rails路由直接映射到子类控制器，但我们需要逆向关联：先找到目标控制器的所有子类，再筛选出这些子类的路由，最后验证路由对应的action是否由目标控制器（或其祖先）定义且未被子类重写。

实现脚本 #

在Rails项目根目录创建脚本find_controller_routes.rb，内容如下：

#!/usr/bin/env ruby
require './config/environment'

# 从文件名获取控制器类
def get_controller_class(filename)
  controller_name = filename.gsub('.rb', '').camelize
  controller_name.constantize
rescue NameError
  puts "无法找到对应控制器类: #{controller_name}"
  exit 1
end

# 获取目标控制器的所有直接/间接子类
def get_all_subclasses(controller_class)
  ObjectSpace.each_object(Class).select { |klass| klass < controller_class }
end

# 筛选并格式化符合条件的路由
def find_routes_for_controller(target_controller)
  subclasses = get_all_subclasses(target_controller)
  return [] if subclasses.empty?

  subclass_names = subclasses.map { |sc| sc.name.underscore }
  matching_routes = []

  Rails.application.routes.routes.each do |route|
    defaults = route.defaults
    next unless defaults[:controller] && defaults[:action]

    # 检查路由是否指向目标控制器的子类
    next unless subclass_names.include?(defaults[:controller])

    action = defaults[:action].to_sym
    subclass = subclasses.find { |sc| sc.name.underscore == defaults[:controller] }

    # 验证action是否由目标控制器定义且未被子类重写
    if target_controller.method_defined?(action) && 
       subclass.instance_method(action) == target_controller.instance_method(action)
      
      # 格式化路由信息：请求方法 + 路径
      verb = route.verb.to_s.upcase.gsub('^', '')
      path = route.path.spec.to_s.gsub('(.:format)', '')
      matching_routes << "#{verb} #{path}"
    end
  end

  matching_routes.uniq
end

# 主逻辑
if ARGV.empty?
  puts "请传入控制器文件名，例如: ruby find_controller_routes.rb user_base_controller.rb"
  exit 1
end

filename = ARGV.first
target_controller = get_controller_class(filename)
routes = find_routes_for_controller(target_controller)

if routes.empty?
  puts "未找到目标控制器关联的路由"
else
  puts "目标控制器 #{target_controller.name} 处理的路由:"
  routes.each { |route| puts "- #{route}" }
end

使用方法 #

1. 给脚本添加执行权限：chmod +x find_controller_routes.rb
2. 运行脚本并传入控制器文件名：

   ./find_controller_routes.rb user_base_controller.rb
   

   输出示例：

   目标控制器 UserBaseController 处理的路由:
   - PUT /users/:id
   

关键细节说明 #

• 加载Rails环境：通过require './config/environment'获取路由和控制器的元数据。
• 子类查找：用ObjectSpace.each_object(Class)遍历所有类，筛选出继承自目标控制器的子类，包括间接继承。
• 重写验证：通过subclass.instance_method(action) == target_controller.instance_method(action)判断子类是否重写了action，确保只返回实际由目标控制器实现的路由。
• 路由格式化：去掉路由中的(.:format)后缀，让输出更简洁直观。

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