Android 利用 Kotlin callbackFlow优雅地实现搜索框关键字联想提示

1. 需求场景

几乎大部分人都使用过下面的场景:使用百度等搜索引擎时,输入一个字符后会自动联想出相关的搜索关键字;在淘宝、京东等APP搜索商品时,会自动帮你联想出相关的商品。这在很大程度上提高了用户体验,快速引导用户到达搜索结果页。

所以我们总结出同类型的需求,有一个搜索输入框,用户可以随意输入任何字符,然后前端根据用户的输入给出联想提示信息。

2. 实现方案

一般前端实现起来也不复杂,前端监听输入框文本的变化,然后根据输入内容从本地或者调用接口从服务端查询相关联数据,然后在前端展示结果即可。虽然看起来很简单,但是要比较完美地实现,还是有很多需要考虑的:

  1. 用户输入文本的速度是随机的,如果监听文本变化之后立马去查询,可能会过多地发起查询,浪费系统资源。例如用户本意要输入"abcde",那么每输入一个字符都会触发查询,会触发 5 次,其实用户可能只想得到 "abcde" 的查询结果;
  2. 查询是异步的,异步返回的时机是不确定的,可能造成当前返回的异步查询结果与当前输入框里的文本不一致。例如用户输入"ab",先后触发关键字 "a"、"ab" 的查询,结果 "a" 的查询结果后返回,最后导致显示的是 "a" 的查询结果;

所以一个优雅的方案我觉得应该包含:

  1. 防抖限流;
  2. 自动取消无效查询;

以前要实现这些效果,监听输入框变化时,会通过计时以及延时任务等,在限定时间段内只触发一次,写起来也很麻烦。

3. 使用 Kotlin callbackFlow

Kotlin Flow 支持防抖、背压等特性,利用 callbackFlow 可以将输入框的文本变化包装成一个 Flow,然后来实现这个需求。

将 EditText 的输入文本变化包装成 Flow:

private fun textChangeFlow(editText: EditText): Flow<String>  {
    return callbackFlow {
        val watcher = object : TextWatcher {
            override fun beforeTextChanged(s: CharSequence?, start: Int, count: Int, after: Int) {
            }

            override fun onTextChanged(s: CharSequence?, start: Int, before: Int, count: Int) {
            }

            override fun afterTextChanged(s: Editable?) {
                s?.let {
                    trySend(s.toString())
                }
            }
        }
        editText.addTextChangedListener(watcher)
        //在 flow 被 close 时调用,可以清理资源,一般必须要有
        awaitClose {
            editText.removeTextChangedListener(watcher)
        }
    }
}

根据输入框文本内容,我们去查询相关信息:

fun testCallbackFlow(editText: EditText) {
    viewModelScope.launch {
        textChangeFlow(editText)
            .debounce(300)  //防抖处理,间隔 300ms 响应一次
            .flatMapLatest { keyword ->     //flatMapLatest 操作符,只处理最新的关键字,并且老的查询如果没有完成会自动 cancel 掉
                println("keyword = $keyword")
                flow { 
                    //根据输入关键字查询信息
                    var result = queryByKeyword(keyword)
                    emit(result)
                }
            }.catch {
                println("exception: $it")
            }
            .collect {
                //查询到相关结果
            }
    }
}

如上代码所示,可以很优雅地实现我们想要的效果。

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

推荐阅读更多精彩内容