理解Android SearchView与数据过滤机制
在android应用开发中，searchview是实现搜索功能常用的ui组件。当用户在searchview中输入文本时，我们通常需要对关联的数据集进行过滤，并更新adapter以显示过滤后的结果。这一过程的核心是adapter中的filter类。
Filter类提供了两个关键方法：
- performFiltering(CharSequence constraint): 在后台线程中执行实际的过滤逻辑，接收用户输入的查询字符串（constraint）。
- publishResults(CharSequence constraint, FilterResults results): 在UI线程中发布过滤结果，更新Adapter的数据集并通知视图刷新。
当SearchView在输入空白字符后显示为空白，通常不是SearchView本身的问题，而是Adapter内部Filter实现未能正确处理空白或空查询字符串所致。例如，如果performFiltering方法简单地对查询字符串进行trim()操作，并且在结果为空时返回空列表，那么SearchView就会显示为空。
解决空白字符导致结果为空的问题
问题的根源在于Filter的performFiltering方法对查询字符串的处理逻辑。为了解决这个问题，我们需要确保：
- 对查询字符串进行适当的预处理，例如去除首尾空白。
- 当处理后的查询字符串为空时，应返回原始的完整数据集，而不是空数据集。
下面我们将通过一个具体的代码示例，展示如何实现一个健壮的自定义Filter。
实现健壮的自定义Filter
假设我们有一个MyItem的数据类和一个MyAdapter，它展示MyItem的列表。
// MyItem.java
public class MyItem {
private String name;
private String description;
public MyItem(String name, String description) {
this.name = name;
this.description = description;
}
public String getName() {
return name;
}
public String getDescription() {
return description;
}
@Override
public String toString() {
return name + " - " + description;
}
}现在，我们创建一个MyAdapter并嵌入一个自定义的ItemFilter。
import android.content.Context;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.BaseAdapter;
import android.widget.Filter;
import android.widget.Filterable;
import android.widget.TextView;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
public class MyAdapter extends BaseAdapter implements Filterable {
private List<MyItem> originalData; // 原始完整数据
private List<MyItem> filteredData; // 过滤后的数据
private LayoutInflater inflater;
private ItemFilter itemFilter;
public MyAdapter(Context context, List<MyItem> data) {
this.originalData = new ArrayList<>(data); // 复制一份原始数据，避免修改
this.filteredData = data; // 初始显示全部数据
this.inflater = LayoutInflater.from(context);
}
@Override
public int getCount() {
return filteredData.size();
}
@Override
public Object getItem(int position) {
return filteredData.get(position);
}
@Override
public long getItemId(int position) {
return position;
}
@Override
public View getView(int position, View convertView, ViewGroup parent) {
ViewHolder holder;
if (convertView == null) {
convertView = inflater.inflate(android.R.layout.simple_list_item_2, parent, false);
holder = new ViewHolder();
holder.text1 = convertView.findViewById(android.R.id.text1);
holder.text2 = convertView.findViewById(android.R.id.text2);
convertView.setTag(holder);
} else {
holder = (ViewHolder) convertView.getTag();
}
MyItem item = filteredData.get(position);
holder.text1.setText(item.getName());
holder.text2.setText(item.getDescription());
return convertView;
}
@Override
public Filter getFilter() {
if (itemFilter == null) {
itemFilter = new ItemFilter();
}
return itemFilter;
}
private static class ViewHolder {
TextView text1;
TextView text2;
}
private class ItemFilter extends Filter {
@Override
protected FilterResults performFiltering(CharSequence constraint) {
FilterResults results = new FilterResults();
List<MyItem> suggestions = new ArrayList<>();
if (constraint == null || constraint.length() == 0) {
// 如果查询字符串为空或null，返回原始完整数据
suggestions.addAll(originalData);
} else {
String filterPattern = constraint.toString().toLowerCase(Locale.getDefault()).trim();
// 如果经过trim()后查询字符串仍然为空，也返回原始完整数据
if (filterPattern.isEmpty()) {
suggestions.addAll(originalData);
} else {
for (MyItem item : originalData) {
// 匹配逻辑：可以根据name或description进行匹配
if (item.getName().toLowerCase(Locale.getDefault()).contains(filterPattern) ||
item.getDescription().toLowerCase(Locale.getDefault()).contains(filterPattern)) {
suggestions.add(item);
}
}
}
}
results.values = suggestions;
results.count = suggestions.size();
return results;
}
@Override
protected void publishResults(CharSequence constraint, FilterResults results) {
// 更新 filteredData
filteredData = (List<MyItem>) results.values;
// 通知数据已改变，刷新UI
notifyDataSetChanged();
}
}
}关键点说明：
- originalData的维护：在MyAdapter中，我们维护了一个originalData列表，它始终保存着未经过滤的完整数据集。这是进行过滤的基础。filteredData则保存当前显示的数据。
-
performFiltering中的逻辑：
- 首先检查constraint是否为null或空字符串。如果是，直接将originalData添加到suggestions中。
- 如果constraint不为空，将其转换为小写并使用trim()方法去除首尾空白。
- 重要：再次检查filterPattern是否为空。如果trim()后为空（例如，用户只输入了空格），同样将originalData添加到suggestions中。
- 只有当filterPattern非空时，才执行实际的匹配逻辑，遍历originalData并根据filterPattern筛选匹配项。
- publishResults中的逻辑：简单地将FilterResults中的values赋值给filteredData，然后调用notifyDataSetChanged()来刷新ListView或RecyclerView。
将Filter与SearchView集成
现在，我们来看如何在Activity或Fragment中将SearchView与MyAdapter的Filter机制连接起来。通常，我们会使用SearchView.OnQueryTextListener。
import android.os.Bundle;
import android.widget.ListView;
import androidx.appcompat.app.AppCompatActivity;
import androidx.appcompat.widget.SearchView;
import java.util.ArrayList;
import java.util.List;
public class MainActivity extends AppCompatActivity {
private ListView listView;
private MyAdapter myAdapter;
private SearchView searchView;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main); // 确保activity_main.xml包含ListView和SearchView
listView = findViewById(R.id.listView);
searchView = findViewById(R.id.searchView);
// 准备一些示例数据
List<MyItem> data = new ArrayList<>();
data.add(new MyItem("Apple", "A red fruit"));
data.add(new MyItem("Banana", "A yellow fruit"));
data.add(new MyItem("Orange", "A citrus fruit"));
data.add(new MyItem("Grape", "Small round fruit"));
data.add(new MyItem("Pineapple", "Tropical fruit"));
myAdapter = new MyAdapter(this, data);
listView.setAdapter(myAdapter);
searchView.setOnQueryTextListener(new SearchView.OnQueryTextListener() {
@Override
public boolean onQueryTextSubmit(String query) {
// 用户提交查询时调用
myAdapter.getFilter().filter(query);
return false; // 返回false表示SearchView不会处理该事件，例如关闭键盘
}
@Override
public boolean onQueryTextChange(String newText) {
// 用户输入文本改变时调用
myAdapter.getFilter().filter(newText);
return false; // 返回false表示SearchView不会处理该事件
}
});
}
}在布局文件activity_main.xml中，你需要添加SearchView和ListView：
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical"
tools:context=".MainActivity">
<androidx.appcompat.widget.SearchView
android:id="@+id/searchView"
android:layout_width="match_parent"
android:layout_height="wrap_content"
app:queryHint="搜索水果..."
android:iconifiedByDefault="false" />
<ListView
android:id="@+id/listView"
android:layout_width="match_parent"
android:layout_height="match_parent" />
</LinearLayout>通过上述实现，当用户在SearchView中输入一个或多个空格时，myAdapter.getFilter().filter(newText)会被调用。在ItemFilter的performFiltering方法中，newText会经过trim()处理。如果处理后的字符串为空，Filter会返回完整的originalData，从而避免SearchView显示空白。
注意事项与最佳实践
- 数据源的副本：始终保持一份原始数据的副本 (originalData)，以便在过滤条件清除时能够恢复完整列表。不要直接在原始数据上进行过滤操作。
-
性能优化：对于大型数据集，performFiltering方法可能会执行耗时操作。Filter类本身已在后台线程中执行performFiltering，但如果过滤逻辑非常复杂，可以考虑：
- Debounce：在onQueryTextChange中引入一个小的延迟（例如300ms），避免用户每输入一个字符就立即触发过滤，减少不必要的计算。
- 并行处理：如果数据量巨大，可以考虑使用Java 8 Stream API或更底层的并发工具来加速过滤过程，尽管Filter的performFiltering已在后台线程。
- 大小写不敏感：在进行字符串匹配时，通常需要将查询字符串和数据项都转换为小写（或大写），以实现大小写不敏感的搜索。
- 国际化：使用Locale.getDefault()进行字符串大小写转换，以适应不同的语言环境。
-
用户体验：
- 在SearchView中设置queryHint，引导用户输入。
- 当过滤结果为空时，可以显示一个友好的提示信息（例如“未找到匹配项”），而不是仅仅显示空白。这可以通过在publishResults中检查results.count来实现。
- 清除搜索框时，自动恢复显示所有数据。上述示例已通过filterPattern.isEmpty()处理。
总结
通过对Adapter中Filter机制的深入理解和精细化实现，我们可以有效解决SearchView在输入空白字符后显示为空的问题。关键在于performFiltering方法中对查询字符串的预处理（如trim()）以及对空查询条件的正确处理，确保在无有效搜索条件时返回完整的原始数据集。遵循这些最佳实践，将有助于构建一个功能完善、用户体验良好的搜索功能。
