YTKNetwork Documentation

YTKNetwork is a high-level request utility based on AFNetworking designed for complex projects. Key features include:

• Caching: Response caching by expiration time or version number.
• URL Management: Set common base URLs and CDN URLs; support for URL filtering, partial URL replacement, or appending common parameters.
• Request Management: Batch requests (YTKBatchRequest), chained requests (YTKChainRequest), and resumeable downloads.
• Validation: Built-in JSON response validation.
• Extensibility: A plugin mechanism to handle request start and finish (e.g., a plugin for showing a 'Loading' HUD is provided).
• Callbacks: Supports both block and delegate callback patterns.

Download requests in 2.0 use NSURLSessionDownloadTask. If you set the resumableDownloadPath property of a YTKRequest to a non-nil value, the file will be automatically saved to that path upon completion.

Download Request Properties:

• responseData: Not available.
• responseString: Not available.
• responseObject: Returns an NSURL representing the local file path.

Progress Tracking: Progress is now handled via AFURLSessionTaskProgressBlock, which provides an NSProgress object. Use totalUnitCount and completedUnitCount to track progress.

You can install YTKNetwork using CocoaPods or Carthage.

CocoaPods: Add the following line to your Podfile:

pod 'YTKNetwork'

Carthage: Add the following line to your Cartfile:

github "yuantiku/YTKNetwork" ~> 2.0

In 2.0, baseUrl and requestUrl are concatenated using [NSURL URLWithString:relativeToURL].

Important: If your requestUrl starts with a / and your baseUrl contains a path (other than the Host), the requestUrl will be appended to the root of the host, potentially stripping the baseUrl path. To avoid this, ensure requestUrl does not have a leading / if your baseUrl includes a path component.

YTKNetwork 2.0 has replaced AFHTTPRequestOperation with NSURLSessionTask. When migrating from 1.X, update your property access as follows:

Note: currentRequest and originalRequest will return nil unless they are accessed after the request has called start.

// YTKNetwork 1.X
@property (nonatomic, strong) AFHTTPRequestOperation *requestOperation;
@property (nonatomic, strong, readonly, nullable) NSError *requestOperationError;

// YTKNetwork 2.X
@property (nonatomic, strong, readonly) NSURLSessionTask *requestTask;
@property (nonatomic, strong, readonly, nullable) NSError *error;

Use the YTKNetworkConfig class to centrally manage the server's base URL and CDN URL. This ensures the Do Not Repeat Yourself principle and allows for easy switching between environments (e.g., testing vs. production). Set these values during application startup, typically in didFinishLaunchingWithOptions.

• baseUrl: The primary server address used for all network requests by default.
• cdnUrl: The address used for static resources like images, JS, or CSS.

- (BOOL)application:(UIApplication *)application 
   didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
   YTKNetworkConfig *config = [YTKNetworkConfig sharedConfig];
   config.baseUrl = @"http://yuantiku.com";
   config.cdnUrl = @"http://fen.bi";
}

You can install YTKNetwork using either CocoaPods or Carthage.

For CocoaPods, add the following to your Podfile:

pod 'YTKNetwork'

For Carthage, add the following to your Cartfile:

gitub "yuantiku/YTKNetwork" ~> 3.0

Use the YTKNetworkConfig class to set the global baseUrl and cdnUrl. This should be done during application launch (e.g., in didFinishLaunchingWithOptions). Once set, all YTKRequest subclasses will automatically use these addresses as their host and CDN prefixes.

- (BOOL)application:(UIApplication *)application 
   didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
   YTKNetworkConfig *config = [YTKNetworkConfig sharedConfig];
   config.baseUrl = @"http://yuantiku.com";
   config.cdnUrl = @"http://fen.bi";
}

After initializing your YTKRequest subclass, you can trigger the request using one of two mechanisms:

Using Completion Blocks

Use startWithCompletionBlockWithSuccess:failure: to handle results. You can safely use self inside these blocks because YTKRequest sets the callback blocks to nil upon completion, preventing retain cycles.

Using Delegates

Set the delegate property of your request object to an object implementing the required delegate methods, then call start.

Example using blocks:

RegisterApi *api = [[RegisterApi alloc] initWithUsername:username password:password];
[api startWithCompletionBlockWithSuccess:^(YTKBaseRequest *request) {
    NSLog(@"succeed");
} failure:^(YTKBaseRequest *request) {
    NSLog(@"failed");
}];