AFNetworking 3.0 源码阅读笔记（五）

最新推荐文章于 2021-04-21 16:20:57 发布
最新推荐文章于 2021-04-21 16:20:57 发布
阅读量467 收藏
点赞数
分类专栏： iOS框架源码分析系列

原文：http://itangqi.me/2016/05/15/the-notes-of-learning-afnetworking-five/

AFURLRequestSerialization

AFURLRequestSerialization 定义为协议，其主要工作是对发出的 HTTP 请求进行处理：

1
2
3
4
5
6
7

@protocol AFURLRequestSerialization <NSObject, NSSecureCoding, NSCopying>

- (nullable NSURLRequest *)requestBySerializingRequest:(NSURLRequest *)request
                               withParameters:(nullable id)parameters
                                        error:(NSError * _Nullable __autoreleasing *)error NS_SWIFT_NOTHROW;

@end

遵循该协议的类同时也要遵循 NSObject、NSSecureCoding 和 NSCopying 这三个协议，以实现 Objective-C 对象的基本行为、安全编码以及拷贝。

AFHTTPRequestSerializer

而在 AFURLRequestSerialization 模块中，最为重要的类便是 AFHTTPRequestSerializer，其主要作用为：

  1. 处理查询的 URL 参数
  2. 设置 HTTP 头部字段
  3. 设置请求的属性
  4. 分块上传

这篇文章不会对其中涉及分块上传的部分进行分析，因为其中涉及到了多个类的功能，比较复杂，如果有兴趣可以研究一下。

处理查询参数

处理查询参数这部分主要是通过 AFQueryStringPair 还有一些 C 函数来完成的，这个类有两个属性 field 和 value 对应 HTTP 请求的查询 URL 中的参数。

我们来看初始化方法，其中的 - (NSString *)URLEncodedStringValue 方法会返回 key=value 这种格式，同时使用 AFPercentEscapedStringFromString 函数来对 field 和 value 进行处理，将其中的 :#[]@!$&'()*+,;= 等字符转换为百分号表示的形式：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

- (instancetype)initWithField:(id)field value:(id)value {
    self = [super init];
    if (!self) {
        return nil;
    }

    self.field = field;
    self.value = value;

    return self;
}

- (NSString *)URLEncodedStringValue {
    if (!self.value || [self.value isEqual:[NSNull null]]) {
        return AFPercentEscapedStringFromString([self.field description]);
    } else {
        return [NSString stringWithFormat:@"%@=%@", AFPercentEscapedStringFromString([self.field description]), AFPercentEscapedStringFromString([self.value description])];
    }
}

这一部分代码还负责返回查询参数，将 AFQueryStringPair 或者 key value 转换为以下这种形式：

1

username = dravenss&password=123456&hello[world]=helloworld

它的实现主要依赖于一个递归函数 AFQueryStringPairsFromKeyAndValue，如果当前的 value 是一个集合类型的话，那么它就会不断地递归调用自己：

1
2
3
4
5
6
7
8

NSArray * AFQueryStringPairsFromKeyAndValue(NSString *key, id value) {
    NSMutableArray *mutableQueryStringComponents = [NSMutableArray array];

    NSSortDescriptor *sortDescriptor = [NSSortDescriptor sortDescriptorWithKey:@"description" ascending:YES selector:@selector(compare:)];	 
    ...
    
    return mutableQueryStringComponents;
}

最后返回一个数组

1
2
3
4
5

[
    username = draveness,
    password = 123456,
    hello[world] = helloworld
]

得到这个数组之后就会调用 AFQueryStringFromParameters 使用 & 来拼接它们：

1
2
3
4
5
6
7
8

static NSString * AFQueryStringFromParameters(NSDictionary *parameters) {
    NSMutableArray *mutablePairs = [NSMutableArray array];
    for (AFQueryStringPair *pair in AFQueryStringPairsFromDictionary(parameters)) {
        [mutablePairs addObject:[pair URLEncodedStringValue]];
    }

    return [mutablePairs componentsJoinedByString:@"&"];
}

设置 HTTP 头部字段

AFHTTPRequestSerializer 在头文件中提供了一些属性方便我们设置 HTTP 头部字段。同时，在类的内部，它提供了 - [AFHTTPRequestSerializer setValue:forHTTPHeaderField:] 方法来设置 HTTP 头部，其实它的实现都是基于一个名为 mutableHTTPRequestHeaders 的属性的：

