当前位置：文江博客话题详情

定义新 API 时使用 struct 作为参数的优点/缺点

发布于 2024-12-06 05:41:14 字数 243 浏览 2 评论 0原文

我正在编写的 API 适用于继承自 ActiveRecord 的 Ruby 类。我正在尝试编写静态方法以避免泄漏 ActiveRecord 实例。现在所有 API 都需要元组来唯一标识数据库行。

采用以下形式的 API 是个好主意吗：

API1(abc, def, ....) API2(abc, def, ....) 等等

，还是我应该定义一个带有字段的结构来帮助将来的更改？

任何其他想法都非常受欢迎！

原文

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

初与友歌 2024-12-13 05:41:14

在 Ruby 中使用结构会很奇怪，而哈希则很正常：

def self.api1(options)
    # Look at options[:abc], options[:def], ...
end

然后可以使用命名参数来调用它，如下所示：

C.api1 :abc => 'abc', :def => '...'

易于扩展，常见的 Ruby 实践，并且易于使某些参数可选。

Using a struct would be strange in Ruby, a Hash would be normal:

def self.api1(options)
    # Look at options[:abc], options[:def], ...
end

And then it could be called using named arguments like this:

C.api1 :abc => 'abc', :def => '...'

Easy to extend, common Ruby practice, and easy to make certain parameters optional.

回复收藏 0 原文

泪意 2024-12-13 05:41:14

继续 mu 所描述的内容，这是一个常见的 Ruby 习惯用法，您将看到它有一个方法为自己设置一些默认选项，然后将该方法接收到的选项合并到该哈希中。通过这种方式，您可以确保始终存在一些最小选项列表：

def self.api1(options={})
  default_options = { :foo => 'bar', :baz => nil }
  options = default_options.merge options
  # Now include your code and you can assume that options[:foo] and options[:bar] are there
end

例如，当您的方法输出 :baz 的值时，这会派上用场。现在您不需要先检查它是否存在，只需输出它就知道它总是存在。

To continue what mu is describing, a common Ruby idiom you'll see it to have a method set itself some default options and then merge into that hash the options that the method received. This way you can be sure that some minimum list of options always exist:

def self.api1(options={})
  default_options = { :foo => 'bar', :baz => nil }
  options = default_options.merge options
  # Now include your code and you can assume that options[:foo] and options[:bar] are there
end

This comes in handy when your method, for example, outputs the value of :baz. Now you don't need to check that it exists first, you can just output it knowing that it would always exist.

回复收藏 0 原文

~没有更多了~