Повернення даних із асинхронного виклику у функції Swift


93

У своєму проекті Swift я створив клас корисності, який обробляє всі запити та відповіді REST. Я створив простий REST API, щоб я міг протестувати свій код. Я створив метод класу, який повинен повернути NSArray, але оскільки виклик API є асинхронним, мені потрібно повернутися з методу всередині виклику async. Проблема полягає в тому, що асинхрон повертає порожнечу. Якби я робив це в Node, я б використовував обіцянки JS, але я не можу знайти рішення, яке працює в Swift.

import Foundation

class Bookshop {
    class func getGenres() -> NSArray {
        println("Hello inside getGenres")
        let urlPath = "http://creative.coventry.ac.uk/~bookshop/v1.1/index.php/genre/list"
        println(urlPath)
        let url: NSURL = NSURL(string: urlPath)
        let session = NSURLSession.sharedSession()
        var resultsArray:NSArray!
        let task = session.dataTaskWithURL(url, completionHandler: {data, response, error -> Void in
            println("Task completed")
            if(error) {
                println(error.localizedDescription)
            }
            var err: NSError?
            var options:NSJSONReadingOptions = NSJSONReadingOptions.MutableContainers
            var jsonResult = NSJSONSerialization.JSONObjectWithData(data, options: options, error: &err) as NSDictionary
            if(err != nil) {
                println("JSON Error \(err!.localizedDescription)")
            }
            //NSLog("jsonResults %@", jsonResult)
            let results: NSArray = jsonResult["genres"] as NSArray
            NSLog("jsonResults %@", results)
            resultsArray = results
            return resultsArray // error [anyObject] is not a subType of 'Void'
        })
        task.resume()
        //return "Hello World!"
        // I want to return the NSArray...
    }
}

5
Ця помилка настільки поширена у Stack Overflow, що я написав низку дописів у блозі, щоб впоратися з нею, починаючи з programmingios.net/what-asynchronous-means
matt

Відповіді:


97

Ви можете передавати зворотний дзвінок та зворотний дзвінок всередині асинхронного дзвінка

щось на зразок:

class func getGenres(completionHandler: (genres: NSArray) -> ()) {
    ...
    let task = session.dataTaskWithURL(url) {
        data, response, error in
        ...
        resultsArray = results
        completionHandler(genres: resultsArray)
    }
    ...
    task.resume()
}

а потім викличте цей метод:

override func viewDidLoad() {
    Bookshop.getGenres {
        genres in
        println("View Controller: \(genres)")     
    }
}

