Ruby自定义错误类:message属性的继承

Question

我似乎无法找到有关自定义异常类的更多信息.

我所知道的

您可以声明自定义错误类并让它继承StandardError,因此它可以是rescued:

class MyCustomError < StandardError
end

这允许您使用以下方法来提高它:

raise MyCustomError, "A message"

然后,在救援时获取该消息

rescue MyCustomError => e
  puts e.message # => "A message"

我不知道的

我想给我的异常一些自定义字段,但我想message从父类继承该属性.我发现阅读关于这个主题是@message不是异常类的实例变量,所以我很担心我的遗产将无法正常工作.

谁能给我更多细节呢？如何使用object属性实现自定义错误类？以下是正确的:

class MyCustomError < StandardError
  attr_reader :object
  def initialize(message, object)
    super(message)
    @object = object
  end
end

然后:

raise MyCustomError.new(anObject), "A message"

要得到:

rescue MyCustomError => e
  puts e.message # => "A message"
  puts e.object # => anObject

它会起作用,如果确实如此,这是正确的做事方式吗？

Answer 1

raise 已设置消息,因此您不必将其传递给构造函数:

class MyCustomError < StandardError
  attr_reader :object

  def initialize(object)
    @object = object
  end
end

begin
  raise MyCustomError.new("an object"), "a message"
rescue MyCustomError => e
  puts e.message # => "a message"
  puts e.object # => "an object"
end

我已经替换rescue Exception了rescue MyCustomError,看看为什么在Ruby中"拯救Exception => e`是一种糟糕的风格？.

Answer 2

鉴于Exception所有其他错误继承的ruby核心文档所述的内容#message

返回调用exception.to_s的结果.通常,这会返回异常的消息或名称.通过提供to_str方法,异常同意在期望字符串的地方使用.

http://ruby-doc.org/core-1.9.3/Exception.html#method-i-message

我会选择重新定义to_s/ to_str或初始化程序.以下是一个示例,我们希望以外部服务无法执行某些操作的方式以人类可读的方式了解这些内容.

注意:下面的第二个策略使用rails pretty字符串方法,例如demodualize,这可能有点复杂,因此在异常中可能不明智.如果需要,您还可以为方法签名添加更多参数.

重写#to_s策略 而不是#to_str,它的工作方式不同

module ExternalService

  class FailedCRUDError < ::StandardError
    def to_s
      'failed to crud with external service'
    end
  end

  class FailedToCreateError < FailedCRUDError; end
  class FailedToReadError < FailedCRUDError; end
  class FailedToUpdateError < FailedCRUDError; end
  class FailedToDeleteError < FailedCRUDError; end
end

控制台输出

begin; raise ExternalService::FailedToCreateError; rescue => e; e.message; end
# => "failed to crud with external service"

begin; raise ExternalService::FailedToCreateError, 'custom message'; rescue => e; e.message; end
# => "failed to crud with external service"

begin; raise ExternalService::FailedToCreateError.new('custom message'); rescue => e; e.message; end
# => "failed to crud with external service"

raise ExternalService::FailedToCreateError
# ExternalService::FailedToCreateError: failed to crud with external service

覆盖#initialize策略

这是最接近我在rails中使用的实现的策略.如上所述,它使用demodualize,underscore以及humanize ActiveSupport方法.但这可以很容易地删除,就像之前的策略一样.

module ExternalService
  class FailedCRUDError < ::StandardError
    def initialize(service_model=nil)
      super("#{self.class.name.demodulize.underscore.humanize} using #{service_model.class}")
    end
  end

  class FailedToCreateError < FailedCRUDError; end
  class FailedToReadError < FailedCRUDError; end
  class FailedToUpdateError < FailedCRUDError; end
  class FailedToDeleteError < FailedCRUDError; end
end

控制台输出

begin; raise ExternalService::FailedToCreateError; rescue => e; e.message; end
# => "Failed to create error using NilClass"

begin; raise ExternalService::FailedToCreateError, Object.new; rescue => e; e.message; end
# => "Failed to create error using Object"

begin; raise ExternalService::FailedToCreateError.new(Object.new); rescue => e; e.message; end
# => "Failed to create error using Object"

raise ExternalService::FailedCRUDError
# ExternalService::FailedCRUDError: Failed crud error using NilClass

raise ExternalService::FailedCRUDError.new(Object.new)
# RuntimeError: ExternalService::FailedCRUDError using Object

演示工具

这是一个演示以显示上述实现的救援和消息传递.引发异常的类是Cloudinary的伪API.只需将上述策略中的一个转储到rails控制台,然后执行此操作.

require 'rails' # only needed for second strategy 

module ExternalService
  class FailedCRUDError < ::StandardError
    def initialize(service_model=nil)
      @service_model = service_model
      super("#{self.class.name.demodulize.underscore.humanize} using #{@service_model.class}")
    end
  end

  class FailedToCreateError < FailedCRUDError; end
  class FailedToReadError < FailedCRUDError; end
  class FailedToUpdateError < FailedCRUDError; end
  class FailedToDeleteError < FailedCRUDError; end
end

# Stub service representing 3rd party cloud storage
class Cloudinary

  def initialize(*error_args)
    @error_args = error_args.flatten
  end

  def create_read_update_or_delete
    begin
      try_and_fail
    rescue ExternalService::FailedCRUDError => e
      e.message
    end
  end

  private def try_and_fail
    raise *@error_args
  end
end

errors_map = [
  # Without an arg
  ExternalService::FailedCRUDError,
  ExternalService::FailedToCreateError,
  ExternalService::FailedToReadError,
  ExternalService::FailedToUpdateError,
  ExternalService::FailedToDeleteError,
  # Instantiated without an arg
  ExternalService::FailedCRUDError.new,
  ExternalService::FailedToCreateError.new,
  ExternalService::FailedToReadError.new,
  ExternalService::FailedToUpdateError.new,
  ExternalService::FailedToDeleteError.new,
  # With an arg
  [ExternalService::FailedCRUDError, Object.new],
  [ExternalService::FailedToCreateError, Object.new],
  [ExternalService::FailedToReadError, Object.new],
  [ExternalService::FailedToUpdateError, Object.new],
  [ExternalService::FailedToDeleteError, Object.new],
  # Instantiated with an arg
  ExternalService::FailedCRUDError.new(Object.new),
  ExternalService::FailedToCreateError.new(Object.new),
  ExternalService::FailedToReadError.new(Object.new),
  ExternalService::FailedToUpdateError.new(Object.new),
  ExternalService::FailedToDeleteError.new(Object.new),
].inject({}) do |errors, args|
  begin 
    errors.merge!( args => Cloudinary.new(args).create_read_update_or_delete)
  rescue => e
    binding.pry
  end
end

if defined?(pp) || require('pp')
  pp errors_map
else
  errors_map.each{ |set| puts set.inspect }
end

Answer 3

你的想法是正确的,但你称之为错误的方式.它应该是

raise MyCustomError.new(an_object, "A message")

Answer 4

我想做类似的事情。我想将一个对象传递给 #new 并根据传递的对象的一些处理设置消息。以下作品。

class FooError < StandardError
  attr_accessor :message # this is critical!
  def initialize(stuff)
    @message = stuff.reverse
  end
end

begin
  raise FooError.new("!dlroW olleH")
rescue FooError => e
  puts e.message #=> Hello World!
end

请注意，如果您不声明，attr_accessor :message则它将不起作用。解决 OP 的问题，您还可以将消息作为附加参数传递并存储您喜欢的任何内容。关键部分似乎是覆盖#message。