进阶

• 使用默认的键盘配置方式
• 设置拉取键位数据的网络接口实现
• 设置键位数据的更新频率接口
• 自定义键位数据供应者接口
  • 键位数据的组装规则
• 自定义键位布局
  • 键位的行距和间距配置
  • 键位的配置
• UI 自定义设置
• 密码检测
  • 弱密码检测
  • 两次密码一致性检测
  • 其他数据模型

使用默认的键盘配置方式

无需额外配置，直接使用 UI 控件：

设置拉取键位数据的网络接口实现

/// 设置网络拉取键位数据接口实现
+ (void)setFetchRemoteConfigDataNetHelper:(id<TMFSKGetKeyPositionNetHelper>)helper;

TMFSKGetKeyPositionNetHelper网络接口协议定义：

/// 定义网络拉取键位数据的回调
typedef void(^SKGetKeyPositionCallback)(SKSCGetKeyPosition *resp);

/// 定义网络拉取键位数据的接口
@protocol TMFSKGetKeyPositionNetHelper <NSObject, NSCopying>

/// 设置网络请求的数据结构
- (void)setRequest:(SKCSGetKeyPosition *)requestDataModel;

/// 执行网络拉取接口
- (void)execute;

/// 拉取结果回调
- (void)setCallback:(nullable SKGetKeyPositionCallback)callback;

@end

网络接口方法说明：

网络接口参数说明：

shark网关的网络请求键位数据实现举例：

#import "TMFSKGetKeyPositionNetHelper.h"

@interface SKGetKeyDataImpl : NSObject <TMFSKGetKeyPositionNetHelper>

@end

#import "SKGetKeyDataImpl.h"
#import "SKKeyboardPosition.h"

@interface SKGetKeyDataImpl ()
@property (atomic, strong)  SKCSGetKeyPosition * requestData;
@property (atomic, copy)  SKGetKeyPositionCallback callbackRef;
@end

@implementation SKGetKeyDataImpl

- (void)setRequest:(SKCSGetKeyPosition *)requestDataModel
{
    self.requestData = requestDataModel;
}

- (void)setCallback:(SKGetKeyPositionCallback)callback
{
    self.callbackRef = callback;
}

- (void)execute
{
    // 从网络获取 SKSCGetKeyPosition *resp 对象并调用block
    if (self.callbackRef) {
        self.callbackRef(resp);
    }
}

@end

设置键位数据的更新频率接口

切换安全键盘使用会话或者同一个使用会话超过5分钟，则会重新刷新键盘布局。

/// 自定义键位数据更新频率，更新包括：从网上重新拉取或者，键位数据重新乱序等
+ (void)setUpdateKeyPositionFrequency:(NSInteger)frequency;

自定义键位数据供应者接口

键位数据类型说明：

SKEPrimaryKeyCode对键盘按键的操作码进行了统一定义：

SKEPrimaryKeyCode_EPKC_SHIFT = -1; // 功能类型按键：切换大小写
SKEPrimaryKeyCode_EPKC_MODE_CHANGE_NUMBER = -2; // 功能类型按键：切换到数字键盘
SKEPrimaryKeyCode_EPKC_MODE_CHANGE_LETTER = -3; // 功能类型按键：切换到字母键盘
SKEPrimaryKeyCode_EPKC_MODE_CHANGE_SYMBOL = -4; // 功能类型按键：切换到符号键盘
SKEPrimaryKeyCode_EPKC_CANCEL = -5; // 功能类型按键：取消输入
SKEPrimaryKeyCode_EPKC_DONE = -6; // 功能类型按键：输入完成
SKEPrimaryKeyCode_EPKC_DELETE = -7; // 功能类型按键：删除
SKEPrimaryKeyCode_EPKC_COLLAPSE = -8; // 功能类型按键：点击收起
SKEPrimaryKeyCode_EPKC_INPUT = 0; // 可输入类型按键

具体按键区域划分如下图（数字键盘为例）：

/// 自定义键位数据供应者
/// @param positionProvider 键位数据供应者自定义实现，需要提供完整的键盘数据
- (void)customKeyPositionProvider:(TMFSKAbstractKeyPositionProvider *)positionProvider;

接口参数说明：

TMFSKAbstractKeyPositionProvider 抽象类的接口说明

TMFSKDefaultKeyPositionProvider 的实现

#import "TMFSKAbstractKeyPositionProvider.h"

@interface TMFSKDefaultKeyPositionProvider : TMFSKAbstractKeyPositionProvider

@end

#import "TMFSKDefaultKeyPositionProvider.h"

@implementation TMFSKDefaultKeyPositionProvider

- (NSArray<SKKeyPosition *> *)provideLetterKeyBoardPositions
{
    BOOL needRefresh = NO;

    @synchronized (mLetters)
    {
        if (mLetters.count == 0)
        {
            needRefresh = YES;
        }
    }

    if (needRefresh)
    {
        NSMutableArray *ret = [self internalLetterKeyboardData];

        if (mShuffleLetterKeyPosition)
        {
            [self shuffleArray:ret];
        }
        [self appendFnKeyItemForLetterKeyboard:ret];

        @synchronized (mLetters)
        {
            [mLetters removeAllObjects];
            [mLetters addObjectsFromArray:ret];
        }
    }
    return mLetters.copy;
}

