使用NSURLSession创建自定义NSURLProtocol

Question

我正在尝试实现这个教程，该教程使用了自定义的NSURLProtocol和NSURLConnection。

https://www.raywenderlich.com/76735/using-nsurlprotocol-swift

它按预期工作，但由于NSURLSession已被iOS9弃用，所以我正在尝试将其转换为NSURLSession。

不幸的是，这并没有起作用。

我正在在UIWebView中加载一个网站，如果我使用NSURLConnection，它可以加载并且所有来自webview的http请求都被捕获，但是当使用NSURLSession时则不能。

感谢您的任何帮助。

以下是我的代码：

    import UIKit

    class MyProtocol: NSURLProtocol, NSURLSessionDataDelegate, NSURLSessionTaskDelegate, NSURLSessionDelegate {

    //var connection: NSURLConnection!
    var mutableData: NSMutableData!
    var response: NSURLResponse!

    var dataSession: NSURLSessionDataTask!

    override class func canInitWithRequest(request: NSURLRequest) -> Bool {

        if NSURLProtocol.propertyForKey("MyURLProtocolHandledKey", inRequest: request) != nil {
            return false
        }

        return true
    }

    override class func canonicalRequestForRequest(request: NSURLRequest) -> NSURLRequest {
        return request
    }

    override class func requestIsCacheEquivalent(aRequest: NSURLRequest,
        toRequest bRequest: NSURLRequest) -> Bool {
            return super.requestIsCacheEquivalent(aRequest, toRequest:bRequest)
    }

    override func startLoading() {
        let newRequest = self.request.mutableCopy() as! NSMutableURLRequest
        NSURLProtocol.setProperty(true, forKey: "MyURLProtocolHandledKey", inRequest: newRequest)

        self.dataSession = NSURLSession.sharedSession().dataTaskWithRequest(newRequest)

        dataSession.resume()
        self.mutableData = NSMutableData()
    }

        override func stopLoading() {

        print("Data task stop")
        self.dataSession.cancel()
        self.mutableData = nil

    }

    func URLSession(session: NSURLSession, dataTask: NSURLSessionDataTask, didReceiveResponse response: NSURLResponse, completionHandler: (NSURLSessionResponseDisposition) -> Void) {
        self.response = response
        self.mutableData = NSMutableData()
        print(mutableData)
    }

    func URLSession(session: NSURLSession, dataTask: NSURLSessionDataTask, didReceiveData data: NSData) {
        self.client?.URLProtocol(self, didLoadData: data)
        self.mutableData.appendData(data)
    }

    func URLSession(session: NSURLSession, task: NSURLSessionTask, didCompleteWithError error: NSError?) {
        if (error == nil)
        {
            self.client!.URLProtocolDidFinishLoading(self)
            self.saveCachedResponse()
        }
        else
        {
            self.client?.URLProtocol(self, didFailWithError: error!)
        }
    }

    func saveCachedResponse () {
        let timeStamp = NSDate()
        let urlString = self.request.URL?.absoluteString
        let dataString = NSString(data: self.mutableData, encoding: NSUTF8StringEncoding) as NSString?
        print("TiemStamp:\(timeStamp)\nURL: \(urlString)\n\nDATA:\(dataString)\n\n")
    }


    }

- kupilot

---

你如何知道你的代码不起作用？你自己有没有尝试过追踪问题？你能否回顾一下你的代码示例并删除所有被注释掉的部分？也许在每个程序中添加一些关于你想要实现的内容的注释。 - Scott Thompson

