web-dev-qa-db-ja.com

JSONリクエスト用のAlamoFire非同期completionHandler

AlamoFireフレームワークを使用して、completionHandlerがメインスレッドで実行されていることに気付きました。次のコードが完了ハンドラー内でコアデータインポートタスクを作成するための良いプラクティスであるかどうか疑問に思います:

Alamofire.request(.GET, "http://myWebSite.com", parameters: parameters)
            .responseJSON(options: .MutableContainers) { (_, _, JSON, error) -> Void in
                dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0), { () -> Void in
                    if let err = error{
                        println("Error:\(error)")
                        return;
                    }

                    if let jsonArray = JSON as? [NSArray]{                       
                        let importer = CDImporter(incomingArray: jsonArray entity: "Artist", map: artistEntityMap);

                    }
                });
            }
77
TheM00s3

これは本当に良い質問です。あなたのアプローチは完全に有効です。ただし、Alamofireは実際にこれをさらに効率化するのに役立ちます。

サンプルコードディスパッチキューの詳細

サンプルコードでは、次のディスパッチキュー間をジャンプしています。

  1. NSURLSessionディスパッチキュー
  2. 検証およびシリアライザー処理のためのTaskDelegateディスパッチキュー
  3. 完了ハンドラーを呼び出すためのメインディスパッチキュー
  4. JSON処理用の高優先度キュー
  5. ユーザーインターフェイスを更新するメインディスパッチキュー(必要な場合)

ご覧のとおり、あちこちを飛び回っています。 Alamofire内の強力な機能を活用する代替アプローチを見てみましょう。

Alamofire応答ディスパッチキュー

Alamofireには、独自の低レベル処理に組み込まれた最適なアプローチがあります。すべてのカスタムレスポンスシリアライザーによって最終的に呼び出される単一のresponseメソッドは、使用することを選択した場合、カスタムディスパッチキューをサポートします。

GCDはディスパッチキュー間のホッピングに優れていますが、ビジーなキュー(メインスレッドなど)へのジャンプは避けたいと思います。非同期処理の途中でメインスレッドに戻るジャンプを排除することにより、潜在的に物事を大幅にスピードアップできます。次の例は、Alamofireロジックをそのまま使用してこれを行う方法を示しています。

Alamofire 1.x

let queue = dispatch_queue_create("com.cnoon.manager-response-queue", DISPATCH_QUEUE_CONCURRENT)

let request = Alamofire.request(.GET, "http://httpbin.org/get", parameters: ["foo": "bar"])
request.response(
    queue: queue,
    serializer: Request.JSONResponseSerializer(options: .AllowFragments),
    completionHandler: { _, _, JSON, _ in

        // You are now running on the concurrent `queue` you created earlier.
        println("Parsing JSON on thread: \(NSThread.currentThread()) is main thread: \(NSThread.isMainThread())")

        // Validate your JSON response and convert into model objects if necessary
        println(JSON)

        // To update anything on the main thread, just jump back on like so.
        dispatch_async(dispatch_get_main_queue()) {
            println("Am I back on the main thread: \(NSThread.isMainThread())")
        }
    }
)

Alamofire 3.x(Swift 2.2および2.3)

let queue = dispatch_queue_create("com.cnoon.manager-response-queue", DISPATCH_QUEUE_CONCURRENT)

let request = Alamofire.request(.GET, "http://httpbin.org/get", parameters: ["foo": "bar"])
request.response(
    queue: queue,
    responseSerializer: Request.JSONResponseSerializer(options: .AllowFragments),
    completionHandler: { response in
        // You are now running on the concurrent `queue` you created earlier.
        print("Parsing JSON on thread: \(NSThread.currentThread()) is main thread: \(NSThread.isMainThread())")

        // Validate your JSON response and convert into model objects if necessary
        print(response.result.value)

        // To update anything on the main thread, just jump back on like so.
        dispatch_async(dispatch_get_main_queue()) {
            print("Am I back on the main thread: \(NSThread.isMainThread())")
        }
    }
)

