Swift에서 오류 유형으로 현지화 된 설명을 제공하는 방법은 무엇입니까?


202

Swift 3 구문으로 사용자 정의 오류 유형을 정의하고 localizedDescription있으며 Error객체 의 속성에 의해 반환되는 오류에 대한 사용자 친화적 인 설명을 제공하려고 합니다. 내가 어떻게 해?

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

하지만 내 오류 유형으로 캐스팅하지 않고 작동하게하는 방법이 있습니까?

답변:


401

Xcode 8 베타 6 릴리스 정보에 설명 된대로

신속한 정의 된 오류 유형은 새로운 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
당신이 만드는 이유가 있습니까 제와 함께 확장 이후는? 처음에 차이를 만들면 차이가 있습니까? MyErrorErrorLocalizedErrorLocalizedError
Gee.E

9
@ Gee.E : 차이가 없습니다. 코드를 구성하는 방법 일뿐입니다 (각 프로토콜 당 하나의 확장). stackoverflow.com/questions/36263892/… , stackoverflow.com/questions/40502086/… 또는 natashatherobot.com/using-swift-extensions를 비교하십시오 .
Martin R

4
아, 확인 나는 당신이 지금 말하는 것을 얻습니다. natashatherobot.com/using-swift-extensions 의 "Protocol Conformance"섹션 은 실제로 여러분이 의미하는 바를 보여주는 좋은 예입니다. 감사!
Gee.E

1
@MartinR 내 오류가 NSError로 변환되면 NSError의 userInfo로 액세스 할 수있는 오류에서 사전을 전달할 수 있습니까?
BangOperator

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에 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

원시 값을 사용하면 또한 오류 중 어떤 관련 값의 사용을 방지 할 수 있습니다
브로디 로버트슨
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.