Swift'te Hata türüyle yerelleştirilmiş bir açıklama nasıl sağlanır?


205

Swift 3 sözdizimi ile özel bir hata türü tanımlıyorum localizedDescriptionve Errornesnenin özelliği tarafından döndürülen hatanın kullanıcı dostu bir açıklamasını vermek istiyorum . Nasıl yapabilirim?

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Özel hata açıklamamı ("Hatanın kullanıcı dostu açıklaması") döndürmenin bir yolu var mı ? Burada hata nesne türünün olduğunu unutmayın Errorve değil MyError. Elbette, nesneyi MyError'a atabilirim

(error as? MyError)?.localizedDescription

ama hata tipime döküm yapmadan çalışmanın bir yolu var mı?

Yanıtlar:


405

Xcode 8 beta 6 sürüm notlarında açıklandığı gibi,

Swift tanımlı hata türleri, yeni LocalizedError protokolünü benimseyerek yerelleştirilmiş hata açıklamaları sağlayabilir.

Senin durumunda:

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.

Hataya dönüştürülürse daha da fazla bilgi sağlayabilirsiniz NSError(bu her zaman mümkündür):

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

CustomNSErrorProtokolü benimseyerek hata bir userInfosözlük (ve ayrıca a domainve code) sağlayabilir . Misal:

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
MyErrorBir Errorilk yapmanın ve LocalizedErrordaha sonra genişletmenizin bir nedeni var mı ? LocalizedErrorİlk etapta yaptıysanız bir fark var mı ?
Gee.E

9
@ Gee.E: Fark etmez. Bu, kodu düzenlemenin bir yoludur (her protokol için bir uzantı). Karşılaştırma stackoverflow.com/questions/36263892/... , stackoverflow.com/questions/40502086/... veya natashatherobot.com/using-swift-extensions .
Martin R

4
Ah, kontrol et. Şimdi söylediklerini anlıyorum. Natashatherobot.com/using-swift-extensions adresindeki "Protokol Uygunluğu" bölümü gerçekten ne demek istediğinize iyi bir örnektir. Teşekkürler!
Gee.E

1
@MartinR Hatam NSError'a dönüştürülürse, NSError kullanıcı userInfo olarak erişilebilen bir sözlükten nasıl hata iletebilirim?
17'de BangOperator

18
var errorDescription: String?Bunun yerine yazmaya dikkat edin String. LocalizedError uygulamasında bir hata var. Görmek SR-5858 .
ethanhuang13

35

Hatanızda böyle parametreler varsa da eklerdim

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

bu parametreleri yerel açıklamanızda şu şekilde çağırabilirsiniz:

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

Bunu şu şekilde kısaltabilirsiniz:

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

4

Artık Objective-C - LocalizedError ve CustomNSError'a ek bilgi sağlamak için hata türünüzün benimseyebileceği iki Hata benimseme protokolü bulunmaktadır. Her ikisini de benimseyen bir örnek hata:

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
Düzenleme yapabilir misiniz? Örnekleriniz, her birinin değerini anlamak için fazla yardımcı olmaz. Ya da sadece sil çünkü MartinR'nin cevabı bunu tam olarak sunuyor ...
Honey

3

Bir yapı kullanmak bir alternatif olabilir. Statik lokalizasyon ile biraz şıklık:

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

İşte daha zarif bir çözüm:

  enum ApiError: String, LocalizedError {

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

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

  }

4
Bu, çalışma zamanında daha şık olabilir, ancak statik yerelleştirme adımı çevirmenler için bu dizeleri ayıklayamaz; "Bad entry in file – Argument is not a literal string"çalıştırdığınızda exportLocalizationsveya genstringsçevrilebilir metin listenizi oluştururken bir hata görürsünüz .
savinola

@savinola katılıyorum, statik lokalizasyon böyle bir durumda çalışmaz. Belki de kullanmak switch + casesadece bir seçenektir ...
Vitaliy Gozhenko

Ham değerleri kullanmak, hatalarınızın herhangi biri için ilişkili değerlerin kullanılmasını da önler
Brody Robertson
Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.