『零行程式碼』解決鍵盤遮擋問題（iOS）

關注倉庫，及時獲得更新：iOS-Source-Code-Analyze

Follow: Draveness · Github

這篇文章會對 IQKeyboardManager 自動解決鍵盤遮擋問題的方法進行分析。

最近在專案中使用了 IQKeyboardManager 來解決 UITextField 被鍵盤遮擋的問題，這個框架的使用方法可以說精簡到了極致，只需要將 IQKeyboardManager 加入 Podfile，然後 pod install 就可以了。

這篇文章的題目《零行程式碼解決鍵盤遮擋問題》來自於開源框架的介紹：

Codeless drop-in universal library allows to prevent issues of keyboard sliding up and cover UITextField/UITextView. Neither need to write any code nor any setup required and much more.

因為在專案中使用了 IQKeyboardManager，所以，我想通過閱讀其原始碼來了解這個黑箱是如何工作的。

雖然這個框架的實現的方法是比較簡單的，不過它的實現程式碼不是很容易閱讀，框架因為包含了很多與 UI 有關的實現細節，所以程式碼比較複雜。

架構分析

說是架構分析，其實只是對 IQKeyboardManager 中包含的類以及檔案有一個粗略地瞭解，研究一下這個專案的層級是什麼樣的。

整個專案中最核心的部分就是 IQKeyboardManager 這個類，它負責管理鍵盤出現或者隱藏時檢視移動的距離，是整個框架中最核心的部分。

在這個框架中還有一些用於支援 IQKeyboardManager 的分類，以及顯示在鍵盤上面的 IQToolBar：

使用紅色標記的部分就是 IQToolBar，左側的按鈕可以在不同的 UITextField 之間切換，中間的文字是 UITextField.placeholderText，右邊的 Done 應該就不需要解釋了。

這篇文章會主要分析 IQKeyboardManager 中解決的問題，會用小篇幅介紹包含佔位符（Placeholder） IQTextView 的實現。

IQTextView 的實現

在具體研究如何解決鍵盤遮擋問題之前，我們先分析一下框架中最簡單的一部分 IQTextView 是如何為 UITextView 新增佔位符的。

IQTextView 繼承自 UITextView，它只是在 UITextView 上新增上了一個 placeHolderLabel。

在初始化時，我們會為 UITextViewTextDidChangeNotification 註冊通知：

在每次 UITextView 中的 text 更改時，就會呼叫 refreshPlaceholder 方法更新 placeHolderLabel 的 alpha 值來隱藏或者顯示 label：

IQKeyboardManager

下面就會進入這篇文章的正題：IQKeyboardManager。

如果你對 iOS 開發比較熟悉，可能會發現每當一個類的名字中包含了 manager，那麼這個類可能可能遵循單例模式，IQKeyboardManager 也不例外。

IQKeyboardManager 的初始化

當 IQKeyboardManager 初始化的時候，它做了這麼幾件事情：

1. 監聽有關鍵盤的
   
   Objective-C

   [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(keyboardWillShow:) name:UIKeyboardWillShowNotification object:nil]; [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(keyboardWillHide:) name:UIKeyboardWillHideNotification object:nil]; [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(keyboardDidHide:) name:UIKeyboardDidHideNotification object:nil];

   1 2 3

   [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(keyboardWillShow:) name:UIKeyboardWillShowNotification object:nil]; [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(keyboardWillHide:) name:UIKeyboardWillHideNotification object:nil]; [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(keyboardDidHide:) name:UIKeyboardDidHideNotification object:nil];

2. 註冊與 UITextField 以及 UITextView 有關的通知
   
   Objective-C

   [self registerTextFieldViewClass:[UITextField class] didBeginEditingNotificationName:UITextFieldTextDidBeginEditingNotification didEndEditingNotificationName:UITextFieldTextDidEndEditingNotification]; [self registerTextFieldViewClass:[UITextView class] didBeginEditingNotificationName:UITextViewTextDidBeginEditingNotification didEndEditingNotificationName:UITextViewTextDidEndEditingNotification];

   1 2 3 4 5 6 7

   [self registerTextFieldViewClass:[UITextField class]   didBeginEditingNotificationName:UITextFieldTextDidBeginEditingNotification     didEndEditingNotificationName:UITextFieldTextDidEndEditingNotification];   [self registerTextFieldViewClass:[UITextView class]   didBeginEditingNotificationName:UITextViewTextDidBeginEditingNotification     didEndEditingNotificationName:UITextViewTextDidEndEditingNotification];

   • 呼叫的方法將通知繫結到了 textFieldViewDidBeginEditing: 和 textFieldViewDidEndEditing: 方法上
     
     Objective-C

     - (void)registerTextFieldViewClass:(nonnull Class)aClass didBeginEditingNotificationName:(nonnull NSString *)didBeginEditingNotificationName didEndEditingNotificationName:(nonnull NSString *)didEndEditingNotificationName { [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(textFieldViewDidBeginEditing:) name:didBeginEditingNotificationName object:nil]; [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(textFieldViewDidEndEditing:) name:didEndEditingNotificationName object:nil]; }

     1 2 3 4 5 6

     - (void)registerTextFieldViewClass:(nonnull Class)aClass     didBeginEditingNotificationName:(nonnull NSString *)didBeginEditingNotificationName       didEndEditingNotificationName:(nonnull NSString *)didEndEditingNotificationName {       [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(textFieldViewDidBeginEditing:) name:didBeginEditingNotificationName object:nil];       [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(textFieldViewDidEndEditing:) name:didEndEditingNotificationName object:nil];   }