Alamofire 4.x(Swift 3)

let queue = DispatchQueue(label: "com.cnoon.response-queue", qos: .utility, attributes: [.concurrent])

Alamofire.request("http://httpbin.org/get", parameters: ["foo": "bar"])
    .response(
        queue: queue,
        responseSerializer: DataRequest.jsonResponseSerializer(),
        completionHandler: { response in
            // You are now running on the concurrent `queue` you created earlier.
            print("Parsing JSON on thread: \(Thread.current) is main thread: \(Thread.isMainThread)")

            // Validate your JSON response and convert into model objects if necessary
            print(response.result.value)

            // To update anything on the main thread, just jump back on like so.
            DispatchQueue.main.async {
                print("Am I back on the main thread: \(Thread.isMainThread)")
            }
        }
    )

Alamofireディスパッチキューの内訳

このアプローチに関連するさまざまなディスパッチキューの内訳を次に示します。

  1. NSURLSessionディスパッチキュー
  2. 検証およびシリアライザー処理のためのTaskDelegateディスパッチキュー
  3. JSON処理用のカスタムマネージャーの同時ディスパッチキュー
  4. ユーザーインターフェイスを更新するためのメインディスパッチキュー(必要な場合)

概要

メインディスパッチキューに戻る最初のホップを排除することで、潜在的なボトルネックを排除し、リクエストと処理全体を非同期にしました。驚くばかり!

そうは言っても、Alamofireが実際にどのように機能するかについての内部に精通することがどれほど重要であるかを十分に強調することはできません。自分のコードの改善に本当に役立つものをいつ見つけることができるのか、あなたは決して知りません。

154
cnoon

Swift 3.0の小さな更新、Alamofire(4.0.1)、@ cnoonの回答の編集:

let queue = DispatchQueue(label: "com.cnoon.manager-response-queue",
                          qos: .userInitiated,
                          attributes:.concurrent)
Alamofire?.request(SERVER_URL, method: .post,
parameters: ["foo": "bar"], 
encoding: JSONEncoding.default,//by default
headers: ["Content-Type":"application/json; charset=UTF-8"])
.validate(statusCode: 200..<300).//by default
responseJSON(queue: queue, options: .allowFragments, 
completionHandler: { (response:DataResponse<Any>) in

        switch(response.result) {
        case .success(_):
            break
        case .failure(_):
            print(response.result.error)
            if response.result.error?._code == NSURLErrorTimedOut{
                //TODO: Show Alert view on netwok connection.
            }
            break
        }
    })
2
Mike.R

@cnoonからの完璧な答えを補完するだけで、私のようにResponseObjectSerializableを使用している場合は、この並行動作をリクエスト拡張自体に埋め込むことができます。

extension Request {
    public func responseObject<T: ResponseObjectSerializable>(completionHandler: Response<T, NSError> -> Void) -> Self {
        let responseSerializer = ResponseSerializer<T, NSError> { request, response, data, error in
            guard error == nil else { return .Failure(error!) }

            let JSONResponseSerializer = Request.JSONResponseSerializer(options: .AllowFragments)
            let result = JSONResponseSerializer.serializeResponse(request, response, data, error)

            switch result {
            case .Success(let value):
                if let
                    response = response,
                    responseObject = T(response: response, representation: value)
                {
                    return .Success(responseObject)
                } else {
                    let failureReason = "JSON could not be serialized into response object: \(value)"
                    let error = Error.errorWithCode(.JSONSerializationFailed, failureReason: failureReason)
                    return .Failure(error)
                }
            case .Failure(let error):
                return .Failure(error)
            }
        }

        let queue = dispatch_queue_create("my.queue", DISPATCH_QUEUE_CONCURRENT)
        return response(queue: queue, responseSerializer: responseSerializer) { response in
            dispatch_async(dispatch_get_main_queue()) {
                completionHandler(response)
            }
        }
    }
}
1