UISearchBar和UISearchController学习使用01

开发中经常要用到搜索框这个控件，如下图所示

很多人不熟悉怎么使用搜索框，本文和大家一起学习系统提供的UISearchBar怎么用，UISearchBar、UISearchController、UISearchContainerViewController、UISearchDisplayController分别是什么，以及该在什么时候使用自定义的搜索框，此篇先研究UISearchBar的使用

1. UISearchBar是什么

UISearchBar和UIButton一样，是系统已经提供给我们使用的用于输入文字进行搜索的一个搜索框，由一个文本框和几个按钮组成，当用户在文本框内输入部分内容之后，程序即可按照指定的规则执行搜索。

UISearchBar使用

最简单的创建方法

UISearchBar *searchBar = [[UISearchBar alloc] initWithFrame:CGRectMake(100, 100, 200, 50)];
[self.view addSubview:searchBar];

效果

UISearchBar效果图

进入UISearchBar头文件，我们解剖一下它的构成

• UISearchBarIcon 枚举类型，用于识别搜索栏中使用的图标的常量。表示UISearchBar相关子控件Icon，可以在设置子控件Icon时使用

    UISearchBarIconSearch, // 搜索图标，放大镜
    UISearchBarIconClear __TVOS_PROHIBITED, // 清除图标，里面有一个X的圆
    UISearchBarIconBookmark __TVOS_PROHIBITED, // 书签图标，打开书图标
    UISearchBarIconResultsList __TVOS_PROHIBITED, // 结果列表图标，名单菱形图标

• UISearchBarStyle 枚举类型，指定搜索栏背景样式。表示UISearchBar样式

    UISearchBarStyleDefault,    // 默认样式，即UISearchBarStyleProminent
    UISearchBarStyleProminent,  // 类似于通讯录搜索栏，搜索栏具有半透明背景，搜索区域不透明。
    UISearchBarStyleMinimal     // 类似于音乐搜索栏，搜索栏没有背景，搜索字段是半透明的。

