UITextField输入字数限制

2017-08-27 本文已影响1340人秋醴泉

一开始，我以为这是一个属性设置问题或者是一个类似helloworld的函数，但是最后发现，这呀的是一个不小的坑。

1、哪些问题需要考虑？

输入字数有哪些？数字、英文、中文、emoji？
字数限制怎么定义？一个中文／emoji算一个字？
如果限制的是字节数呢？
会出现字符截断问题？
（中文输入法）在剩余的输入字数为1的情况下，是否还允许用户输入一堆拼音字符？
要是粘贴进一大段文字，能正确处理？
...

2、测试用例

在介绍用例之前，我们先来看看微信（iOS V6.5.12.32）是怎么做的。进入微信的名字修改界面～

纯数字输入，允许输入32个数字。
纯emoji输入，允许输入8个emoji。
纯中文输入，允许输入16个中文
先输入15个中文，然后再输入一个中文。是的，此时你只能输入一个拼音字母（也即前面的“h”问题）。
存在上述提到的黏贴问题
基本可以断定微信的名字是用字节数做了限制，并且使用的是3.1提到的方法。

下面是具体的测试用例（最基本的用例就不赘述了）：（如无特殊说明，限定输入字数为10个）
case1：输入10个中文，此时是否还允许有高亮的拼音字母输入？
case2：输入10个中文，将键盘切换为九宫格英文输入模式，快速点击某个字母，最后一个中文是否会被替换？
case3：在剩余的输入字数为1的情况下，是否还允许用户输入一堆高亮拼音字符？
case4：输入字数已经满了，此时是否允许粘贴？？？？？
case5：限制输入字符为11个，输入10个中文，再输入一个emoji表情，emoji会被截断？

3、网上参考做法

网上很多博客介绍了相关的方法，但是归根到底就是两种:
3.1 实现 UITextFieldDelegate 协议中的接口，这里有说明

- (BOOL)textField:(UITextField *)textField shouldChangeCharactersInRange:(NSRange)range replacementString:(NSString *)string {
    // Prevent crashing undo bug – see note below.
    if(range.length + range.location > textField.text.length)
    {
        return NO;
    }
    NSUInteger newLength = [textField.text length] + [string length] - range.length;
    return newLength <= kMaxLength;
}

该方法最简单，在只允许输入数字/英文/emoji的情况下，基本能满足。但该方法在黏贴文本长度超过允许值时，直接黏贴失败（也许我们更期待是自动截取）。
在允许输入中文的情况，该方法的缺陷更明显。假如还剩下一个字可以输入，你打算输入“好”，当你输入字母“h”之后，发现无法再输入其他拼音字母了。

3.2 为UITextField实例添加监听 UIControlEventEditingChanged，然后对其进一步处理。可以通过在NSNotificationCenter中添加监听，但是还需手动移除，比较繁琐，所以推荐直接使用下面的方法

[textField addTarget:self action:@selector(textFieldDidChange:) forControlEvents:UIControlEventEditingChanged];

- (void)textFieldDidChange:(UITextField *)textField
{
    NSString *toBeString = textField.text;
    
    //获取高亮部分
    UITextRange *selectedRange = [textField markedTextRange];
    UITextPosition *position = [textField positionFromPosition:selectedRange.start offset:0];
    
    // 没有高亮选择的字，则对已输入的文字进行字数统计和限制
    if (!position)
    {
        if (toBeString.length > kMaxLength)
        {
            NSRange rangeIndex = [toBeString rangeOfComposedCharacterSequenceAtIndex:kMaxLength];
            if (rangeIndex.length == 1)
            {
                textField.text = [toBeString substringToIndex:kMaxLength];
            }
            else
            {
                NSRange rangeRange = [toBeString rangeOfComposedCharacterSequencesForRange:NSMakeRange(0, kMaxLength - 1 )];
                textField.text = [toBeString substringWithRange:rangeRange];
            }
        }
    }
}

该方法是对3.1方法的改善，但是仍旧存在不足。
其一，假如限制输入5个中文，你可以尝试在输入5个中文字符之后，将键盘切换为九宫格英文输入模式，快速点击某个字母，看看最后一个中文是否会被替换？
再者，当输入达到限制的字数时，仍旧可以输入拼音字符，只是选中词语之后会被截断，这种体验也不是我们期待的。

4、完美解决方案

对比前面提到的两种方法，可以发现，方法3.1在UITextField文本改变之前调用，方法3.2在UITextField文本改变之后调用，这也导致了它们各自存在一定的缺陷。
那么，有没有一个新的方案，能完美解决这个问题呢?答案是肯定的，也就是同时实现这两个方法，达到兼而有之。

核心代码如下

- (void)textFieldDidChange:(UITextField *)textField
{
    if(_maxLength <= 0){
        return;
    }
    
    NSString *text = textField.text;
    UITextRange *selectedRange = [textField markedTextRange];
    UITextPosition *position = [textField positionFromPosition:selectedRange.start offset:0];
    
    //没有高亮选择的字，则对已输入的文字进行字数统计和限制,防止中文/emoj被截断
    if (!position){
        if (text.length > _maxLength){
            NSRange rangeIndex = [text rangeOfComposedCharacterSequenceAtIndex:_maxLength];
            if (rangeIndex.length == 1){
                textField.text = [text substringToIndex:_maxLength];
            }else{
                if(_maxLength == 1){
                    textField.text = @"";
                }else{
                    NSRange rangeRange = [text rangeOfComposedCharacterSequencesForRange:NSMakeRange(0, _maxLength - 1 )];
                    textField.text = [text substringWithRange:rangeRange];
                }
            }
            
        }
    }
}

#pragma mark -- UITextFieldDelegate
- (BOOL)textField:(UITextField *)textField shouldChangeCharactersInRange:(NSRange)range replacementString:(NSString *)string
{  
    if(_maxLength <= 0){
        return YES;
    }
    
    UITextRange *selectedRange = [textField markedTextRange];//高亮选择的字
    UITextPosition *startPos = [textField positionFromPosition:selectedRange.start offset:0];
    UITextPosition *endPos = [textField positionFromPosition:selectedRange.end offset:0];
    NSInteger markLength = [textField offsetFromPosition:startPos toPosition:endPos];
    
    NSInteger confirmlength =  textField.text.length - markLength - range.length;//已经确认输入的字符长度
    if(confirmlength >= _maxLength ){
        return NO;
    }
    
    NSInteger allowMaxMarkLength = [self allowMaxMarkLength:_maxLength - confirmlength];
    if(markLength > allowMaxMarkLength ){// && string.length > 0){
        return NO;
    }
    return YES;
}
/**
 主要是用于中文输入的场景，可根据需要自定义
 剩余的允许输入的字数较少时，限制拼音字符的输入，提升体验
 */
- (NSInteger)allowMaxMarkLength:(NSInteger)remainLength
{
    NSInteger length = 0;
    if(remainLength > 2){
        length = NSIntegerMax;
    }else if(remainLength > 0){
        length = remainLength * 6;  //一个中文对应的拼音一般不超过6个
    }
    
    return length;
}

首先在shouldChangeCharactersInRange方法中计算得到已经确认输入的文本长度，该长度不包含高亮或者选中的文本。同时计算剩余允许输入的文本长度，通过allowMaxMarkLength来控制允许输入的拼音字符的长度。
最后，在textFieldDidChange方法中，对文本进行截断操作，使得文本长度满足要求。

完整demo可以参看这里

UITextField输入字数限制

1、哪些问题需要考虑？

2、测试用例

3、网上参考做法

4、完美解决方案

猜你喜欢

热点阅读