• Homepage
• Github
• RubyGem (code_error)

What

它一個標準的StandardError，但加上了錯誤代碼(code)來管理一系列錯誤情況的功能。

Why

錯誤的情況有很多種，通常都需要能根據不同情況來進行不同的處理，單一個StandardError很難做這點。CodeError則是基於StandardError多了下面的特點：

• 所有的錯誤情況都定義在同一個class中，方便管理與參考。
• 只要在raise一個帶有錯誤代碼的CodeError，就可以使用對應的錯誤訊息與狀態。
• 高度客制化與彈性的設計，可以自行定義預設的錯誤訊息與狀態。

How

1. 定義一個class繼承CodeError::Base，在class中定義錯誤代碼。

class MyError < CodeError::Base
  error_codes({
    purchase_info_incorrect: {
      status: :failed,
      msg: 'Purchase information format is incorrect.'
    },
    device_info_incorrect: {
      status: :failed,
      msg: 'Device information format is incorrect.'
    },
    unknown_store: {
      status: :failed,
      msg: 'Unknown store.'
    },
    duplicated_request: {
      status: :duplicated,
      msg: 'A duplicated IAP request is sent.'
    },
    resend_iap: {
      status: :retry,
      msg: 'Client should send the IAP request again.'
    }
  })
end

2. 在raise錯誤時加上錯誤代碼。

raise MyError.gen(:purchase_info_incorrect)

3. rescue，接著就可以根據錯誤情況來處理它。

begin
  #...
  raise MyError.gen(:purchase_info_incorrect)
  #...
rescue MyError => e
  raise e if e.internal?
  msg = e.msg
  code = e.code
  info = e.info
  data = e.data
  case(e.status)
  when :failed
    #...
  when :duplicated
    #...
  else
    #...
  end
  #...
end

心得

一直覺得用StandardError來處理多種錯誤的情況有點不太夠用，用繼承體系做出多的Error似乎又太麻煩，而且不好管理，於是就試著做個可以儲存狀態的Error。只是對於ruby的dsl還不是很熟，想要做出方便好用的使用方式(就是可以在class中設定變數)倒是花了一段時間。