• 常见的或经常使用的相关属性

  1. @property(nonatomic) UIBarStyle barStyle; 这个属性可以设置searchBar的搜索框的背景风格，枚举如下：

  typedef NS_ENUM(NSInteger, UIBarStyle) {
  UIBarStyleDefault = 0,//默认风格 白色搜索框，多出的背景为灰色暗内容
  UIBarStyleBlack = 1,//黑色风格，黑色背景的白色搜索框
  //下面两个枚举已经被禁用，作用和黑色风格一样
  UIBarStyleBlackOpaque = 1, // Deprecated. Use UIBarStyleBlack
  UIBarStyleBlackTranslucent = 2, // Deprecated. Use UIBarStyleBlack and set the translucent property to YES};
  ```

  2. @property(nullable,nonatomic,weak) id delegate; 设置searchBar的代理，用于搜索时调用一些代理方法
  3. @property(nullable,nonatomic,copy) NSString *text; 设置搜索框中的文字

  4. @property(nullable,nonatomic,copy) NSString *prompt; 在搜索栏顶部显示的单行文本。默认为空，官方解释是在搜索框顶部显示一行文字，其实就是背景文字，上图说明：
     
  5. @property(nullable,nonatomic,copy) NSString *placeholder; 文本字段中没有其他文本时显示的字符串。和其他文本输入控件的placeholder相同，在输入文字时就会消失

  6. @property(nonatomic) BOOL showsBookmarkButton; 是否在搜索框右侧显示一个图书的按钮，默认为NO，YES的效果如下：
     

  7. @property(nonatomic) BOOL showsCancelButton; 是否显示取消按钮，默认为NO，YES的效果如下：
     

  8. @property(nonatomic) BOOL showsSearchResultsButton; 是否显示搜索结果按钮，默认为NO，YES效果如下：
     
  9. @property(nonatomic, getter=isSearchResultsButtonSelected) BOOL searchResultsButtonSelected; 设置搜索结果按钮的选中状态,设为YES，则按钮为选中的蓝色状态
  10. @property (nonatomic, readonly, strong) UITextInputAssistantItem *inputAssistantItem;用于配置键盘快捷键的输入助手,只读属性，不能设置更改
  11. @property(null_resettable, nonatomic,strong) UIColor *tintColor; 设置这个颜色值会影响搜索框中的光标的颜色
  12. @property(nullable, nonatomic,strong) UIColor *barTintColor; 设置这个颜色会影响搜索框的背景颜色
  13. @property (nonatomic) UISearchBarStyle searchBarStyle; 设置搜索框的风格
  14. @property(nonatomic,assign,getter=isTranslucent) BOOL translucent; 设置是否半透明
  15. @property(nullable, nonatomic,copy) NSArray *scopeButtonTitles; 设置选择按钮试图的按钮标题
  16. @property(nonatomic) NSInteger selectedScopeButtonIndex; 设置一个默认的选中按钮
  17. @property(nonatomic) BOOL showsScopeBar; 是否显示搜索栏的附件选择按钮试图，要想显示这个试图，首先要将这个属性设置为YES，之后给按钮数组中添加按钮，使用scopeButtonTitles属性和selectedScopeButtonIndex属性
  18. @property (nullable, nonatomic, readwrite, strong) UIView *inputAccessoryView; 键盘的附属视图
  19. @property(nullable, nonatomic,strong) UIImage *backgroundImage; 设置搜索框的背景图案
  20. @property(nullable, nonatomic,strong) UIImage *scopeBarBackgroundImage; 设置附属选择按钮视图的背景图案
  21. @property(nonatomic) UIOffset searchFieldBackgroundPositionAdjustment; textfield在搜索框中的位置偏移
  22. @property(nonatomic) UIOffset searchTextPositionAdjustment; 搜索文字在搜索框中的位置偏移

• 常见的或经常使用的方法

  1. - (instancetype)init;
- (instancetype)initWithFrame:(CGRect)frame；
     初始化创建方法
  2. - (void)setShowsCancelButton:(BOOL)showsCancelButton animated:(BOOL)animated 带动画设置取消按钮的显示状态
  3. - (void)setBackgroundImage:(nullable UIImage *)backgroundImage forBarPosition:(UIBarPosition)barPosition barMetrics:(UIBarMetrics)barMetrics;
     设置在给定位置和给定度量的背景图像,用于设置某个状态枚举下的搜索框的背景图案
  4. - (nullable UIImage *)backgroundImageForBarPosition:(UIBarPosition)barPosition barMetrics:(UIBarMetrics)barMetrics;
     返回给定位置和给定度量值中用于背景的图像，获取某个状态枚举下的搜索框的背景图案
  5. - (void)setSearchFieldBackgroundImage:(nullable UIImage *)backgroundImage forState:(UIControlState)state;
     设置给定状态搜索文本框图像，用于设置搜索框中TextField的背景图案
  6. - (nullable UIImage *)searchFieldBackgroundImageForState:(UIControlState)state;
     返回给定状态的搜索文本框图像，用于获取搜索框中TextField的背景图案
  7. - (void)setImage:(UIImage *)iconImage forSearchBarIcon:(UISearchBarIcon)icon state:(UIControlState)state ;
- (UIImage *)imageForSearchBarIcon:(UISearchBarIcon)icon state:(UIControlState)state ;
     这一对方法用于获取和设置搜索栏icon图片的图案
  8. - (void)setScopeBarButtonBackgroundImage:(UIImage *)backgroundImage forState:(UIControlState)state;
- (UIImage *)scopeBarButtonBackgroundImageForState:(UIControlState)state;
     这一对方法用于设置和获取搜索框的附加选择按钮视图的背景图案
  9. - (void)setScopeBarButtonDividerImage:(UIImage *)dividerImage forLeftSegmentState:(UIControlState)leftState rightSegmentState:(UIControlState)rightState;
- (UIImage *)scopeBarButtonDividerImageForLeftSegmentState:(UIControlState)leftState rightSegmentState:(UIControlState)rightState;
     这一对方法用于获取和设置附加选择按钮视图中切换按钮的图案
  10. - (void)setScopeBarButtonTitleTextAttributes:(NSDictionary *)attributes forState:(UIControlState)state;
- (NSDictionary *)scopeBarButtonTitleTextAttributesForState:(UIControlState)state;
      这一对方法用于设置和获取切换按钮标题文字的字体属性字典
  11. - (void)setPositionAdjustment:(UIOffset)adjustment forSearchBarIcon:(UISearchBarIcon)icon;
- (UIOffset)positionAdjustmentForSearchBarIcon:(UISearchBarIcon)icon;
      设置和获取搜索栏中图片的位置偏移

• 常见的或经常使用的delegate代理方法

  1. - (BOOL)searchBarShouldBeginEditing:(UISearchBar *)searchBar;
     将要开始编辑时的回调，返回为NO，则不能编辑
  2. - (void)searchBarTextDidBeginEditing:(UISearchBar *)searchBar;
     已经开始编辑时的回调
  3. - (BOOL)searchBarShouldEndEditing:(UISearchBar *)searchBar;
     将要结束编辑时的回调
  4. - (void)searchBarTextDidEndEditing:(UISearchBar *)searchBar;
     已经结束编辑的回调
  5. - (void)searchBar:(UISearchBar *)searchBar textDidChange:(NSString *)searchText;
     编辑文字发生改变的回调
  6. - (BOOL)searchBar:(UISearchBar *)searchBar shouldChangeTextInRange:(NSRange)range replacementText:(NSString *)text
     编辑文字将要改变前的回调，返回NO则不能加入新的编辑文字
  7. - (void)searchBarSearchButtonClicked:(UISearchBar *)searchBar;
     搜索按钮点击的回调
  8. - (void)searchBarBookmarkButtonClicked:(UISearchBar *)searchBar;
     书本按钮点击的回调
  9. - (void)searchBarCancelButtonClicked:(UISearchBar *)searchBar;
     取消按钮点击的回调
  10. - (void)searchBarResultsListButtonClicked:(UISearchBar *)searchBar;
      搜索结果按钮点击的回调
  11. - (void)searchBar:(UISearchBar *)searchBar selectedScopeButtonIndexDidChange:(NSInteger)selectedScope;
      搜索栏的附加试图中切换按钮触发的回调