嗨，我是Swift的新手，遇到了Webview缓存问题。我正在尝试使用相同的源代码，网页可以正常加载并保存在缓存中。但是当设备离线时，我无法从缓存数据中获取它。也许我需要使用urlsession更新代码。你能帮我看一下这个源码吗？ :( https://drive.google.com/file/d/0B-5GPXUpPZh-Q2FOWEJudXRaQkE/view?usp=sharing - Jamshed Alam

Answer 1

我已经解决了。

如果有人需要，这是代码。

import Foundation

class MyProtocol1: NSURLProtocol, NSURLSessionDataDelegate, NSURLSessionTaskDelegate
{
private var dataTask:NSURLSessionDataTask?
private var urlResponse:NSURLResponse?
private var receivedData:NSMutableData?

class var CustomKey:String {
    return "myCustomKey"
}

// MARK: NSURLProtocol

override class func canInitWithRequest(request: NSURLRequest) -> Bool {
    if (NSURLProtocol.propertyForKey(MyProtocol1.CustomKey, inRequest: request) != nil) {
        return false
    }

    return true
}

override class func canonicalRequestForRequest(request: NSURLRequest) -> NSURLRequest {
    return request
}

override func startLoading() {

    let newRequest = self.request.mutableCopy() as! NSMutableURLRequest

    NSURLProtocol.setProperty("true", forKey: MyProtocol1.CustomKey, inRequest: newRequest)

    let defaultConfigObj = NSURLSessionConfiguration.defaultSessionConfiguration()
    let defaultSession = NSURLSession(configuration: defaultConfigObj, delegate: self, delegateQueue: nil)

    self.dataTask = defaultSession.dataTaskWithRequest(newRequest)
    self.dataTask!.resume()

}

override func stopLoading() {
    self.dataTask?.cancel()
    self.dataTask       = nil
    self.receivedData   = nil
    self.urlResponse    = nil
}

// MARK: NSURLSessionDataDelegate

func URLSession(session: NSURLSession, dataTask: NSURLSessionDataTask,
                didReceiveResponse response: NSURLResponse,
                                   completionHandler: (NSURLSessionResponseDisposition) -> Void) {

    self.client?.URLProtocol(self, didReceiveResponse: response, cacheStoragePolicy: .NotAllowed)

    self.urlResponse = response
    self.receivedData = NSMutableData()

    completionHandler(.Allow)
}

func URLSession(session: NSURLSession, dataTask: NSURLSessionDataTask, didReceiveData data: NSData) {
    self.client?.URLProtocol(self, didLoadData: data)

    self.receivedData?.appendData(data)
}

// MARK: NSURLSessionTaskDelegate

func URLSession(session: NSURLSession, task: NSURLSessionTask, didCompleteWithError error: NSError?) {
    if error != nil && error!.code != NSURLErrorCancelled {
        self.client?.URLProtocol(self, didFailWithError: error!)
    } else {
        saveCachedResponse()
        self.client?.URLProtocolDidFinishLoading(self)
    }
}

// MARK: Private methods

/**
 Do whatever with the data here
 */
func saveCachedResponse () {
    let timeStamp = NSDate()
    let urlString = self.request.URL?.absoluteString
    let dataString = NSString(data: self.receivedData!, encoding: NSUTF8StringEncoding) as NSString?
    print("TimeStamp:\(timeStamp)\nURL: \(urlString)\n\nDATA:\(dataString)\n\n")
}


}

- kupilot

---

谢谢，帮了很大的忙。以下是同一类的 Swift 3 版本，以防有人需要。 - deepax11

你真的不需要为每个请求使用单独的 NSURLSession。那样非常低效。相反，你应该考虑使用一个共享实例（使用在 dispatch_once 块中初始化的全局变量）。 - dgatwood

能否拦截来自移动文档目录的文件请求？ 它只拦截具有http、https、file:///var/container/... URL，但不拦截file:///var/mobile//Containers/Data/Application/...。 - Vineet Kumar Singh

Answer 2

Swift 3 版本：

//  CustomURLProtocol.swift

class CustomURLProtocol: URLProtocol, URLSessionDataDelegate, URLSessionTaskDelegate {
  private var dataTask: URLSessionDataTask?
  private var urlResponse: URLResponse?
  private var receivedData: NSMutableData?

  class var CustomHeaderSet: String {
      return "CustomHeaderSet"
  }

  // MARK: NSURLProtocol

  override class func canInit(with request: URLRequest) -> Bool {
      guard let host = request.url?.host, host == "your domain.com" else {
          return false
      }
      if (URLProtocol.property(forKey: CustomURLProtocol.CustomHeaderSet, in: request as URLRequest) != nil) {
          return false
      }

      return true
  }

  override class func canonicalRequest(for request: URLRequest) -> URLRequest {
      return request
  }

  override func startLoading() {

      let mutableRequest =  NSMutableURLRequest.init(url: self.request.url!, cachePolicy: NSURLRequest.CachePolicy.useProtocolCachePolicy, timeoutInterval: 240.0)//self.request as! NSMutableURLRequest

      //Add User Agent

      var userAgentValueString = "myApp"
     mutableRequest.setValue(userAgentValueString, forHTTPHeaderField: "User-Agent")

      print(mutableRequest.allHTTPHeaderFields ?? "")
      URLProtocol.setProperty("true", forKey: CustomURLProtocol.CustomHeaderSet, in: mutableRequest)
      let defaultConfigObj = URLSessionConfiguration.default
      let defaultSession = URLSession(configuration: defaultConfigObj, delegate: self, delegateQueue: nil)
      self.dataTask = defaultSession.dataTask(with: mutableRequest as URLRequest)
      self.dataTask!.resume()

  }

  override func stopLoading() {
      self.dataTask?.cancel()
      self.dataTask       = nil
      self.receivedData   = nil
      self.urlResponse    = nil
  }

  // MARK: NSURLSessionDataDelegate

  func urlSession(_ session: URLSession, dataTask: URLSessionDataTask,
                  didReceive response: URLResponse,
                  completionHandler: @escaping (URLSession.ResponseDisposition) -> Void) {

      self.client?.urlProtocol(self, didReceive: response, cacheStoragePolicy: .notAllowed)

      self.urlResponse = response
      self.receivedData = NSMutableData()

      completionHandler(.allow)
  }

  func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data) {
      self.client?.urlProtocol(self, didLoad: data as Data)

      self.receivedData?.append(data as Data)
  }

  // MARK: NSURLSessionTaskDelegate

  func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?) {
      if error != nil { //&& error.code != NSURLErrorCancelled {
          self.client?.urlProtocol(self, didFailWithError: error!)
      } else {
          //saveCachedResponse()
          self.client?.urlProtocolDidFinishLoading(self)
      }
  }
}

