本文是「iOS 區域網路聯機——蘋果官方原始碼 WiTap 剖析」系列的第三篇,與第二篇緊密相連,閱讀前建議先看過系列第二篇。
系列第一篇提到,要徹底弄懂 AppController 的 setup 方法,必須先搞明白 TCPService 類別。第二篇已經把它分析完畢,現在回頭再看 setup,除了最後那句 presentPicker 之外,前面每一行的意義應該都清楚了。
在討論 presentPicker 之前,先把第二篇的遺留問題收尾。我們在 NSNetServiceDelegate 的兩個方法裡都呼叫了 TCPServer 的 delegate 協議方法,而這個 delegate 就是 AppController。來看看它實作的 TCPServerDelegate 方法:
- (void)serverDidEnableBonjour:(TCPServer *)server withName:(NSString *)string
{
[self presentPicker:string];
}
這個方法在 NSNetService 發布成功的回調中被呼叫,內容只有一行,同樣是呼叫 presentPicker。至於發布失敗時的 server:didNotEnableBonjour:,你找不到它是正常的——這些方法都是 @optional,蘋果沒有實作。因此 TCPService 在發布失敗的回調裡不會觸發後續的 delegate 呼叫。
要理解 presentPicker,得先認識 BrowserViewController。簡單說,它的職責是在當前網路中搜尋特定服務——也就是我們在 TCPService 的 enableBonjourWithDomain: 裡發布的那種服務。
先看它的頭檔:
#import <UIKit/UIKit.h> #import <Foundation/NSNetServices.h> @class BrowserViewController; @protocol BrowserViewControllerDelegate <NSObject> @required // 使用者從服務列表中選好一項並完成解析時呼叫; // 若使用者按下 Cancel,ref 為 nil。 - (void)browserViewController:(BrowserViewController *)bvc didResolveInstance:(NSNetService *)ref; @end
這裡定義的 BrowserViewControllerDelegate 協議只有一個方法,且被 @required 修飾——宣告遵守這個協議的類別必須實作它。前面看到的協議方法多半是 @optional,可以不實作。這個方法在「使用者選取的服務完成解析」時被呼叫。
類別宣告如下:
@interface BrowserViewController : UITableViewController <NSNetServiceDelegate, NSNetServiceBrowserDelegate> {
@private
id<BrowserViewControllerDelegate> _delegate;
NSString *_searchingForServicesString;
NSString *_ownName;
NSNetService *_ownEntry;
BOOL _showDisclosureIndicators;
NSMutableArray *_services;
NSNetServiceBrowser *_netServiceBrowser;
NSNetService *_currentResolve;
NSTimer *_timer;
BOOL _needsActivityIndicator;
BOOL _initialWaitOver;
}
@property (nonatomic, assign) id<BrowserViewControllerDelegate> delegate;
@property (nonatomic, copy) NSString *searchingForServicesString;
@property (nonatomic, copy) NSString *ownName;
- (id)initWithTitle:(NSString *)title showDisclosureIndicators:(BOOL)showDisclosureIndicators showCancelButton:(BOOL)showCancelButton;
- (BOOL)searchForServicesOfType:(NSString *)type inDomain:(NSString *)domain;
@end
這個類別繼承自 UITableViewController,因此自帶一個 table view,在這裡用來列出搜尋到的服務。它同時宣告符合 NSNetServiceDelegate 與 NSNetServiceBrowserDelegate:後者是 NSNetServiceBrowser 在搜尋到服務或其他特定狀況時的系列回調。
私有變數的分工是:_delegate 是符合 BrowserViewControllerDelegate 的委託;_searchingForServicesString 是要搜尋的服務完整型別名稱(本例中即 TCPService 的 bonjourTypeFromIdentifier: 回傳值);_ownName 與 _ownEntry 分別是自己發布的服務名稱與服務本身;_showDisclosureIndicators 決定 cell 是否顯示右箭頭;_services 存放所有符合條件的服務;_netServiceBrowser 是負責搜尋的物件;_currentResolve 是目前正在解析的服務;_timer 用於延遲呼叫;_needsActivityIndicator 標記是否需要顯示活動指示器;_initialWaitOver 標記初始等待是否結束。
實作檔開頭先為 NSNetService 建立一個分類,加入依名稱排序的方法:
@implementation NSNetService (BrowserViewControllerAdditions)
- (NSComparisonResult)localizedCaseInsensitiveCompareByName:(NSNetService *)aService {
return [[self name] localizedCaseInsensitiveCompare:[aService name]];
}
@end
接著在類別擴充中補上剩餘私有變數的 readwrite 屬性宣告,並宣告兩個內部方法:stopCurrentResolve 用來中止目前正在進行的發布或解析;initialWaitOver: 用來延遲處理部分操作。
關於 @synthesize 與 @dynamic:@synthesize 表示若不自行實作 setter/getter,編譯器會依屬性自動產生;若你自己寫了,編譯器就不再生成。@dynamic 則表示 setter/getter 必須由開發者自行實作。
- (id)initWithTitle:(NSString *)title showDisclosureIndicators:(BOOL)show showCancelButton:(BOOL)showCancelButton {
if ((self = [super initWithStyle:UITableViewStylePlain])) {
self.title = title;
_services = [[NSMutableArray alloc] init];
self.showDisclosureIndicators = show;
if (showCancelButton) {
UIBarButtonItem *addButton = [[UIBarButtonItem alloc]
initWithBarButtonSystemItem:UIBarButtonSystemItemCancel target:self action:@selector(cancelAction)];
self.navigationItem.rightBarButtonItem = addButton;
[addButton release];
}
// 給系統一點時間發現裝置,再告訴使用者「目前沒找到」
[NSTimer scheduledTimerWithTimeInterval:1.0 target:self selector:@selector(initialWaitOver:) userInfo:nil repeats:NO];
}
return self;
}
流程很單純:呼叫父類初始化並指定 table 樣式、設定標題、初始化服務陣列、設定是否顯示右箭頭;若需要取消按鈕就建立一個並掛在導航列右側;最後安排 1 秒後呼叫 initialWaitOver,確保在對使用者顯示「找不到服務」之前,已經有足夠時間完成搜尋。
- (void)cancelAction {
[self.delegate browserViewController:self didResolveInstance:nil];
}
- (void)initialWaitOver:(NSTimer *)timer {
self.initialWaitOver = YES;
if (![self.services count])
[self.tableView reloadData];
}
searchingForServicesString 的 getter 就是一般寫法,setter 多了一件事:若目前搜尋到的服務數為 0,就重新載入 table,確保這段提示文字會出現。
ownName 的 setter 更有意思:
- (void)setOwnName:(NSString *)name {
if (_ownName != name) {
_ownName = [name copy];
if (self.ownEntry)
[self.services addObject:self.ownEntry];
NSNetService* service;
for (service in self.services) {
if ([service.name isEqual:name]) {
self.ownEntry = service;
[_services removeObject:service];
break;
}
}
[self.tableView reloadData];
}
}
若原本的 ownEntry 有效,先把它放回服務陣列;再逐一比對名稱,找到與新名稱相同的服務就設為 ownEntry 並移出陣列。如此一來,在 ownEntry 有效的前提下更換「自己的服務」,就等於完成兩個服務的位置交換。
- (BOOL)searchForServicesOfType:(NSString *)type inDomain:(NSString *)domain {
[self stopCurrentResolve];
[self.netServiceBrowser stop];
[self.services removeAllObjects];
NSNetServiceBrowser *aNetServiceBrowser = [[NSNetServiceBrowser alloc] init];
if (!aNetServiceBrowser)
return NO;
aNetServiceBrowser.delegate = self;
self.netServiceBrowser = aNetServiceBrowser;
[aNetServiceBrowser release];
[self.netServiceBrowser searchForServicesOfType:type inDomain:domain];
[self.tableView reloadData];
return YES;
}
- (void)stopCurrentResolve {
self.needsActivityIndicator = NO;
self.timer = nil;
[self.currentResolve stop];
self.currentResolve = nil;
}
開頭三行是清理工作:假設之前有解析正在進行就先停掉、停止上一輪的服務搜尋、清空舊的服務清單。接著建立 NSNetServiceBrowser,設定 delegate 為自己,指定型別與網域開始搜尋,最後刷新列表並回傳成功。
值得一看的是 timer 的 setter——它在換上新值之前,會先 invalidate 並釋放舊的 timer:
- (void)setTimer:(NSTimer *)newTimer {
[_timer invalidate];
[newTimer retain];
[_timer release];
_timer = newTimer;
}
只有一個 section,所以 numberOfSectionsInTableView: 回傳 1。行數的計算有一個小細節:
- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section {
NSUInteger count = [self.services count];
if (count == 0 && self.searchingForServicesString && self.initialWaitOver)
return 1; // 用一行告訴使用者「正在搜尋」
return count;
}
也就是說:服務數為 0、搜尋型別名稱有效、且 1 秒的初始等待已結束,就顯示一行提示,否則照實際服務數量。
cell 的配置分成兩種情況:
- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {
static NSString *tableCellIdentifier = @"UITableViewCell";
UITableViewCell *cell = (UITableViewCell *)[tableView dequeueReusableCellWithIdentifier:tableCellIdentifier];
if (cell == nil) {
cell = [[[UITableViewCell alloc] initWithStyle:UITableViewCellStyleDefault reuseIdentifier:tableCellIdentifier] autorelease];
}
NSUInteger count = [self.services count];
if (count == 0 && self.searchingForServicesString) {
cell.textLabel.text = self.searchingForServicesString;
cell.textLabel.textColor = [UIColor colorWithWhite:0.5 alpha:0.5];
cell.accessoryType = UITableViewCellAccessoryNone;
if (cell.accessoryView)
cell.accessoryView = nil;
return cell;
}
NSNetService *service = [self.services objectAtIndex:indexPath.row];
cell.textLabel.text = [service name];
cell.textLabel.textColor = [UIColor blackColor];
cell.accessoryType = self.showDisclosureIndicators ? UITableViewCellAccessoryDisclosureIndicator : UITableViewCellAccessoryNone;
if (self.needsActivityIndicator && self.currentResolve == service) {
if (!cell.accessoryView) {
CGRect frame = CGRectMake(0.0, 0.0, kProgressIndicatorSize, kProgressIndicatorSize);
UIActivityIndicatorView* spinner = [[UIActivityIndicatorView alloc] initWithFrame:frame];
[spinner startAnimating];
spinner.activityIndicatorViewStyle = UIActivityIndicatorViewStyleGray;
[spinner sizeToFit];
spinner.autoresizingMask = (UIViewAutoresizingFlexibleLeftMargin |
UIViewAutoresizingFlexibleRightMargin |
UIViewAutoresizingFlexibleTopMargin |
UIViewAutoresizingFlexibleBottomMargin);
cell.accessoryView = spinner;
[spinner release];
}
} else if (cell.accessoryView) {
cell.accessoryView = nil;
}
return cell;
}
dequeueReusableCellWithIdentifier: 是 table view 最重要的效能優化之一:列表可能有大量資料,但同時只有可見的少數幾行出現在螢幕上,因此把滾出可見範圍的 cell 回收重複使用,而不是每次捲動都重新配置一個。
第二種情況中,若需要顯示活動指示器且正在解析的服務就是目前這行,就建立 spinner 作為 accessoryView;否則把可能殘留的 accessoryView 清掉。這裡特意比對 currentResolve == service 而非直接用索引,是因為底層陣列可能已經變動,要確保指示器出現在正確的那一格。
- (NSIndexPath *)tableView:(UITableView *)tableView willSelectRowAtIndexPath:(NSIndexPath *)indexPath {
if ([self.services count] == 0)
return nil; // 只有提示文字時,點了也不該有反應
return indexPath;
}
- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath {
// 若已有另一個解析在跑,先停掉並清掉它的指示器
if (self.currentResolve) {
NSIndexPath* activeIndexPath = [NSIndexPath indexPathForRow:[self.services indexOfObject:self.currentResolve] inSection:0];
[self stopCurrentResolve];
if (activeIndexPath.row != NSNotFound)
[self.tableView reloadRowsAtIndexPaths:[NSArray arrayWithObject:activeIndexPath] withRowAnimation:UITableViewRowAnimationNone];
}
self.currentResolve = [self.services objectAtIndex:indexPath.row];
[self.currentResolve setDelegate:self];
[self.currentResolve resolveWithTimeout:0.0]; // 0.0 代表不設逾時
// 延遲 1 秒才顯示指示器,避免解析很快時畫面閃一下
self.timer = [NSTimer scheduledTimerWithTimeInterval:1.0 target:self selector:@selector(showWaiting:) userInfo:self.currentResolve repeats:NO];
}
而 showWaiting 的內容是:
- (void)showWaiting:(NSTimer *)timer {
if (timer == self.timer) {
NSNetService* service = (NSNetService*)[self.timer userInfo];
if (self.currentResolve == service) {
self.needsActivityIndicator = YES;
NSIndexPath* indexPath = [NSIndexPath indexPathForRow:[self.services indexOfObject:self.currentResolve] inSection:0];
if (indexPath.row != NSNotFound) {
[self.tableView reloadRowsAtIndexPaths:[NSArray arrayWithObject:indexPath] withRowAnimation:UITableViewRowAnimationNone];
[self.tableView deselectRowAtIndexPath:indexPath animated:YES];
}
}
}
}
這裡的設計相當細膩:解析通常很快,1 秒內就會透過回調把 timer 取消,因此多數情況下 showWaiting 根本不會被執行,使用者也就不會看到多餘的閃爍。只有真的慢下來時,才把指示器顯示出來,並順便取消該列的高亮選取。
另外還有一個排序方法,用前面定義的分類方法排序後刷新畫面:
- (void)sortAndUpdateUI {
[self.services sortUsingSelector:@selector(localizedCaseInsensitiveCompareByName:)];
[self.tableView reloadData];
}
- (void)netServiceBrowser:(NSNetServiceBrowser *)browser didRemoveService:(NSNetService *)service moreComing:(BOOL)moreComing {
if (self.currentResolve && [service isEqual:self.currentResolve])
[self stopCurrentResolve];
[self.services removeObject:service];
if (self.ownEntry == service)
self.ownEntry = nil;
// moreComing 為 NO 代表 Bonjour 的訊息已全部送達,此時才更新 UI 可避免閃爍
if (!moreComing) {
[self sortAndUpdateUI];
}
}
- (void)netServiceBrowser:(NSNetServiceBrowser *)browser didFindService:(NSNetService *)service moreComing:(BOOL)moreComing {
if ([service.name isEqual:self.ownName])
self.ownEntry = service;
else
[self.services addObject:service];
if (!moreComing) {
[self sortAndUpdateUI];
}
}
moreComing 這個參數是效能與體驗的關鍵:一批服務事件抵達時,只在最後一筆才更新 UI,避免列表連續重繪造成的閃動。
- (void)netService:(NSNetService *)sender didNotResolve:(NSDictionary *)errorDict {
[self stopCurrentResolve];
[self.tableView reloadData];
}
- (void)netServiceDidResolveAddress:(NSNetService *)service {
assert(service == self.currentResolve);
[service retain];
[self stopCurrentResolve];
[self.delegate browserViewController:self didResolveInstance:service];
[service release];
}
解析失敗的方法在本例中永遠不會被觸發,因為前面設定的逾時是 0,代表不設上限。解析成功時,先用 assert 確認回調的服務正是我們正在解析的那一個,接著 retain 保護物件、停止解析、通知 delegate,最後 release。這裡的 retain/release 是為了避免在 stopCurrentResolve 把 currentResolve 清成 nil 的過程中,服務物件被提早釋放。
最後的 dealloc 就是例行清理:
- (void)dealloc {
[self stopCurrentResolve];
self.services = nil;
[self.netServiceBrowser stop];
self.netServiceBrowser = nil;
[_searchingForServicesString release];
[_ownName release];
[_ownEntry release];
[super dealloc];
}
所有大塊的類別都講完了。老實說這篇寫得偏趕,因為程式碼量實在太大,而其中大多是常規邏輯,沒有太多特殊知識點需要細究,很多地方只能大致交代作用與流程。接下來只要把正常的執行順序理清楚,這個範例就算通透了。
下一篇是系列完結篇,我會畫出整個程式的完整執行流程圖,對照著看前面講過的所有方法會更清楚。
(能力有限,文中若有不周之處,敬請指正。謝謝!)