स्विफ्ट फ़ंक्शन में async कॉल से डेटा वापस करना

Question 1

मैंने अपने स्विफ्ट प्रोजेक्ट में एक उपयोगिता वर्ग बनाया है जो सभी REST अनुरोधों और प्रतिक्रियाओं को संभालता है। मैंने एक साधारण REST API बनाया है ताकि मैं अपने कोड का परीक्षण कर सकूं। मैंने एक क्लास विधि बनाई है जिसमें NSArray को वापस करने की आवश्यकता है लेकिन क्योंकि API कॉल async है मुझे async कॉल के अंदर विधि से वापस जाने की आवश्यकता है। समस्या async रिटर्न शून्य है। अगर मैं नोड में ऐसा कर रहा था तो मैं जेएस वादों का उपयोग करूंगा लेकिन मैं स्विफ्ट में काम करने वाले समाधान का पता नहीं लगा सकता।

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...
    }
}

Question 2

आप कॉलबैक पास कर सकते हैं, और कॉल को कॉल कर सकते हैं async कॉल के अंदर

कुछ इस तरह:

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

Question 3

स्विफ्टज़ पहले से ही फ्यूचर ऑफर करता है, जो एक प्रॉमिस का बेसिक बिल्डिंग ब्लॉक है। एक भविष्य एक वादा है जो विफल नहीं हो सकता (यहां सभी शब्द स्काला व्याख्या पर आधारित हैं, जहां एक वादा एक मोनाड है )।

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

उम्मीद है कि आखिरकार पूर्ण स्काला-शैली के वादे का विस्तार होगा (मैं इसे स्वयं किसी बिंदु पर लिख सकता हूं; मुझे यकीन है कि अन्य पीआर का स्वागत किया जाएगा; यह भविष्य में पहले से मुश्किल नहीं है)।

आपके विशेष मामले में, मैं शायद एक Result<[Book]>( अलेक्जेंड्रोस सालज़ार के संस्करणResult पर आधारित ) बनाऊंगा । तब आपकी विधि हस्ताक्षर होगी:

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

टिप्पणियाँ

मैं getस्विफ्ट के साथ उपसर्ग कार्यों की अनुशंसा नहीं करता हूं । यह ओबजेक के साथ कुछ प्रकार के अंतर को तोड़ देगा।
मैं Bookआपके परिणाम को वापस करने से पहले किसी वस्तु को सभी तरह से पार्स करने की सलाह देता हूं Future। ऐसे कई तरीके हैं जो इस प्रणाली को विफल कर सकते हैं, और यह बहुत अधिक सुविधाजनक है यदि आप उन सभी चीजों की जांच करते हैं, तो उन्हें लपेटने से पहले Future। करने के लिए हो रही है [Book]ज्यादा बेहतर एक के आसपास सौंपने की तुलना में अपने स्विफ्ट कोड के बाकी के लिए है NSArray।

Question 4

मूल पैटर्न समापन हैंडलर बंद करने का उपयोग करना है।

उदाहरण के लिए, आगामी स्विफ्ट 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

ध्यान दें, ऊपर मैं मॉडल और UI अपडेट को सरल बनाने के लिए मुख्य हैंडलर पर वापस हैंडलर को भेज रहा हूं। कुछ डेवलपर्स इस अभ्यास के लिए अपवाद लेते हैं और या तो जो भी कतार का URLSessionउपयोग करते हैं या अपनी खुद की कतार का उपयोग करते हैं (कॉलर को मैन्युअल रूप से परिणामों को स्वयं सिंक्रनाइज़ करने की आवश्यकता होती है)।

लेकिन वह यहाँ भौतिक नहीं है। प्रमुख मुद्दा कोड के ब्लॉक को निर्दिष्ट करने के लिए पूरा हैंडलर का उपयोग होता है जब अतुल्यकालिक अनुरोध किया जाता है।

पुराना, स्विफ्ट 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(हम उन उपयोग किए गए उद्देश्य-सी प्रकारों का उपयोग नहीं करते हैं )। मुझे लगता है कि हमारे पास एक Genreप्रकार था और हमने इसे डिकोड करने के JSONDecoderबजाय संभवतः उपयोग किया JSONSerializationथा। लेकिन इस सवाल में अंतर्निहित JSON के बारे में पर्याप्त जानकारी नहीं थी, ताकि मैं यहां जानकारी प्राप्त कर सकूं, इसलिए मैंने छोड़ दिया कि मुख्य मुद्दे को टालने से बचने के लिए, समापन हैंडलर के रूप में बंद का उपयोग करें।

Question 5

स्विफ्ट 4.0

Async अनुरोध-प्रतिक्रिया के लिए आप पूर्ण हैंडलर का उपयोग कर सकते हैं। नीचे देखें मैंने पूर्ण हैंडल प्रतिमान के साथ समाधान को संशोधित किया है।

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
}

Question 6

@Alexey Globchastyy के जवाब का स्विफ्ट 3 संस्करण:

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

Question 7

मुझे आशा है कि आप अभी भी इस पर नहीं अटके हैं, लेकिन संक्षिप्त जवाब यह है कि आप स्विफ्ट में ऐसा नहीं कर सकते।

एक वैकल्पिक दृष्टिकोण एक कॉलबैक को वापस करना होगा जो आपको तैयार होने के साथ ही आवश्यक डेटा प्रदान करेगा।

Question 8

कॉल बैक फ़ंक्शंस बनाने के 3 तरीके हैं: 1. समापन हैंडलर 2. अधिसूचना 3. प्रतिनिधि

पूर्ण हैंडलर अंदर ब्लॉक के सेट को निष्पादित किया जाता है और स्रोत उपलब्ध होने पर लौटा दिया जाता है, हैंडलर इंतजार करेगा जब तक कि प्रतिक्रिया नहीं आती है ताकि यूआई को अपडेट किया जा सके।

सूचना की सूचना सभी ऐप पर बंच को ट्रिगर किया जाता है, लिस्टनर उस जानकारी का उपयोग कर सकते हैं। परियोजना के माध्यम से जानकारी प्राप्त करने का Async तरीका।

प्रतिनिधि का आह्वान करने पर विधियों का सेट ट्रिगर हो जाएगा, स्रोत स्वयं विधियों द्वारा प्रदान किया जाना चाहिए

Question 9

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()

Question 10

मुख्य रूप से स्विफ्ट में कॉलबैक प्राप्त करने के 3 तरीके हैं

क्लोजर / कंप्लीट हैंडलर
प्रतिनिधियों
सूचनाएं

एक बार Async कार्य पूरा होने के बाद पर्यवेक्षकों को सूचित करने के लिए भी उपयोग किया जा सकता है।

Question 11

कुछ बहुत ही सामान्य आवश्यकताएं हैं जो हर अच्छे एपीआई प्रबंधक को संतुष्ट करना चाहेंगे: एक प्रोटोकॉल उन्मुख एपीआई क्लाइंट को लागू करेगा ।

प्रारंभिक प्रारंभिक इंटरफ़ेस

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

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

protocol APIResponse: Decodable {
}

अब कृपया पूर्ण एपीआई संरचना की जांच करें

// ******* 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)
        }
    }

}

Question 12

यह एक छोटा सा उपयोग मामला है जो सहायक हो सकता है: -

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