Android ListView用EditText实现搜索功能效果

前言

最近在开发一个IM项目的时候有一个需求就是，好友搜索功能。即在EditText中输入好友名字，ListView列表中动态展示刷选的好友列表。我把这个功能抽取出来了，先贴一下效果图：

分析

在查阅资料以后，发现其实Android中已经帮我们实现了这个功能，如果你的ListView使用的是系统的ArrayAdapter，那么恭喜你，下面的事情就很简单了，你只需要调用下面的代码就可以实现了：   

searchEdittext.addTextChangedListener(new TextWatcher() {
  @Override
  public void onTextChanged(CharSequence cs, int arg1, int arg2, int arg3) {
    // When user change the text
    mAdapter.getFilter().filter(cs);
  }
  
  @Override
  public void beforeTextChanged(CharSequence cs, int arg1, int arg2, int arg3) {
    //
  }
  
  @Override
  public void afterTextChanged(Editable arg0) {
    //
  }
});

你没看错，就一行 mAdapter.getFilter().filter(cs);便可以实现这个搜索功能。不过我相信大多数Adapter都是自定义的，基于这个需求，我去分析了下ArrayAdapter，发现它实现了Filterable接口，那么接下来的事情就比较简单了，就让我们自定的Adapter也去实现Filterable这个接口，不久可以实现这个需求了吗。下面贴出ArrayAdapter中显示过滤功能的关键代码： 

public class ArrayAdapter<T> extends BaseAdapter implements Filterable {
  /**
   * Contains the list of objects that represent the data of this ArrayAdapter.
   * The content of this list is referred to as "the array" in the documentation.
   */
  private List<T> mObjects;
  
  /**
   * Lock used to modify the content of {@link #mObjects}. Any write operation
   * performed on the array should be synchronized on this lock. This lock is also
   * used by the filter (see {@link #getFilter()} to make a synchronized copy of
   * the original array of data.
   */
  private final Object mLock = new Object();
  
  // A copy of the original mObjects array, initialized from and then used instead as soon as
  // the mFilter ArrayFilter is used. mObjects will then only contain the filtered values.
  private ArrayList<T> mOriginalValues;
  private ArrayFilter mFilter;
  
  ...
  
  public Filter getFilter() {
    if (mFilter == null) {
      mFilter = new ArrayFilter();
    }
    return mFilter;
  }

  /**
   * <p>An array filter constrains the content of the array adapter with
   * a prefix. Each item that does not start with the supplied prefix
   * is removed from the list.</p>
   */
  private class ArrayFilter extends Filter {
    @Override
    protected FilterResults performFiltering(CharSequence prefix) {
      FilterResults results = new FilterResults();

      if (mOriginalValues == null) {
        synchronized (mLock) {
          mOriginalValues = new ArrayList<T>(mObjects);
        }
      }

      if (prefix == null || prefix.length() == 0) {
        ArrayList<T> list;
        synchronized (mLock) {
          list = new ArrayList<T>(mOriginalValues);
        }
        results.values = list;
        results.count = list.size();
      } else {
        String prefixString = prefix.toString().toLowerCase();

        ArrayList<T> values;
        synchronized (mLock) {
          values = new ArrayList<T>(mOriginalValues);
        }

        final int count = values.size();
        final ArrayList<T> newValues = new ArrayList<T>();

        for (int i = 0; i < count; i++) {
          final T value = values.get(i);
          final String valueText = value.toString().toLowerCase();

          // First match against the whole, non-splitted value
          if (valueText.startsWith(prefixString)) {
            newValues.add(value);
          } else {
            final String[] words = valueText.split(" ");
            final int wordCount = words.length;

            // Start at index 0, in case valueText starts with space(s)
            for (int k = 0; k < wordCount; k++) {
              if (words[k].startsWith(prefixString)) {
                newValues.add(value);
                break;
              }
            }
          }
        }

        results.values = newValues;
        results.count = newValues.size();
      }

      return results;
    }

    @Override
    protected void publishResults(CharSequence constraint, FilterResults results) {
      //noinspection unchecked
      mObjects = (List<T>) results.values;
      if (results.count > 0) {
        notifyDataSetChanged();
      } else {
        notifyDataSetInvalidated();
      }
    }
  }
}

实现

首先写了一个Model（User）模拟数据

public class User {
  private int avatarResId;
  private String name;

  public User(int avatarResId, String name) {
    this.avatarResId = avatarResId;
    this.name = name;
  }

  public int getAvatarResId() {
    return avatarResId;
  }

  public void setAvatarResId(int avatarResId) {
    this.avatarResId = avatarResId;
  }

  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }
}

自定义一个Adapter（UserAdapter）继承自BaseAdapter，实现了Filterable接口，Adapter一些常见的处理，我都去掉了，这里主要讲讲Filterable这个接口。
 

