ruby - 在 Grape 中只加载一次属性

Question

我对 Ruby 有点陌生，但我在 Ruby 中使用 Grape API 编写了以下代码。每次点击 GET/api/v1/foo 时，我都会调用 @data = YAML.load()，在 Grape 中有没有办法只加载一次并使用它？这种方式更加优化，不会每次都调用 YAML.load()。我是否应该覆盖 initialize 方法并为此操作放置一个 super()？

谢谢，

require 'grape'
require 'json'
require "yaml"

module MyProject
  CONFIG_FILE = "./config.yml"

  class Api < Grape::API
    rescue_from :all
    prefix 'api'
    version 'v1'
    format :json

    resources :foo do
      get do
        @data = YAML.load(File.open(MyProject::CONFIG_FILE))
      end
    end
  end
end

Answer 1

简短的回答是 Grape 并不像您想象的那样工作，并且 MyProject::Api 的属性变量不是您新网站的前进方向服务。然而，这是一个有趣的问题，值得探讨为什么会这样。

如果你在 resources :foo block 中添加一个 puts self.inspect，并使用 rackup 运行，当你调用路由时应该看到 self 实际上是一个 Grape::Endpoint 对象。此外，无论您尝试对实例变量做什么，对于每个请求，它们总是以相同的状态开始。那是因为 Grape 将你的路由定义变成了准备好的 Grape::Endpoint 对象，大量的定义数据和设置被放入了一个快速访问的形式(所以它每个请求都没有计算出来)。最终，在每个请求中，匹配的 Grape::Endpoint 对象包括你的 block (以及你为路由定义的其他细节)在被调用之前被复制，这意味着状态是在请求之间不维护。

这可能看起来很复杂，但大多数涵盖网络服务请求的框架都会做类似的事情。通常您不希望请求处理状态在请求之间持续存在。范围更大的框架——例如Rails - 有地方可以放置为您计划的更持久的数据。葡萄没有这个定义，这有其优点和缺点。一个明显的优点是您可以更自由地使用您希望使用的任何其他数据持久性方法。

23tux 的回答将立即为您整理加载配置。虽然我不完全确定 @@data 是如何被端点 block 访问的(它甚至可能在变量周围创建一个闭包)。

从长远来看，您应该考虑将配置管理移出您的 MyProject::Api 类，并通过 Grape 的 helpers 方法将其作为一个模块包含在内(我是如果您有兴趣，很乐意提供示例)。

编辑:示例基于您当前的代码，但将配置管理移至单独的模块:

require 'grape'
require 'json'
require "yaml"

module MyProject

  module Config
    CONFIG_FILE = "./config.yml"
    @@data = nil
    def config
      @@data ||= YAML.load( File.open( CONFIG_FILE ) )
    end
  end

  class Api < Grape::API
    rescue_from :all
    prefix 'api'
    version 'v1'
    format :json

    helpers MyProject::Config

    resources :foo do
      get do
        config
      end
    end
  end
end

这在结构上比 23tux 的答案更进一步，但仍未完全分离存储(和缓存等)与 api 访问的关注点。随着您向更复杂的 Web 服务迈进，您将希望保持 Grape 路由定义简单，仅使用少量逻辑来管理或操作数据 - 好吧，至少如直接在 block 中看到的那样。

在您的 Grape 定义与可能管理配置、日志记录、身份验证和其他服务的其他 gem 之间建立链接的一种方法是通过 Grape 的 helpers 方法。 Grape 还有一些用于常见任务的内置辅助方法。

使用 helpers MyModule 将共享函数添加到 Grape 的主要异常(exception)是当您想要管理来自核心应用程序的显示数据对象(又名“模型”)时。为此，您有几个选择，但 grape-entity gem 和 present 方法是一个不错的起点。