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

アプリでエラーを検出する作業をしており、の使用を検討していNSErrorます。それをどのように使用し、どのように実装するかについて少し混乱しています。

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

まあ、私が通常行うことは、実行時にエラーが発生する可能性がある私のメソッドに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には、素晴らしくシンプルなチュートリアルがあります。

私の最新の実装に基づいて、さらにいくつかの提案を追加したいと思います。私は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上記のコードに対してAppleが生成する標準のエラーメッセージ（）は、次のようになります。

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便宜上、このファイルは常にプレフィックスヘッダー（）に含めます。

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];

すばらしい答えアレックス。潜在的な問題の1つは、NULL逆参照です。NSErrorオブジェクトの作成と返却に関するAppleのリファレンス

...
[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;
...

Objective-C

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

次のチュートリアルを参照してください

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

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

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がまだであるかどうかをチェックし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.

私が見たもう1つの設計パターンはブロックの使用を含みます。これは、メソッドが非同期で実行されているときに特に役立ちます。

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

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

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

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

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.