一. 前言
我們在項目開發(fā)中很經(jīng)常會碰到各種對輸入框
的限制需求评腺,比如姓名
最多只能10字符
切蟋,密碼
最多只能16個字符
忱辅,金額
最多9位數(shù)
且小數(shù)點
只能保留兩位小數(shù)
焰宣,且不能
包含表情
霉囚,更有甚者,可能會要求姓名
匕积,中文
最多6個字符
盈罐,英文
最多12個
字符。面對著各種錯綜復雜輸入限制
以及不同種類
的第三方鍵盤
闪唆,處理起來很經(jīng)常需要寫一定量
的代碼盅粪,且處理邏輯
相對復雜∏睦伲基于這樣的情況票顾,于是編寫了這樣一個輸入框攔截器
:FJFTextInputIntercepter。
FJFTextInputIntercepter攔截器
的作用就類似于你請的家政服務
帆调,原本你需要自己來打掃家里
奠骄,但是現(xiàn)在你只需把你的需求
告訴家政人員
,他們會按照
你的需求
來進行打掃
贷帮,最后將打掃結(jié)果
告知你戚揭。輸入框攔截器
就類似這樣的效果,你只需告訴它輸入的限制條件
撵枢,然后他就會將依據(jù)你的限制條件
進行處理民晒,并將處理結(jié)果
回調(diào)給你。
這個輸入框攔截器:FJFTextInputIntercepter
使用簡單锄禽,只需設置限制條件
潜必,然后傳入需要限制的輸入框
,其他的就交給攔截器
進行處理沃但。
二.使用介紹
- 使用方法
/**
設置 需要 攔截的輸入框
@param textInputView 輸入框
*/
- (void)textInputView:(UIView *)textInputView;
/**
設置 攔截器和攔截的輸入框
@param textInputView 輸入框
@param intercepter 攔截器
*/
+ (void)textInputView:(UIView *)textInputView setInputIntercepter:(FJFTextInputIntercepter *)intercepter;
/**
生成 輸入框 攔截器
@param textInputView 需要限制的輸入框
@param beyoudLimitBlock 超過限制 回調(diào)
@return 生成 輸入框 攔截器
*/
+ (FJFTextInputIntercepter *)textInputView:(UIView *)textInputView beyoudLimitBlock:(FJFTextInputIntercepterBlock)beyoudLimitBlock;
舉個例子:
金額
輸入限制:最多9位
數(shù)磁滚,最多保留2位
小數(shù)。
// moneyTextFieldView
- (FJTextFieldView *)moneyTextFieldView {
if (!_moneyTextFieldView) {
_moneyTextFieldView = [[FJTextFieldView alloc] initWithFrame:CGRectMake(0, CGRectGetMaxY(self.cardTextFieldView.frame) + 20, [UIScreen mainScreen].bounds.size.width - 80 - 20, 44)];
_moneyTextFieldView.tipLabel.text = @"金額:";
_moneyTextFieldView.textField.placeholder = @"請輸入金額(最多9位數(shù)宵晚,保留2位小數(shù))";
FJFTextInputIntercepter *intercepter = [[FJFTextInputIntercepter alloc] init];
// 最多輸入9位數(shù)
intercepter.maxCharacterNum = 9;
// 保留兩位小數(shù)
intercepter.decimalPlaces = 2;
// 分數(shù)類型
intercepter.intercepterNumberType = FJFTextInputIntercepterNumberTypeDecimal;
intercepter.beyoudLimitBlock = ^(FJFTextInputIntercepter *textInputIntercepter, NSString *string) {
NSLog(@"最多只能輸入9位數(shù)字");
};
[intercepter textInputView:_moneyTextFieldView.textField];
}
return _moneyTextFieldView;
}
如上我們可以看到:
我們生成了一個FJFTextInputIntercepter攔截器實例
垂攘,然后給實例
的屬性分別添加限制
要求,最后將限制的輸入框
傳入攔截器
淤刃,表示對此輸入框
依據(jù)限制要求
進行輸入攔截
晒他。
- 集成方法:
靜態(tài):手動將FJFTextInputIntercepter文件夾拖入到工程中。
動態(tài):CocoaPods:pod 'FJFTextInputIntercepter'
github 鏈接
Demo地址: https://github.com/fangjinfeng/FJFTextInputIntercepter
-
效果展示:
三. 原理分析
1. 原理簡介
FJFTextInputIntercepter
只有一種調(diào)用方法就是:
- 首先生成
攔截器實例
:
FJFTextInputIntercepter *intercepter = [[FJFTextInputIntercepter alloc] init];
- 然后給
攔截器實例
相關屬性設置限制要求
:
intercepter.maxCharacterNum = 10;
intercepter.emojiAdmitted = NO;
intercepter.doubleBytePerChineseCharacter = NO;
intercepter.beyoudLimitBlock = ^(FJFTextInputIntercepter *textInputIntercepter, NSString *string) {
NSLog(@"最多只能輸入漢字5個字逸贾,英文10個字母");
};
- 最后設置
攔截對象
即需要進行輸入限制
的輸入框
:
[intercepter textInputView:_nameTextFieldView.textField];
2. 代碼分析:
屬性分析:
// maxCharacterNum 限制 最大 字符
@property (nonatomic, assign) NSUInteger maxCharacterNum;
// decimalPlaces 小數(shù) 位數(shù)
// (當intercepterNumberType 為FJFTextInputIntercepterNumberTypeDecimal 有用)
@property (nonatomic, assign) NSUInteger decimalPlaces;
// beyoudLimitBlock 超過限制 最大 字符數(shù) 回調(diào)
@property (nonatomic, copy) FJFTextInputIntercepterBlock beyoudLimitBlock;
// emojiAdmitted 是否 允許 輸入 表情
@property (nonatomic, assign, getter=isEmojiAdmitted) BOOL emojiAdmitted;
// intercepterNumberType 數(shù)字 類型
// FJFTextInputIntercepterNumberTypeNone 默認
// FJFTextInputIntercepterNumberTypeNumberOnly 只允許 輸入 數(shù)字陨仅,emojiAdmitted津滞,decimalPlaces 不起作用
// FJFTextInputIntercepterNumberTypeDecimal 分數(shù) emojiAdmitted 不起作用 decimalPlaces 小數(shù) 位數(shù)
@property (nonatomic, assign) FJFTextInputIntercepterNumberType intercepterNumberType;
/**
doubleBytePerChineseCharacter 為 NO
字母、數(shù)字灼伤、漢字都是1個字節(jié) 表情是兩個字節(jié)
doubleBytePerChineseCharacter 為 YES
不允許 輸入表情 一個漢字是否代表兩個字節(jié) default YES
允許 輸入表情 一個漢字代表3個字節(jié) 表情 代表 4個字節(jié)
*/
@property (nonatomic, assign, getter=isDoubleBytePerChineseCharacter) BOOL doubleBytePerChineseCharacter;
屬性功能
如注釋
所示触徐,攔截器
默認設置如下屬性
:
_emojiAdmitted = NO;
_maxCharacterNum = UINT_MAX;
_doubleBytePerChineseCharacter = NO;
_intercepterNumberType = FJFTextInputIntercepterNumberTypeNone;
默認不允許輸入表情
、不限制最大輸入字符數(shù)
狐赡、漢字
和字符
同樣一個字節(jié)
撞鹉、表情兩個字節(jié)
、不設置數(shù)字類型
猾警。
限制邏輯分析:
- A. 調(diào)用公共方法:
#pragma mark -------------------------- Public Methods
- (void)textInputView:(UIView *)textInputView {
[FJFTextInputIntercepter textInputView:textInputView setInputIntercepter:self];
}
+ (FJFTextInputIntercepter *)textInputView:(UIView *)textInputView beyoudLimitBlock:(FJFTextInputIntercepterBlock)beyoudLimitBlock {
FJFTextInputIntercepter *tmpInputIntercepter = [[FJFTextInputIntercepter alloc] init];
tmpInputIntercepter.beyoudLimitBlock = [beyoudLimitBlock copy];
[self textInputView:textInputView setInputIntercepter:tmpInputIntercepter];
return tmpInputIntercepter;
}
+ (void)textInputView:(UIView *)textInputView setInputIntercepter:(FJFTextInputIntercepter *)intercepter {
if ([textInputView isKindOfClass:[UITextField class]]) {
UITextField *textField = (UITextField *)textInputView;
textField.yb_textInputIntercepter = intercepter;
[[NSNotificationCenter defaultCenter] addObserver:intercepter
selector:@selector(textInputDidChangeWithNotification:)
name:UITextFieldTextDidChangeNotification
object:textInputView];
} else if ([textInputView isKindOfClass:[UITextView class]]) {
UITextView *textView = (UITextView *)textInputView;
textView.yb_textInputIntercepter = intercepter;
[[NSNotificationCenter defaultCenter] addObserver:intercepter
selector:@selector(textInputDidChangeWithNotification:)
name:UITextViewTextDidChangeNotification
object:textInputView];
}
}
從代碼中我們可以看出最后都會走:
+ (void)textInputView:(UIView *)textInputView setInputIntercepter:(FJFTextInputIntercepter *)intercepter
類方法孔祸,這里對輸入框類型
進行了判斷,并設置將攔截器
和輸入框
關聯(lián)在一起发皿,保證攔截器
的生命周期
和輸入框
一致,同時注冊
了文本改變
的通知
拂蝎。
- B. 文本改變通知:
#pragma mark -------------------------- Noti Methods
- (void)textInputDidChangeWithNotification:(NSNotification *)noti {
if (![((UIView *)noti.object) isFirstResponder]) {
return;
}
BOOL textFieldTextDidChange = [noti.name isEqualToString:UITextFieldTextDidChangeNotification] &&
[noti.object isKindOfClass:[UITextField class]];
BOOL textViewTextDidChange = [noti.name isEqualToString:UITextViewTextDidChangeNotification] &&
[noti.object isKindOfClass:[UITextView class]];
if (!textFieldTextDidChange && !textViewTextDidChange) {
return;
}
if ([noti.name isEqualToString:UITextFieldTextDidChangeNotification]) {
[self textFieldTextDidChangeWithNotification:noti];
} else if ([noti.name isEqualToString:UITextViewTextDidChangeNotification]) {
[self textViewTextDidChangeWithNotification:noti];
}
}
該函數(shù)主要對是否為當前第一響應者
和通知名稱
是否匹配進行判斷穴墅,然后調(diào)用輸入框類型
對應的通知處理方法
。
- C. 輸入框類型通知處理方法:
#pragma mark -------------------------- Private Methods
- (void)textFieldTextDidChangeWithNotification:(NSNotification *)noti {
UITextField *textField = (UITextField *)noti.object;
NSString *inputText = textField.text;
NSString *primaryLanguage = [textField.textInputMode primaryLanguage];
//獲取高亮部分
UITextRange *selectedRange = [textField markedTextRange];
UITextPosition *textPosition = [textField positionFromPosition:selectedRange.start
offset:0];
inputText = [self handleWithInputText:inputText];
NSString *finalText = [self finalTextAfterProcessingWithInput:inputText
maxCharacterNum:self.maxCharacterNum
primaryLanguage:primaryLanguage
textPosition:textPosition
isDoubleBytePerChineseCharacter:self.isDoubleBytePerChineseCharacter];
if (finalText.length > 0) {
textField.text = finalText;
}
else if(self.intercepterNumberType == FJFTextInputIntercepterNumberTypeNumberOnly ||
self.intercepterNumberType == FJFTextInputIntercepterNumberTypeDecimal ||
self.isEmojiAdmitted == NO){
textField.text = inputText;
}
_previousText = textField.text;
}
- (void)textViewTextDidChangeWithNotification:(NSNotification *)noti {
UITextView *textView = (UITextView *)noti.object;
NSString *inputText = textView.text;
NSString *primaryLanguage = [textView.textInputMode primaryLanguage];
//獲取高亮部分
UITextRange *selectedRange = [textView markedTextRange];
UITextPosition *textPosition = [textView positionFromPosition:selectedRange.start
offset:0];
inputText = [self handleWithInputText:inputText];
NSString *finalText = [self finalTextAfterProcessingWithInput:inputText
maxCharacterNum:self.maxCharacterNum
primaryLanguage:primaryLanguage
textPosition:textPosition
isDoubleBytePerChineseCharacter:self.isDoubleBytePerChineseCharacter];
if (finalText.length > 0) {
textView.text = finalText;
}
_previousText = textView.text;
}
通知處理方法
內(nèi)部分別獲取當前語言類型
温自、和高亮部分
玄货,然后調(diào)用輸入文本的處理方法:handleWithInputText
和最大輸入字符的截取方法:finalTextAfterProcessingWithInput
。
- D. 在
輸入文本的處理方法:handleWithInputText
中分別對只能輸入數(shù)字
悼泌、輸入分數(shù)
和是否允許輸入表情
進行處理.
// 處理 輸入 字符串
- (NSString *)handleWithInputText:(NSString *)inputText {
if (_previousText.length >= inputText.length) {
return inputText;
}
NSString *tmpReplacementString = [inputText substringWithRange:NSMakeRange(_previousText.length, (inputText.length - _previousText.length))];
// 只允許 輸入 數(shù)字
if (self.intercepterNumberType == FJFTextInputIntercepterNumberTypeNumberOnly) {
if ([tmpReplacementString fjf_isCertainStringType:FJFTextInputStringTypeNumber] == NO) {
inputText = _previousText;
}
}
// 輸入 小數(shù)
else if(self.intercepterNumberType == FJFTextInputIntercepterNumberTypeDecimal){
NSRange tmpRange = NSMakeRange(_previousText.length, 0);
BOOL isCorrect = [self inputText:_previousText shouldChangeCharactersInRange:tmpRange replacementString:tmpReplacementString];
if (isCorrect == YES) {
if (inputText.length == self.maxCharacterNum && [tmpReplacementString isEqualToString:@"."]) {
inputText = _previousText;
}
}
else {
inputText = _previousText;
}
}
// 不允許 輸入 表情
else if (!self.isEmojiAdmitted && [tmpReplacementString fjf_isSpecialLetter]) {
inputText = _previousText;
}
return inputText;
}
- F. 在
finalTextAfterProcessingWithInput
函數(shù)中依據(jù)是否為中文輸入法
來分別進行處理
// 核心代碼
- (NSString *)finalTextAfterProcessingWithInput:(NSString *)inputText
maxCharacterNum:(NSUInteger)maxCharacterNum
primaryLanguage:(NSString *)primaryLanguage
textPosition:(UITextPosition *)textPosition
isDoubleBytePerChineseCharacter:(BOOL)isDoubleBytePerChineseCharacter {
NSString *finalText = nil;
if ([primaryLanguage isEqualToString:@"zh-Hans"] ||
[primaryLanguage isEqualToString:@"zh-Hant"]) { // 簡繁體中文輸入
// 沒有高亮選擇的字松捉,則對已輸入的文字進行字數(shù)統(tǒng)計和限制
if (!textPosition) {
finalText = [self processingTextWithInput:inputText
maxCharacterNum:maxCharacterNum
isDoubleBytePerChineseCharacter:isDoubleBytePerChineseCharacter];
}
} else { // 中文輸入法以外的直接對其統(tǒng)計限制即可,不考慮其他語種情況
finalText = [self processingTextWithInput:inputText
maxCharacterNum:maxCharacterNum
isDoubleBytePerChineseCharacter:isDoubleBytePerChineseCharacter];
}
return finalText;
}
這段代碼里面判斷了是否為簡繁體中文輸入
馆里,如果不是簡繁體中文輸入
隘世,直接調(diào)用processingTextWithInput方法
對已輸入的文字
進行字數(shù)
和統(tǒng)計
的限制,如果是簡繁體中文輸入
鸠踪,判斷是否為高亮選擇
的字丙者,如果不是高亮選擇
的字,對已輸入的文字
進行字數(shù)
和統(tǒng)計的限制
营密。
- G.
processingTextWithInput
依據(jù)是否一個漢字對應兩個字節(jié)
來分別進行處理
- (NSString *)processingTextWithInput:(NSString *)inputText
maxCharacterNum:(NSUInteger)maxCharacterNum
isDoubleBytePerChineseCharacter:(BOOL)isDoubleBytePerChineseCharacter {
NSString *processingText = nil;
if (isDoubleBytePerChineseCharacter) { //如果一個漢字是雙字節(jié)
processingText = [self doubleBytePerChineseCharacterSubString:inputText
maxCharacterNum:maxCharacterNum];
} else {
if (inputText.length > maxCharacterNum) {
NSRange rangeIndex = [inputText rangeOfComposedCharacterSequenceAtIndex:maxCharacterNum];
if (rangeIndex.length == 1) {
processingText = [inputText substringToIndex:maxCharacterNum];
} else {
NSRange rangeRange = [inputText rangeOfComposedCharacterSequencesForRange:NSMakeRange(0, maxCharacterNum)];
processingText = [inputText substringWithRange:rangeRange];
}
if (self.beyoudLimitBlock) {
self.beyoudLimitBlock(self, processingText);
}
}
}
return processingText;
}
該函數(shù)判斷如果一個漢字
是雙字節(jié)
械媒,就調(diào)用doubleBytePerChineseCharacterSubString
依據(jù)是否允許輸入表情
,調(diào)用不同的編碼方式
進行處理评汰。如果一個漢字是一個字節(jié)
纷捞,直接進行最大字符截取
。
四. 總結(jié)
綜上所述就是FJFTextInputIntercepter
這個輸入框
的一個設計思路
被去,核心代碼量差不多400行左右主儡,能應對大部分的
輸入框要求`,使用簡單编振。
如果你覺得你覺得這思路或是代碼有什么問題缀辩,歡迎留言大家討論下臭埋!如果覺得不錯,麻煩給個喜歡或star,謝謝臀玄!