[iOS-Foundation] NSURLSessionConfiguration

NSURLSessionConfiguration 定义了NSURLSession中网络请求的行为和策略,如超时时间、缓存策略等。当使用NSURLSessionConfiguration对象创建NSURLSession对象时,会使用NSURLSessionConfiguration对象的一份拷贝,而之后对原NSURLSessionConfiguration对象的修改则不会影响NSURLSession对象。若要修改则只能用更改后的NSURLSessionConfiguration对象重新创建新的NSURLSession对象。需要注意的是,NSURLSessionConfiguration中的某些设置可能会被NSURLSessionTask的 request 覆盖。

普通配置项

  • identifier,用于唯一标识一个后台下载的 session,当系统重启被自动关闭的应用时,可以通过这个标识符,重新创建 configuration 和 session 对象来恢复中断的下载。
  • HTTPAdditionalHeaders,一个 dictionary,包含了需要额外添加到 session 中所有 request 的 header,如User-Agent。不应添加
    AuthorizationConnectionHostWWW-Authenticate。如果 request 中已存在某一 header,则使用 request 中的值,该 dictionary 默认为空。
  • networkServiceTypeNSURLRequestNetworkServiceType类型,network service type 影响着操作系统对于网络传输的优先级排列,进而影响系统电量、性能的消耗。默认值是NSURLNetworkServiceTypeDefault
  • allowsCellularAccess,布尔值,指明在移动网络下是否可发起请求。
  • timeoutIntervalForRequest,请求的超时时间,默认值为60秒。
  • timeoutIntervalForResource,所有资源下载或上传完成的超时时间,中间请求失败可重新请求,单位为秒,默认时间为7天。
  • sharedContainerIdentifier,用于应用扩展与应用间的后台会话的扩展容器。

HTTP cookie 相关配置项

  • HTTPCookieAcceptPolicy,接收 cookie 的策略,
    NSHTTPCookieAcceptPolicy类型,默认值是
    NSHTTPCookieAcceptPolicyOnlyFromMainDocumentDomain
  • HTTPCookieStorage,对于default 和 background session,该属性值为NSHTTPCookieStorage的单例对象,而 ephemeral session 的默认值为一个私有的NSHTTPCookieStorage对象,只将 cookie 保存在内存中,如果 session 不想保存 cookie,可将该属性设为 nil。
  • HTTPShouldSetCookies,布尔值,指明请求时是否携带 cookie 信息。

安全相关配置项

  • TLSMaximumSupportedProtocol,SSLProtocol 类型,请求支持的最高 TLS 版本,默认值是 kTLSProtocol12,即 TLS1.2。
  • TLSMinimumSupportedProtocol,SSLProtocol 类型,请求支持的最低 TLS 版本,默认值是 kSSLProtocol3,即 SSL3.0。
  • URLCredentialStorage,管理需要验证的请求证书。

缓存策略配置项

  • URLCache,用于保存缓存响应的NSURLCache对象,default session 默认使用NSURLCache的单例对象,background session 的默认值为 nil,而 ephemeral session 的默认值是一个私有的NSURLCache对象,数据只保存在内存中。如果不想使用缓存,可直接设置该值为 nil。
  • requestCachePolicy,枚举类型NSURLRequestCachePolicy,指明了请求使用缓存响应的策略。
// 默认值,使用协议本身的缓存逻辑。
NSURLRequestUseProtocolCachePolicy
// 不使用现有缓存,数据需要从原始地址加载。
NSURLRequestReloadIgnoringLocalCacheData
// 无论缓存是否过期,先使用本地缓存数据。如果缓存中没有请求所对应的数据,那么从原始地址加载数据。
NSURLRequestReturnCacheDataElseLoad
// 无论缓存是否过期,先使用本地缓存数据。如果缓存中没有请求所对应的数据,那么放弃从原始地址加载数据,请求视为失败。
NSURLRequestReturnCacheDataDontLoad

后台下载配置项

  • sessionSendsLaunchEvents,布尔值,说明在 session task 完成或者需要验证时,是否在后台运行应用。当设为 YES 时,系统会自动启动或运行应用,并调用 AppDelegate 中的方法
    application:handleEventsForBackgroundURLSession:completionHandler:,通过参数提供上述提到的唯一标识后台下载 session 的 identifier。
  • discretionary,布尔值,说明在下载时是否由系统统一安排资源。

自定义协议配置项

  • protocolClasses,由自定义实现的NSURLProtocol子类的 Class 对象组成的数组,配置了 session 支持的自定义协议。

HTTP相关配置项

  • HTTPMaximumConnectionsPerHost,session 内一个域名的最大同时连接数。
  • HTTPShouldUsePipelining,布尔值,说明 session 内的 task 是否使用 HTTP pipelining。
  • connectionProxyDictionary,字典类型,保存了连接代理的相关信息,默认为 NULL。

内置的配置对象

通过类方法,NSURLSessionConfiguration提供了适用于不同情况的配置对象,它们的一些配置属性设置了不同的默认值。

  • + defaultSessionConfiguration,默认的配置对象,持久化存储缓存,证书,cookie。
  • + ephemeralSessionConfiguration,不持久化存储缓存,证书,cookie的配置。所有相关内容只保存在内存中,当 session 失效或应用终止,所有内容被清空。该配置可提高私密性,因为不会向硬盘上写入数据。
  • + backgroundSessionConfigurationWithIdentifier:,适用于在后台上传和下载文件的网络请求。当应用被系统终止并重启,传入的参数 identifier 可用来重新创建配置和 session 对象,以便恢复中断的下载任务。如果是用户主动终止程序,则不会有上述行为。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容