/**
   * Contains the list of objects that represent the data of this Adapter.
   * Adapter数据源
   */
  private List<User> mDatas;

 //过滤相关
  /**
   * This lock is also used by the filter
   * (see {@link #getFilter()} to make a synchronized copy of
   * the original array of data.
   * 过滤器上的锁可以同步复制原始数据。
   * 
   */
  private final Object mLock = new Object();

  // A copy of the original mObjects array, initialized from and then used instead as soon as
  // the mFilter ArrayFilter is used. mObjects will then only contain the filtered values.
  //对象数组的备份，当调用ArrayFilter的时候初始化和使用。此时，对象数组只包含已经过滤的数据。
  private ArrayList<User> mOriginalValues;
  private ArrayFilter mFilter;

 @Override
  public Filter getFilter() {
    if (mFilter == null) {
      mFilter = new ArrayFilter();
    }
    return mFilter;
  }

写一个ArrayFilter类继承自Filter类，我们需要两个方法：

//执行过滤的方法
 protected FilterResults performFiltering(CharSequence prefix);

//得到过滤结果
 protected void publishResults(CharSequence prefix, FilterResults results);

贴上完整的代码，注释已经写的不能再详细了

 /**
   * 过滤数据的类
   */
  /**
   * <p>An array filter constrains the content of the array adapter with
   * a prefix. Each item that does not start with the supplied prefix
   * is removed from the list.</p>
   * <p/>
   * 一个带有首字母约束的数组过滤器，每一项不是以该首字母开头的都会被移除该list。
   */
  private class ArrayFilter extends Filter {
    //执行刷选
    @Override
    protected FilterResults performFiltering(CharSequence prefix) {
      FilterResults results = new FilterResults();//过滤的结果
      //原始数据备份为空时，上锁，同步复制原始数据
      if (mOriginalValues == null) {
        synchronized (mLock) {
          mOriginalValues = new ArrayList<>(mDatas);
        }
      }
      //当首字母为空时
      if (prefix == null || prefix.length() == 0) {
        ArrayList<User> list;
        synchronized (mLock) {//同步复制一个原始备份数据
          list = new ArrayList<>(mOriginalValues);
        }
        results.values = list;
        results.count = list.size();//此时返回的results就是原始的数据，不进行过滤
      } else {
        String prefixString = prefix.toString().toLowerCase();//转化为小写

        ArrayList<User> values;
        synchronized (mLock) {//同步复制一个原始备份数据
          values = new ArrayList<>(mOriginalValues);
        }
        final int count = values.size();
        final ArrayList<User> newValues = new ArrayList<>();

        for (int i = 0; i < count; i++) {
          final User value = values.get(i);//从List<User>中拿到User对象
//          final String valueText = value.toString().toLowerCase();
          final String valueText = value.getName().toString().toLowerCase();//User对象的name属性作为过滤的参数
          // First match against the whole, non-splitted value
          if (valueText.startsWith(prefixString) || valueText.indexOf(prefixString.toString()) != -1) {//第一个字符是否匹配
            newValues.add(value);//将这个item加入到数组对象中
          } else {//处理首字符是空格
            final String[] words = valueText.split(" ");
            final int wordCount = words.length;

            // Start at index 0, in case valueText starts with space(s)
            for (int k = 0; k < wordCount; k++) {
              if (words[k].startsWith(prefixString)) {//一旦找到匹配的就break，跳出for循环
                newValues.add(value);
                break;
              }
            }
          }
        }
        results.values = newValues;//此时的results就是过滤后的List<User>数组
        results.count = newValues.size();
      }
      return results;
    }

    //刷选结果
    @Override
    protected void publishResults(CharSequence prefix, FilterResults results) {
      //noinspection unchecked
      mDatas = (List<User>) results.values;//此时，Adapter数据源就是过滤后的Results
      if (results.count > 0) {
        notifyDataSetChanged();//这个相当于从mDatas中删除了一些数据，只是数据的变化，故使用notifyDataSetChanged()
      } else {
        /**
         * 数据容器变化 ----> notifyDataSetInValidated

         容器中的数据变化 ----> notifyDataSetChanged
         */
        notifyDataSetInvalidated();//当results.count<=0时，此时数据源就是重新new出来的，说明原始的数据源已经失效了
      }
    }
  }

特别说明

//User对象的name属性作为过滤的参数
 final String valueText = value.getName().toString().toLowerCase();

这个地方是，你要进行搜索的关键字，比如我这里使用的是User对象的Name属性，就是把用户名当作关键字来进行过滤筛选的。这里要根据你自己的具体逻辑来进行设置。

复制代码 代码如下:
if (valueText.startsWith(prefixString) || valueText.indexOf(prefixString.toString()) != -1)

