您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發基礎

YTKNetwork 源碼解析:iOS 網絡層該如何分層

編輯:iOS 開發基礎

本文授權轉載:Shelin(簡書)

先說問題

談到網絡層,最先想到的可能是 AFNetworking,或者 Swift 中的 Alamofire。直接用它們當然很快樂,但稍複雜的項目就會顯得不夠用:一方面是第三方耦合,另一方面是散落在各處的請求回調實在難以維護。所以多數團隊都會在其上做一層針對性封裝。

初期業務簡單,考慮的維度少;後期業務膨脹,網絡層往往需要重構。一個好的架構必然與業務緊密相連,隨業務增長而不斷健壯。

最近讀了 YTKNetwork 的源碼和相關文章,站在前輩的肩膀上,寫一些自己對網絡層設計的理解。

與業務層對接的兩種風格

集約型。最典型的就是 AFNetworking、Alamofire:所有請求集中在一個類上發起,回調通過 Block 或閉包實現。這種方式靈活性很好,可以在任意位置發請求,但缺點也顯而易見——回調散落各處,後期維護成本高。

[_manager GET:url
    parameters:param
       success:^(AFHTTPRequestOperation *operation, id responseObject) {
        // The data processing, rendering interface
    }
       failure:^(AFHTTPRequestOperation *operation, NSError *error) {
}];

用集約型網絡庫時,大家應該都遇到過這樣的場景:回調裡要做的處理比較多,代碼一長就乾脆再定義一個私有方法,在 Block 裡調它。繞了一圈,本質上和代理回調並沒有區別。

離散型。YTKNetwork 走的是這條路:一個網絡請求對應一個獨立類,類內部封裝請求地址、方式、參數、校驗和數據處理,通常通過代理回調,需要跨層傳遞時則用通知。的好處是數據處理都在內部完成,返回給控制器的已經是模型化數據,控制器拿到就能直接渲染 UI,自身保持輕量。

發起請求:

NSString *userId = @"1";
GetUserInfoApi *api = [[GetUserInfoApi alloc] initWithUserId:userId];
api.delegate = self;
[api start];

代理回調:

- (void)requestFinished:(YTKBaseRequest *)request {
    NSLog(@"----- succeed ---- %@", request.responseJSONObject);
    // Rendering interface
}

- (void)requestFailed:(YTKBaseRequest *)request {
    NSLog(@"failed");
}

類結構

YTKNetwork.png

先看它們之間的調用關係,理順這張圖,源碼理解起來基本沒有障礙:

Scrren.png

YTKBaseRequest:YTKRequest 的父類,定義 Request 的相關屬性、Block 與 Delegate,並提供對外接口的默認實現與公共邏輯。

YTKRequest:主要負責緩存——更新緩存、讀取緩存、手動寫入緩存、是否忽略緩存。這裡採用歸檔形式存儲,把請求方式、根路徑、請求地址、請求參數、app 版本號、敏感數據拼接後取 MD5 作為文件名,保證唯一性。同時支持設置緩存有效期,判斷依據是緩存文件上次修改時刻距今的時長與設置時長作比較。

發起請求前的判斷邏輯:

- (void)start {
    if (self.ignoreCache) {
        // 忽略緩存 -> 直接網絡請求
        [super start];
        return;
    }

    // 校驗緩存有效時間
    if ([self cacheTimeInSeconds] < 0) {
        [super start];
        return;
    }

    // 校驗緩存版本號
    long long cacheVersionFileContent = [self cacheVersionFileContent];
    if (cacheVersionFileContent != [self cacheVersion]) {
        [super start];
        return;
    }

    // 校驗緩存是否存在
    NSString *path = [self cacheFilePath];
    NSFileManager *fileManager = [NSFileManager defaultManager];
    if (![fileManager fileExistsAtPath:path isDirectory:nil]) {
        [super start];
        return;
    }

    // 緩存文件距今時長 與 緩存有效時間 對比
    int seconds = [self cacheFileDuration:path];
    if (seconds < 0 || seconds > [self cacheTimeInSeconds]) {
        [super start];
        return;
    }

    // 讀取緩存
    _cacheJson = [NSKeyedUnarchiver unarchiveObjectWithFile:path];
    if (_cacheJson == nil) {
        [super start];
        return;
    }

    _dataFromCache = YES;

    [self requestCompleteFilter];
    [strongSelf.delegate requestFinished:strongSelf];

    if (strongSelf.successCompletionBlock) {
        strongSelf.successCompletionBlock(strongSelf);
    }
    [strongSelf clearCompletionBlock];
}

歸檔存儲緩存數據:

