Android两种方式实现延迟搜索

每个应用都有搜索功能,通常我们在进行搜索时,只要是输入框输入了内容就要执行搜索请求,这样会产生很多次无意义的接口请求,同时用户体验也非常差。遇到这种情况我们的一般的解决思路是:当输入内容超过设定的时间间隔将执行搜索,否则不执行。

需要依赖的类:

YqTextChangeListener.kt
/**
 * Created by wangkai on 2021/01/30 10:31

 * Desc TextView事件监听
 */
open class YqTextChangeListener : TextWatcher {
    override fun afterTextChanged(s: Editable?) {
        logger {
            "afterTextChanged s=$s"
        }
    }

    override fun beforeTextChanged(s: CharSequence?, start: Int, count: Int, after: Int) {
        logger {
            "beforeTextChanged s=$s; start=$start; after=$after; count=$count"
        }
    }

    override fun onTextChanged(s: CharSequence?, start: Int, before: Int, count: Int) {
        logger {
            "onTextChanged s=$s; start=$start; before=$before; count=$count"
        }
    }

}
LifecycleOwerExt.kt

/**
 * Context 用于返回LifecycleOwner
 */
fun Context?.getLifecycleOwner(): LifecycleOwner? {
   return when (this) {
        is Fragment -> {
            return this
        }
        is LifecycleOwner -> {
            return this
        }
        else -> {
            null
        }
    }
}
EditTextExt.kt

```kotlin

@file:JvmName("EditTextExt")
/**
 * 搜索间隔
 */
fun EditText?.addTextChangedDebounceListener(debounceTimeOutInMills: Long = 300L, onTextChanged: ((String?) -> Unit)? = null) {

    this?.let {
        this.addTextChangedListener(YqTextChangeDebounceListener(this, debounceTimeOutInMills) { str: String? ->
            onTextChanged?.invoke(str)
        })
    }
}

/**
 * 搜索间隔
 */

fun EditText?.addTextChangedCoroutineDebounceListener(debounceTimeOutInMills: Long = 300L, onTextChanged: ((String?) -> Unit)? = null) {

    this?.let {
        this.addTextChangedListener(YqTextChangeCoroutineDebounceListener(this, debounceTimeOutInMills) { str: String? ->
            onTextChanged?.invoke(str)
        })
    }
}

我们使用两种方式显示:

Handler

监听EditText的输入,每当文本变化,先检查Handler当前有无未处理的消息,有则移除该消息,然后用sendEmptyMessageDelayed再发送一条延迟消息,如若文本超过延迟时间没有变化,该延迟消息就可以成功执行

/**
 * Created by wangkai on 2021/01/30 10:31

 * Desc EditText事件搜索监听,使用Handler延迟方式实现
 */

open class YqTextChangeDebounceListener(view: View, private val delayMillis: Long = 300L, onTextChanged: ((String?) -> Unit)? = null) : YqTextChangeListener() {

    private var handler: Handler? = null

    private val rand by lazy {
        Random(100)
    }

    companion object {

        private var HANDLER_WHAT = 0

        private const val BUNDLE_KEY = "bundleKey"
    }

    init {

        HANDLER_WHAT = rand.nextInt()

        view.addOnAttachStateChangeListener(object : View.OnAttachStateChangeListener {
            override fun onViewAttachedToWindow(v: View?) {
                logger {
                    "onViewAttachedToWindow 感知View状态变化"
                }

                handler = Handler(Looper.getMainLooper()) {
                    onTextChanged?.invoke(it.peekData().getString(BUNDLE_KEY))
                    false
                }
            }

            override fun onViewDetachedFromWindow(v: View?) {
                logger {
                    "onViewDetachedFromWindow 感知View状态变化"
                }
                handler?.removeCallbacksAndMessages(null)
            }
        })
    }

    override fun afterTextChanged(s: Editable?) {
        super.afterTextChanged(s)
        val editText = s.toString().trim()

        if (handler?.hasMessages(HANDLER_WHAT) == true) {
            logger {
                "handler hasMessages"
            }
            handler?.removeMessages(HANDLER_WHAT)
        }

        Message().also {
            it.what = HANDLER_WHAT
            it.data = Bundle().apply {
                putString(BUNDLE_KEY, editText)
            }
        }.let {
            handler?.sendMessageDelayed(it, delayMillis)
        }
    }
}

注意:因为Handler可能造成内存泄露,所以我使用OnAttachStateChangeListener通过View的状态变化来监听当前界面是否销毁。防止出现内存泄露

Kotlin协程的StateFlow


/**
 * Created by wangkai on 2021/01/30 10:31

 * Desc EditText事件搜索监听,使用协程Coroutine的方式实现
 *
 * 参考自:https://juejin.cn/post/6925304772383735822
 */

@SuppressLint("RestrictedApi")
open class YqTextChangeCoroutineDebounceListener(val view: View, private val delayMillis: Long = 300L, onTextChanged: ((String?) -> Unit)? = null) : YqTextChangeListener(), LifecycleEventObserver {

    //定义一个全局的 StateFlow
    @ExperimentalCoroutinesApi
    private val _etState by lazy { MutableStateFlow("") }

    init {
        view.context?.getLifecycleOwner()?.also {
            it.lifecycle.addObserver(this)//注册自己到activity或fragment的LifecycleRegistry中
        }.apply {
            this?.lifecycleScope?.launch {
            _etState
                    .debounce(delayMillis) // 限流,500毫秒
//                    .filter {
//                        // 空文本过滤掉
//                        it.isNotBlank()
//                    }
                    .collect {
                        // 订阅数据
                        logger {
                            "Thread thread: ${Thread.currentThread()}"
                        }
                        onTextChanged?.invoke(it)
                    }
            }
        }
    }

    override fun afterTextChanged(s: Editable?) {
        super.afterTextChanged(s)
        val editText = s.toString().trim()
        // 往流里写数据
        _etState.value = editText
    }

    override fun onStateChanged(source: LifecycleOwner, event: Lifecycle.Event) {
        logger {
            "onStateChanged source: $source; event: $event"
        }
    }
}

使用

 editText.addTextChangedDebounceListener { str ->
          //do something
 }

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

推荐阅读更多精彩内容