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


228

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

有人可以提供一个示例,说明我如何填充然后使用NSError吗?

Answers:


473

好吧,我通常要做的是使我的方法在运行时可能出错,并引用一个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的文档。真的很好。

关于Cocoa Is My Girlfriend也有一个不错的简单教程。


37
这是有史以来最有趣的例子
ming ye11年

尽管ARC中存在一些问题并将强制转换为id,但这是一个很棒的答案BOOL。任何轻微的ARC兼容变化将不胜感激。
NSTJ

6
@TomJowett如果我们最终不能仅仅因为苹果推动我们转向新的仅限ARC的世界而无法消除世界饥饿,我将真的很生气。
Manav 2012年

1
返回类型可以是BOOLNO出现错误时返回,而不是检查返回值,只需检查error。如果nil继续,请!= nil处理。
加布里埃尔·彼得罗内拉(December

8
-1:您确实需要合并验证**error为非零的代码。否则,程序将抛出一个完全不友好的错误,并且不会使正在发生的事情变得显而易见。
FreeAsInBeer 2013年

58

我想根据我的最新实现添加更多建议。我看过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;
}

苹果公司error.localizedDescription为上述代码生成的标准错误消息()如下所示:

Error Domain=com.felis.myapp Code=1002 "The operation couldn’t be completed. (com.felis.myapp error 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为了方便起见,)中。

常数+ 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];

9
好答案!但是,为什么不将本地化描述放入所属的用户信息字典中呢?[NSError errorWithDomain:FSMyAppErrorDomain代码:FSProfileParsingFailedError userInfo:@ {NSLocalizedDescriptionKey:FS_ERROR_LOCALIZED_DESCRIPTION(error.code)}]];
理查德·文布尔

1
在哪里应该放置字符串文件?从FS_ERROR_LOCALIZED_DESCRIPTION()中,我只是得到数字(错误代码)。
huggie 2013年

@huggie:不确定您的意思。我通常将这些在整个应用程序中使用的宏放在一个名为的Constants+Macros.h文件中,然后将此文件导入前缀标头(.pchfile),以便在任何地方都可以使用。如果您的意思是只使用2个宏中的1个,那可能会起作用。尽管我没有测试过,也许从int到的转换NSString并不是真正必要的。
Wolfgang Schreurs 2013年

@huggie:哦,我想我现在明白了。字符串应位于可本地化的文件(.stringsfile)中,因为这是Apple宏的外观。阅读关于使用NSLocalizedStringFromTable这里:developer.apple.com/library/mac/documentation/cocoa/conceptual/...
沃尔夫冈Schreurs的

1
@huggie:是的,我使用了本地化的字符串表。宏中的代码FS_ERROR_LOCALIZED_DESCRIPTION检查名为的文件中的可本地化字符串FSError.strings。如果您不熟悉Apple的.strings文件本地化指南,则可能需要查看。
Wolfgang Schreurs

38

很好的答案,Alex。一个潜在的问题是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;
...

30

物镜

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

迅捷3

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


3

我将尝试总结一下Alex和jlmendezbonini的观点的出色答案,并添加一个修改内容,使所有ARC都兼容(到目前为止,这并不是因为ARC会抱怨,因为您应该返回id,这意味着“任何对象”,但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为still ,而不是检查方法调用的返回值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.

3
@Gabriela:Apple声明,使用间接变量返回错误时,方法成功或失败的情况下,方法本身应始终具有一些返回值。苹果公司敦促开发人员首先检查返回值,并且在返回值某种程度上无效的情况下才检查错误。请参阅以下页面:developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/...
沃尔夫冈人Schreurs

3

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

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

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

0

好吧,这超出了问题范围,但是如果您没有NSError选项,则始终可以显示低级错误:

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

0
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.
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.