Дякую за це. Моє останнє запитання - як мені викликати цей метод класу з мого контролера перегляду. Наразі код такий:override func viewDidLoad() { super.viewDidLoad() var genres = Bookshop.getGenres() // Missing argument for parameter #1 in call //var genres:NSArray //Bookshop.getGenres(genres) NSLog("View Controller: %@", genres) }
Марк Тайерс

13

Swiftz вже пропонує Future, яке є основним будівельним елементом Promise. Майбутнє - це обіцянка, яка не може зазнати невдачі (усі терміни тут базуються на інтерпретації Scala, де обіцянка - це монада ).

https://github.com/maxpow4h/swiftz/blob/master/swiftz/Future.swift

Сподіваємось, з часом це розшириться до повної обіцянки в стилі Scala (я можу в якийсь момент написати її; я впевнений, що інші PR будуть вітатися; це вже не так складно, оскільки Future вже на місці).

У вашому конкретному випадку я, мабуть, створив би Result<[Book]>(на основі версії Олександра СалазараResult ). Тоді ваш підпис методу буде таким:

class func fetchGenres() -> Future<Result<[Book]>> {

Примітки

  • Я не рекомендую використовувати префікс для функцій getу Swift. Це порушить певні види взаємодії з ObjC.
  • Я рекомендую проаналізувати весь Bookоб'єкт до того, як повертати результати як Future. Ця система може вийти з ладу кількома способами, і набагато зручніше, якщо ви перевірите всі ці речі, перш ніж обертати їх у Future. Потрапити до [Book]цього набагато краще для решти коду Swift, ніж передача NSArray.

4
Swiftz більше не підтримує Future. Але погляньте на github.com/mxcl/PromiseKit, він чудово працює з Swiftz!
badeleux

у мене пішло кілька секунд, щоб зрозуміти, що ти не писав Свіфт, а написав Свіфт z
Мед,

4
Схоже, "Swiftz" - це стороння функціональна бібліотека для Swift. Оскільки ваша відповідь ґрунтується на цій бібліотеці, ви повинні це чітко вказати. (наприклад, "Існує стороння бібліотека під назвою" Swiftz ", яка підтримує такі функціональні конструкції, як Futures, і повинна слугувати доброю відправною точкою, якщо ви хочете реалізувати Promises".) Інакше ваші читачі просто збираються задатися питанням, чому ви неправильно написали " Стрімкий ".
Duncan C

3
Зверніть увагу, що github.com/maxpow4h/swiftz/blob/master/swiftz/Future.swift більше не працює.
Ахмад Ф

1
@Rob getПрефікс вказує повернення за посиланням в ObjC (наприклад, у -[UIColor getRed:green:blue:alpha:]). Коли я писав це, я був стурбований тим, що імпортери скористаються цим фактом (наприклад, щоб автоматично повернути кортеж). Виявилося, що вони цього не зробили. Коли я писав це, я, мабуть, також забув, що KVC підтримує префікси "отримати" для доступу (це те, про що я дізнався і забував кілька разів). Так домовились; Я не стикався з випадками, коли провідне getламає речі. Це просто вводить в оману тих, хто знає значення ObjC "отримати".
Роб Нейпір,

9

Основний шаблон - використовувати закриття обробників завершень.

Наприклад, у майбутньому Swift 5 ви б використали Result:

func fetchGenres(completion: @escaping (Result<[Genre], Error>) -> Void) {
    ...
    URLSession.shared.dataTask(with: request) { data, _, error in 
        if let error = error {
            DispatchQueue.main.async {
                completion(.failure(error))
            }
            return
        }

        // parse response here

        let results = ...
        DispatchQueue.main.async {
            completion(.success(results))
        }
    }.resume()
}

І ви б назвали це так:

fetchGenres { results in
    switch results {
    case .success(let genres):
        // use genres here, e.g. update model and UI

    case .failure(let error):
        print(error.localizedDescription)
    }
}

// but don’t try to use genres here, as the above runs asynchronously

Зверніть увагу, що вище я відправляю обробник завершення назад до основної черги для спрощення оновлення моделі та інтерфейсу. Деякі розробники виключають цю практику і використовують будь-яку чергу, що URLSessionвикористовується, або використовують власну чергу (вимагаючи, щоб абонент вручну синхронізував результати самостійно).

Але це не матеріально. Ключовою проблемою є використання обробника завершення для вказівки блоку коду, який буде запущений, коли виконано асинхронний запит.


Старий шаблон Swift 4:

func fetchGenres(completion: @escaping ([Genre]?, Error?) -> Void) {
    ...
    URLSession.shared.dataTask(with: request) { data, _, error in 
        if let error = error {
            DispatchQueue.main.async {
                completion(nil, error)
            }
            return
        }

        // parse response here

        let results = ...
        DispatchQueue.main.async {
            completion(results, error)
        }
    }.resume()
}

І ви б назвали це так:

fetchGenres { genres, error in
    guard let genres = genres, error == nil else {
        // handle failure to get valid response here

        return
    }

    // use genres here
}

// but don’t try to use genres here, as the above runs asynchronously

Зверніть увагу, що вище я скасував використання NSArray(ми більше не використовуємо ці мостові типи Objective-C ). Я припускаю, що у нас був Genreтип, і ми, мабуть, використовували JSONDecoder, а не JSONSerializationдля його декодування. Але в цьому питанні не було достатньо інформації про базовий JSON, щоб вдатися до деталей тут, тому я пропустив це, щоб уникнути помутніння основної проблеми, використання закриття як обробників завершення.


Ви також можете використовувати Resultв Swift 4 і старіших версіях, але ви повинні заявити про перерахування самостійно. Я використовую такий зразок роками.
вадіан

Так, звичайно, як і я. Але, схоже, це було прийнято Apple з виходом Swift 5. Вони просто запізнилися на вечірку.
Роб

7

Свіфт 4.0

Для асинхронного запиту-відповіді ви можете використовувати обробник завершення. Дивіться нижче Я змінив рішення з парадигмою дескриптора завершення.

func getGenres(_ completion: @escaping (NSArray) -> ()) {

        let urlPath = "http://creative.coventry.ac.uk/~bookshop/v1.1/index.php/genre/list"
        print(urlPath)

        guard let url = URL(string: urlPath) else { return }

        let task = URLSession.shared.dataTask(with: url) { (data, response, error) in
            guard let data = data else { return }
            do {
                if let jsonResult = try JSONSerialization.jsonObject(with: data, options: JSONSerialization.ReadingOptions.mutableContainers) as? NSDictionary {
                    let results = jsonResult["genres"] as! NSArray
                    print(results)
                    completion(results)
                }
            } catch {
                //Catch Error here...
            }
        }
        task.resume()
    }

Ви можете викликати цю функцію, як показано нижче:

getGenres { (array) in
    // Do operation with array
}

2

Відповідь Swift 3 @Alexey Globchastyy:

class func getGenres(completionHandler: @escaping (genres: NSArray) -> ()) {
...
let task = session.dataTask(with:url) {
    data, response, error in
    ...
    resultsArray = results
    completionHandler(genres: resultsArray)
}
...
task.resume()
}

2

Сподіваюся, ви все ще не затрималися на цьому, але коротка відповідь полягає в тому, що ви не можете зробити це в Swift.

Альтернативним підходом може бути повернення зворотного дзвінка, який надасть потрібні вам дані, як тільки він буде готовий.


1
Він може швидко обіцяти. Але нині рекомендованого aproceh яблука використовується callbackз closureS , як ви відзначаєте або використовувати delegationяк старший какао - API,
Моджтаба Хоссейні

Ви праві щодо обіцянок. Але Swift не надає для цього власного API, тому йому доводиться використовувати PromiseKit або іншу альтернативу.
LironXYZ

1

Існує 3 способи створення функцій зворотного виклику, а саме: 1. Обробник завершення 2. Повідомлення 3. Делегати

Обробник завершення Внутрішній набір блоків виконується і повертається, коли джерело доступне, обробник буде чекати, поки не надійде відповідь, щоб інтерфейс можна було оновити після.

Повідомлення Купка інформації запускається у всьому додатку, Listner може отримати n, скориставшись цією інформацією. Асинхронний спосіб отримання інформації через проект.

Делегати Набір методів спрацьовує під час виклику делегата. Джерело має надаватися через самі методи


-1
self.urlSession.dataTask(with: request, completionHandler: { (data, response, error) in
            self.endNetworkActivity()

            var responseError: Error? = error
            // handle http response status
            if let httpResponse = response as? HTTPURLResponse {

                if httpResponse.statusCode > 299 , httpResponse.statusCode != 422  {
                    responseError = NSError.errorForHTTPStatus(httpResponse.statusCode)
                }
            }

            var apiResponse: Response
            if let _ = responseError {
                apiResponse = Response(request, response as? HTTPURLResponse, responseError!)
                self.logError(apiResponse.error!, request: request)

                // Handle if access token is invalid
                if let nsError: NSError = responseError as NSError? , nsError.code == 401 {
                    DispatchQueue.main.async {
                        apiResponse = Response(request, response as? HTTPURLResponse, data!)
                        let message = apiResponse.message()
                        // Unautorized access
                        // User logout
                        return
                    }
                }
                else if let nsError: NSError = responseError as NSError? , nsError.code == 503 {
                    DispatchQueue.main.async {
                        apiResponse = Response(request, response as? HTTPURLResponse, data!)
                        let message = apiResponse.message()
                        // Down time
                        // Server is currently down due to some maintenance
                        return
                    }
                }

            } else {
                apiResponse = Response(request, response as? HTTPURLResponse, data!)
                self.logResponse(data!, forRequest: request)
            }

            self.removeRequestedURL(request.url!)

            DispatchQueue.main.async(execute: { () -> Void in
                completionHandler(apiResponse)
            })
        }).resume()

-1

В основному існує 3 способи швидкого зворотного виклику

  1. Закриття / обробник завершення

  2. Делегати

  3. Повідомлення

Спостерігачі також можуть використовуватися для отримання сповіщень після завершення завдання асинхронізації.


-2

Існує кілька загальних вимог, яким хотів би задовольнити кожен хороший менеджер API: реалізує клієнт API, орієнтований на протокол.

Початковий інтерфейс APIClient

protocol APIClient {
   func send(_ request: APIRequest,
              completion: @escaping (APIResponse?, Error?) -> Void) 
}

protocol APIRequest: Encodable {
    var resourceName: String { get }
}

protocol APIResponse: Decodable {
}

Тепер перевірте повну структуру API

// ******* This is API Call Class  *****
public typealias ResultCallback<Value> = (Result<Value, Error>) -> Void

/// Implementation of a generic-based  API client
public class APIClient {
    private let baseEndpointUrl = URL(string: "irl")!
    private let session = URLSession(configuration: .default)

    public init() {

    }

    /// Sends a request to servers, calling the completion method when finished
    public func send<T: APIRequest>(_ request: T, completion: @escaping ResultCallback<DataContainer<T.Response>>) {
        let endpoint = self.endpoint(for: request)

        let task = session.dataTask(with: URLRequest(url: endpoint)) { data, response, error in
            if let data = data {
                do {
                    // Decode the top level response, and look up the decoded response to see
                    // if it's a success or a failure
                    let apiResponse = try JSONDecoder().decode(APIResponse<T.Response>.self, from: data)

                    if let dataContainer = apiResponse.data {
                        completion(.success(dataContainer))
                    } else if let message = apiResponse.message {
                        completion(.failure(APIError.server(message: message)))
                    } else {
                        completion(.failure(APIError.decoding))
                    }
                } catch {
                    completion(.failure(error))
                }
            } else if let error = error {
                completion(.failure(error))
            }
        }
        task.resume()
    }

    /// Encodes a URL based on the given request
    /// Everything needed for a public request to api servers is encoded directly in this URL
    private func endpoint<T: APIRequest>(for request: T) -> URL {
        guard let baseUrl = URL(string: request.resourceName, relativeTo: baseEndpointUrl) else {
            fatalError("Bad resourceName: \(request.resourceName)")
        }

        var components = URLComponents(url: baseUrl, resolvingAgainstBaseURL: true)!

        // Common query items needed for all api requests
        let timestamp = "\(Date().timeIntervalSince1970)"
        let hash = "\(timestamp)"
        let commonQueryItems = [
            URLQueryItem(name: "ts", value: timestamp),
            URLQueryItem(name: "hash", value: hash),
            URLQueryItem(name: "apikey", value: "")
        ]

        // Custom query items needed for this specific request
        let customQueryItems: [URLQueryItem]

        do {
            customQueryItems = try URLQueryItemEncoder.encode(request)
        } catch {
            fatalError("Wrong parameters: \(error)")
        }

        components.queryItems = commonQueryItems + customQueryItems

        // Construct the final URL with all the previous data
        return components.url!
    }
}

// ******  API Request Encodable Protocol *****
public protocol APIRequest: Encodable {
    /// Response (will be wrapped with a DataContainer)
    associatedtype Response: Decodable

    /// Endpoint for this request (the last part of the URL)
    var resourceName: String { get }
}

// ****** This Results type  Data Container Struct ******
public struct DataContainer<Results: Decodable>: Decodable {
    public let offset: Int
    public let limit: Int
    public let total: Int
    public let count: Int
    public let results: Results
}
// ***** API Errro Enum ****
public enum APIError: Error {
    case encoding
    case decoding
    case server(message: String)
}


// ****** API Response Struct ******
public struct APIResponse<Response: Decodable>: Decodable {
    /// Whether it was ok or not
    public let status: String?
    /// Message that usually gives more information about some error
    public let message: String?
    /// Requested data
    public let data: DataContainer<Response>?
}

// ***** URL Query Encoder OR JSON Encoder *****
enum URLQueryItemEncoder {
    static func encode<T: Encodable>(_ encodable: T) throws -> [URLQueryItem] {
        let parametersData = try JSONEncoder().encode(encodable)
        let parameters = try JSONDecoder().decode([String: HTTPParam].self, from: parametersData)
        return parameters.map { URLQueryItem(name: $0, value: $1.description) }
    }
}

// ****** HTTP Pamater Conversion Enum *****
enum HTTPParam: CustomStringConvertible, Decodable {
    case string(String)
    case bool(Bool)
    case int(Int)
    case double(Double)

    init(from decoder: Decoder) throws {
        let container = try decoder.singleValueContainer()

        if let string = try? container.decode(String.self) {
            self = .string(string)
        } else if let bool = try? container.decode(Bool.self) {
            self = .bool(bool)
        } else if let int = try? container.decode(Int.self) {
            self = .int(int)
        } else if let double = try? container.decode(Double.self) {
            self = .double(double)
        } else {
            throw APIError.decoding
        }
    }

    var description: String {
        switch self {
        case .string(let string):
            return string
        case .bool(let bool):
            return String(describing: bool)
        case .int(let int):
            return String(describing: int)
        case .double(let double):
            return String(describing: double)
        }
    }
}

/// **** This is your API Request Endpoint  Method in Struct *****
public struct GetCharacters: APIRequest {
    public typealias Response = [MyCharacter]

    public var resourceName: String {
        return "characters"
    }

    // Parameters
    public let name: String?
    public let nameStartsWith: String?
    public let limit: Int?
    public let offset: Int?

    // Note that nil parameters will not be used
    public init(name: String? = nil,
                nameStartsWith: String? = nil,
                limit: Int? = nil,
                offset: Int? = nil) {
        self.name = name
        self.nameStartsWith = nameStartsWith
        self.limit = limit
        self.offset = offset
    }
}

// *** This is Model for Above Api endpoint method ****
public struct MyCharacter: Decodable {
    public let id: Int
    public let name: String?
    public let description: String?
}


// ***** These below line you used to call any api call in your controller or view model ****
func viewDidLoad() {
    let apiClient = APIClient()

    // A simple request with no parameters
    apiClient.send(GetCharacters()) { response in

        response.map { dataContainer in
            print(dataContainer.results)
        }
    }

}

-2

Це невеликий випадок використання, який може бути корисним: -

func testUrlSession(urlStr:String, completionHandler: @escaping ((String) -> Void)) {
        let url = URL(string: urlStr)!


        let task = URLSession.shared.dataTask(with: url){(data, response, error) in
            guard let data = data else { return }
            if let strContent = String(data: data, encoding: .utf8) {
            completionHandler(strContent)
            }
        }


        task.resume()
    }

Під час виклику функції: -

testUrlSession(urlStr: "YOUR-URL") { (value) in
            print("Your string value ::- \(value)")
}
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.