1
2
3
4
5
6
7
8
9

- (void)setValue:(NSString *)value
forHTTPHeaderField:(NSString *)field
{
    [self.mutableHTTPRequestHeaders setValue:value forKey:field];
}

- (NSString *)valueForHTTPHeaderField:(NSString *)field {
    return [self.mutableHTTPRequestHeaders valueForKey:field];
}

在设置 HTTP 头部字段时，都会存储到这个可变字典中。而当真正使用时，会用 HTTPRequestHeaders 这个方法，来获取对应版本的不可变字典：

1
2
3

- (NSDictionary *)HTTPRequestHeaders {
    return [NSDictionary dictionaryWithDictionary:self.mutableHTTPRequestHeaders];
}

到了这里，可以来分析一下，这个类是如何设置一些我们平时常用的头部字段的。首先是 User-Agent，在 AFHTTPRequestSerializer 刚刚初始化时，就会根据当前编译的平台生成一个 userAgent 字符串：

1
2
3

userAgent = [NSString stringWithFormat:@"%@/%@ (%@; iOS %@; Scale/%0.2f)", [[NSBundle mainBundle] infoDictionary][(__bridge NSString *)kCFBundleExecutableKey] ?: [[NSBundle mainBundle] infoDictionary][(__bridge NSString *)kCFBundleIdentifierKey], [[NSBundle mainBundle] infoDictionary][@"CFBundleShortVersionString"] ?: [[NSBundle mainBundle] infoDictionary][(__bridge NSString *)kCFBundleVersionKey], [[UIDevice currentDevice] model], [[UIDevice currentDevice] systemVersion], [[UIScreen mainScreen] scale]];

[self setValue:userAgent forHTTPHeaderField:@"User-Agent"];

设置验证字段时，可以使用 - [AFHTTPRequestSerializer setAuthorizationHeaderFieldWithUsername:password:] 方法：

1
2
3
4
5
6
7

- (void)setAuthorizationHeaderFieldWithUsername:(NSString *)username
                                       password:(NSString *)password
{
    NSData *basicAuthCredentials = [[NSString stringWithFormat:@"%@:%@", username, password] dataUsingEncoding:NSUTF8StringEncoding];
    NSString *base64AuthCredentials = [basicAuthCredentials base64EncodedStringWithOptions:(NSDataBase64EncodingOptions)0];
    [self setValue:[NSString stringWithFormat:@"Basic %@", base64AuthCredentials] forHTTPHeaderField:@"Authorization"];
}

设置请求的属性

还有一些 NSURLRequest 的属性是通过另一种方式来设置的，AFNetworking 为这些功能提供了接口：

1
2
3
4
5
6
7
8
9
10
11

@property (nonatomic, assign) BOOL allowsCellularAccess;

@property (nonatomic, assign) NSURLRequestCachePolicy cachePolicy;

@property (nonatomic, assign) BOOL HTTPShouldHandleCookies;

@property (nonatomic, assign) BOOL HTTPShouldUsePipelining;

@property (nonatomic, assign) NSURLRequestNetworkServiceType networkServiceType;

@property (nonatomic, assign) NSTimeInterval timeoutInterval;

它们都会通过 AFHTTPRequestSerializerObservedKeyPaths 的调用而返回：

1
2
3
4
5
6
7
8
9

static NSArray * AFHTTPRequestSerializerObservedKeyPaths() {
    static NSArray *_AFHTTPRequestSerializerObservedKeyPaths = nil;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        _AFHTTPRequestSerializerObservedKeyPaths = @[NSStringFromSelector(@selector(allowsCellularAccess)), NSStringFromSelector(@selector(cachePolicy)), NSStringFromSelector(@selector(HTTPShouldHandleCookies)), NSStringFromSelector(@selector(HTTPShouldUsePipelining)), NSStringFromSelector(@selector(networkServiceType)), NSStringFromSelector(@selector(timeoutInterval))];
    });

    return _AFHTTPRequestSerializerObservedKeyPaths;
}

在这些属性被设置时，会触发 KVO，然后将新的属性存储在一个名为 mutableObservedChangedKeyPaths 的字典中：

1
2
3
4
5
6
7
8
9
10
11
12
13

