iOS基础深入补完计划--NSURLRequest/NSURLResponse相关API

iOS基础深入补完计划--NSURLRequest/NSURLResponse相关API_第1张图片
学习NSURLSession之前、先撸一遍NSURLRequest(请求)和NSURLResponse(响应)头文件里的属性和API

本文链接


NSURLRequest

@interface NSURLRequest : NSObject 
{
    @private
    NSURLRequestInternal *_internal;
}

/*! 
创建NSURLRequest对象
默认使用NSURLRequestUseProtocolCachePolicy缓存逻辑 
默认请求超时时限为60s
*/
+ (instancetype)requestWithURL:(NSURL *)URL;
/*! 
是否支持安全编码
*/
+ (BOOL)supportsSecureCoding;
/*!
    创建时设置缓存策略和超时时限

    @param URL 请求链接
    @param cachePolicy 缓存策略
    @param timeoutInterval 超时时间
*/
+ (instancetype)requestWithURL:(NSURL *)URL cachePolicy:(NSURLRequestCachePolicy)cachePolicy timeoutInterval:(NSTimeInterval)timeoutInterval;
//init方法进行对象的创建 默认使用NSURLRequestUseProtocolCachePolicy缓存逻辑 默认请求超时时限为60s
- (instancetype)initWithURL:(NSURL *)URL;
/*! 
创建NSURLRequest对象
默认使用NSURLRequestUseProtocolCachePolicy缓存逻辑 
默认请求超时时限为60s
*/
- (instancetype)initWithURL:(NSURL *)URL cachePolicy:(NSURLRequestCachePolicy)cachePolicy timeoutInterval:(NSTimeInterval)timeoutInterval;
/*! 
    只读属性、获取对象的URL
*/
@property (nullable, readonly, copy) NSURL *URL;
/*! 
    只读属性、获取对象的缓存策略
*/
/*
NSURLRequestCachePolicy枚举如下:
typedef NS_ENUM(NSUInteger, NSURLRequestCachePolicy)
{
    //默认的缓存协议
    NSURLRequestUseProtocolCachePolicy = 0,
    //无论有无本地缓存数据 都进行从新请求
    NSURLRequestReloadIgnoringLocalCacheData = 1,
    //忽略本地和远程的缓存数据 未实现的策略
    NSURLRequestReloadIgnoringLocalAndRemoteCacheData = 4, 
    //无论有无缓存数据 都进行从新请求
    NSURLRequestReloadIgnoringCacheData = NSURLRequestReloadIgnoringLocalCacheData,
    //先检查缓存 如果没有缓存再进行请求
    NSURLRequestReturnCacheDataElseLoad = 2,
    //类似离线模式,只读缓存 无论有无缓存都不进行请求
    NSURLRequestReturnCacheDataDontLoad = 3,
    //未实现的策略
    NSURLRequestReloadRevalidatingCacheData = 5, // Unimplemented
};
*/
@property (readonly) NSURLRequestCachePolicy cachePolicy;
/*! 
    只读属性、获取对象的超时时间
*/
@property (readonly) NSTimeInterval timeoutInterval;
/*! 
    只读属性、获取缓存路径
*/
@property (nullable, readonly, copy) NSURL *mainDocumentURL;
/*! 
    只读属性、获取网络请求的服务类型
*/
/*
typedef NS_ENUM(NSUInteger, NSURLRequestNetworkServiceType)
{
    NSURLNetworkServiceTypeDefault = 0, // 普通网络传输,默认使用这个
    NSURLNetworkServiceTypeVoIP = 1,    // 网络语音通信传输,只能在VoIP使用
    NSURLNetworkServiceTypeVideo = 2,   // 影像传输
    NSURLNetworkServiceTypeBackground = 3, // 网络后台传输,优先级不高时可使用。对用户不需要的网络操作可使用
    NSURLNetworkServiceTypeVoice = 4       // 语音传输
};
*/
@property (readonly) NSURLRequestNetworkServiceType networkServiceType;
/*! 
    只读属性、获取是否允许蜂窝请求
*/
@property (readonly) BOOL allowsCellularAccess;

@end

NSMutableURLRequest

NSURLRequest的子类、放开了许多只读权限

