跳到内容 跳到搜索

抽象控制器 Base

AbstractController::Base 是一个低级 API。没有人应该直接使用它，子类（例如 ActionController::Base）应该提供自己的 render 方法，因为渲染的含义根据上下文不同。

方法
A
C
F
I
M
P
R
S
包含的模块

属性

[R] abstract
[R] abstract?

类公共方法

abstract!()

将控制器定义为抽象。有关更多详细信息，请参阅 internal_methods。

来源：显示 | 在 GitHub 上

# File actionpack/lib/abstract_controller/base.rb, line 58
def abstract!
  @abstract = true
end

action_methods()

应该被视为操作的方法名称列表。这包括控制器上所有公共实例方法，减去任何内部方法（见 internal_methods），将类本身存在的任何内部方法添加回来。

返回值

  • Set - 所有应该被视为操作的方法的集合。

来源：显示 | 在 GitHub 上

# File actionpack/lib/abstract_controller/base.rb, line 97
def action_methods
  @action_methods ||= begin
    # All public instance methods of this class, including ancestors except for
    # public instance methods of Base and its ancestors.
    methods = public_instance_methods(true) - internal_methods
    # Be sure to include shadowed public instance methods of this class.
    methods.concat(public_instance_methods(false))
    methods.map!(&:to_s)
    methods.to_set
  end
end

clear_action_methods!()

action_methods 被缓存，有时需要刷新它们。 ::clear_action_methods! 允许你这样做，所以下次你运行 action_methods 时，它们将被重新计算。

来源：显示 | 在 GitHub 上

# File actionpack/lib/abstract_controller/base.rb, line 112
def clear_action_methods!
  @action_methods = nil
end

controller_path()

返回完整控制器名称，带下划线，不含结尾的 Controller。

class MyApp::MyPostsController < AbstractController::Base

end

MyApp::MyPostsController.controller_path # => "my_app/my_posts"

返回值

  • 字符串

来源：显示 | 在 GitHub 上

# File actionpack/lib/abstract_controller/base.rb, line 127
def controller_path
  @controller_path ||= name.delete_suffix("Controller").underscore unless anonymous?
end

internal_methods()

控制器所有内部方法的列表。这会找到控制器的第一个抽象超类，并获取该抽象类上所有公共实例方法的列表。控制器的公共实例方法通常会被视为操作方法，因此在抽象类上声明的方法被移除。（ActionController::Metal 和 ActionController::Base 被定义为抽象）

来源：显示 | 在 GitHub 上

# File actionpack/lib/abstract_controller/base.rb, line 77
def internal_methods
  controller = self
  methods = []

  until controller.abstract?
    methods += controller.public_instance_methods(false)
    controller = controller.superclass
  end

  controller.public_instance_methods(true) - methods
end

method_added(name)

当添加新的 action_method 时，刷新缓存的 action_methods。

来源：显示 | 在 GitHub 上

# File actionpack/lib/abstract_controller/base.rb, line 132
def method_added(name)
  super
  clear_action_methods!
end

supports_path?()

如果给定控制器能够渲染路径，则返回 true。AbstractController::Base 的子类可能返回 false。例如，电子邮件控制器不支持路径，只支持完整的 URL。

来源：显示 | 在 GitHub 上

# File actionpack/lib/abstract_controller/base.rb, line 200
def self.supports_path?
  true
end

实例公共方法

action_methods()

委托给类的 ::action_methods。

来源：显示 | 在 GitHub 上

# File actionpack/lib/abstract_controller/base.rb, line 172
def action_methods
  self.class.action_methods
end

action_name

返回此控制器正在处理的操作的名称。

来源：显示 | 在 GitHub 上

# File actionpack/lib/abstract_controller/base.rb, line 44
attr_internal :action_name

available_action?(action_name)

如果操作的方法可用并且可以调度，则返回 true，否则返回 false。

请注意，action_methods.include?("foo") 可能会返回 false，而 available_action?("foo") 返回 true，因为此方法考虑了通过其他方式也可用操作，例如隐式渲染操作。

参数

  • action_name - 要测试的操作的名称

来源：显示 | 在 GitHub 上

# File actionpack/lib/abstract_controller/base.rb, line 187
def available_action?(action_name)
  _find_action_name(action_name)
end

controller_path()

委托给类的 ::controller_path。

来源：显示 | 在 GitHub 上

# File actionpack/lib/abstract_controller/base.rb, line 167
def controller_path
  self.class.controller_path
end

formats

返回控制器可以处理的格式。

来源：显示 | 在 GitHub 上

# File actionpack/lib/abstract_controller/base.rb, line 48
attr_internal :formats

performed?()

测试是否设置了响应体。用于确定 AbstractController::Callbacks 中是否需要终止 process_action 回调。

来源：显示 | 在 GitHub 上

# File actionpack/lib/abstract_controller/base.rb, line 193
def performed?
  response_body
end

process(action, ...)

调用操作，遍历整个 Action Dispatch 堆栈。

实际调用的方法是通过调用 method_for_action 确定的。如果没有任何方法可以处理操作，则会抛出 AbstractController::ActionNotFound 错误。

返回值

  • 自身

来源：显示 | 在 GitHub 上

# File actionpack/lib/abstract_controller/base.rb, line 154
def process(action, ...)
  @_action_name = action.to_s

  unless action_name = _find_action_name(@_action_name)
    raise ActionNotFound.new("The action '#{action}' could not be found for #{self.class.name}", self, action)
  end

  @_response_body = nil

  process_action(action_name, ...)
end

response_body

返回控制器发送的 HTTP 响应的主体。

来源：显示 | 在 GitHub 上

# File actionpack/lib/abstract_controller/base.rb, line 40
attr_internal :response_body