如何获取 ruby​​ on Rails 中的控制器和操作列表？

Question

在rails中，我可以通过controller_name获取当前控制器的名称，并通过调用action_name获取当前操作。我正在寻找类似的运行时反射来获取以下内容：

1. 应用程序中所有控制器的列表。
2. 给定控制器中的所有操作的列表。

例如，我有一个具有“添加”和“编辑”操作的产品控制器。我可以通过编程方式提取这些操作的名称来向用户显示支持哪些操作吗？

我研究了一种调用 ActionController::Routing::Routes.named_routes.routes.each 的方法 但我无法让它发挥作用。当我使用它时，我遇到了未初始化的常量 ActionDispatch::Routing::Routes 错误。

如果有什么好的教程或文档可以帮助我了解rails反射功能如何。我搜索了它，但我主要找到了与活动记录反射相关的博客。我正在寻找一些可以让我在运行时获取有关控制器和操作/方法的信息的东西。
谢谢，

塔布雷兹

Answer 1

获取控制器类列表的最简单方法是：

ApplicationController.descendants

但是，由于类是延迟加载的，因此您需要在执行此操作之前预先加载所有类。请记住，此方法需要时间，并且会减慢启动速度：

Rails.application.eager_load!

要获取控制器中的所有操作，请使用 action_methods

PostsController.action_methods

这将返回一个 Set，其中包含控制器中作为“操作”的所有方法的列表（使用 Rails 用来确定方法是否是要路由到的有效操作的相同逻辑）。

Answer 2

PostsController.action_methods 将返回 PostsController 的所有操作，包括继承的，这不是我想要的，我发现 PostsController.instance_methods(false)，它将返回 PostsController 的所有实例方法，而不包括继承的方法，这正是我想要的。

Answer 3

我也有类似的问题；就我而言，它是用于编写控制器测试。我想对某些控制器的每个操作运行某些基本测试（例如，如果用户未登录，则返回 401）。 action_methods 解决方案的问题在于，它会选取控制器类上的所有方法，即使该方法在 config/routes.rb 中没有相应的路由。

这就是我最终要做的：

def actions_for_controller(controller_path)
  route_defaults = Rails.application.routes.routes.map(&:defaults)
  route_defaults = route_defaults.select { |x| x[:controller] == controller_path }
  route_defaults.map { |x| x[:action] }.uniq
end

所以如果你想要 PostsController 的操作列表，你会说：

actions_for_controller('posts')

你会得到：

['show', 'create', 'edit', 'destroy'] (or whatever)

如果你想要所有控制器的列表，类似这样的事情应该可以做到：

def controllers_list
  route_defaults = Rails.application.routes.routes.map(&:defaults)
  files = route_defaults.map { |x| "#{x[:controller]}_controller" }.uniq
  files -= ['_controller']
  files.map { |x| x.split('/').map(&:camelize).join('::').constantize }
end

Answer 4

我们正在清理未使用的控制器和操作。所以我想创建一个详尽的列表来标记删除。这就是我最终所做的

ApplicationController.descendants.each do |controller|
  puts controller.name
  controller.action_methods.each do |action|
    puts '  ' + action
  end
end

，它提供了一个很好的列表，其中包含在控制器名称下缩进的操作。

Answer 5

TLDR，

您可以在 Rails 控制台上检查这一点，

all_controllers = Rails.application.routes.routes.map do |route|
  route.defaults[:controller]
end.uniq.compact

controllers = all_controllers.reject { |x| x =~ /active_storage|rails|action_mailbox|devise|service_worker/ }
controller_with_actions = controllers.map do |name|
  controller = if name.match?('/') 
      splits = name.split('/')
      prefix = splits[0..-2].map(&:capitalize)
      suffix = [splits[-1]].map(&:classify)
      (prefix + suffix).join('::').pluralize
    else 
      name.classify.pluralize
    end
  verified_controller = controller.concat('Controller').constantize rescue controller.singularize.concat('Controller').constantize rescue next
  [verified_controller.to_s, verified_controller&.public_instance_methods(false)&.to_a] rescue next
end.compact 

# [
#   ["DashboardController", ["index"]],
#   ["UsersController", ["index", "new", "create", "show", "update", "destroy"]]
#   ["Api::V1::StaticController", ["index", "new", "create", "show", "update", "destroy"]]
# ] 

这也已经在 Rails 7.0 和其他较低版本中进行了测试。
因为 ApplicationController.descendants 在 Rails 的第 7 版中根本不起作用。

或者您可以在我的公共 github gist ControllerActionList 链接上使用我的课程