Android开发中搜索功能的实现

Posted 2023-03-06 邹奇

现在很多的app中都有搜索的功能。也就是说搜索栏下面有一个列表，列表中放的内容可能是游戏，也有可能是其他的内容。这时候，我们可以在搜索框中输入你想要搜索的内容，这时候，下面的列表就会出现你想要的内容。

别担心，实现起来不难，下面是关键的步骤：

---

搜索框及列表界面怎么设计，我在这里就不多说了，因为重点是搜索这个功能的实现，布局界面的话，都可以在xml里面自己好好设计就行了。而我上一篇的博客就介绍了自定义搜索框的一个样式，大家可以参考。

• 首先，显示界面就是一个搜索框（我用的是EditText控件），搜索框下面有一个列表，列表中我简单的添加了几条数据以供测试用。主活动中的代码如下：

package com.example.mysearchview;

import java.util.ArrayList;
import java.util.List;

import android.app.Activity;
import android.os.Bundle;
import android.text.Editable;
import android.text.TextWatcher;
import android.util.Log;
import android.view.View;
import android.widget.AdapterView;
import android.widget.AdapterView.OnItemClickListener;
import android.widget.EditText;
import android.widget.ListView;
import android.widget.Toast;

public class MainActivity extends Activity 

    private EditText et_ss;
    private ListView lsv_ss;
    private List<String> list = new ArrayList<String>();
    boolean isFilter;
    private MyAdapter adapter = null;

    @Override
    protected void onCreate(Bundle savedInstanceState) 
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        setViews();// 控件初始化
        setData();// 给listView设置adapter
        setListeners();// 设置监听
    

    /**
     * 数据初始化并设置adapter
     */
    private void setData() 
        initData();// 初始化数据

        // 这里创建adapter的时候，构造方法参数传了一个接口对象，这很关键，回调接口中的方法来实现对过滤后的数据的获取
        adapter = new MyAdapter(list, this, new FilterListener() 
            // 回调方法获取过滤后的数据
            public void getFilterData(List<String> list) 
                // 这里可以拿到过滤后数据，所以在这里可以对搜索后的数据进行操作
                Log.e("TAG", "接口回调成功");
                Log.e("TAG", list.toString());
                setItemClick(list);
            
        );
        lsv_ss.setAdapter(adapter);
    

    /**
     * 给listView添加item的单击事件
     * @param filter_lists  过滤后的数据集
     */
    protected void setItemClick(final List<String> filter_lists) 
        lsv_ss.setOnItemClickListener(new OnItemClickListener() 
            public void onItemClick(AdapterView<?> parent, View view,
                    int position, long id) 
                // 点击对应的item时，弹出toast提示所点击的内容
                Toast.makeText(MainActivity.this, filter_lists.get(position), Toast.LENGTH_SHORT).show();
            
        );
    

    /**
     * 简单的list集合添加一些测试数据
     */
    private void initData() 
        list.add("看着飞舞的尘埃   掉下来");
        list.add("没人发现它存在");
        list.add("多自由自在");
        list.add("可世界都爱热热闹闹");
        list.add("容不下   我百无聊赖");
        list.add("不应该   一个人 发呆");
        list.add("只有我   守着安静的沙漠");
        list.add("等待着花开");
        list.add("只有我   看着别人的快乐");
    

    private void setListeners() 
        // 没有进行搜索的时候，也要添加对listView的item单击监听
        setItemClick(list);

        /**
         * 对编辑框添加文本改变监听，搜索的具体功能在这里实现
         * 很简单，文本该变的时候进行搜索。关键方法是重写的onTextChanged（）方法。
         */
        et_ss.addTextChangedListener(new TextWatcher() 

            /**
             * 
             * 编辑框内容改变的时候会执行该方法
             */
            @Override
            public void onTextChanged(CharSequence s, int start, int before,
                    int count) 
                // 如果adapter不为空的话就根据编辑框中的内容来过滤数据
                if(adapter != null)
                    adapter.getFilter().filter(s);
                
            

            @Override
            public void beforeTextChanged(CharSequence s, int start, int count,
                    int after) 
                // TODO Auto-generated method stub
            

            @Override
            public void afterTextChanged(Editable s) 
                // TODO Auto-generated method stub
            
        );
    

    /**
     * 控件初始化
     */
    private void setViews() 
        et_ss = (EditText) findViewById(R.id.et_ss);// EditText控件
        lsv_ss = (ListView)findViewById(R.id.lsv_ss);// ListView控件
    

上面的代码，主要就是界面上有一个搜索框，搜索框下面有一个列表。当在搜索框中输入内容的时候，此时下面的列表显示的内容会自动匹配你输入在搜索框中的内容。

如下图所示：

---

• 接下来就是adapter这个类了，这个类我实现了Filterable接口，然后重写了getFilter()方法，在adapter中定义了一个内部类MyFilter继承Filter类，并重写相关方法，实现数据的过滤。代码如下所示：

package com.example.mysearchview;

import java.util.ArrayList;
import java.util.List;