- (void)observeValueForKeyPath:(NSString *)keyPath
                      ofObject:(__unused id)object
                        change:(NSDictionary *)change
                       context:(void *)context
{
    if (context == AFHTTPRequestSerializerObserverContext) {
        if ([change[NSKeyValueChangeNewKey] isEqual:[NSNull null]]) {
            [self.mutableObservedChangedKeyPaths removeObject:keyPath];
        } else {
            [self.mutableObservedChangedKeyPaths addObject:keyPath];
        }
    }
}

然后会在生成 NSURLRequest 的时候设置这些属性：

1
2
3
4
5
6
7
8

NSMutableURLRequest *mutableRequest = [[NSMutableURLRequest alloc] initWithURL:url];
mutableRequest.HTTPMethod = method;

for (NSString *keyPath in AFHTTPRequestSerializerObservedKeyPaths()) {
    if ([self.mutableObservedChangedKeyPaths containsObject:keyPath]) {
        [mutableRequest setValue:[self valueForKeyPath:keyPath] forKey:keyPath];
    }
}

关于这个方法的的具体实现会在下一节中介绍。

工作流程

AFHTTPRequestSerializer 会在 AHHTTPSessionManager 初始化时一并初始化，这时它会根据当前系统环境预设置一些 HTTP 头部字段 Accept-Language User-Agent。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

- (instancetype)init {
    self = [super init];
    if (!self) {
        return nil;
    }

    self.stringEncoding = NSUTF8StringEncoding;

    self.mutableHTTPRequestHeaders = [NSMutableDictionary dictionary];


    #1: 设置接收语言，用户代理，略

    // HTTP Method Definitions; see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html
    self.HTTPMethodsEncodingParametersInURI = [NSSet setWithObjects:@"GET", @"HEAD", @"DELETE", nil];

    self.mutableObservedChangedKeyPaths = [NSMutableSet set];
    for (NSString *keyPath in AFHTTPRequestSerializerObservedKeyPaths()) {
        if ([self respondsToSelector:NSSelectorFromString(keyPath)]) {
            [self addObserver:self forKeyPath:keyPath options:NSKeyValueObservingOptionNew context:AFHTTPRequestSerializerObserverContext];
        }
    }

    return self;
}

同时它还对一些属性进行 KVO，确保它们在改变后更新 NSMutableURLRequest 中对应的属性。

在初始化之后，如果调用了 - [AFHTTPSessionManager dataTaskWithHTTPMethod:URLString:parameters:uploadProgress:downloadProgress:success:failure:]，就会进入 AFHTTPRequestSerializer 的这一方法：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27


- (NSMutableURLRequest *)requestWithMethod:(NSString *)method
                                 URLString:(NSString *)URLString
                                parameters:(id)parameters
                                     error:(NSError *__autoreleasing *)error
{
    NSParameterAssert(method);
    NSParameterAssert(URLString);

    NSURL *url = [NSURL URLWithString:URLString];
    // 1. 对参数进行检查
    NSParameterAssert(url);

    NSMutableURLRequest *mutableRequest = [[NSMutableURLRequest alloc] initWithURL:url];
    // 2. 设置 HTTP 方法
    mutableRequest.HTTPMethod = method;
    // 3. 通过 `mutableObservedChangedKeyPaths` 字典设置 `NSMutableURLRequest` 的属性
    for (NSString *keyPath in AFHTTPRequestSerializerObservedKeyPaths()) {
        if ([self.mutableObservedChangedKeyPaths containsObject:keyPath]) {
            [mutableRequest setValue:[self valueForKeyPath:keyPath] forKey:keyPath];
        }
    }
    // 设置 HTTP 头部字段和查询参数
    mutableRequest = [[self requestBySerializingRequest:mutableRequest withParameters:parameters error:error] mutableCopy];

    return mutableRequest;
}

- [AFHTTPRequestSerializer requestBySerializingRequest:withParameters:error:] 方法主要做了以下几件事情：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

