- Notifications
You must be signed in to change notification settings - Fork10.5k
A delightful networking framework for iOS, macOS, watchOS, and tvOS.
License
AFNetworking/AFNetworking
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
As of Jan. 17, 2023, AFNetworking is deprecated and there will be no further releases. This repo will remain online in perpetuity as an archive. There are a couple options for continued AFNetworking use:
- Copy AFNetworking into your project and compile it directly. This gives you full control over the code.
- Fork AFNetworking and use the fork in your dependency manager. There will be no official forks but anyone can fork at any time and can even publish those forks under a different name, in accordance with AFNetworking's license.
Moving forward, Alamofire is the suggested migration path for networking in modern Swift. Anyone who needs help making that migration is welcome to ask onStackOverflow and tagalamofire
andafnetworking
, or open a discussion on Alamofire'sGitHub Discussions regarding any migration issues or missing features.
AFNetworking is a delightful networking library for iOS, macOS, watchOS, and tvOS. It's built on top of theFoundation URL Loading System, extending the powerful high-level networking abstractions built into Cocoa. It has a modular architecture with well-designed, feature-rich APIs that are a joy to use.
Perhaps the most important feature of all, however, is the amazing community of developers who use and contribute to AFNetworking every day. AFNetworking powers some of the most popular and critically-acclaimed apps on the iPhone, iPad, and Mac.
- Download AFNetworking and try out the included Mac and iPhone example apps
- Read the"Getting Started" guide,FAQ, orother articles on the Wiki
- If youneed help, useStack Overflow. (Tag 'afnetworking')
- If you'd like toask a general question, useStack Overflow.
- If youfound a bug,and can provide steps to reliably reproduce it, open an issue.
- If youhave a feature request, open an issue.
- If youwant to contribute, submit a pull request.
AFNetworking supports multiple methods for installing the library in a project.
To integrate AFNetworking into your Xcode project using CocoaPods, specify it in yourPodfile
:
pod'AFNetworking','~> 4.0'
Once you have your Swift package set up, adding AFNetworking as a dependency is as easy as adding it to thedependencies
value of yourPackage.swift
.
dependencies:[.package(url:"https://github.com/AFNetworking/AFNetworking.git",.upToNextMajor(from:"4.0.0"))]
Note: AFNetworking's Swift package does not include it's UIKit extensions.
Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate AFNetworking, add the following to yourCartfile
.
github "AFNetworking/AFNetworking" ~> 4.0
AFNetworking Version | Minimum iOS Target | Minimum macOS Target | Minimum watchOS Target | Minimum tvOS Target | Notes |
---|---|---|---|---|---|
4.x | iOS 9 | macOS 10.10 | watchOS 2.0 | tvOS 9.0 | Xcode 11+ is required. |
3.x | iOS 7 | OS X 10.9 | watchOS 2.0 | tvOS 9.0 | Xcode 7+ is required.NSURLConnectionOperation support has been removed. |
2.6 -> 2.6.3 | iOS 7 | OS X 10.9 | watchOS 2.0 | n/a | Xcode 7+ is required. |
2.0 -> 2.5.4 | iOS 6 | OS X 10.8 | n/a | n/a | Xcode 5+ is required.NSURLSession subspec requires iOS 7 or OS X 10.9. |
1.x | iOS 5 | Mac OS X 10.7 | n/a | n/a | |
0.10.x | iOS 4 | Mac OS X 10.6 | n/a | n/a |
(macOS projects must support64-bit with modern Cocoa runtime).
Programming in Swift? TryAlamofire for a more conventional set of APIs.
AFURLSessionManager
AFHTTPSessionManager
<AFURLRequestSerialization>
AFHTTPRequestSerializer
AFJSONRequestSerializer
AFPropertyListRequestSerializer
<AFURLResponseSerialization>
AFHTTPResponseSerializer
AFJSONResponseSerializer
AFXMLParserResponseSerializer
AFXMLDocumentResponseSerializer
(macOS)AFPropertyListResponseSerializer
AFImageResponseSerializer
AFCompoundResponseSerializer
AFSecurityPolicy
AFNetworkReachabilityManager
AFURLSessionManager
creates and manages anNSURLSession
object based on a specifiedNSURLSessionConfiguration
object, which conforms to<NSURLSessionTaskDelegate>
,<NSURLSessionDataDelegate>
,<NSURLSessionDownloadDelegate>
, and<NSURLSessionDelegate>
.
NSURLSessionConfiguration *configuration = [NSURLSessionConfigurationdefaultSessionConfiguration];AFURLSessionManager *manager = [[AFURLSessionManageralloc]initWithSessionConfiguration:configuration];NSURL *URL = [NSURLURLWithString:@"http://example.com/download.zip"];NSURLRequest *request = [NSURLRequestrequestWithURL:URL];NSURLSessionDownloadTask *downloadTask = [managerdownloadTaskWithRequest:requestprogress:nildestination:^NSURL *(NSURL *targetPath,NSURLResponse *response) {NSURL *documentsDirectoryURL = [[NSFileManagerdefaultManager]URLForDirectory:NSDocumentDirectoryinDomain:NSUserDomainMaskappropriateForURL:nilcreate:NOerror:nil];return [documentsDirectoryURLURLByAppendingPathComponent:[responsesuggestedFilename]];}completionHandler:^(NSURLResponse *response,NSURL *filePath,NSError *error) {NSLog(@"File downloaded to:%@", filePath);}];[downloadTaskresume];
NSURLSessionConfiguration *configuration = [NSURLSessionConfigurationdefaultSessionConfiguration];AFURLSessionManager *manager = [[AFURLSessionManageralloc]initWithSessionConfiguration:configuration];NSURL *URL = [NSURLURLWithString:@"http://example.com/upload"];NSURLRequest *request = [NSURLRequestrequestWithURL:URL];NSURL *filePath = [NSURLfileURLWithPath:@"file://path/to/image.png"];NSURLSessionUploadTask *uploadTask = [manageruploadTaskWithRequest:requestfromFile:filePathprogress:nilcompletionHandler:^(NSURLResponse *response,id responseObject,NSError *error) {if (error) {NSLog(@"Error:%@", error); }else {NSLog(@"Success:%@%@", response, responseObject); }}];[uploadTaskresume];
NSMutableURLRequest *request = [[AFHTTPRequestSerializerserializer]multipartFormRequestWithMethod:@"POST"URLString:@"http://example.com/upload"parameters:nilconstructingBodyWithBlock:^(id<AFMultipartFormData> formData) { [formDataappendPartWithFileURL:[NSURLfileURLWithPath:@"file://path/to/image.jpg"]name:@"file"fileName:@"filename.jpg"mimeType:@"image/jpeg"error:nil]; }error:nil];AFURLSessionManager *manager = [[AFURLSessionManageralloc]initWithSessionConfiguration:[NSURLSessionConfigurationdefaultSessionConfiguration]];NSURLSessionUploadTask *uploadTask;uploadTask = [manageruploadTaskWithStreamedRequest:requestprogress:^(NSProgress * _Nonnull uploadProgress) {// This is not called back on the main queue.// You are responsible for dispatching to the main queue for UI updatesdispatch_async(dispatch_get_main_queue(), ^{//Update the progress view [progressViewsetProgress:uploadProgress.fractionCompleted]; }); }completionHandler:^(NSURLResponse * _Nonnull response,id _Nullable responseObject,NSError * _Nullable error) {if (error) {NSLog(@"Error:%@", error); }else {NSLog(@"%@%@", response, responseObject); } }];[uploadTaskresume];
NSURLSessionConfiguration *configuration = [NSURLSessionConfigurationdefaultSessionConfiguration];AFURLSessionManager *manager = [[AFURLSessionManageralloc]initWithSessionConfiguration:configuration];NSURL *URL = [NSURLURLWithString:@"http://httpbin.org/get"];NSURLRequest *request = [NSURLRequestrequestWithURL:URL];NSURLSessionDataTask *dataTask = [managerdataTaskWithRequest:requestcompletionHandler:^(NSURLResponse *response,id responseObject,NSError *error) {if (error) {NSLog(@"Error:%@", error); }else {NSLog(@"%@%@", response, responseObject); }}];[dataTaskresume];
Request serializers create requests from URL strings, encoding parameters as either a query string or HTTP body.
NSString *URLString =@"http://example.com";NSDictionary *parameters = @{@"foo":@"bar",@"baz": @[@1, @2, @3]};
[[AFHTTPRequestSerializerserializer]requestWithMethod:@"GET"URLString:URLStringparameters:parameterserror:nil];
GET http://example.com?foo=bar&baz[]=1&baz[]=2&baz[]=3
[[AFHTTPRequestSerializerserializer]requestWithMethod:@"POST"URLString:URLStringparameters:parameterserror:nil];
POST http://example.com/Content-Type: application/x-www-form-urlencodedfoo=bar&baz[]=1&baz[]=2&baz[]=3
[[AFJSONRequestSerializerserializer]requestWithMethod:@"POST"URLString:URLStringparameters:parameterserror:nil];
POST http://example.com/Content-Type: application/json{"foo": "bar", "baz": [1,2,3]}
AFNetworkReachabilityManager
monitors the reachability of domains, and addresses for both WWAN and WiFi network interfaces.
- Do not use Reachability to determine if the original request should be sent.
- You should try to send it.
- You can use Reachability to determine when a request should be automatically retried.
- Although it may still fail, a Reachability notification that the connectivity is available is a good time to retry something.
- Network reachability is a useful tool for determining why a request might have failed.
- After a network request has failed, telling the user they're offline is better than giving them a more technical but accurate error, such as "request timed out."
See alsoWWDC 2012 session 706, "Networking Best Practices.".
[[AFNetworkReachabilityManagersharedManager]setReachabilityStatusChangeBlock:^(AFNetworkReachabilityStatus status) {NSLog(@"Reachability:%@",AFStringFromNetworkReachabilityStatus(status));}];[[AFNetworkReachabilityManagersharedManager]startMonitoring];
AFSecurityPolicy
evaluates server trust against pinned X.509 certificates and public keys over secure connections.
Adding pinned SSL certificates to your app helps prevent man-in-the-middle attacks and other vulnerabilities. Applications dealing with sensitive customer data or financial information are strongly encouraged to route all communication over an HTTPS connection with SSL pinning configured and enabled.
AFHTTPSessionManager *manager = [AFHTTPSessionManagermanager];manager.securityPolicy.allowInvalidCertificates =YES;// not recommended for production
AFNetworking includes a suite of unit tests within the Tests subdirectory. These tests can be run simply be executed the test action on the platform framework you would like to test.
AFNetworking is owned and maintained by theAlamofire Software Foundation.
AFNetworking was originally created byScott Raymond andMattt Thompson in the development ofGowalla for iPhone.
AFNetworking's logo was designed byAlan Defibaugh.
And most of all, thanks to AFNetworking'sgrowing list of contributors.
If you believe you have identified a security vulnerability with AFNetworking, you should report it as soon as possible via email tosecurity@alamofire.org. Please do not post it to a public issue tracker.
AFNetworking is released under the MIT license. SeeLICENSE for details.
About
A delightful networking framework for iOS, macOS, watchOS, and tvOS.