在库中包装第三方服务的最佳实践

Question

我有兴趣为我正在使用的第三方 API 编写一个库，并且我需要一些建议。该库的平均使用会在一个请求中涉及多个 api 调用。例如，一次 api 调用从第三方服务获取用户，然后另一次调用使用该用户获取他/她的照片。每个 API 调用都会获得自己的库方法包装器，并带有额外的逻辑来处理错误/超时，但我最大的问题是该库是否应该作为包含状态的单例或仅作为一系列类方法。

例如：

user_id = ThirdParty.get_user("[email protected]")
photos = ThirdParty.get_photos(user_id)

或者

thirdpartyservice = ThirdPartyService.new("[email protected]")
photos = thirdpartyservice.get_photos

这些不一定是库的确切设计，但我只是对每种方法的优缺点感到困惑。任何帮助都会很棒！

顺便说一句，我正在使用红宝石！

Answer 1

我会让库包含状态，因为这会降低用户端代码的复杂性（这就是 API 应该做的，增加简单性）。通过这种方法，用户不必跟踪该 user_id，因为库会保留该状态。

如果用户确实想要他们的 user_id （或库存储的任何其他数据），您只需在库中创建一个 attr_reader 即可公开该数据。

要为 get_photos 方法添加灵活性，您可以执行以下操作：

class ThirdPartyService

  def get_photos(user_id=@id_stored_in_library)
    # do work
  end

end

这种方式默认为存储的 id，但是它增加了灵活性，因为用户可以根据需要指定 userid。

Answer 2

您需要状态（主机等）和基于该状态的行为，因此您应该使用对象，而不是一个单例对象。

如前所述，您不应命名诸如 get_photos 之类的方法，而应命名为 photos。

Answer 3

我认为最佳实践是使用提供商和服务，以便能够不受特定服务提供商的束缚。您可能希望对其进行一些抽象，而不是简单地包装该库，并且默认情况下仅允许单个服务提供者。

尽管在像 Ruby 这样的动态/鸭类型语言中并不真正需要继承，但这可能有助于具体化“原因”。

class MailProvider 

  def initialize(args); raise "Not Implemented"; end

  def send_mail(args); raise "Not Implemented"; end

end

class SendGridService < MailProvider

  def initialize(args)
    # Use args here
  end

  def send_mail(args)
    # Use SendGrid's API or Gem here
  end

end

然后，在您的代码中可以有这样的内容：

config.mail_provider = SendGridService.new({
  username: ENV['SENDGRID_USERNAME'],
  password: ENV['SENDGRID_PASSWORD']
})

config.mail_provider.send_mail({ subject: 'woot', message: 'Look ma, I did it!' })

然后六个月后，当您的用户喜欢您的 Gem/库但需要 MailChimp 支持时，您可以简单地创建第二个服务“MailChimpService”并允许您的客户使用新的提供程序。

Answer 4

使用 getter 和 setter 方法会比 get_set_ 方法更好。它是 ruby​​ 标准（不确定，但 get_ 和 set_ 方法我只在 ruby​​ 代码中看到过一次）。

如果您不需要在请求之间保存某些状态，请将其设为静态。但这取决于很多因素。您能告诉我们您需要包装哪些 API 吗？