@interface NSMutableURLRequest : NSURLRequest
/*! 
    设置请求的URL
*/
@property (nullable, copy) NSURL *URL;
/*! 
    设置请求的缓存策略
*/@property NSURLRequestCachePolicy cachePolicy;
/*! 
    设置请求的超时时间
*/
@property NSTimeInterval timeoutInterval;
/*! 
    设置请求的缓存目录
*/
@property (nullable, copy) NSURL *mainDocumentURL;
/*! 
    设置请求的网络服务类型
*/
@property NSURLRequestNetworkServiceType networkServiceType NS_AVAILABLE(10_7, 4_0);
/*! 
    设置请求是否支持蜂窝网络
*/
@property BOOL allowsCellularAccess NS_AVAILABLE(10_8, 6_0);

NSURLRequest (NSHTTPURLRequest)

NSURLRequest的扩展、可以针对HTTP进行许多设置

@interface NSURLRequest (NSHTTPURLRequest) 
/*! 
    设置HTTP请求的方式、默认为Get
*/
@property (copy) NSString *HTTPMethod;
//通过字典设置HTTP请求头的键值数据
/*! 
    通过字典、设置HTTP请求头
*/
@property (nullable, copy) NSDictionary *allHTTPHeaderFields;
/*! 
    通过键值对、设置HTTP请求头
*/
- (void)setValue:(nullable NSString *)value forHTTPHeaderField:(NSString *)field;
/*! 
    通过键值对、为HTTP请求头添加字段
*/
- (void)addValue:(NSString *)value forHTTPHeaderField:(NSString *)field;
/*! 
    在Post方式下、设置请求体
*/
@property (nullable, copy) NSData *HTTPBody;
/*! 
    设置http请求体的输入流
*/
@property (nullable, retain) NSInputStream *HTTPBodyStream;
/*! 
    发送请求时是否发送cookie数据
*/
@property BOOL HTTPShouldHandleCookies;
/*! 
    请求时是否按顺序收发
*/
@property BOOL HTTPShouldUsePipelining;
@end

NSURLResponse

@interface NSURLResponse : NSObject 
{
    @package
    NSURLResponseInternal *_internal;
}

/*!
    你可以自己生成一个NSURLResponse对象
    @param URL 链接
    @param MIMEType 响应类型(`application/json`等等)
    @param length 响应内容长度
    @param name 编码的名称
    @result The initialized NSURLResponse.
    @discussion This is the designated initializer for NSURLResponse.
*/
- (instancetype)initWithURL:(NSURL *)URL MIMEType:(nullable NSString *)MIMEType expectedContentLength:(NSInteger)length textEncodingName:(nullable NSString *)name NS_DESIGNATED_INITIALIZER;

/*! 
    返回响应对象的URL
*/
@property (nullable, readonly, copy) NSURL *URL;

/*! 
    返回响应类型(`application/json`等等)
*/
@property (nullable, readonly, copy) NSString *MIMEType;

/*! 
    返回响应内容长度
*/
@property (readonly) long long expectedContentLength;

/*! 
    返回编码类型
*/
@property (nullable, readonly, copy) NSString *textEncodingName;

/*!
    返回响应文件的文件名(比如:person_object.json)
*/
@property (nullable, readonly, copy) NSString *suggestedFilename;

@end

NSHTTPURLResponse : NSURLResponse

@class NSHTTPURLResponseInternal;

@interface NSHTTPURLResponse : NSURLResponse 
{
    @package
    NSHTTPURLResponseInternal *_httpInternal;
}

/*!
  @param    url 链接
  @param    statusCode 状态码(404等等)
  @param    HTTPVersion HTTP版本(HTTP1.1/HTTP 2.0等)
  @param    headerFields 响应头(字典)
*/
- (nullable instancetype)initWithURL:(NSURL *)url statusCode:(NSInteger)statusCode HTTPVersion:(nullable NSString *)HTTPVersion headerFields:(nullable NSDictionary *)headerFields API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));

/*! 
    返回状态码
*/
@property (readonly) NSInteger statusCode;

/*! 
    返回请求头字典
*/
@property (readonly, copy) NSDictionary *allHeaderFields;

/*! 
    将HTTP状态码转换成字符串
    对照表:http://www.zhimengzhe.com/IOSkaifa/264293.html
*/
+ (NSString *)localizedStringForStatusCode:(NSInteger)statusCode;

@end
```

###参考资料
[NSHTTPURLResponse的localizedStringForStatusCode](http://www.zhimengzhe.com/IOSkaifa/264293.html)

你可能感兴趣的