3. 初始化一個 UITapGestureRecognizer，在點選 UITextField 對應的 UIWindow 的時候，收起鍵盤
   
   Objective-C

   strongSelf.tapGesture = [[UITapGestureRecognizer alloc] initWithTarget:self action:@selector(tapRecognized:)]; - (void)tapRecognized:(UITapGestureRecognizer*)gesture { if (gesture.state == UIGestureRecognizerStateEnded) [self resignFirstResponder]; }

   1 2 3 4 5

   strongSelf.tapGesture = [[UITapGestureRecognizer alloc] initWithTarget:self action:@selector(tapRecognized:)]; - (void)tapRecognized:(UITapGestureRecognizer*)gesture {      if (gesture.state == UIGestureRecognizerStateEnded)          [self resignFirstResponder]; }

4. 初始化一些預設屬性，例如鍵盤距離、覆寫鍵盤的樣式等
   
   Objective-C

   strongSelf.animationDuration = 0.25; strongSelf.animationCurve = UIViewAnimationCurveEaseInOut; [self setKeyboardDistanceFromTextField:10.0]; [self setShouldPlayInputClicks:YES]; [self setShouldResignOnTouchOutside:NO]; [self setOverrideKeyboardAppearance:NO]; [self setKeyboardAppearance:UIKeyboardAppearanceDefault]; [self setEnableAutoToolbar:YES]; [self setPreventShowingBottomBlankSpace:YES]; [self setShouldShowTextFieldPlaceholder:YES]; [self setToolbarManageBehaviour:IQAutoToolbarBySubviews]; [self setLayoutIfNeededOnUpdate:NO];

   1 2 3 4 5 6 7 8 9 10 11 12

   strongSelf.animationDuration = 0.25; strongSelf.animationCurve = UIViewAnimationCurveEaseInOut; [self setKeyboardDistanceFromTextField:10.0]; [self setShouldPlayInputClicks:YES]; [self setShouldResignOnTouchOutside:NO]; [self setOverrideKeyboardAppearance:NO]; [self setKeyboardAppearance:UIKeyboardAppearanceDefault]; [self setEnableAutoToolbar:YES]; [self setPreventShowingBottomBlankSpace:YES]; [self setShouldShowTextFieldPlaceholder:YES]; [self setToolbarManageBehaviour:IQAutoToolbarBySubviews]; [self setLayoutIfNeededOnUpdate:NO];

5. 設定不需要解決鍵盤遮擋問題的類
   
   Objective-C

   strongSelf.disabledDistanceHandlingClasses = [[NSMutableSet alloc] initWithObjects:[UITableViewController class], nil]; strongSelf.enabledDistanceHandlingClasses = [[NSMutableSet alloc] init]; strongSelf.disabledToolbarClasses = [[NSMutableSet alloc] init]; strongSelf.enabledToolbarClasses = [[NSMutableSet alloc] init]; strongSelf.toolbarPreviousNextAllowedClasses = [[NSMutableSet alloc] initWithObjects:[UITableView class],[UICollectionView class],[IQPreviousNextView class], nil]; strongSelf.disabledTouchResignedClasses = [[NSMutableSet alloc] init]; strongSelf.enabledTouchResignedClasses = [[NSMutableSet alloc] init];

   1 2 3 4 5 6 7 8 9 10

   strongSelf.disabledDistanceHandlingClasses = [[NSMutableSet alloc] initWithObjects:[UITableViewController class], nil]; strongSelf.enabledDistanceHandlingClasses = [[NSMutableSet alloc] init];   strongSelf.disabledToolbarClasses = [[NSMutableSet alloc] init]; strongSelf.enabledToolbarClasses = [[NSMutableSet alloc] init];   strongSelf.toolbarPreviousNextAllowedClasses = [[NSMutableSet alloc] initWithObjects:[UITableView class],[UICollectionView class],[IQPreviousNextView class], nil];   strongSelf.disabledTouchResignedClasses = [[NSMutableSet alloc] init]; strongSelf.enabledTouchResignedClasses = [[NSMutableSet alloc] init];

   
   整個初始化方法大約有幾十行的程式碼，在這裡就不再展示整個方法的全部程式碼了。

