QMUISearchController 支持“最近搜索”功能

MoLice · MoLice · commit a006c3ddb27d · 2017-03-24T10:50:57.000+08:00
diff --git a/QMUIKit/UIKitExtensions/QMUISearchController.h b/QMUIKit/UIKitExtensions/QMUISearchController.h
@@ -13,19 +13,17 @@
 @class QMUISearchController;
 
 /**
- * 配合QMUISearchController使用的protocol，主要负责两件事情：
+ *  配合 QMUISearchController 使用的 protocol，主要负责两件事情：
  *
- * <ol>
- * <li>响应用户的输入，在搜索框内的文字发生变化后被调用，可在<i>searchController:updateResultsForSearchString:</i>方法内更新搜索结果的数据集，在里面请自行调用<i>[searchController.tableView reloadData]</i></li>
- * <li>渲染最终用于显示搜索结果的UITableView的数据，该tableView的delegate、dataSource均在这里实现</li>
- * </ol>
+ *  1. 响应用户的输入，在搜索框内的文字发生变化后被调用，可在 searchController:updateResultsForSearchString: 方法内更新搜索结果的数据集，在里面请自行调用 [searchController.tableView reloadData]
+ *  2. 渲染最终用于显示搜索结果的 UITableView 的数据，该 tableView 的 delegate、dataSource 均包含在这个 protocol 里
  */
-@protocol QMUISearchControllerDelegate <UITableViewDataSource,UITableViewDelegate>
+@protocol QMUISearchControllerDelegate <UITableViewDataSource, UITableViewDelegate>
 
 @required
 /**
- * 搜索框文字发生变化时的回调，请自行调用 `[tableView reloadData]` 来更新界面。
- * @warning 搜索框文字为空（例如第一次点击搜索框进入搜索状态时，或者文字全被删掉了，或者点击搜索框的×）也会走进来，此时参数searchString为@""，这是为了和系统的UISearchController保持一致
+ *  搜索框文字发生变化时的回调，请自行调用 `[tableView reloadData]` 来更新界面。
+ *  @warning 搜索框文字为空（例如第一次点击搜索框进入搜索状态时，或者文字全被删掉了，或者点击搜索框的×）也会走进来，此时参数searchString为@""，这是为了和系统的UISearchController保持一致
  */
 - (void)searchController:(QMUISearchController *)searchController updateResultsForSearchString:(NSString *)searchString;
 
@@ -40,25 +38,41 @@
 @end
 
 /**
- * 兼容iOS7及以后的版本的searchController，在iOS7下会使用UISearchDisplayController实现，在iOS8及以后会使用UISearchController实现。<br/>
- * 使用方法：
- * <ol>
- * <li>使用<i>initWithContentsViewController:</i>初始化</li>
- * <li>指定<i>searchResultsDelegate</i>属性并在其中实现<i>searchController:updateResultsForSearchString:</i>方法以更新搜索结果数据集</li>
- * <li>通过<i>searchBar</i>属性得到搜索框的引用并直接使用，例如 @code tableHeaderView = searchController.searchBar @endcode</li>
- * </ol>
+ *  兼容 iOS 7 及以后的版本的 searchController，在 iOS7 下会使用 UISearchDisplayController 实现，在 iOS 8 及以后会使用 UISearchController 实现。
+ *  支持在搜索文字为空时（注意并非“搜索结果为空”）显示一个界面，例如常见的“最近搜索”功能，具体请查看属性 launchView。
+ *  使用方法：
+ *  1. 使用 initWithContentsViewController: 初始化
+ *  2. 通过 searchBar 属性得到搜索框的引用并直接使用，例如 `tableHeaderView = searchController.searchBar`
+ *  3. 指定 searchResultsDelegate 属性并在其中实现 searchController:updateResultsForSearchString: 方法以更新搜索结果数据集
+ *
+ *  @note QMUICommonTableViewController 内部自带 QMUISearchController，只需在 QMUITableViewDelegate shouldShowSearchBarInTableView: 方法里返回 YES 即可，无需自行初始化 QMUISearchController。
  */
 @interface QMUISearchController : QMUICommonViewController
 
 /**
- * 在某个指定的UIViewController上创建一个与其绑定的searchController
- * @param viewController 要在哪个viewController上添加搜索功能
+ *  在某个指定的UIViewController上创建一个与其绑定的searchController
+ *  @param viewController 要在哪个viewController上添加搜索功能
  */
 - (instancetype)initWithContentsViewController:(UIViewController *)viewController;
 