- (NSURLRequest *)requestBySerializingRequest:(NSURLRequest *)request
                               withParameters:(id)parameters
                                        error:(NSError *__autoreleasing *)error
{
    NSParameterAssert(request);

    NSMutableURLRequest *mutableRequest = [request mutableCopy];
    // 1. 通过 `HTTPRequestHeaders` 字典设置头部字段
    [self.HTTPRequestHeaders enumerateKeysAndObjectsUsingBlock:^(id field, id value, BOOL * __unused stop) {
        if (![request valueForHTTPHeaderField:field]) {
            [mutableRequest setValue:value forHTTPHeaderField:field];
        }
    }];

    NSString *query = nil;
    if (parameters) {
        if (self.queryStringSerialization) {
            NSError *serializationError;
            query = self.queryStringSerialization(request, parameters, &serializationError);

            if (serializationError) {
                if (error) {
                    *error = serializationError;
                }

                return nil;
            }
        } else {
            switch (self.queryStringSerializationStyle) {
                case AFHTTPRequestQueryStringDefaultStyle:
                    // 2. 调用 `AFQueryStringFromParameters` 将参数转换为查询参数
                    query = AFQueryStringFromParameters(parameters);
                    break;
            }
        }
    }
    // 3. 将 parameters 添加到 URL 或者 HTTP body 中
    if ([self.HTTPMethodsEncodingParametersInURI containsObject:[[request HTTPMethod] uppercaseString]]) {
        if (query) {
            mutableRequest.URL = [NSURL URLWithString:[[mutableRequest.URL absoluteString] stringByAppendingFormat:mutableRequest.URL.query ? @"&%@" : @"?%@", query]];
        }
    } else {
        // #2864: an empty string is a valid x-www-form-urlencoded payload
        if (!query) {
            query = @"";
        }
        if (![mutableRequest valueForHTTPHeaderField:@"Content-Type"]) {
            [mutableRequest setValue:@"application/x-www-form-urlencoded" forHTTPHeaderField:@"Content-Type"];
        }
        [mutableRequest setHTTPBody:[query dataUsingEncoding:self.stringEncoding]];
    }
    // 4. 将 parameters 添加到 URL 或者 HTTP body 中
    return mutableRequest;
}

小结

  • AFURLResponseSerialization 负责对返回的数据进行序列化
  • AFURLRequestSerialization 负责生成 NSMutableURLRequest，为请求设置 HTTP 头部，管理发出的请求

参考