- deepax11

---

它可以工作，但显示整个网站。没有显示移动站点视图。 - vp2698

Answer 3

您代码遇到的问题在于使用了NSURLSession.sharedSession来包含您的数据任务。使用共享会话，您将无法更改会话委托，因此不会调用任何委托例程。

您需要创建一个自定义会话，并将您的协议建立为会话的委托。然后，在被要求开始加载时，您可以在该会话中创建一个数据任务。

- Scott Thompson

---

嗨，感谢回复。注释掉的代码是用于 NSURLConnection 的，由于在 iOS9 中已被弃用，我需要将其转换为 NSURLSession。我的目的是要监视来自 uiwebview 的所有 http 请求，并保存某些 url 请求的 JSON 响应。使用 NSURLConnection 时，代码运行良好，我可以看到请求并且 webview 加载网站和任何链接点击。但是，由于改用 NSURLSession，webview 不再加载网站。 - kupilot

是的，我明白。正如我在我的答案中所说，当您使用NSURLConnection时，您设置了连接的代理，您的代理方法收集了数据。在您的新基于NSSession的代码中，您需要创建一个自定义会话，而不是使用NSSession.sharedSession，以便您可以在该会话上设置代理，以便可以调用您的会话和数据任务代理回调。 - Scott Thompson

嗨，Scott Thomson，你能告诉我当设备离线时如何使用startLoading()方法来显示缓存数据本地备份吗？这是我的代码，我是Swift的新手，对此有些困惑。教程链接：https://www.raywenderlich.com/76735/using-nsurlprotocol-swift - Jamshed Alam

Answer 4

从URLSession的文档中：

重要

会话对象将一直保持对委托的强引用，直到您的应用程序退出或明确使会话无效。如果您没有使会话无效，则应用程序在退出之前泄漏内存。

还有：

注意

小心不要创建比所需更多的会话。例如，如果您的应用程序有几个需要类似配置的会话的部分，请创建一个会话并在它们之间共享它。

因此，我将从startLoading方法中将URLSession的创建移动到URLProtocol子类的初始化器中：

class MyURLProtocol: URLProtocol, URLSessionDataDelegate,URLSessionTaskDelegate {
    override init(request: URLRequest, cachedResponse: CachedURLResponse?, client: URLProtocolClient?) {
        super.init(request: request, cachedResponse: cachedResponse, client: client)
        defaultSession = URLSession(configuration: .default, delegate: self, delegateQueue: nil)
    }
    private var defaultSession: URLSession?

- Hugo F