-@property(nonatomic,weak) id<QMUISearchControllerDelegate> searchResultsDelegate;
+@property(nonatomic, weak) id<QMUISearchControllerDelegate> searchResultsDelegate;
+
+/// 搜索框，在 iOS 7 下是 QMUISearchBar，在 iOS 8 及以后是 UISearchBar
+@property(nonatomic, strong, readonly) UISearchBar *searchBar;
+
+/// 搜索结果列表，在 iOS 7 下是 UITableView，并且每次进行搜索时指针都会发生变化（系统如此），在 iOS 8 及以后是 QMUITableView
+@property(nonatomic, strong, readonly) UITableView *tableView;
+
+/// 在搜索文字为空时会展示的一个 view，通常用于实现“最近搜索”之类的功能。launchView 最终会被布局为撑满搜索框以下的所有空间。
+@property(nonatomic, strong) UIView *launchView;
 
-@property(nonatomic,strong,readonly) UISearchBar *searchBar;
-@property(nonatomic,strong,readonly) UITableView *tableView;
-@property(nonatomic,assign,readonly) BOOL active;
+/// 控制以无动画的形式进入/退出搜索状态
+@property(nonatomic, assign, getter=isActive) BOOL active;
+
+/**
+ *  控制进入/退出搜索状态
+ *  @param active YES 表示进入搜索状态，NO 表示退出搜索状态
+ *  @param animated 是否要以动画的形式展示状态切换
+ */
+- (void)setActive:(BOOL)active animated:(BOOL)animated;
 @end
diff --git a/QMUIKit/UIKitExtensions/QMUISearchController.m b/QMUIKit/UIKitExtensions/QMUISearchController.m
@@ -14,6 +14,9 @@
 #import "QMUIEmptyView.h"
 #import "UISearchBar+QMUI.h"
 #import "UITableView+QMUI.h"
+#import "NSString+QMUI.h"
+#import "NSObject+QMUI.h"
+#import "UIView+QMUI.h"
 
 BeginIgnoreDeprecatedWarning
 
