控制器和交互器上错误处理的最佳实践

时间:2018-07-31 06:55:23

标签: ruby error-handling hanami

# users_show_controller.rb
class Controllers::Users::Show
  include Hanami::Action

  params do
    required(:id).filled(:str?)
  end

  def call(params)
    result = users_show_interactor(id: params[:id])

    halt 404 if result.failure?
    @user = result.user
  end
end

# users_show_interactor.rb
class Users::Show::Interactor
  include Hanami::Interactor

  expose :user
  def call(:id)
    @user = UserRepository.find_by(:id)
  end
end

我有一个像上面一样的控制器和一个交互器。 而且我正在考虑在控制器上区分ClientError和ServerError的更好方法。

如果可以处理如下错误,我认为很好。

handle_exeption StandardError => :some_handler

但是,hanami-interactor将自身引发的错误包装起来,因此,控制器通过来自interactor的结果对象接收错误。

我不认为重新引发控制器错误是个好方法。

result = some_interactor.call(params)
raise result.error if result.failure

如何实现这样的错误处理程序? 我知道if语句会很容易增加,因此这种方式并不明智。

def call(params)
  result = some_interactor.call(params)
  handle_error(result.error) if result.faulure?
end

private

def handle_error(error)
  return handle_client_error(error) if error.is_a?(ClientError)
  return server_error(error) if error.is_a?(ServerError)
end

3 个答案:

答案 0 :(得分:1)

实际上不是面向花名的方式,但是请看看dry-monads with do notation。基本思想是,您可以通过以下方式编写类似交互器的处理代码

matcher.(result) do |m|
  m.success do |v|
    # ok
  end

  m.failure :some_error_code do |v|
    halt 400
  end

  m.failure :some_error_2 do |v|
    halt 422
  end
end

然后在控制器中,您可以使用dry-matcher来匹配故障:

prepend

可以在class Car { Long weight; String model; String color; Engine engine; } class Engine { Long power; Long torque; Enum fuelType; } 代码中为所有控制器定义匹配器,因此很容易删除重复的代码。

答案 1 :(得分:0)

Hanami方法是在每个请求处理程序之前验证输入参数。因此,必须始终在操作逻辑之前识别ClientError。

halt 400 unless params.valid? #halt ClientError
#your code
result = users_show_interactor(id: params[:id])
halt 422 if result.failure? #ServerError
halt 404 unless result.user
@user = result.user

答案 2 :(得分:0)

我通常通过在交互器中引发范围错误来解决问题,然后控制器只需挽救由交互器引发的错误并返回适当的状态响应即可。

交互者:

module Users
  class Delete
    include Tnt::Interactor

    class UserNotFoundError < ApplicationError; end

    def call(report_id)
      deleted = UserRepository.new.delete(report_id)

      fail_with!(UserNotFoundError) unless deleted
    end
  end
end

控制器:

module Api::Controllers::Users
  class Destroy
    include Api::Action
    include Api::Halt

    params do
      required(:id).filled(:str?, :uuid?)
    end

    def call(params)
      halt 422 unless params.valid?

      Users::Delete.new.call(params[:id])
    rescue Users::Delete::UserNotFoundError => e
      halt_with_status_and_error(404, e)
    end
  end
end

fail_with!halt_with_status_and_error分别是我的交互器和控制器通用的辅助方法。

# module Api::Halt
def halt_with_status_and_error(status, error = ApplicationError)
  halt status, JSON.generate(
    errors: [{ key: error.key, message: error.message }],
  )
end

# module Tnt::Interactor
def fail_with!(exception)
  @__result.fail!
  raise exception
end