•  


GitHub - AFNetworking/AFNetworking: A delightful networking framework for iOS, macOS, watchOS, and tvOS.
Skip to content
This repository has been archived by the owner on Jan 17, 2023. It is now read-only.

A delightful networking framework for iOS, macOS, watchOS, and tvOS.

License

Notifications You must be signed in to change notification settings

AFNetworking/AFNetworking

Repository files navigation

AFNetworking is Deprecated

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:

  1. Copy AFNetworking into your project and compile it directly. This gives you full control over the code.
  2. 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 on StackOverflow and tag alamofire and afnetworking , or open a discussion on Alamofire's GitHub Discussions regarding any migration issues or missing features.


AFNetworking

Build Status CocoaPods Compatible Carthage Compatible Platform Twitter

AFNetworking is a delightful networking library for iOS, macOS, watchOS, and tvOS. It's built on top of the Foundation 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.

How To Get Started

Communication

  • If you need help , use Stack Overflow . (Tag 'afnetworking')
  • If you'd like to ask a general question , use Stack Overflow .
  • If you found a bug , and can provide steps to reliably reproduce it , open an issue.
  • If you have a feature request , open an issue.
  • If you want to contribute , submit a pull request.

Installation

AFNetworking supports multiple methods for installing the library in a project.

Installation with CocoaPods

To integrate AFNetworking into your Xcode project using CocoaPods, specify it in your Podfile :

pod
 'AFNetworking'
,
 '~> 4.0'

Installation with Swift Package Manager

Once you have your Swift package set up, adding AFNetworking as a dependency is as easy as adding it to the dependencies value of your Package.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.

Installation with Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate AFNetworking, add the following to your Cartfile .

github "AFNetworking/AFNetworking" ~> 4.0

Requirements

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 support 64-bit with modern Cocoa runtime ).

Programming in Swift? Try Alamofire for a more conventional set of APIs.

Architecture

NSURLSession

  • AFURLSessionManager
  • AFHTTPSessionManager

Serialization

  • <AFURLRequestSerialization>
    • AFHTTPRequestSerializer
    • AFJSONRequestSerializer
    • AFPropertyListRequestSerializer
  • <AFURLResponseSerialization>
    • AFHTTPResponseSerializer
    • AFJSONResponseSerializer
    • AFXMLParserResponseSerializer
    • AFXMLDocumentResponseSerializer (macOS)
    • AFPropertyListResponseSerializer
    • AFImageResponseSerializer
    • AFCompoundResponseSerializer

Additional Functionality

  • AFSecurityPolicy
  • AFNetworkReachabilityManager

Usage

AFURLSessionManager

AFURLSessionManager creates and manages an NSURLSession object based on a specified NSURLSessionConfiguration object, which conforms to <NSURLSessionTaskDelegate> , <NSURLSessionDataDelegate> , <NSURLSessionDownloadDelegate> , and <NSURLSessionDelegate> .

Creating a Download Task

NSURLSessionConfiguration
 *configuration = [
NSURLSessionConfiguration
 defaultSessionConfiguration
];
AFURLSessionManager *manager = [[AFURLSessionManager 
alloc
] 
initWithSessionConfiguration:
configuration];

NSURL
 *URL = [
NSURL
 URLWithString:
@"
http://example.com/download.zip
"
];
NSURLRequest
 *request = [
NSURLRequest
 requestWithURL:
URL];

NSURLSessionDownloadTask
 *downloadTask = [manager 
downloadTaskWithRequest:
request 
progress:
nil
 destination:
^
NSURL
 *(
NSURL
 *targetPath, 
NSURLResponse
 *response) {
    
NSURL
 *documentsDirectoryURL = [[
NSFileManager
 defaultManager
] 
URLForDirectory:
NSDocumentDirectory 
inDomain:
NSUserDomainMask 
appropriateForURL:
nil
 create:
NO
 error:
nil
];
    
return
 [documentsDirectoryURL 
URLByAppendingPathComponent:
[response 
suggestedFilename
]];
} 
completionHandler:
^(
NSURLResponse
 *response, 
NSURL
 *filePath, 
NSError
 *error) {
    
NSLog
(
@"
File downloaded to: 
%@
"
, filePath);
}];
[downloadTask 
resume
];

Creating an Upload Task

NSURLSessionConfiguration
 *configuration = [
NSURLSessionConfiguration
 defaultSessionConfiguration
];
AFURLSessionManager *manager = [[AFURLSessionManager 
alloc
] 
initWithSessionConfiguration:
configuration];

NSURL
 *URL = [
NSURL
 URLWithString:
@"
http://example.com/upload
"
];
NSURLRequest
 *request = [
NSURLRequest
 requestWithURL:
URL];

NSURL
 *filePath = [
NSURL
 fileURLWithPath:
@"
file://path/to/image.png
"
];
NSURLSessionUploadTask
 *uploadTask = [manager 
uploadTaskWithRequest:
request 
fromFile:
filePath 
progress:
nil
 completionHandler:
^(
NSURLResponse
 *response, 
id
 responseObject, 
NSError
 *error) {
    
if
 (error) {
        
NSLog
(
@"
Error: 
%@
"
, error);
    } 
else
 {
        
NSLog
(
@"
Success: 
%@
 %@
"
, response, responseObject);
    }
}];
[uploadTask 
resume
];

Creating an Upload Task for a Multi-Part Request, with Progress

