如何在我的 iPhone 应用程序中使用 NSError？

Question

我正在努力捕获应用程序中的错误，并且正在考虑使用 NSError。我对如何使用它以及如何填充它有点困惑。

有人可以提供一个关于如何填充然后使用 NSError 的示例吗？

Answer 1

嗯，我通常做的是让我的方法在运行时可能出错，并引用 NSError 指针。如果该方法中确实出现问题，我可以使用错误数据填充 NSError 引用，并从该方法返回 nil。

示例：

- (id) endWorldHunger:(id)largeAmountsOfMonies error:(NSError**)error {
    // begin feeding the world's children...
    // it's all going well until....
    if (ohNoImOutOfMonies) {
        // sad, we can't solve world hunger, but we can let people know what went wrong!
        // init dictionary to be used to populate error object
        NSMutableDictionary* details = [NSMutableDictionary dictionary];
        [details setValue:@"ran out of money" forKey:NSLocalizedDescriptionKey];
        // populate the error object with the details
        *error = [NSError errorWithDomain:@"world" code:200 userInfo:details];
        // we couldn't feed the world's children...return nil..sniffle...sniffle
        return nil;
    }
    // wohoo! We fed the world's children. The world is now in lots of debt. But who cares? 
    return YES;
}

然后我们可以使用这样的方法。除非该方法返回 nil，否则甚至不必检查错误对象：

// initialize NSError object
NSError* error = nil;
// try to feed the world
id yayOrNay = [self endWorldHunger:smallAmountsOfMonies error:&error];
if (!yayOrNay) {
   // inspect error
   NSLog(@"%@", [error localizedDescription]);
}
// otherwise the world has been fed. Wow, your code must rock.

我们能够访问错误的 localizedDescription 因为我们为 NSLocalizedDescriptionKey 设置了一个值。

获取更多信息的最佳位置是 Apple 文档。确实很好。

可可是我的女朋友。

Answer 2

我想根据我最近的实施添加一些更多建议。我查看了 Apple 的一些代码，我认为我的代码的行为方式大致相同。

上面的帖子已经解释了如何创建 NSError 对象并返回它们，所以我不会打扰那部分。我只是尝试建议一种在您自己的应用程序中集成错误（代码、消息）的好方法。

---

我建议创建 1 个标头，它将概述您的域（即应用程序、库等）的所有错误。我当前的标头如下所示：

FSError.h

FOUNDATION_EXPORT NSString *const FSMyAppErrorDomain;

enum {
    FSUserNotLoggedInError = 1000,
    FSUserLogoutFailedError,
    FSProfileParsingFailedError,
    FSProfileBadLoginError,
    FSFNIDParsingFailedError,
};

FSError.m

#import "FSError.h" 

NSString *const FSMyAppErrorDomain = @"com.felis.myapp";

现在，当使用上述错误值时，Apple 将为您的应用程序创建一些基本的标准错误消息。可以创建如下所示的错误：

+ (FSProfileInfo *)profileInfoWithData:(NSData *)data error:(NSError **)error
{
    FSProfileInfo *profileInfo = [[FSProfileInfo alloc] init];
    if (profileInfo)
    {
        /* ... lots of parsing code here ... */

        if (profileInfo.username == nil)
        {
            *error = [NSError errorWithDomain:FSMyAppErrorDomain code:FSProfileParsingFailedError userInfo:nil];            
            return nil;
        }
    }
    return profileInfo;
}

上述代码的标准 Apple 生成的错误消息 (error.localizedDescription) 如下所示：

Error Domain=com.felis.myapp 代码=1002“操作无法完成。（com.felis.myapp错误1002。）”

上面的内容对于开发人员来说已经非常有帮助了，因为该消息显示了发生错误的域以及相应的错误代码。最终用户不知道错误代码 1002 的含义，因此现在我们需要为每个代码实现一些不错的消息。

对于错误消息，我们必须牢记本地化（即使我们不立即实现本地化消息）。我在当前项目中使用了以下方法：

---

1) 创建一个包含错误的 strings 文件。字符串文件很容易本地化。该文件可能如下所示：

FSError.strings

"1000" = "User not logged in.";
"1001" = "Logout failed.";
"1002" = "Parser failed.";
"1003" = "Incorrect username or password.";
"1004" = "Failed to parse FNID."

---

2) 添加宏以将整数代码转换为本地化错误消息。我在 Constants+Macros.h 文件中使用了 2 个宏。为了方便起见，我总是将此文件包含在前缀标头 (MyApp-Prefix.pch) 中。

Constants+Macros.h

// error handling ...

#define FS_ERROR_KEY(code)                    [NSString stringWithFormat:@"%d", code]
#define FS_ERROR_LOCALIZED_DESCRIPTION(code)  NSLocalizedStringFromTable(FS_ERROR_KEY(code), @"FSError", nil)

---

3) 现在可以轻松地根据错误代码显示用户友好的错误消息。一个例子：