在这里进行关键字匹配，如果你只想使用第一个字符匹配，那么你只需要使用这行代码就可以了：

//首字符匹配
valueText.startsWith(prefixString)

如果你的需求是只要输入的字符出现在ListView列表中，那么该item就要显示出来，那么你就需要这行代码了：

//你输入的关键字包含在了某个item中，位置不做考虑，即可以不是第一个字符 
valueText.indexOf(prefixString.toString()) != -1

这样就完成了一个EditText + ListView实现搜索的功能。我在demo中用两种方法实现了这一效果。第一种是系统的ArrayAdapter实现，第二种是自定义Adapter实现。

demo下载地址：EditSearch_jb51.rar

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。

# edittext实现搜索  # edittext搜索listview  # listview  # edittext  # Android Studio搜索功能(查找功能)及快捷键图文详解  # Android实现搜索功能并本地保存搜索历史记录  # Android自定义View实现搜索框（SearchView）功能  # Android仿简书动态searchview搜索栏效果  # Android百度地图实现搜索和定位及自定义图标绘制并点击时弹出泡泡  # Android搜索框SearchView属性和用法详解  # Android SearchView搜索框组件的使用方法  # Android遍历所有文件夹和子目录搜索文件  # Android搜索框组件SearchView的基本使用方法  # Android实现简单动态搜索功能  # 第一个  # 实现了  # 自定义  # 的是  # 首字母  # 就可以  # 为空  # 搜索功能  # 这行  # 自己的  # 都是  # 你只需要  # 原始数据  # 这一  # 如果你  # 在这里  # 我在  # 你就  # 你要  # 下载地址 

相关文章： 如何高效配置香港服务器实现快速建站？  网站制作怎么样才能赚钱,用自己的电脑做服务器架设网站有什么利弊，能赚钱吗？  ppt制作免费网站有哪些,ppt模板免费下载网站？  建站之星各版本价格是多少？  如何在阿里云虚拟主机上快速搭建个人网站？  Java解压缩zip - 解压缩多个文件或文件夹实例  如何选择最佳自助建站系统？快速指南解析优劣  c# await 一个已经完成的Task会发生什么  如何在宝塔面板创建新站点？  香港服务器网站推广：SEO优化与外贸独立站搭建策略  定制建站模板如何实现SEO优化与智能系统配置？18字教程  小说建站VPS选用指南：性能对比、配置优化与建站方案解析  湖南网站制作公司,湖南上善若水科技有限公司做什么的？  学校建站服务器如何选型才能满足性能需求？  东莞市网站制作公司有哪些,东莞找工作用什么网站好？  行程制作网站有哪些,第三方机票电子行程单怎么开？  设计网站制作公司有哪些,制作网页教程？  如何在腾讯云服务器快速搭建个人网站？  国美网站制作流程,国美电器蒸汽鍋怎么用官方网站？  如何自定义建站之星模板颜色并下载新样式？  如何快速建站并高效导出源代码？  建站主机选哪种环境更利于SEO优化？  建站之星后台密码遗忘或太弱？如何重置与强化？  如何选择适配移动端的WAP自助建站平台？  如何快速生成可下载的建站源码工具？  高性价比服务器租赁——企业级配置与24小时运维服务  高端云建站费用究竟需要多少预算？  h5在线制作网站电脑版下载,h5网页制作软件？  建站之星如何取消后台验证码生成？  网站设计制作企业有哪些,抖音官网主页怎么设置？  车管所网站制作流程,交警当场开简易程序处罚决定书，在交警网站查询不到怎么办？  企业在线网站设计制作流程,想建设一个属于自己的企业网站，该如何去做？  美食网站链接制作教程视频,哪个教做美食的网站比较专业点？  建站之星Pro快速搭建教程：模板选择与功能配置指南  济南专业网站制作公司,济南信息工程学校怎么样？  C#如何在一个XML文件中查找并替换文本内容  招贴海报怎么做,什么是海报招贴？  如何通过西部建站助手安装IIS服务器？  武汉网站制作费用多少,在武汉武昌，建面100平方左右的房子，想装暖气片，费用大概是多少啊？  如何用腾讯建站主机快速创建免费网站？  网页设计网站制作软件,microsoft office哪个可以创建网页？  建站VPS配置与SEO优化指南：关键词排名提升策略  如何快速搭建虚拟主机网站？新手必看指南  C++用Dijkstra(迪杰斯特拉)算法求最短路径  建站之星如何一键生成手机站？  建设网站制作价格,怎样建立自己的公司网站？  淘宝制作网站有哪些,淘宝网官网主页？  网站制作公司排行榜,抖音怎样做个人官方网站  免费网站制作模板下载,除了易企秀之外还有什么H5平台可以制作H5长页面，最好是免费的？  太原网站制作公司有哪些,网约车营运证查询官网？