如何在Swift中提供带有错误类型的本地化描述？

我正在用Swift 3语法定义一个自定义错误类型，我想提供一个用户友好的错误描述，该错误由

错误

对象的

本地化描述

属性返回。我怎么做

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.)"

是否有方法让本地化描述返回我的自定义错误描述（“用户友好的错误描述”）？请注意，此处的错误对象的类型为

error

，而不是

MyError

。当然，我可以将对象投射到MyError

(error as? MyError)?.localizedDescription

---

但是有没有一种方法可以让它在不转换为我的错误类型的情况下工作呢？

如Xcode 8 beta 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.

如果转换错误，则可以提供更多信息 到

n错误

（这总是可能的）：

通过采用

CustomNSError

协议，错误可以提供 一个

userInfo

字典（以及一个

domain

和

code

）。例如：

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

---

我还要补充一点，如果你的错误有这样的参数

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"
  }
}

您甚至可以将其缩短，如下所示：

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"
  }
}

---

为了向Objective-C-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" }

}

---

以下是更优雅的解决方案：

  enum ApiError: String, LocalizedError {

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

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

  }

---

使用结构可以是一种替代方法。带有静态本地化的一点优雅：

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)")
   }
}

---

这一个对我有用：

NSError(domain: "com.your", code: 0, userInfo: [NSLocalizedDescriptionKey: "Error description"])

---

您是否有理由先将

MyError

设置为

Error

，然后使用

LocalizedError

对其进行扩展？如果你一开始就把它做成一个

LocalizedError

，那有什么区别吗？@Gee.E:没有区别。这只是一种组织代码的方法（每个协议有一个扩展）。比较，或者。啊，检查。我明白你现在说的。上的“协议一致性”部分确实是一个很好的例子，说明了您的意思。谢谢@MartinR如果我的错误将被转换为NSError，我如何从错误中传递字典，该字典可以作为NSError的用户信息访问？请注意键入

var errorDescription:String？

，而不是

String

。LocalizedError的实现中有一个bug。请参阅。这在运行时可能更优雅，但静态本地化步骤将无法为翻译人员提取这些字符串；当您运行

exportLocalizations

或

genstrings

创建可翻译文本列表时，您会看到一个

“文件中的错误条目–参数不是文字字符串”

错误。@savinola同意，在这种情况下静态本地化将不起作用。也许使用

switch+case

是唯一的选择…使用原始值也会阻止对任何错误使用关联值扫描是否进行编辑？你的例子对理解每一个例子的价值没有多大帮助。或者干脆删除它，因为马丁纳的答案正好提供了这一点。。。