- (NSArray<SKKeyPosition *> *)provideNumberKeyBoardPositions
{
    BOOL needRefresh = NO;

    @synchronized (mNumbers)
    {
        if (mNumbers.count == 0)
        {
            needRefresh = YES;
        }
    }

    if (needRefresh)
    {
        NSMutableArray *ret = [self internalNumberKeyboardData];

        if (mShuffleNumberKeyPosition)
        {
            [self shuffleArray:ret];
        }
        [self appendFnKeyItemForNumberKeyboard:ret];

        @synchronized (mNumbers)
        {
            [mNumbers removeAllObjects];
            [mNumbers addObjectsFromArray:ret];
        }
    }
    return mNumbers.copy;
}

- (NSArray<SKKeyPosition *> *)provideSymbolKeyBoardPositions
{
    BOOL needRefresh = NO;

    @synchronized (mSymbols)
    {
        if (mSymbols.count == 0)
        {
            needRefresh = YES;
        }
    }

    if (needRefresh)
    {
        NSMutableArray *ret = [self internalSymbolKeyboardData];

        if (mShuffleSymbolKeyPosition)
        {
            [self shuffleArray:ret];
        }
        [self appendFnKeyItemForSymbolKeyboard:ret];

        @synchronized (mSymbols)
        {
            [mSymbols removeAllObjects];
            [mSymbols addObjectsFromArray:ret];
        }
    }
    return mSymbols.copy;
}

#pragma mark 默认为QWERTY键位布局
- (NSMutableArray <SKKeyPosition *> *)internalLetterKeyboardData
{
    const NSString *letters     = @"qwertyuiopasdfghjklzxcvbnm";

    NSMutableArray *keys        = NSMutableArray.new;
    NSMutableArray *chars       = [self charArrayFromString:letters];
    NSMutableArray *values      = [self getMagicCodeArray:chars shuffle:NO];

    if (chars.count != values.count)
    {
        assert(NO);
        return nil;
    }

    for (NSInteger i = 0; i < chars.count; i++)
    {
        NSString *letter    = chars[i];
        NSString *magicChar = values[i];

        SKKeyPosition *key  =
        [SKKeyPosition keyPositionWithPrimaryKey:SKPrimaryKeyCodeInput displayText:letter];

        [key setMagicCharWithLowercaseText:magicChar
                             uppercaseText:magicChar.uppercaseString];

        [keys addObject:key];
    }
    return keys;
}


#pragma mark 生成数字键盘可输入键位的数据
- (NSMutableArray <SKKeyPosition *> *)internalNumberKeyboardData
{
    const NSString *numberText  = @"1234567890";

    NSMutableArray *keys        = NSMutableArray.new;
    NSMutableArray *chars       = [self charArrayFromString:numberText];
    NSMutableArray *values      = [self getMagicCodeArray:chars shuffle:NO];

    if (chars.count != values.count)
    {
        assert(NO);
        return nil;
    }

    for (NSInteger i = 0; i < chars.count; i++)
    {
        NSString *text      = chars[i];
        NSString *magicChar = values[i];

        SKKeyPosition *key  =
        [SKKeyPosition keyPositionWithPrimaryKey:SKPrimaryKeyCodeInput displayText:text];

        [key setMagicCharWithLowercaseText:magicChar
                             uppercaseText:magicChar];

        [keys addObject:key];
    }
    return keys;
}

#pragma mark 假如是身份类型，加入X
- (void)appendFnKeyItemForNumberKeyboard:(NSMutableArray<SKKeyPosition *> *)keys
{
    [super appendFnKeyItemForNumberKeyboard:keys];

    if (mCurrInputType == SKInputTypeChinaIDCard)
    {
        SKKeyPosition *key = [SKKeyPosition keyPositionWithPrimaryKey:SKPrimaryKeyCodeInput displayText:@"X"];

        [key setDisplayLowercaseText:@"X"
                displayUppercaseText:@"X"];

        [key setMagicCharWithLowercaseText:@"X"
                             uppercaseText:@"X"];

        [keys addObject:key];
    }
}

#pragma mark 生成符号键盘可输入的键位的数据
- (NSMutableArray <SKKeyPosition *> *)internalSymbolKeyboardData
{
    const NSString *symbolText  = @"_\\{}[]^*+=-/:;()$&@\"#%.,<>?!'";
    // @"[]{}#%^*+=-/<>()$&@\".,:;?!'_ \\"; // 更贴近iOS原生键盘

    NSMutableArray *keys        = NSMutableArray.new;
    NSMutableArray *chars       = [self charArrayFromString:symbolText];
    NSMutableArray *values      = [self getMagicCodeArray:chars shuffle:NO];

    if (chars.count != values.count)
    {
        assert(NO);
        return nil;
    }

    for (NSInteger i = 0; i < chars.count; i++)
    {
        NSString *text      = chars[i];
        NSString *magicChar = values[i];

        SKKeyPosition *key  =
        [SKKeyPosition keyPositionWithPrimaryKey:SKPrimaryKeyCodeInput displayText:text];

        [key setMagicCharWithLowercaseText:magicChar
                             uppercaseText:magicChar];

        [keys addObject:key];
    }
    return keys;
}