UIAlertView *alert = [[UIAlertView alloc] initWithTitle:@"Error" 
            message:FS_ERROR_LOCALIZED_DESCRIPTION(error.code) 
            delegate:nil 
            cancelButtonTitle:@"OK" 
            otherButtonTitles:nil];
[alert show];

Answer 3

亚历克斯的回答很好。一个潜在的问题是 NULL 取消引用。 Apple 的参考 创建并返回 NSError 对象

...
[details setValue:@"ran out of money" forKey:NSLocalizedDescriptionKey];

if (error != NULL) {
    // populate the error object with the details
    *error = [NSError errorWithDomain:@"world" code:200 userInfo:details];
}
// we couldn't feed the world's children...return nil..sniffle...sniffle
return nil;
...

Answer 4

Objective-C

NSError *err = [NSError errorWithDomain:@"some_domain"
                                   code:100
                               userInfo:@{
                                           NSLocalizedDescriptionKey:@"Something went wrong"
                               }];

Swift 3

let error = NSError(domain: "some_domain",
                      code: 100,
                  userInfo: [NSLocalizedDescriptionKey: "Something went wrong"])

Answer 5

请参考以下教程

我希望它对您有所帮助，但在此之前您必须阅读 NSError

这是我最近发现的非常有趣的链接 ErrorHandling

Answer 6

我将尝试总结 Alex 的精彩答案和 jlmendezbonini 的观点，添加一个修改，使所有内容都兼容 ARC（到目前为止，ARC 不会抱怨，因为您应该返回 id，这意味着“任何object”，但 BOOL 不是对象类型）。

- (BOOL) endWorldHunger:(id)largeAmountsOfMonies error:(NSError**)error {
    // begin feeding the world's children...
    // it's all going well until....
    if (ohNoImOutOfMonies) {
        // sad, we can't solve world hunger, but we can let people know what went wrong!
        // init dictionary to be used to populate error object
        NSMutableDictionary* details = [NSMutableDictionary dictionary];
        [details setValue:@"ran out of money" forKey:NSLocalizedDescriptionKey];
        // populate the error object with the details
        if (error != NULL) {
             // populate the error object with the details
             *error = [NSError errorWithDomain:@"world" code:200 userInfo:details];
        }
        // we couldn't feed the world's children...return nil..sniffle...sniffle
        return NO;
    }
    // wohoo! We fed the world's children. The world is now in lots of debt. But who cares? 
    return YES;
}

现在，我们不再检查方法调用的返回值，而是检查 error 是否仍为 nil。如果不是，我们就有问题了。

// initialize NSError object
NSError* error = nil;
// try to feed the world
BOOL success = [self endWorldHunger:smallAmountsOfMonies error:&error];
if (!success) {
   // inspect error
   NSLog(@"%@", [error localizedDescription]);
}
// otherwise the world has been fed. Wow, your code must rock.

Answer 7

我见过的另一种设计模式涉及使用块，这在异步运行方法时特别有用。

假设我们定义了以下错误代码：

typedef NS_ENUM(NSInteger, MyErrorCodes) {
    MyErrorCodesEmptyString = 500,
    MyErrorCodesInvalidURL,
    MyErrorCodesUnableToReachHost,
};

您将定义可以引发错误的方法，如下所示：

- (void)getContentsOfURL:(NSString *)path success:(void(^)(NSString *html))success failure:(void(^)(NSError *error))failure {
    if (path.length == 0) {
        if (failure) {
            failure([NSError errorWithDomain:@"com.example" code:MyErrorCodesEmptyString userInfo:nil]);
        }
        return;
    }

    NSString *htmlContents = @"";

    // Exercise for the reader: get the contents at that URL or raise another error.

    if (success) {
        success(htmlContents);
    }
}

然后当您调用它时，您无需担心声明 NSError 对象（代码完成将为您完成） ，或检查返回值。您可以只提供两个块：一个在出现异常时调用，另一个在成功时调用：

[self getContentsOfURL:@"http://google.com" success:^(NSString *html) {
    NSLog(@"Contents: %@", html);
} failure:^(NSError *error) {
    NSLog(@"Failed to get contents: %@", error);
    if (error.code == MyErrorCodesEmptyString) { // make sure to check the domain too
        NSLog(@"You must provide a non-empty string");
    }
}];

Answer 8

extension NSError {
    static func defaultError() -> NSError {
        return NSError(domain: "com.app.error.domain", code: 0, userInfo: [NSLocalizedDescriptionKey: "Something went wrong."])
    }
}

每当我没有有效的错误对象时，我都可以使用 NSError.defaultError() 。

let error = NSError.defaultError()
print(error.localizedDescription) //Something went wrong.

Answer 9

好吧，这有点超出范围，但如果你没有 NSError 选项，你可以随时显示低级错误：

 NSLog(@"Error = %@ ",[NSString stringWithUTF8String:strerror(errno)]);