@@ -41,28 +44,136 @@ - (void)initTableView {
 
 @end
 
-@interface QMUISearchController ()<UISearchResultsUpdating,UISearchControllerDelegate,QMUISearchResultsTableViewControllerDelegate,UISearchDisplayDelegate>
+@interface QMUISearchDisplayController : UISearchDisplayController
 
-// iOS8及以后使用这个
-@property(nonatomic,strong) UISearchController *searchController;
+@property(nonatomic, strong) UIView *customDimmingView;
+@property(nonatomic, copy) void (^dimmingViewVisibleChangedBlock)(BOOL visible);
+@end
+
+@implementation QMUISearchDisplayController
+
+- (void)setActive:(BOOL)visible animated:(BOOL)animated {
+    [super setActive:visible animated:animated];
+    if (self.customDimmingView.superview) {
+        BOOL shouldChangeSize = !CGSizeEqualToSize(self.customDimmingView.frame.size, self.customDimmingView.superview.bounds.size);
+        [UIView qmui_animateWithAnimated:animated duration:[CATransaction animationDuration] animations:^{
+            self.customDimmingView.superview.alpha = visible ? 1 : 0;
+            if (shouldChangeSize) {
+                self.customDimmingView.frame = self.customDimmingView.superview.bounds;
+            }
+        }];
+    }
+}
+
+- (void)setCustomDimmingView:(UIView *)customDimmingView {
+    if (_customDimmingView != customDimmingView) {
+        [_customDimmingView removeFromSuperview];
+    }
+    _customDimmingView = customDimmingView;
+}
+
+- (UIColor *)_dimmingViewColor {
+    if (self.customDimmingView) {
+        BeginIgnorePerformSelectorLeaksWarning
+        UIView *containerView = [self performSelector:NSSelectorFromString(@"_containerView")];
+        EndIgnorePerformSelectorLeaksWarning
+        UIView *superviewOfDimmingView = containerView.subviews.lastObject;
+        UIView *defaultDimmingView = superviewOfDimmingView.subviews.firstObject;
+        if (defaultDimmingView) {
+            defaultDimmingView.alpha = 1;
+            self.customDimmingView.frame = defaultDimmingView.bounds;
+            if (self.customDimmingView.superview != defaultDimmingView) {
+                [defaultDimmingView addSubview:self.customDimmingView];
+            }
+            if (self.dimmingViewVisibleChangedBlock) {
+                self.dimmingViewVisibleChangedBlock(self.isActive);
+            }
+        }
+    }
+    
+    return [self qmui_performSelectorToSuperclass:_cmd];
+}
+
+@end
+
+@interface QMUICustomSearchController : UISearchController
 
-// iOS7及以前使用这个
-@property(nonatomic,strong) UISearchDisplayController *searchDisplayController;
+@property(nonatomic, strong) UIView *customDimmingView;
+@end
+
+@implementation QMUICustomSearchController
+
+- (void)setCustomDimmingView:(UIView *)customDimmingView {
+    if (_customDimmingView != customDimmingView) {
+        [_customDimmingView removeFromSuperview];
+    }
+    _customDimmingView = customDimmingView;
+    
+    self.dimsBackgroundDuringPresentation = !_customDimmingView;
+    if ([self isViewLoaded]) {
+        [self addCustomDimmingView];
+    }
+}
+
+- (void)viewWillAppear:(BOOL)animated {
+    [super viewWillAppear:animated];
+    [self addCustomDimmingView];
+}
+
+- (void)addCustomDimmingView {
+    UIView *superviewOfDimmingView = self.searchResultsController.view.superview;
+    if (self.customDimmingView && self.customDimmingView.superview != superviewOfDimmingView) {
+        [superviewOfDimmingView insertSubview:self.customDimmingView atIndex:0];
+        [self layoutCustomDimmingView];
+    }
+}
+
+- (void)layoutCustomDimmingView {
+    UIView *searchBarContainerView = nil;
+    for (UIView *subview in self.view.subviews) {
+        if ([NSStringFromClass(subview.class) isEqualToString:@"_UISearchBarContainerView"]) {
+            searchBarContainerView = subview;
+            break;
+        }
+    }
+    
+    self.customDimmingView.frame = CGRectInsetEdges(self.customDimmingView.superview.bounds, UIEdgeInsetsMake(searchBarContainerView ? CGRectGetMaxY(searchBarContainerView.frame) : 0, 0, 0, 0));
+}
+
+- (void)viewDidLayoutSubviews {
+    [super viewDidLayoutSubviews];
+    
+    if (self.customDimmingView) {
+        [UIView animateWithDuration:[CATransaction animationDuration] animations:^{
+            [self layoutCustomDimmingView];
+        }];
+    }
+}
+
+@end
+
+@interface QMUISearchController () <UISearchResultsUpdating, UISearchControllerDelegate, QMUISearchResultsTableViewControllerDelegate, UISearchDisplayDelegate>
+
+// iOS 8 及以后使用这个
+@property(nonatomic,strong) QMUICustomSearchController *searchController;
+
+// iOS 7 及以前使用这个
+@property(nonatomic,strong) QMUISearchDisplayController *searchDisplayController;
 @end
 
 @implementation QMUISearchController
 
 - (instancetype)initWithContentsViewController:(UIViewController *)viewController {
-    if (self = [self init]) {
+    if (self = [self initWithNibName:nil bundle:nil]) {
         if (NSStringFromClass([UISearchController class])) {
-            // 将definesPresentationContext置为YES有两个作用：
+            // 将 definesPresentationContext 置为 YES 有两个作用：
             // 1、保证从搜索结果界面进入子界面后，顶部的searchBar不会依然停留在navigationBar上
             // 2、使搜索结果界面的tableView的contentInset.top正确适配searchBar
             viewController.definesPresentationContext = YES;
             
-            QMUISearchResultsTableViewController *viewController = [[QMUISearchResultsTableViewController alloc] init];
-            viewController.delegate = self;
-            self.searchController = [[UISearchController alloc] initWithSearchResultsController:viewController];
+            QMUISearchResultsTableViewController *searchResultsViewController = [[QMUISearchResultsTableViewController alloc] init];
+            searchResultsViewController.delegate = self;
+            self.searchController = [[QMUICustomSearchController alloc] initWithSearchResultsController:searchResultsViewController];
             self.searchController.searchResultsUpdater = self;
             self.searchController.delegate = self;
             _searchBar = self.searchController.searchBar;
@@ -73,7 +184,7 @@ - (instancetype)initWithContentsViewController:(UIViewController *)viewControlle
             [self.searchBar qmui_styledAsQMUISearchBar];
         } else {
             _searchBar = [[QMUISearchBar alloc] init];
-            self.searchDisplayController = [[UISearchDisplayController alloc] initWithSearchBar:self.searchBar contentsController:viewController];
+            self.searchDisplayController = [[QMUISearchDisplayController alloc] initWithSearchBar:self.searchBar contentsController:viewController];
             self.searchDisplayController.delegate = self;
         }
     }
@@ -96,14 +207,26 @@ - (void)setSearchResultsDelegate:(id<QMUISearchControllerDelegate>)searchResults
     }
 }
 
-- (BOOL)active {
+- (BOOL)isActive {
     if (self.searchController) {
         return self.searchController.active;
     } else {
         return self.searchDisplayController.active;
     }
 }
 
+- (void)setActive:(BOOL)active {
+    [self setActive:active animated:NO];
+}
+
+- (void)setActive:(BOOL)active animated:(BOOL)animated {
+    if (self.searchController) {
+        self.searchController.active = active;
+    } else {
+        [self.searchDisplayController setActive:active animated:animated];
+    }
+}
+
 - (UITableView *)tableView {
     if (self.searchController) {
         return ((QMUICommonTableViewController *)self.searchController.searchResultsController).tableView;
@@ -113,7 +236,7 @@ - (UITableView *)tableView {
 }
 
 - (void)removeDefaultEmptyLabelInSearchDisplayController {
-    // 移除UISearchDisplayController自带的“无结果”的label
+    // 移除 UISearchDisplayController 自带的“无结果”的label
     for (UIView *subview in self.searchDisplayController.searchResultsTableView.subviews) {
         if ([subview isKindOfClass:[UILabel class]]) {
             [subview removeFromSuperview];
@@ -123,6 +246,16 @@ - (void)removeDefaultEmptyLabelInSearchDisplayController {
     }
 }
 
+- (void)setLaunchView:(UIView *)dimmingView {
+    _launchView = dimmingView;
+    
+    if (self.searchController) {
+        self.searchController.customDimmingView = _launchView;
+    } else {
+        self.searchDisplayController.customDimmingView = _launchView;
+    }
+}
+
 #pragma mark - QMUIEmptyView
 
 - (void)showEmptyView {
@@ -156,7 +289,7 @@ - (void)showEmptyView {
 
 - (BOOL)layoutEmptyView {
     if ([self.emptyView.superview isKindOfClass:[UITableView class]]) {
-        // iOS7 UISearchDisplayController里，会把emptyView加到searchResultsTableView上，参照showEmptyView里的代码
+        // iOS7 UISearchDisplayController 里，会把emptyView加到searchResultsTableView上，参照showEmptyView里的代码
         UITableView *tableView = (UITableView *)self.emptyView.superview;
         CGSize newEmptyViewSize = CGSizeMake(CGRectGetWidth(tableView.bounds) - UIEdgeInsetsGetHorizontalValue(tableView.contentInset), CGRectGetHeight(tableView.frame) - UIEdgeInsetsGetVerticalValue(tableView.contentInset));
         CGSize oldEmptyViewSize = self.emptyView.frame.size;