#pragma mark 打乱数组排序
- (void)shuffleArray:(NSMutableArray *)array
{
    if (array == nil ||
        [array isKindOfClass:[NSMutableArray class]] == NO ||
        array.count == 0)
    {
        return;
    }

    for (NSInteger i = array.count; i > 1; i--)
    {
        uint64_t swapIndex  = 0;
        if (SecRandomCopyBytes(kSecRandomDefault, sizeof(uint64_t), &swapIndex) == errSecSuccess)
        {
            swapIndex           = swapIndex % i;
            id swapVaule        = array[i - 1];
            array[i - 1]        = array[swapIndex];
            array[swapIndex]    = swapVaule;
        }
        else
        {
            // error!!!
        }
    }
}

#pragma mark 字符串转字符数组
- (NSMutableArray <NSString *>*)charArrayFromString:(const NSString *)string
{
    NSMutableArray *chars = [NSMutableArray array];

    for (NSInteger i = 0; i < string.length; i++)
    {
        [chars addObject:[string substringWithRange:NSMakeRange(i, 1)]];
    }

    return chars;
}

- (NSMutableArray *)getMagicCodeArray:(NSArray *)chars shuffle:(BOOL)shuffle
{
    if (chars == nil || chars.count == 0)
    {
        return nil;
    }

    NSMutableArray *values  = chars.mutableCopy;

    if (shuffle)
    {
        [self shuffleArray:values];
        return values;
    }
    else
    {
        return values;
    }
}

@end

SKKeyPosition 的接口说明

键位数据类

键位数据的组装规则

以数字键盘为例，接口- (NSArray <SKKeyPosition *>*)provideSymbolKeyBoardPositions;返回的list元素组成及排序（红色标）如下：

元素组装原则：

• 每行从左到右，到边换行。
• 遇到跨行键位，换行。

自定义键位布局

键位的行距和间距配置

在 使用 > 安全键盘控件标准集成方式 已经提到，键盘的 UI 控件需要配合TMFSafeKeyboardWrapper，里面提供了众多键盘UI自定义的接口，其中键位的行距和间距也是通过这个包装类的接口实现的：

键位的配置

出于autolayout自适应分辨率的需要，键位的布局配置采用权重和屏幕百分比的数据标注方式。

键位布局采用按行布局的方式，键位布局的数据结构为KeyboardLayoutRow：

以数字键盘布局为例，请留意标注内容：

布局规则：

• 每行从左到右，到边换行。
• 遇到跨行键位，换行。

从上图可以看到，第一行有四个键位，存在一个跨行按键，因而第二行只布局了三个，第三行同第一行，第四行同第二行。

UI 自定义设置

除了上述自定设置之外，还提供了更多键位样式自定义设置，具体如下图：

TMFSafeKeyboardWrapper提供的具体接口说明如下：

密码检测

弱密码检测

TMFSafeKeyboardCheckApi

调用示例

         TMFSafeKeyboardCheckContent *content1 = [TMFSafeKeyboardCheckContent contentWithText:_passwordTextF.text context:_passwordTextF.safeKeyboardWrapper.context];

    [TMFSafeKeyboardCheckApi textWeakCheckForContent:content1 passwordStrength:pwdStrength repeatNumber:repeatNum completion:^(BOOL pass, NSError * _Nullable error) {
        NSLog(@"[TMFSafeKeyboard-Check]%d, %@", pass, error);
        [self showAlertTitle:pass?@"通过":@"失败" msg:[NSString stringWithFormat:@"输入框1弱密码%@",pass?@"通过":@"失败"]];
    }];

两次密码一致性检测

TMFSafeKeyboardCheckApi

调用示例

         TMFSafeKeyboardCheckContent *content1 = [TMFSafeKeyboardCheckContent contentWithText:_passwordTextF.text context:_passwordTextF.safeKeyboardWrapper.context];
    TMFSafeKeyboardCheckContent *content2 = [TMFSafeKeyboardCheckContent contentWithText:_repeatPasswordTextF.text context:_repeatPasswordTextF.safeKeyboardWrapper.context];

    [TMFSafeKeyboardCheckApi textDoubleCheckForContent:content1 secondContent:content2 passwordStrength:pwdStrength repeatNumber:repeatNum completion:^(BOOL pass, NSError * _Nullable error) {
        NSLog(@"[TMFSafeKeyboard-Check2]%d, %@", pass, error);
        NSString *message;
        if (error && error.code == 7) {
           message = @"两次密码输入不一致";
        } else if (!error && pass == NO) {
            message = @"弱密码";
        }
        [self showAlertTitle:pass?@"通过":@"失败" msg:message];
   }];

其他数据模型

TMFSafeKeyboardCheckContent

• 创建方法

+ (instancetype)contentWithText:(NSString *)text
                        context:(NSData *)context;

TMFKeyboardTextCheckStrength

TMFSafeKeyboardCheckCompletion