基於通知的解決方案

在這裡，我們以 UITextField 為例，分析方法的呼叫流程。

在初始化方法中，我們註冊了很多的通知，包括鍵盤的出現和隱藏，UITextField 開始編輯與結束編輯。

在這些通知響應時，會執行以下的方法：

Notification	Selector
UIKeyboardWillShowNotification	@selector(keyboardWillShow:)
UIKeyboardWillHideNotification	@selector(keyboardWillHide:)
UIKeyboardDidHideNotification	@selector(keyboardDidHide:)
UITextFieldTextDidBeginEditingNotification	@selector(textFieldViewDidBeginEditing:)
UITextFieldTextDidEndEditingNotification	@selector(textFieldViewDidEndEditing:)

開啟 Debug 模式

在閱讀原始碼的過程中，我發現 IQKeyboardManager 提供了 enableDebugging 這一屬性，可以通過開啟它，來追蹤方法的呼叫，我們可以在 Demo 加入下面這行程式碼：

鍵盤的出現

然後執行工程，在 Demo 中點選一個 UITextField

上面的操作會列印出如下所示的 Log：

我們可以通過分析 - textFieldViewDidBeginEditing: 以及 - keyboardWillShow: 方法來了解這個專案的原理。

textFieldViewDidBeginEditing:

當 UITextField 被點選時，方法 - textFieldViewDidBeginEditing: 被呼叫，但是注意這裡的方法並不是代理方法，它只是一個跟代理方法同名的方法，根據 Log，它做了三件事情：

• 為 UITextField 新增 IQToolBar
• 在調整 frame 前，儲存當前 frame，以備之後鍵盤隱藏後的恢復
• 呼叫 - adjustFrame 方法，將檢視移動到合適的位置

新增 ToolBar

新增 ToolBar 是通過方法 - addToolbarIfRequired 實現的，在 - textFieldViewDidBeginEditing: 先通過 - privateIsEnableAutoToolbar 判斷 ToolBar 是否需要新增，再使用相應方法 - addToolbarIfRequired 實現這一目的。

這個方法會根據根檢視上 UITextField 的數量執行對應的程式碼，下面為一般情況下執行的程式碼：

在鍵盤上的 IQToolBar 一般由三部分組成：

• 切換 UITextField 的箭頭按鈕
• 指示當前 UITextField 的 placeholder
• Done Button

這些 item 都是 IQBarButtonItem 的子類

這些 IQBarButtonItem 以及 IQToolBar 都是通過方法 - addPreviousNextDoneOnKeyboardWithTarget:previousAction:nextAction:doneAction: 或者類似方法新增的：

上面是方法簡化後的實現程式碼，初始化需要的 IQBarButtonItem，然後將這些 IQBarButtonItem 全部加入到 IQToolBar 上，最後設定 UITextField 的 accessoryView。

儲存 frame

這一步的主要目的是為了在鍵盤隱藏時恢復到原來的狀態，其實現也非常簡單：

獲取 topMostController，在 _topViewBeginRect 中儲存 frame。

adjustFrame

在上述的任務都完成之後，最後就需要呼叫 - adjustFrame 方法來調整當前根試圖控制器的 frame 了：

我們只會研究一般情況下的實現程式碼，因為這個方法大約有 400 行程式碼對不同情況下的實現有不同的路徑，包括有 lastScrollView、含有 superScrollView 等等。

而這裡會省略絕大多數情況下的實現程式碼。

方法 - adjustFrame 的工作分為兩部分：

1. 計算 move 的距離
2. 呼叫 - setRootViewFrame: 方法設定 rootView 的大小
   
   Objective-C

   - (void)setRootViewFrame:(CGRect)frame { UIViewController *controller = [_textFieldView topMostController]; frame.size = controller.view.frame.size; [UIView animateWithDuration:_animationDuration delay:0 options:(_animationCurve|UIViewAnimationOptionBeginFromCurrentState) animations:^{ [controller.view setFrame:frame]; } completion:NULL]; }

   1 2 3 4 5 6 7 8

   - (void)setRootViewFrame:(CGRect)frame {      UIViewController *controller = [_textFieldView topMostController];          frame.size = controller.view.frame.size;        [UIView animateWithDuration:_animationDuration delay:0 options:(_animationCurve|UIViewAnimationOptionBeginFromCurrentState) animations:^{          [controller.view setFrame:frame];      } completion:NULL]; }

