Swiftでローカライズされた説明とエラータイプを提供するにはどうすればよいですか?


202

Swift 3構文でカスタムエラータイプを定義してlocalizedDescriptionErrorます。オブジェクトのプロパティによって返されるエラーのわかりやすい説明を提供したいと思います。どうすればできますか?

public enum MyError: Error {
  case customError

  var localizedDescription: String {
    switch self {
    case .customError:
      return NSLocalizedString("A user-friendly description of the error.", comment: "My error")
    }
  }
}

let error: Error = MyError.customError
error.localizedDescription
// "The operation couldn’t be completed. (MyError error 0.)"

localizedDescriptionカスタムエラーの説明(「ユーザーにわかりやすいエラーの説明」)を返す方法はありますか?ここでのエラーオブジェクトはタイプErrorではなくタイプであることに注意してくださいMyError。もちろん、オブジェクトをMyErrorにキャストできます

(error as? MyError)?.localizedDescription

しかし、私のエラータイプにキャストせずにそれを機能させる方法はありますか?

回答:


402

Xcode 8ベータ6リリースノートに記載されているように、

Swift定義のエラータイプは、新しいLocalizedErrorプロトコルを採用することで、ローカライズされたエラーの説明を提供できます。

あなたの場合:

public enum MyError: Error {
    case customError
}

extension MyError: LocalizedError {
    public var errorDescription: String? {
        switch self {
        case .customError:
            return NSLocalizedString("A user-friendly description of the error.", comment: "My error")
        }
    }
}

let error: Error = MyError.customError
print(error.localizedDescription) // A user-friendly description of the error.

エラーが次のように変換された場合は、さらに多くの情報を提供できますNSError(これは常に可能です)。

extension MyError : LocalizedError {
    public var errorDescription: String? {
        switch self {
        case .customError:
            return NSLocalizedString("I failed.", comment: "")
        }
    }
    public var failureReason: String? {
        switch self {
        case .customError:
            return NSLocalizedString("I don't know why.", comment: "")
        }
    }
    public var recoverySuggestion: String? {
        switch self {
        case .customError:
            return NSLocalizedString("Switch it off and on again.", comment: "")
        }
    }
}

let error = MyError.customError as NSError
print(error.localizedDescription)        // I failed.
print(error.localizedFailureReason)      // Optional("I don\'t know why.")
print(error.localizedRecoverySuggestion) // Optional("Switch it off and on again.")

CustomNSErrorプロトコルを採用することにより、エラーはuserInfo辞書(およびa domaincode)を提供できます。例:

extension MyError: CustomNSError {

    public static var errorDomain: String {
        return "myDomain"
    }

    public var errorCode: Int {
        switch self {
        case .customError:
            return 999
        }
    }

    public var errorUserInfo: [String : Any] {
        switch self {
        case .customError:
            return [ "line": 13]
        }
    }
}

let error = MyError.customError as NSError

if let line = error.userInfo["line"] as? Int {
    print("Error in line", line) // Error in line 13
}

print(error.code) // 999
print(error.domain) // myDomain

7
最初に作成しMyError、後でError拡張 する理由はありますLocalizedErrorか?そもそもaにしたと違いはありますLocalizedErrorか?
Gee.E 2017年

9
@ Gee.E:違いはありません。これは、コードを整理する方法にすぎません(プロトコルごとに1つの拡張子)。比較stackoverflow.com/questions/36263892/...stackoverflow.com/questions/40502086/...、またはnatashatherobot.com/using-swift-extensions
マーティンR

4
ああ、チェック。私はあなたが今言っていることを理解します。natashatherobot.com/using-swift-extensionsの「プロトコルの適合性」セクションは、実際の意味の良い例です。ありがとう!
Gee.E 2017年

1
@MartinRエラーがNSErrorに変換される場合、NSErrorのuserInfoとしてアクセスできるエラーから辞書をどのように渡すことができますか?
BangOperator 2017年

18
var errorDescription: String?代わりに入力することに注意してくださいString。LocalizedErrorの実装にバグがあります。SR-5858を参照してください。
ethanhuang13

35

あなたのエラーがこのようなパラメータを持っているなら、私も追加します

enum NetworkError: LocalizedError {
  case responseStatusError(status: Int, message: String)
}

これらのパラメータは、ローカライズされた説明で次のように呼び出すことができます。

extension NetworkError {
  public var errorDescription: String? {
    switch self {
    case .responseStatusError(status: let status, message: let message):
      return "Error with status \(status) and message \(message) was thrown"
  }
}

これを次のように短くすることもできます。

extension NetworkError {
  public var errorDescription: String? {
    switch self {
    case let .responseStatusError(status, message):
      return "Error with status \(status) and message \(message) was thrown"
  }
}

4

Objective-Cに追加情報を提供するためにエラータイプが採用できる2つのエラー採用プロトコル— LocalizedErrorとCustomNSErrorがあります。これらの両方を採用するエラーの例を次に示します。

enum MyBetterError : CustomNSError, LocalizedError {
    case oops

    // domain
    static var errorDomain : String { return "MyDomain" }
    // code
    var errorCode : Int { return -666 }
    // userInfo
    var errorUserInfo: [String : Any] { return ["Hey":"Ho"] };

    // localizedDescription
    var errorDescription: String? { return "This sucks" }
    // localizedFailureReason
    var failureReason: String? { return "Because it sucks" }
    // localizedRecoverySuggestion
    var recoverySuggestion: String? { return "Give up" }

}

2
編集できますか?あなたの例はそれぞれの価値を理解するのにあまり役に立ちません。または、MartinRの答えがこれを正確に提供するので、単にそれを削除してください...
Honey

3

構造体を使用することもできます。静的ローカライゼーションによる少し優雅さ:

import Foundation

struct MyError: LocalizedError, Equatable {

   private var description: String!

   init(description: String) {
       self.description = description
   }

   var errorDescription: String? {
       return description
   }

   public static func ==(lhs: MyError, rhs: MyError) -> Bool {
       return lhs.description == rhs.description
   }
}

extension MyError {

   static let noConnection = MyError(description: NSLocalizedString("No internet connection",comment: ""))
   static let requestFailed = MyError(description: NSLocalizedString("Request failed",comment: ""))
}

func throwNoConnectionError() throws {
   throw MyError.noConnection
}

do {
   try throwNoConnectionError()
}
catch let myError as MyError {
   switch myError {
   case .noConnection:
       print("noConnection: \(myError.localizedDescription)")
   case .requestFailed:
       print("requestFailed: \(myError.localizedDescription)")
   default:
      print("default: \(myError.localizedDescription)")
   }
}

0

これはよりエレガントなソリューションです:

  enum ApiError: String, LocalizedError {

    case invalidCredentials = "Invalid credentials"
    case noConnection = "No connection"

    var localizedDescription: String { return NSLocalizedString(self.rawValue, comment: "") }

  }

4
これは実行時にはより洗練されているかもしれませんが、静的ローカリゼーションのステップは、翻訳者のためにこれらの文字列を抽出することに失敗します。あなたは参照してくださいよ"Bad entry in file – Argument is not a literal string"、あなたが実行したときにエラーが発生しexportLocalizationsたりgenstrings、翻訳テキストのリストを作成します。
savinola

@savinolaは同意します。このような場合、静的ローカリゼーションは機能しません。おそらく使用するのswitch + caseは唯一の選択肢です...
Vitaliy Gozhenko 2017

生の値を使用すると、エラーの関連する値の使用も防止されます
Brody Robertson
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.