URLProtocol

URLProtocolを使用してスタブして開発する紹介

1. URLProtocol Ͱελϒͯ͠։ൃ 2017/11/24
2. Introduction
3. ʢલ৬ͰͷʣதؒϨϏϡʔ • ͓٬͞Μʹը໘ϨΠΞ΢τ΍ಈ͖ʢը໘ભҠͳͲʣͷೝ ͕͍ࣝ͋ͬͯΔ͔֬ೝͯ͠΋Β͏ɻ • ͜ͷ࣌఺ͰαʔόαΠυAPI͸ະ׬ • σʔλऔಘʢAPIϦΫΤετʣͷίʔυΛԾ࣮૷͢Δ͕ ຊ࣮૷͢Δ࣌ʹେ෯ͳมߋΛՃ͑ͨ͘ͳ͍ • ͋ͱͰෆཁʹͳΔϞοΫσʔλΛੜ੒͢Δίʔυ΋ॻ͖ ͨ͘ͳ͍
4. #if DEBUG DispatchQueue.global().async { // ϞοΫσʔλΛ࡞੒ let user = User.mockData() // ݁Ռॲཧ } #else let request = URLRequest(url: URL(string: "https://api.test.com/ users/foo")!) let task = URLSession.shared.dataTask(with: request) { (data, response, error) in // ݁Ռॲཧ } task.resume() #endif
5. Demo
6. "NS" URLProtocol Swift3Ͱ `Foundation` APIͷ"NS"ϓϨϑΟοΫ ε͕࡟আ͞Ε·͕ͨ͠ɺυΩϡϝϯτʹ͸׬શ ʹ൓ө͞Ε͓ͯΒͣɺ"NS"͕෇͍͍ͯͨΓ෇͍ ͯͳ͔ͬͨΓ͠·͢ɻ
7. URL Loading System
8. URL Loading System The URL loading system is a set of classes and protocols that allow your app to access content referenced by a URL. At the heart of this technology is the NSURL class, which lets your app manipulate URLs and the resources they refer to. https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/ URLLoadingSystem/URLLoadingSystem.html
9. URL loading system͕αϙʔ τ͍ͯ͠Δϓϩτίϧ • ftp:// • http:// • https:// • file:/// • data:
10. Foundation͕ఏڙ͍ͯ͠ΔΫϥ ε • URLͷίϯςϯπΛϩʔυ • αʔόʹσʔλΛΞοϓϩʔυ • ΫοΩʔετϨʔδͷ؅ཧ • ϨεϙϯεΩϟογϡͷ੍ޚ • ΞϓϦέʔγϣϯݻ༗ͷํ๏ͰͷΫϨσϯγϟϧετϨʔδͱೝ ূͷॲཧ • ΧελϜϓϩτίϧͷ֦ு
11. ϔϧύʔΫϥε
12. ϔϧύʔΫϥε
13. URLProtocol
14. URLProtocol An NSURLProtocol object handles the loading of protocol-specific URL data. The NSURLProtocol class itself is an abstract class that provides the infrastructure for processing URLs with a specific URL scheme. You create subclasses for any custom protocols or URL schemes that your app supports. https://developer.apple.com/documentation/foundation/urlprotocol
15. ͲͷΑ͏ͳ໨తͰ࢖͏͔ • ΧελϜϨεϙϯεΛฦ͢ʢςετ໨తͷελϒʣ • ωοτϫʔΫΛεΩοϓͯ͠ϩʔΧϧσʔλΛฦ͢ʢΩϟο γϡʣ • ϦμΠϨΫτʢϓϩΩγʣ • ϢʔβʔΤʔδΣϯτͷมߋ • ΧελϜϓϩτίϧ https://www.raywenderlich.com/76735/using-nsurlprotocol-swift
16. ࢖͍ํ
17. ొ࿥ • URLProtocolͷαϒΫϥεΛ௚઀Πϯελϯε Խ͢Δඞཁ͸ͳ͍ • ࣗ෼Ͱ࡞੒ͨ͠URLProtocolαϒΫϥεΛ࢖͑ ΔΑ͏ʹ registerClass(_:) ΫϥεϝιουΛ ݺͿ
18. ඞ࣮ͣ૷͠ͳ͍ͱ͍͚ͳ͍΋ͷ • class func canInit(with request: URLRequest) - > Bool • class func canonicalRequest(for request: URLRequest) -> URLRequest • func startLoading() • func stopLoading()
19. ࣗ෼͕Α͘ར༻͢Δ࢖͍ํ
20. ͲͷΑ͏ͳ໨తͰ࢖͏͔ • ΧελϜϨεϙϯεΛฦ͢ʢςετ໨తͷελϒʣ • ωοτϫʔΫΛεΩοϓͯ͠ϩʔΧϧσʔλΛฦ͢ʢΩϟο γϡʣ • ϦμΠϨΫτʢϓϩΩγʣ • ϢʔβʔΤʔδΣϯτͷมߋ • ΧελϜϓϩτίϧ https://www.raywenderlich.com/76735/using-nsurlprotocol-swift
21. URLProtocolͷΧελϚΠζ
22. • ϦΫΤετΛϋϯυϦϯά͢Δ৔߹͸ `true` Λฦ͢ • ΠϯελϯεԽ͞Εͯ௨৴ॲཧ΁ • `false`Λฦͨ͠৔߹͸ଞͷURLProtocol΁ॲཧ ͕ҠΔ override class func canInit(with request: URLRequest) -> Bool { return true }
23. • 'canonical'ͳϦΫΤετΛฦ͢ • ඞཁͳ৔߹͸͜͜Ͱ'canonical'ͳܗࣜʹมߋ ͢Δ • ඞཁͳ͚Ε͹ͦͷ··ฦ͢ override class func canonicalRequest(for request: URLRequest) -> URLRequest { return request }
24. override func startLoading() { // ϞοΫσʔλΛऔಘʢྫ͑͹Bundle͔ΒJSONσʔλΛऔಘʣ guard let path = Bundle.main.path(forResource: "user", ofType: "json"), let data = try? Data(contentsOf: URL(fileURLWithPath: path)) else { // Τϥʔॲཧ } let client = self.client let response = HTTPURLResponse(url: request.url!, statusCode: 200, httpVersion: "HTTP/1.1", headerFields: ["Content-Type" : "application/ json;"]) // ϨεϙϯεΛฦ͢ client?.urlProtocol(self, didReceive: response!, cacheStoragePolicy: .notAllowed) // σʔλΛฦ͢ client?.urlProtocol(self, didLoad: data) // ௨৴Λऴྃ client?.urlProtocolDidFinishLoading(self) }
25. override func startLoading() { ... // Τϥʔॲཧ let client = self.client let response = HTTPURLResponse(url: request.url!, statusCode: 500, httpVersion: "HTTP/1.1", headerFields: ["Content-Type" : "application/ json;"]) // ϨεϙϯεΛฦ͢ client?.urlProtocol(self, didReceive: response!, cacheStoragePolicy: .notAllowed) // ΤϥʔΛ࡞੒ͯ͠௨৴Λऴྃ let error = NSError(domain: "CustomURLProtocolError", code: 10001, userInfo: nil) client?.urlProtocol(self, didFailWithError: error) return .... }
26. URLProtocolClient • URLProtocolͷαϒΫϥε͕"URL Loading System"ͱ΍ΓͱΓ͢Δϓϩτίϧ • func urlProtocol(URLProtocol, didReceive: URLResponse, cacheStoragePolicy: URLCache.StoragePolicy) • func urlProtocol(URLProtocol, didLoad: Data) • func urlProtocolDidFinishLoading(URLProtocol) • func urlProtocol(URLProtocol, didFailWithError: Error) • func urlProtocol(URLProtocol, didReceive: URLAuthenticationChallenge) • func urlProtocol(URLProtocol, didCancel: URLAuthenticationChallenge) • func urlProtocol(URLProtocol, wasRedirectedTo: URLRequest, redirectResponse: URLResponse) • func urlProtocol(URLProtocol, cachedResponseIsValid: CachedURLResponse)
27. URLProtocolClient • URLProtocolͷαϒΫϥε͕"URL Loading System"ͱ΍ΓͱΓ͢Δϓϩτίϧ • func urlProtocol(URLProtocol, didReceive: URLResponse, cacheStoragePolicy: URLCache.StoragePolicy) • func urlProtocol(URLProtocol, didLoad: Data) • func urlProtocolDidFinishLoading(URLProtocol) • func urlProtocol(URLProtocol, didFailWithError: Error) • func urlProtocol(URLProtocol, didReceive: URLAuthenticationChallenge) • func urlProtocol(URLProtocol, didCancel: URLAuthenticationChallenge) • func urlProtocol(URLProtocol, wasRedirectedTo: URLRequest, redirectResponse: URLResponse) • func urlProtocol(URLProtocol, cachedResponseIsValid: CachedURLResponse) ੒ޭ࣌
28. URLProtocolClient • URLProtocolͷαϒΫϥε͕"URL Loading System"ͱ΍ΓͱΓ͢Δϓϩτίϧ • func urlProtocol(URLProtocol, didReceive: URLResponse, cacheStoragePolicy: URLCache.StoragePolicy) • func urlProtocol(URLProtocol, didLoad: Data) • func urlProtocolDidFinishLoading(URLProtocol) • func urlProtocol(URLProtocol, didFailWithError: Error) • func urlProtocol(URLProtocol, didReceive: URLAuthenticationChallenge) • func urlProtocol(URLProtocol, didCancel: URLAuthenticationChallenge) • func urlProtocol(URLProtocol, wasRedirectedTo: URLRequest, redirectResponse: URLResponse) • func urlProtocol(URLProtocol, cachedResponseIsValid: CachedURLResponse) ࣦഊ࣌
29. • ϦΫΤετ͕Ωϟϯηϧ͞Εͨ࣌ʹݺ͹ΕΔ • ผʹURLSessionΛ࢖༻ͯ͠ผͷϦΫΤετΛ ͍ͯͨ͠ΓɺGCDͰඇಉظॲཧΛ͍ͯͨ͠৔ ߹ʹͦΕΒ΋Ωϟϯηϧ͢Δ override func stopLoading() { }
30. ΧελϚΠζͨ͠ URLProtocolΛར༻͢Δ
31. • ྫ͑͹ `application(_: didFinishLaunchingWithOptions:)`Ͱొ࿥ func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { // ࢖༻ొ࿥ URLProtocol.registerClass(CustomURLProtocol.self) return true } URL Loading Systemʹొ࿥
32. • Կ΋ҙࣝ͠ͳͯ͘ྑ͍ • ϦϦʔε༻ίʔυͦͷ··ͷ࣮૷Ͱྑ͍ let request = URLRequest(url: URL(string: "https://api.test.com/users/ foo")!) let task = URLSession.shared.dataTask(with: request) { (data, response, error) in // ݁Ռॲཧ } task.resume() ϦΫΤετॲཧ
33. • ྫ͑͹ίϯύΠϧFlagsͰ࣮૷Λ෼͚Δඞཁ͕ ͳ͍ #if DEBUG let path = Bundle.main.path(forResource: "user", ofType: "json")! let data = try! Data(contentsOf: URL(fileURLWithPath: path)) DispatchQueue.global().async { // ݁Ռॲཧ } #else let request = URLRequest(url: URL(string: "https://api.test.com/users/foo")!) let task = URLSession.shared.dataTask(with: request) { (data, response, error) in // ݁Ռॲཧ } task.resume() #endif
34. ͔͠͠ɺ ͜Ε͸URLSession.sharedΛ ར༻͍ͯ͠Δ৔߹
35. αʔυύʔςΟϥΠϒϥϦͰ ར༻͢Δ
36. • Կ΋ҙࣝ͠ͳͯ͘ྑ͍ • ϦϦʔε༻ίʔυͦͷ··ͷ࣮૷Ͱྑ͍ • ྫ͑͹ίϯύΠϧFlagsͰ࣮૷Λ෼͚Δඞཁ͕ͳ͍ let request = URLRequest(url: URL(string: "https://api.test.com/users/ foo")!) let task = URLSession.shared.dataTask(with: request) { (data, response, error) in // ݁Ռॲཧ } task.resume() ϦΫΤετॲཧ
37. • ྫ͑͹ `application(_: didFinishLaunchingWithOptions:)`Ͱొ࿥ func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { // ࢖༻ొ࿥ URLProtocol.registerClass(CustomURLProtocol.self) return true } URL Loading Systemʹొ࿥
38. URLSession.shared • The shared session uses the shared NSURLCache, NSHTTPCookieStorage, and NSURLCredentialStorage objects, uses a shared custom networking protocol list (configured with registerClass(_:) and unregisterClass(_:)), and is based on a default configuration. • In other words, if you’re doing anything with caches, cookies, authentication, or custom networking protocols, you should probably be using a default session instead of the shared session. https://developer.apple.com/documentation/foundation/urlsession/1409000-shared
39. • URLSession.sharedΛར༻͠ͳ͍৔߹͸ɺΧελϚΠζ ͨ͠URLSessionConfigurationΛར༻͢Δ • αʔυύʔςΟϥΠϒϥϦͰ͸େ఍ URLSessionConfiguration.defaultΛجʹͨ͠URLSession Λར༻͍ͯ͠Δ • URLProtocol.registerClassͰ͸ػೳ͠ͳ͍ URLProtocol.registerClass(CustomURLProtocol.self)
40. • URLSessionConfigurationͷ var protocolClasses: [AnyClass]? ʹઃఆ let config = URLSessionConfiguration.default config.protocolClasses = [CustomURLProtocol.self] let session = URLSession(configuration: config) let task = session.dataTask(with: urlRequest) { (data, response, error) in ... } ಛఆͷϦΫΤετͷΈར༻
41. • ΧελϜURLProtocolΛઃఆͨ͠URLSessionConfigurationΛݩʹ SessionManagerΛੜ੒ͯ͠ར༻ • (஫)࡞੒ͨ͠SessionManager͸Ͳ͔͜Ͱอ͓࣋ͯ͘͠ඞཁ͋Γ let config = URLSessionConfiguration.default config.protocolClasses = [CustomURLProtocol.self] self.manager = SessionManager(configuration: config) // อ࣋͢Δ manager.request(url).response { response in ... } AlamofireͰར༻
42. • ΧελϜURLProtocolΛઃఆͨ͠URLSessionConfigurationΛݩʹ URLSessionAdapterɺSessionΛੜ੒ͯ͠ར༻ let config = URLSessionConfiguration.default config.protocolClasses = [CustomURLProtocol.self] let adapter = URLSessionAdapter(configuration: config) let session = Session(adapter: adapter) session.send(request) { (result) in ... } APIKitͰར༻
43. Ͳ͏͍͏࣌ʹ࢖͏ʁ
44. • ։ൃϑΣʔζͰͷը໘࡞੒ • ·ͩAPI͕࣮૷͞Ε͍ͯͳ͍࣌ʹதؒϨϏϡʔ Ͱ͓٬͞Μʹಈ͖Λݟͯ΋Β͏ɻ • Qiita APIͳͲճ਺੍ݶ͕ܾ·͍ͬͯΔαʔυ ύʔςΟͷAPIΛར༻͢Δ৔߹ʹɺΞΫηεෆ ՄʹͳΒͳ͍Α͏ʹ։ൃத͸μ΢ϯϩʔυ͠ ͓͍ͯͨσʔλΛར༻͢Δ
45. URLProtocolͷ࣮༻ྫ • https://github.com/Alamofire/Alamofire/ blob/master/Tests/URLProtocolTests.swift • https://github.com/ishkawa/APIKit/blob/ master/Tests/APIKitTests/TestComponents/ HTTPStub.swift • https://github.com/AliSoftware/ OHHTTPStubs
46. Appendix • [URL Loading System]: https://developer.apple.com/library/content/ documentation/Cocoa/Conceptual/URLLoadingSystem/ URLLoadingSystem.html • [URLProtocol]: https://developer.apple.com/documentation/foundation/ urlprotocol • [Using NSURLProtocol with Swift]: https://www.raywenderlich.com/76735/ using-nsurlprotocol-swift • [iOS Advent Calendar 2011 5೔໨ / NSURLProtocolͷ࢖͍ํ]: http:// faultier.blog.jp/archives/1762587.html • [Using NSURLProtocol for Testing]: https://yahooeng.tumblr.com/post/ 141143817861/using-nsurlprotocol-for-testing