不過，在 - textFieldViewDidBeginEditing: 的呼叫棧中，並沒有執行 - setRootViewFrame: 來更新檢視的大小，因為點選最上面的 UITextField 時，不需要移動檢視就能保證鍵盤不會遮擋 UITextField。

keyboardWillShow:

上面的程式碼都是在鍵盤出現之前執行的，而這裡的 - keyboardWillShow: 方法的目的是為了保證鍵盤出現之後，依然沒有阻擋 UITextField。

因為每一個 UITextField 對應的鍵盤大小可能不同，所以，這裡通過檢測鍵盤大小是否改變，來決定是否呼叫 - adjustFrame 方法更新檢視的大小。

在 - adjustFrame 方法呼叫之前，執行了很多程式碼都是用來儲存一些關鍵資訊的，比如通知物件、動畫曲線、動畫時間。

最關鍵的是更新鍵盤的大小，然後比較鍵盤的大小 CGSizeEqualToSize(_kbSize, oldKBSize) 來判斷是否執行 - adjustFrame 方法。

因為 - adjustFrame 方法的結果是依賴於鍵盤大小的，所以這裡對 - adjustFrame 是有意義並且必要的。

鍵盤的隱藏

通過點選 IQToolBar 上面的 done 按鈕，鍵盤就會隱藏：

鍵盤隱藏的過程中會依次呼叫下面的三個方法：

• - keyboardWillHide:
• - textFieldViewDidEndEditing:
• - keyboardDidHide:

鍵盤在收起時，需要將檢視恢復至原來的位置，而這也就是 – keyboardWillHide: 方法要完成的事情：

並不會給出該方法的全部程式碼，只會給出關鍵程式碼梳理它的工作流程。

在重新設定檢視的大小以及位置之後，會對之前儲存的屬性進行清理：

而之後呼叫的兩個方法 - textFieldViewDidEndEditing: 以及 - keyboardDidHide: 也只做了很多簡單的清理工作，包括新增到 window 上的手勢，並重置儲存的 UITextField 和檢視的大小。

UITextField 和 UITextView 通知機制

因為框架的功能是基於通知實現的，所以通知的時序至關重要，在 IQKeyboardManagerConstants.h 檔案中詳細地描述了在編輯 UITextField 的過程中，通知觸發的先後順序。

上圖準確說明了通知發出的時機，透明度為 50% 的部分表示該框架沒有監聽這個通知。

而 UITextView 的通知機制與 UITextField 略有不同：

當 Begin Editing 這個事件發生時，UITextView 的通知機制會先發出 UIKeyboardWillShowNotification 通知，而 UITextField 會先發出 UITextFieldTextDidBeginEditingNotification 通知。

而這兩個通知的方法都呼叫了 - adjustFrame 方法來更新檢視的大小，最開始我並不清楚到底是為什麼？直到我給作者發了一封郵件，作者告訴我這麼做的原因：

Good questions draveness. I’m very happy to answer your questions. There is a file in library IQKeyboardManagerConstants.h. You can find iOS Notification mechanism structure.

You’ll find that for UITextField, textField notification gets fire first and then UIKeyboard notification fires.

For UITextView, UIKeyboard notification gets fire first and then UITextView notification get’s fire.

So that’s why I have to call adjustFrame at both places to fulfill both situations. But now I think I should add some validation and make sure to call it once to improve performance.

Let me know if you have some more questions, I would love to answer them. Thanks again to remind me about this issue.

在不同方法中呼叫通知的原因是，UITextView 和 UITextField 通知機制的不同，不過作者可能會在未來的版本中修復這一問題，來獲得效能上的提升。

小結

IQKeyboardManager 使用通知機制來解決鍵盤遮擋輸入框的問題，因為使用了分類並且在 IQKeyboardManager 的 + load 方法中啟用了框架的使用，所以達到了零行程式碼解決這一問題的效果。

雖然 IQKeyboardManager 很好地解決了這一問題、為我們帶來了良好的體驗。不過，由於其涉及 UI 層級；並且需要考慮非常多的邊界以及特殊條件，框架的程式碼不是很容易閱讀，但是這不妨礙 IQKeyboardManager 成為非常優秀的開源專案。

關注倉庫，及時獲得更新：iOS-Source-Code-Analyze

Follow: Draveness · Github

原文連結: http://draveness.me/keyboard/