- (void)saveJsonResponseToCacheFile:(id)jsonResponse {
    if ([self cacheTimeInSeconds] > 0 && ![self isDataFromCache]) {
        NSDictionary *json = jsonResponse;
        if (json != nil) {
            [NSKeyedArchiver archiveRootObject:json toFile:[self cacheFilePath]];
            [NSKeyedArchiver archiveRootObject:@([self cacheVersion]) toFile:[self cacheVersionFilePath]];
        }
    }
}

YTKNetworkAgent:真正發起網絡請求的類。addRequest 內部調用 AFN 的方法,這層隔離的好處是可以隨時更換第三方庫。此外還包含請求取消、插件代理方法調用等邏輯。所有請求成功或失敗,最終都匯到同一個方法:

- (void)handleRequestResult:(AFHTTPRequestOperation *)operation {
    NSString *key = [self requestHashKey:operation];
    YTKBaseRequest *request = _requestsRecord[key];

    YTKLog(@"Finished Request: %@", NSStringFromClass([request class]));

    if (request) {
        BOOL succeed = [self checkResult:request];

        if (succeed) {
            // 請求成功
            [request toggleAccessoriesWillStopCallBack];   // 執行加載動畫插件
            [request requestCompleteFilter];

            if (request.delegate != nil) {
                [request.delegate requestFinished:request];   // 代理回調
            }
            if (request.successCompletionBlock) {
                request.successCompletionBlock(request);      // Block 回調
            }
            [request toggleAccessoriesDidStopCallBack];
        } else {
            // 請求失敗
            YTKLog(@"Request %@ failed, status code = %ld",
                   NSStringFromClass([request class]), (long)request.responseStatusCode);

            [request toggleAccessoriesWillStopCallBack];
            [request requestFailedFilter];

            if (request.delegate != nil) {
                [request.delegate requestFailed:request];
            }
            if (request.failureCompletionBlock) {
                request.failureCompletionBlock(request);
            }
            [request toggleAccessoriesDidStopCallBack];
        }
    }

    [self removeOperation:operation];
    [request clearCompletionBlock];
}

YTKNetworkConfig:配置請求根路徑與 DNS 地址。

YTKNetworkPrivate:可以理解為工具類,負責拼接地址、提供加密方法、定義分類等。

批量與鏈式請求

YTKBatchRequest 與 YTKChainRequest 是 YTKNetwork 的兩個高級用法,本質上都是存放 Request 的容器。

批量請求用 finishedCount 記錄已完成數量:

@interface YTKBatchRequest ()

@property (nonatomic) NSInteger finishedCount;

@end

每完成一個請求就遞增,直到等於請求總數時才觸發成功回調:

#pragma mark - Network Request Delegate

- (void)requestFinished:(YTKRequest *)request {
    _finishedCount++;

    if (_finishedCount == _requestArray.count) {
        [self toggleAccessoriesWillStopCallBack];

        if ([_delegate respondsToSelector:@selector(batchRequestFinished:)]) {
            [_delegate batchRequestFinished:self];
        }
        if (_successCompletionBlock) {
            _successCompletionBlock(self);
        }

        [self clearCompletionBlock];
        [self toggleAccessoriesDidStopCallBack];
    }
}

鏈式請求則給每個 Request 綁定一個索引:

@interface YTKChainRequest ()

@property (assign, nonatomic) NSUInteger nextRequestIndex;

@end

從數組中依次取出並發起,索引隨之遞增;任何一個環節失敗就觸發整體失敗回調:

- (void)start {
    if (_nextRequestIndex > 0) {
        YTKLog(@"Error! Chain request has already started.");
        return;
    }

    if ([_requestArray count] > 0) {
        [self toggleAccessoriesWillStartCallBack];
        [self startNextRequest];
        [[YTKChainRequestAgent sharedInstance] addChainRequest:self];
    } else {
        YTKLog(@"Error! Chain request array is empty.");
    }
}

// 下一個網絡請求
- (BOOL)startNextRequest {
    if (_nextRequestIndex < [_requestArray count]) {
        YTKBaseRequest *request = _requestArray[_nextRequestIndex];
        _nextRequestIndex++;
        request.delegate = self;
        [request start];
        return YES;
    } else {
        return NO;
    }
}

總結

YTKNetwork 的價值不在代碼量,而在分層思路:把「請求的描述與數據處理」收攏到一個類裡,把「請求的執行」交給統一的 Agent,把緩存作為可插拔的一層,再用批量與鏈式容器覆蓋複雜業務場景。

讀源碼的收穫往往比寫業務代碼更多。有些項目要看好幾遍,每一遍都有新發現——貴在堅持。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved