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

iOS 郵箱後綴模糊匹配輸入框 XLTextField 實作解析

編輯:iOS 開發基礎

本文為投稿文章。

做過表單類需求的人,大概都聽過產品這樣說:「某個 App 的訂單填寫頁,輸入信箱的時候會自動提示後綴,還能依各信箱服務的使用量排優先順序,很不錯,你也幫我做一個吧!」這類需求做起來確實有點繁瑣,但並不難。下面已經把功能封裝進一個自訂的 textField 裡,直接看效果。

郵箱匹配效果圖.gif

一、功能說明

輸入一段字元後,會預設補上 @qq.com,這個預設值可以換成 @163.com 等其他後綴。範例中選 @qq.com,是因為統計顯示多數使用者仍在用 QQ 郵箱。

只輸入 @ 時不會有變化;一旦在 @ 之後敲了字元,就會拿這些字元去比對候選後綴清單。範例中的候選清單包含 @qq.com、@163.com、@126.com、@yahoo.com、@139.com、@henu.com。例如輸入 @1,會補出 63.com;接著再輸入 2 變成 @12,就補出 6.com。匹配的優先順序取自候選清單的排列順序,而清單本身完全可自訂。

二、使用方式

1. 在 xib 中使用:先拉一個 textField 並設好約束,把它的 class 關聯到 XLTextField(前提是已下載並匯入 XLTextField.h 與 XLTextField.m)。記得把 textField.delegate 設給 viewController,樣式可在 xib 自行調整,匹配區域的顏色也可自訂,然後在程式碼中呼叫 API:

/**
 * 1. 透過 xib 建立時,只需賦值此參數
 * @param mailTypeArray 郵箱匹配類型
 */
@property(nonatomic, strong) NSMutableArray *mailTypeArray;

範例程式碼:

self.textField.mailTypeArray = [NSMutableArray arrayWithObjects:@"@qq.com", @"@163.com", @"@126.com", @"@yahoo.com", @"@139.com", @"@henu.com", nil];

self.textField.didPressedReturnCompletion = ^(UITextField * textField){
    // 點擊 return 的回調,可選,依自身需求使用
};

XLTextField.h 另外提供一個可選的 mailMatchColor 屬性,型別為 UIColor,用來設定匹配後綴的顏色。

/**
 * Optional:匹配的郵箱類型後綴預設為 RGB(170, 170, 170),可自行設定
 */
@property(nonatomic, strong) UIColor * mailMatchColor;

2. 以純程式碼建立:透過 initWithFrame:fontSize: 一次指定大小與字級,其餘設定自行補上。

/**
 * 2. 手寫建立 textField 時呼叫
 * @param frame frame 大小
 * @param fontSize textField 字級
 * @return self
 */
- (instancetype)initWithFrame:(CGRect)frame fontSize:(CGFloat)fontSize;

範例程式碼:

XLTextField * field = [[XLTextField alloc] initWithFrame:CGRectMake(100, 200, 200, 30) fontSize:12];
field.placeholder = @"輸入郵箱地址";
field.mailTypeArray = [NSMutableArray arrayWithObjects:@"@qq.com", @"@163.com", @"@126.com", @"@yahoo.com", @"@139.com", @"@henu.com", nil];

field.didPressedReturnCompletion = ^(UITextField * textField){
    // 點擊 return 的回調,可選,依自身需求使用
};

field.mailMatchColor = [UIColor redColor]; // 可選屬性

[self.view addSubview:field];

範例程式中只為 xib 建立的 textField 加了手勢以結束輸入,純程式碼建立的版本沒有實作收起鍵盤的邏輯。實務上可依場景自行處理,例如點擊鍵盤的 Done 鍵,或觸摸畫面上的其他 view 時結束第一響應者,再從 textField.text 取值做後續處理。

Frame 與字級都可以依需求自訂。不過不支援 init 與 new 這兩個初始化方式,即使誤用了也會有清楚的編譯提示:

- (instancetype)init __attribute__((unavailable("init 方法不可用,請用 initWithName:fontSzie:")));
+ (instancetype)new __attribute__((unavailable("init 方法不可用,請用 initWithName:fontSzie:")));

更新內容:若接入方需要在 textField 的代理方法中做額外處理,實作對應的 protocol 即可。

@protocol XLEmailTextFieldDelegate (NSObject)

@optional
- (BOOL)XLTextFieldShouldBeginEditing:(UITextField *)textField;
- (void)XLTextFieldDidBeginEditing:(UITextField *)textField;
- (void)XLTextFieldDidEndEditing:(UITextField *)textField;
- (BOOL)XLTextField:(UITextField *)textField shouldChangeCharactersInRange:(NSRange)range replacementString:(NSString *)string;
- (BOOL)XLTextFieldShouldReturn:(UITextField *)textField;

@end

三、實作原理

1. 不看原始碼可能會以為全靠一個 textField 完成,其實不然。這裡搭配了一個 Label:在 xib 情境下以 Auto Layout 手動加入。textField 只負責接收使用者輸入,Label 則用來存放並顯示匹配後的完整郵箱(帳號加後綴),畫面上你看到的其實是 Label 的內容。編輯結束時,Label 會把內容拷貝回 textField.text,然後清空自己。也就是說,真正取用的值仍然來自 textField.text。

你可能會問:為什麼不用一個 textField 就好?因為實測單一 textField 時遇到了一些奇怪的行為,這裡就不展開了,有興趣可以自己試試。

2. textField 的代理方法全部封裝在 XLTextField.m 內部,已經處理妥當,呼叫方不必再花心思調代理。不論用 xib 還是純程式碼建立,都不需要把 textField.delegate 設給控制器。

3. 在 shouldChangeCharactersInRange 中針對每個輸入字元做匹配;在 textFieldDidEndEditing 中把 Label 的值賦給 textField.text,再清空 Label。最終一律以 textField.text 作為結果。

以下貼出匹配過程的關鍵程式碼,每行都有註解:

/**
 * 匹配郵箱過程
 * @param range range
 * @param string 使用者輸入 string
 */
- (void)configMailMatchingRange:(NSRange)range replacementString:(NSString *)string {
    // 取得完整的輸入文本
    NSString *completeStr = [self.text stringByReplacingCharactersInRange:range withString:string];

    // 以 @ 符號分割文本
    NSArray *temailArray = [completeStr componentsSeparatedByString:@"@"];

    // 取得郵箱前綴
    NSString *emailString = [temailArray firstObject];

    // 尚未輸入 @ 時,用 @ 進行匹配
    NSString *matchString = @"@";
    if (temailArray.count > 1) {
        // 已輸入 @,截取 @ 之後的字串作為匹配字串
        matchString = [completeStr substringFromIndex:emailString.length];
    }

    // 匹配得到所有符合當前輸入的郵箱後綴
    NSMutableArray *suffixArray = [self checkEmailStr:matchString];

    // 邊界控制:若無匹配後綴則置為空字串
    NSString *fixStr = suffixArray.count > 0 ? [suffixArray firstObject] : @"";

    // 計算 lblEmail 中需要隱藏的部分長度
    NSInteger cutLenth = suffixArray.count > 0 ? completeStr.length : emailString.length;

    // 最終的郵箱地址
    self.email = fixStr.length > 0 ? [NSString stringWithFormat:@"%@%@", emailString, fixStr] : completeStr;

    // 設定 lblEmail 的富文本
    NSMutableAttributedString *attributeString = [[NSMutableAttributedString alloc] initWithString:[NSString stringWithFormat:@"%@%@", emailString, fixStr]];
    [attributeString addAttribute:NSForegroundColorAttributeName value:[UIColor clearColor] range:NSMakeRange(0, cutLenth)];
    self.mailLabel.attributedText = attributeString;

    // 清空輸入框時隱藏 lblEmail
    if (completeStr.length == 0) {
        self.mailLabel.text = @"";
        self.email = @"";
    }
}

後續更新:在實際專案中複用這個元件時,發現原專案已自行實作了 textField 的代理方法,並帶有額外邏輯。為了不影響既有程式碼,特別對外開放了 textField 的代理方法,讓接入方實作 customDelegate 即可,這也算是適配器模式的一種應用場景——透過更換介面來複用舊程式碼。

覺得有幫助的話,歡迎給個 Star。本人水準有限,若有疏漏之處歡迎指正;使用上有未被滿足的需求也可以提出,我會盡量調整。這裡也要感謝 @QYunFat 的建議(點擊 return 時回填 textField),這個細節原本確實沒考慮到,已經補上。

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