web-dev-qa-db-ja.com

iPhoneアプリでNSErrorを使用するにはどうすればよいですか？

私はアプリでエラーをキャッチすることに取り組んでおり、NSErrorの使用を検討しています。私はそれをどのように使うか、そしてどのようにそれを移入するかについて少し混乱しています。

誰かが私がどのように入力するかについての例を提供してからNSErrorを使用できますか？

iphoneiosobjective-cios4nserror
223
Nic Hubbard

さて、私が普段やっていることは、実行時にエラーになりうるメソッドを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 についての、すてきな簡単なチュートリアルもあります。

468
Alex

私の最新の実装に基づいて、いくつかの提案を追加したいと思います。私は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 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];
54
Wolfgang Schreurs

素晴らしい答えアレックス。潜在的な問題の1つは、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;
...
37
jlmendezbonini

Objective-C

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

Swift

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

以下を参照してください tutorial

私はそれがあなたに役立つことを願っていますが、事前に NSError のドキュメントを読む必要があります

これは最近見つけた非常に興味深いリンクです ErrorHandling

9
Tirth

私が見た別の設計パターンには、ブロックの使用が含まれます。これは、メソッドが非同期で実行されている場合に特に便利です。

次のエラーコードが定義されているとします。

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オブジェクトの宣言（コード補完が自動的に行います）や戻り値の確認を心配する必要はありません。 2つのブロックを指定できます。1つは例外が発生したときに呼び出され、もう1つは成功したときに呼び出されます。

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

Alexとjlmendezboniniのポイントによる素晴らしい答えを要約して、ARCをすべて互換にする修正を追加します（これまでのところ、idname__を返す必要があるのでARCは文句を言いませんが、これは「任意のオブジェクト」を意味しますが、BOOLname__はそうではありません）オブジェクトタイプ）。

- (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;
}

ここで、メソッド呼び出しの戻り値をチェックする代わりに、errorname__がまだnilname__であるかどうかをチェックします。そうでない場合、問題があります。

// 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
Gabriele Petronella

質問の範囲外ですが、NSErrorのオプションがない場合は、常に低レベルエラーを表示できます。

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