NSMutableURLRequest
 *request = [[AFHTTPRequestSerializer 
serializer
] 
multipartFormRequestWithMethod:
@"
POST
"
 URLString:
@"
http://example.com/upload
"
 parameters:
nil
 constructingBodyWithBlock:
^(
id
<AFMultipartFormData> formData) {
        [formData 
appendPartWithFileURL:
[
NSURL
 fileURLWithPath:
@"
file://path/to/image.jpg
"
] 
name:
@"
file
"
 fileName:
@"
filename.jpg
"
 mimeType:
@"
image/jpeg
"
 error:
nil
];
    } 
error:
nil
];

AFURLSessionManager *manager = [[AFURLSessionManager 
alloc
] 
initWithSessionConfiguration:
[
NSURLSessionConfiguration
 defaultSessionConfiguration
]];

NSURLSessionUploadTask
 *uploadTask;
uploadTask = [manager
              
uploadTaskWithStreamedRequest:
request
              
progress:
^(
NSProgress
 * _Nonnull uploadProgress) {
                  
//
 This is not called back on the main queue.

                  //
 You are responsible for dispatching to the main queue for UI updates

                  dispatch_async
(
dispatch_get_main_queue
(), ^{
                      
//
Update the progress view

                      [progressView 
setProgress:
uploadProgress.fractionCompleted];
                  });
              }
              
completionHandler:
^(
NSURLResponse
 * _Nonnull response, 
id
  _Nullable responseObject, 
NSError
 * _Nullable error) {
                  
if
 (error) {
                      
NSLog
(
@"
Error: 
%@
"
, error);
                  } 
else
 {
                      
NSLog
(
@"
%@
 %@
"
, response, responseObject);
                  }
              }];

[uploadTask 
resume
];

Creating a Data Task

NSURLSessionConfiguration
 *configuration = [
NSURLSessionConfiguration
 defaultSessionConfiguration
];
AFURLSessionManager *manager = [[AFURLSessionManager 
alloc
] 
initWithSessionConfiguration:
configuration];

NSURL
 *URL = [
NSURL
 URLWithString:
@"
http://httpbin.org/get
"
];
NSURLRequest
 *request = [
NSURLRequest
 requestWithURL:
URL];

NSURLSessionDataTask
 *dataTask = [manager 
dataTaskWithRequest:
request 
completionHandler:
^(
NSURLResponse
 *response, 
id
 responseObject, 
NSError
 *error) {
    
if
 (error) {
        
NSLog
(
@"
Error: 
%@
"
, error);
    } 
else
 {
        
NSLog
(
@"
%@
 %@
"
, response, responseObject);
    }
}];
[dataTask 
resume
];

Request Serialization

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
]};

Query String Parameter Encoding

[[AFHTTPRequestSerializer 
serializer
] 
requestWithMethod:
@"
GET
"
 URLString:
URLString 
parameters:
parameters 
error:
nil
];
GET http://example.com?foo=bar&baz[]=1&baz[]=2&baz[]=3

URL Form Parameter Encoding

[[AFHTTPRequestSerializer 
serializer
] 
requestWithMethod:
@"
POST
"
 URLString:
URLString 
parameters:
parameters 
error:
nil
];
POST http://example.com/
Content-Type: application/x-www-form-urlencoded

foo=bar&baz[]=1&baz[]=2&baz[]=3

JSON Parameter Encoding

[[AFJSONRequestSerializer 
serializer
] 
requestWithMethod:
@"
POST
"
 URLString:
URLString 
parameters:
parameters 
error:
nil
];
POST http://example.com/
Content-Type: application/json

{"foo": "bar", "baz": [1,2,3]}

Network Reachability Manager

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 also WWDC 2012 session 706, "Networking Best Practices." .

Shared Network Reachability

[[AFNetworkReachabilityManager 
sharedManager
] 
setReachabilityStatusChangeBlock:
^(AFNetworkReachabilityStatus status) {
    
NSLog
(
@"
Reachability: 
%@
"
, 
AFStringFromNetworkReachabilityStatus
(status));
}];

[[AFNetworkReachabilityManager 
sharedManager
] 
startMonitoring
];

Security Policy

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.

Allowing Invalid SSL Certificates

AFHTTPSessionManager *manager = [AFHTTPSessionManager 
manager
];
manager.securityPolicy.allowInvalidCertificates = 
YES
; 
//
 not recommended for production

Unit Tests

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.

Credits

AFNetworking is owned and maintained by the Alamofire Software Foundation .

AFNetworking was originally created by Scott Raymond and Mattt Thompson in the development of Gowalla for iPhone .

AFNetworking's logo was designed by Alan Defibaugh .

And most of all, thanks to AFNetworking's growing list of contributors .

Security Disclosure

If you believe you have identified a security vulnerability with AFNetworking, you should report it as soon as possible via email to security@alamofire.org . Please do not post it to a public issue tracker.

License

AFNetworking is released under the MIT license. See LICENSE for details.

- "漢字路" 한글한자자동변환 서비스는 교육부 고전문헌국역지원사업의 지원으로 구축되었습니다.
- "漢字路" 한글한자자동변환 서비스는 전통문화연구회 "울산대학교한국어처리연구실 옥철영(IT융합전공)교수팀"에서 개발한 한글한자자동변환기를 바탕하여 지속적으로 공동 연구 개발하고 있는 서비스입니다.
- 현재 고유명사(인명, 지명등)을 비롯한 여러 변환오류가 있으며 이를 해결하고자 많은 연구 개발을 진행하고자 하고 있습니다. 이를 인지하시고 다른 곳에서 인용시 한자 변환 결과를 한번 더 검토하시고 사용해 주시기 바랍니다.
- 변환오류 및 건의,문의사항은 juntong@juntong.or.kr로 메일로 보내주시면 감사하겠습니다. .
Copyright ⓒ 2020 By '전통문화연구회(傳統文化硏究會)' All Rights reserved.
 한국   대만   중국   일본