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

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

<pre class="brush:java;">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) {
//
}
});
</pre>

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

<pre class="brush:java;">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();
  }
}

}
}

</pre>

实现

首先写了一个Model(User)模拟数据

<pre class="brush:java;">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;
}
}

</pre>

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

<pre class="brush:java;">/**

  • 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;
}

</pre>

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

<pre class="brush:java;">//执行过滤的方法
protected FilterResults performFiltering(CharSequence prefix);</pre>

<pre class="brush:java;">//得到过滤结果
protected void publishResults(CharSequence prefix, FilterResults results);</pre>

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

<pre class="brush:java;"> /**

  • 过滤数据的类
    /
    /
    *

  • <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出来的,说明原始的数据源已经失效了
  }
}

}

</pre>

特别说明

<pre class="brush:java;">//User对象的name属性作为过滤的参数
final String valueText = value.getName().toString().toLowerCase();</pre>

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

<a onclick="doCopy('code18366')" id="copybut18366" class="copybut" style="CURSOR: pointer" data="18366"><u>复制代码</u></a>

代码如下:

if (valueText.startsWith(prefixString) || valueText.indexOf(prefixString.toString()) != -1)

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

<pre class="brush:java;">//首字符匹配
valueText.startsWith(prefixString)</pre>

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

<pre class="brush:java;">//你输入的关键字包含在了某个item中,位置不做考虑,即可以不是第一个字符
valueText.indexOf(prefixString.toString()) != -1</pre>

这样就完成了一个EditText + ListView实现搜索的功能。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,716评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,558评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,431评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,127评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,511评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,692评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,915评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,664评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,412评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,616评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,105评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,424评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,098评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,096评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,869评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,748评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,641评论 2 271

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,100评论 18 139
  • 背景 一年多以前我在知乎上答了有关LeetCode的问题, 分享了一些自己做题目的经验。 张土汪:刷leetcod...
    土汪阅读 12,663评论 0 33
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,296评论 18 399
  • 去阿尔比斯山脉的行程实属偶然。 10月28号,看朋友圈才知道当天是农历的九月九,想起去年的九月九我们去葡萄牙的最高...
    罗冬梅Faustina阅读 545评论 5 7
  • 绵长的公路上 有数不清的云 像公主、王子 城堡和白马 我们就要走到 树和树的身边 你给孩子们说 树的背后 就是家 ...
    文艺病阅读 125评论 0 2