冷小G
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
通过修改请求头的User-Agent发送请求
guifei010的博客
02-27 1万+
1.    抓包工具    Fiddler    Charles:Charles可以监控浏览器发送和接收的所有数据2.get的参数 参数1：url，填网址 参数2：params,网址后需要添加的参数 参数3：**kwargs ,不定长键值对参数，一般 key=value    headers={}    cookies={} 或者 CookieJar    timeout=小数或者元组    3....
AFNetWorking 请求头的配置用来完成HTTP Basic Auth的鉴权
热门推荐
Deft_MKJing的博客
07-13 1万+
AFNetWorking的请求头设置
iOS UserAgent 设置
SHTLoveXX的专栏
04-22 4261
顾名思义，UserAgent  用户身份标识，可模拟PC 、iPhone 、Android、各个浏览器    一般web页面都有自动适配机制。手机端访问跟PC端访问页面展示不一致，想要在手机上访问web时显示的跟PC端一致，就必须修改 UserAgent      iOS开发中 直接获取 UserAgent  值为 null      NSString *user
处理请求和响应 AFURLSerialization（三）
appdeveloperxg的博客
07-29 610
Blog: [Draveness](http://draveness.me) http://ghbtns.com/github-btn.html?user=draveness&type=follow&size=large" height="30" width="240" frameborder="0" scrolling="0" style="width:240px; hei
AFNetworking之观察属性的变化
暗黑的博客
07-01 1082
也许在属性的观察方面每个人有自己不同的方法，例如可以通过检测属性的初值是否发生变化 当然只要达到了我们的目的就可以了 现在来看一下AFN是如何来判断属性是否发生变化的 当AFN中的AFHTTPRequestSerializer类在创建的时候，在构造函数-init中就已经通过KVO添加对属性的观察 for (NSString *keyPath in AFHTTPRequestSeri
《AFNetworking 3.0 源码解读》系列文章整理版
12-15
AFNetworking 3.0 源码解读 系列文章的整理全篇版，强烈推荐，分章可查看我的博客
基于AFNetworking3.0的请求封装
04-05
作者lianleven，源码LYHTTPClient，最近很多人问一些基于AFNetworking3.0网络请求的封装，其实不用真的不用封装，唯一需要封装的地方就是客户端做缓存，统一把所有请求做了缓存接口。缓存用的是YYCache。基于...
AFNetworking3.0封装网络请求功能
04-05
作者caixindong，源码XDNetworking，基于AFNetworking3.0封装网络请求功能，API面向业务层更友好，基础功能包括GET、POST、下载、单文件上传、多文件上传、取消网络请求。此外拓展出缓存功能，缓存分为内存缓存和...
基于AFNetworking 3.0的集约性网络请求API再封装
04-05
作者SummerHF，源码AFNetworking-，关于AFNetworking 3.0NSURLConnection的API已废弃 AFNetworking 1.0 是建立在 NSURLConnection基础上的，AFNetworking 2.0 开始使用基于 NSURLConnection *API基础功能，同时也有...
AFNetworking3.0简单的二次封装网络请求
04-06
作者allenjzl，源码JZLNetworking，AFNetworking3.0简单的二次封装网络请求。
iOS NSURLConnection的简单使用
假装你是大灰狼的专栏
04-21 461
因为最近在做项目的过程中牵扯到一些离线断点下载的需求，用到了NSURLConnection和NSRULSession这两个对象，而平时工作大多数的时间都是和AFNetworking打交道，所以对这两个对象用起来不是那么的熟练，所以想借着今天整理一下，以备以后查看 我们都知道在iOS7后，NSURLSession对象基本代替了NSURLConnection进行网络开发，在iOS9后，NSURLConnection相关方法被完全的弃用，iOS系统有向下兼容的特性，尽管NSURLConnection已经被弃用，但
AFNetworking3.0设置请求头问题解决
九天揽月
06-20 3480
许多公司后台开发都会在网络请求里面加上许多字段://获取当前系统版本号+ (NSString*)getIOSVersion{return [NSString stringWithFormat:@"%f",[[[UIDevice currentDevice]systemVersion]floatValue]];}//获取当前APP版本号+ (NSString*)getAPPVersion {NSSt...
网络连接相关类
weixin_33901843的博客
02-25 75
NSURLConnection：支持ftp://，http://，https://，file:///（本地文件）连接发送同步连接请求，该函数会阻塞，直到有响应返回+ (NSData*)sendSynchronousRequest:(NSURLRequest*)requestreturningResponse:(NSURLResponse**)responseerro...
ios开发:AFNetworking3+在请求头中添加UserAgent方法
tiebanshao的博客
05-25 3975
找到文件:AFURLRequestSerialization.m 搜索"userAgent"所在位置, 然后修改即可 userAgent = [NSString stringWithFormat:@"%@/%@ (%@ %@; Apple x64; JpushToken %@; uniqueId %@; source AppStore) ooyby/%@", [[NSBundle mainBu
iOS获取User-Agent(UA)信息的方法
Dlg1992的博客
10-22 1万+
转自：http://mobile.51cto.com/iphone-407791.htm User-Agent(简称UA)是HTTP请求头部用来标识客户端信息的字符串, 包括操作系统, 浏览器等信息. 为了建立手机客户端的信息数据库, 需要从手机的http请求中取到这一字符串. iPhone中取到UA信息的方法如下: 1.利用浏览器控件UIWebView建立一
iOS开发 AFNetworking 3.0使用遇到的问题补充
lqk的博客
04-13 3593
1.很多初学者，在每处用到网络请求的地方会直接拿afn实例去请求，从而带来了后续难以维护代码的问题 [[AFHTTPSessionManager manager] POST:nil parameters:nil success:^(NSURLSessionDataTask *task, id responseObject) { } failure:^(NSURLSessionD
陕西应用物理化学研究所考研6个学院，54个专业课历年考试真题及答案汇总整理，备考资料题库视频.pdf
最新发布
07-15
陕西应用物理化学研究所考研6个学院，54个专业课历年考试真题及答案汇总整理，备考资料题库视频.pdf
励志商务聚力领航2024新年工作计划PPT模板
07-15
【作品名称】：励志商务聚力领航2024新年工作计划PPT模板 【适用人群】：适用于希望学习不同技术领域的小白或进阶学习者。可作为毕设项目、课程设计、大作业、工程实训或初期项目立项。
thinkphp3.0源码
01-12
ThinkPHP 3.0源码是指这个版本框架的源代码，通过阅读和理解源码，我们可以深入了解框架的设计思想、工作原理以及具体的实现方式。 ThinkPHP框架的源码以MVC（Model-View-Controller）模式组织，将应用程序分为模型...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值