
第一次看到這種標題,我覺得偏理論——實戰中哪來這種詭異需求。直到真的碰上,才發現它確實有價值,於是整理成一篇。
當時的需求是這樣:寫一個方法,傳入起始標記(NSString)、結束標記(NSString)與一段文字(NSMutableString),方法內部掃描文字,回傳被標記包裹內容的範圍集合(NSRange,且範圍不含標記本身)。由於可能有多組,返回值應該是裝著 range 的陣列;同時順手把原字串中的起訖標記過濾掉,把清理後的字串一併帶回來。
舉例:傳入起始標記「<」、結束標記「>」,文字為「會議需要叫上<彼得>和<羅賓>」,期望回傳 [{location:6,length:2},{location:9,length:2}],以及處理後的字串「會議需要叫上彼得和羅賓」。
理想中的簽名大概長這樣,但 Objective-C 不允許:
- (NSArray *, NSMutableString *)scanBeginStr:(NSString *)beginstr
endStr:(NSString *)endstr
inText:(NSMutableString *)text下面給三種可行路徑。
最樸素也最好理解:需要回傳多個物件,就把它們塞進字典,自己約定 key,然後回傳字典。字典能裝多少個「返回值」都行。
- (NSDictionary *)scanBeginStr:(NSString *)beginstr
endStr:(NSString *)endstr
inText:(NSMutableString *)text {
NSRange range1, range2;
NSUInteger location = 0, length = 0;
range1.location = 0;
NSMutableArray *rangeArray = [NSMutableArray array];
while (range1.location != NSNotFound) {
range1 = [text rangeOfString:beginstr];
range2 = [text rangeOfString:endstr];
if (range1.location != NSNotFound) {
location = range1.location;
length = range2.location - range1.location - 1;
if (length > 5000) break;
[text replaceOccurrencesOfString:beginstr withString:@""
options:NSCaseInsensitiveSearch
range:NSMakeRange(0, range1.location + range1.length)];
[text replaceOccurrencesOfString:endstr withString:@""
options:NSCaseInsensitiveSearch
range:NSMakeRange(0, range2.location + range2.length - 1)];
}
[rangeArray addObject:@{@"location": @(location), @"length": @(length)}];
}
return @{@"rangeArray": rangeArray, @"text": text};
}呼叫端非常直白:
NSDictionary *result = [self scanBeginStr:@"<" endStr:@">" inText:mutableText]; NSArray *rangeArray = result[@"rangeArray"]; NSMutableString *text = [result[@"text"] mutableCopy];
如果嫌字典不夠型別安全,也可以自訂一個 Model,把各項結果賦值後回傳。可讀性更好,但要多寫不少程式碼,而且欄位是寫死的,無法任意擴充——思路其實和字典一樣,就不單獨列為一種了。
這是我實際採用的做法:把需要修改的 text 的「指標的指標」傳進去,方法內部對實參取值拿到 text 指標,再透過它改寫外部變數。
- (NSArray *)scanBeginStr:(NSString *)beginstr
endStr:(NSString *)endstr
inText:(NSMutableString **)textPointer {
NSRange range1, range2;
NSUInteger location = 0, length = 0;
range1.location = 0;
NSMutableString *text = *textPointer;
NSMutableArray *rangeArray = [NSMutableArray array];
while (range1.location != NSNotFound) {
range1 = [text rangeOfString:beginstr];
range2 = [text rangeOfString:endstr];
if (range1.location != NSNotFound) {
location = range1.location;
length = range2.location - range1.location - 1;
if (length > 5000) break;
[text replaceOccurrencesOfString:beginstr withString:@""
options:NSCaseInsensitiveSearch
range:NSMakeRange(0, range1.location + range1.length)];
[text replaceOccurrencesOfString:endstr withString:@""
options:NSCaseInsensitiveSearch
range:NSMakeRange(0, range2.location + range2.length - 1)];
}
[rangeArray addObject:@{@"location": @(location), @"length": @(length)}];
}
return rangeArray;
}呼叫端這樣寫,mutableText 的修改是無聲無息發生的:
NSArray *rangeArray = [self scanBeginStr:@"<" endStr:@">" inText:&mutableText];
嚴格說這不算「返回值」,但效果上能達到目的,也最貼近現代 API 的寫法。
- (void)scanBeginStr:(NSString *)beginstr
endStr:(NSString *)endstr
inText:(NSMutableString *)text
result:(void (^)(NSArray *rangeArray, NSMutableString *text))result {
NSRange range1, range2;
NSUInteger location = 0, length = 0;
range1.location = 0;
NSMutableArray *rangeArray = [NSMutableArray array];
while (range1.location != NSNotFound) {
range1 = [text rangeOfString:beginstr];
range2 = [text rangeOfString:endstr];
if (range1.location != NSNotFound) {
location = range1.location;
length = range2.location - range1.location - 1;
if (length > 5000) break;
[text replaceOccurrencesOfString:beginstr withString:@""
options:NSCaseInsensitiveSearch
range:NSMakeRange(0, range1.location + range1.length)];
[text replaceOccurrencesOfString:endstr withString:@""
options:NSCaseInsensitiveSearch
range:NSMakeRange(0, range2.location + range2.length - 1)];
}
[rangeArray addObject:@{@"location": @(location), @"length": @(length)}];
}
result(rangeArray, text);
}呼叫方式:
[self scanBeginStr:@"<" endStr:@">" inText:mutabletext result:^(NSArray *rangeArray, NSMutableString *text) {
NSLog(@"%@, %@", rangeArray, text);
}];把 block 的參數換成字典或 Model 當然也行,不過那就顯得多此一舉了。另外別忘了:返回值不能是結構體,結構體裡也只能放基本型別,不能塞 OC 物件。
其實還有別的路子,例如在方法內部計算完再 set 到 N 個成員變數上,也完全可行,只是成員變數一多就很難看。近來比較流行的函數式編程強調「函式內部不得產生副作用」「實現引用透明」,以此標準看,後兩種做法都不合規,但各有其適用場合。我自己的結論是:對外 API 用 block 表達最清楚,內部實作若必須原地修改,指標的指標比字典更省一層包裝。