import android.content.Context;
import android.text.TextUtils;
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;

public class MyAdapter extends BaseAdapter implements Filterable 

    private List<String> list = new ArrayList<String>();
    private Context context;
    private MyFilter filter = null;// 创建MyFilter对象
    private FilterListener listener = null;// 接口对象

    public MyAdapter(List<String> list, Context context, FilterListener filterListener) 
        this.list = list;
        this.context = context;
        this.listener = filterListener;
    

    @Override
    public int getCount() 
        // TODO Auto-generated method stub
        return list.size();
    

    @Override
    public Object getItem(int position) 
        // TODO Auto-generated method stub
        return list.get(position);
    

    @Override
    public long getItemId(int position) 
        // TODO Auto-generated method stub
        return position;
    

    @Override
    public View getView(int position, View convertView, ViewGroup parent) 
        ViewHolder holder = null;
        if (convertView == null) 
            convertView = LayoutInflater.from(context).inflate(R.layout.item_listview_ss, null);
            holder = new ViewHolder();
            holder.tv_ss = (TextView) convertView.findViewById(R.id.tv_ss);
            convertView.setTag(holder);
        
        holder = (ViewHolder) convertView.getTag();
        holder.tv_ss.setText(list.get(position));
        return convertView;
    

    /**
     * 自定义MyAdapter类实现了Filterable接口，重写了该方法
     */
    @Override
    public Filter getFilter() 
        // 如果MyFilter对象为空，那么重写创建一个
        if (filter == null) 
            filter = new MyFilter(list);
        
        return filter;
    

    /**
     * 创建内部类MyFilter继承Filter类，并重写相关方法，实现数据的过滤
     * @author 邹奇
     *
     */
    class MyFilter extends Filter 

        // 创建集合保存原始数据
        private List<String> original = new ArrayList<String>();

        public MyFilter(List<String> list) 
            this.original = list;
        

        /**
         * 该方法返回搜索过滤后的数据
         */
        @Override
        protected FilterResults performFiltering(CharSequence constraint) 
            // 创建FilterResults对象
            FilterResults results = new FilterResults();

            /**
             * 没有搜索内容的话就还是给results赋值原始数据的值和大小
             * 执行了搜索的话，根据搜索的规则过滤即可，最后把过滤后的数据的值和大小赋值给results
             * 
             */
            if(TextUtils.isEmpty(constraint))
                results.values = original;
                results.count = original.size();
            else 
                // 创建集合保存过滤后的数据
                List<String> mList = new ArrayList<String>();
                // 遍历原始数据集合，根据搜索的规则过滤数据
                for(String s: original)
                    // 这里就是过滤规则的具体实现【规则有很多，大家可以自己决定怎么实现】
                    if(s.trim().toLowerCase().contains(constraint.toString().trim().toLowerCase()))
                        // 规则匹配的话就往集合中添加该数据
                        mList.add(s);
                    
                
                results.values = mList;
                results.count = mList.size();
            

            // 返回FilterResults对象
            return results;
        

        /**
         * 该方法用来刷新用户界面，根据过滤后的数据重新展示列表
         */
        @Override
        protected void publishResults(CharSequence constraint,
                FilterResults results) 
            // 获取过滤后的数据
            list = (List<String>) results.values;
            // 如果接口对象不为空，那么调用接口中的方法获取过滤后的数据，具体的实现在new这个接口的时候重写的方法里执行
            if(listener != null)
                listener.getFilterData(list);
            
            // 刷新数据源显示
            notifyDataSetChanged();
        

    

    /**
     * 控件缓存类
     * 
     * @author 邹奇
     *
     */
    class ViewHolder 
        TextView tv_ss;
    

上面的代码我都给出了注释，大家可以好好的去理解。

---

细心的同学可能会发现，我在内部类MyFilter里面重写的
protected void publishResults（CharSequence constraint,FilterResults results）｛｝方法里用到了接口里的抽象方法获取过滤后的数据。如下图所示：

这里用到了接口的回调，目的是为了获取过滤后的数据。为什么要写这个方法呢？是因为我刚开始搜索完成后，点击搜索后的数据，但是显示的是原来的数据，那么就是数据源没有变、而这个回调，就是为了解决这个问题的，拿到过滤后的数据源，对新的数据源进行操作即可很好的解决这个问题。

点我下载测试版apk

---

• 最后接口类代码如下，很简单：

package com.example.mysearchview;

import java.util.List;
/**
 * 接口类，抽象方法用来获取过滤后的数据
 * @author 邹奇
 *
 */
public interface FilterListener 
    void getFilterData(List<String> list);// 获取过滤后的数据

接口中定义了一个抽象方法，用来获取数据用的。

---

• 最后，大家通过这篇博客应该能加深对接口回调的理解和应用。希望大家以后遇到问题可以先自己想想解决的办法，然后再结合自己的想法尝试尝试，相信很多问题自己都可以很好的解决。比如上面的：搜索后的数据没有变，点击后还是显示原来的数据。这个问题的解决方法就是一个简单的接口回调解决了。

---

每天进步一点点！加油！