Android 关于 Retrofit 回调的正确处理方式

1. 疑惑

对于 Activity，发起网络请求后得到一个 null，到底应不应该刷新列表？

或者说，应该如何处理 Retrofit 的回调才显得合理并且优雅呢？

2. 结论

// 总的原则：
// 1. 返回 null 认为是非正常情况，不刷新列表
// 2. 返回非 null 才刷新列表，如果是用户在 PC 上清空了数据（如浏览记录），
// 手机上刷新时需要服务器返回一个空列表（size 为 0）而不是 null
// 3. ViewModel 中任何 case 都要转调到 Activity 里去，否则可能出现下拉刷新无法结束的问题

3. 代码

这里进行了简单封装，参见 SimpleCallback，只需要一句话即可发起请求并将结果通过 LiveData 传递出去。

Api.mApiService.getTestData().enqueue(SimpleCallback(mTestData))

activity_retrofit_callback.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout 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:padding="8dp">

    <androidx.recyclerview.widget.RecyclerView
        android:id="@+id/recycler_view"
        android:layout_width="match_parent"
        android:layout_height="0dp"
        app:layout_constraintBottom_toTopOf="@+id/linearLayout"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        tools:listitem="@android:layout/simple_list_item_1" />

    <LinearLayout
        android:id="@+id/linearLayout"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:orientation="horizontal"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent">

        <Button
            android:id="@+id/normal"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_weight="1"
            android:text="normal"
            android:textAllCaps="false" />

        <Button
            android:id="@+id/empty"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginLeft="8dp"
            android:layout_weight="1"
            android:text="empty"
            android:textAllCaps="false" />

        <Button
            android:id="@+id/error"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginLeft="8dp"
            android:layout_weight="1"
            android:text="error"
            android:textAllCaps="false" />

        <Button
            android:id="@+id/timeout"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginLeft="8dp"
            android:layout_weight="1"
            android:text="timeout"
            android:textAllCaps="false" />

    </LinearLayout>

</androidx.constraintlayout.widget.ConstraintLayout>

RetrofitCallbackActivity.kt

class RetrofitCallbackActivity : BaseActivity() {
    private lateinit var mAdapter: MyAdapter
    private val mViewModel: MyViewModel by viewModels()
    private var mDataType = 0

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        initRetrofit()
        initUi()
        initViewModel()
    }

    private fun initViewModel() {
        mViewModel.mTestData.observe(this) {
            // 总的原则：
            // 1. 返回 null 认为是非正常情况，不刷新列表
            // 2. 返回非 null 才刷新列表，如果是用户在 PC 上清空了数据（如浏览记录），
            //    手机上刷新时需要服务器返回一个空列表（size 为 0）而不是 null

            it?.let {
                // 针对本身列表为空的情况，要求在 ViewModel 中返回空列表而非 null
                mAdapter.setList(it)
            }

            // TODO 在这里结束下拉刷新
            // 这就要求 ViewModel 在所有 case 下都必须调用 MutableLiveData#setValue()，
            // 否则会出现下拉状态无法结束的问题
        }

        mViewModel.mResultTestData.observe(this) {
            ToastUtils.showShort("code: ${it.code}")
        }
    }

    private fun initUi() {
        setContentView(R.layout.activity_retrofit_callback)
        val recyclerView = findViewById<RecyclerView>(R.id.recycler_view)
        recyclerView.layoutManager = LinearLayoutManager(this)
        recyclerView.adapter = MyAdapter().apply {
            mAdapter = this
        }
        mAdapter.setEmptyView(TextView(this).apply {
            layoutParams = ViewGroup.LayoutParams(
                ViewGroup.LayoutParams.MATCH_PARENT,
                ViewGroup.LayoutParams.MATCH_PARENT
            )
            gravity = Gravity.CENTER
            text = "Empty!"
            setTextSize(TypedValue.COMPLEX_UNIT_SP, 20f)
        })

        findViewById<Button>(R.id.normal).setOnClickListener {
            mDataType = 0
            mViewModel.getTestData()
        }

        findViewById<Button>(R.id.empty).setOnClickListener {
            mDataType = 1
            mViewModel.getTestData()
        }

        findViewById<Button>(R.id.error).setOnClickListener {
            mDataType = 2
            mViewModel.getResultTestData()
        }

        findViewById<Button>(R.id.timeout).setOnClickListener {
            mDataType = 3
            mViewModel.getTestData()
        }
    }

    private fun initRetrofit() {
        val client = OkHttpClient.Builder()
            .connectTimeout(3, TimeUnit.SECONDS)
            .readTimeout(3, TimeUnit.SECONDS)
            .writeTimeout(3, TimeUnit.SECONDS)
            .addInterceptor { chain ->
                // error
                if (mDataType == 3) {
                    throw SocketTimeoutException("timeout occurred.")
                }

                val body = ResponseBody.create(MediaType.parse("application/json"), mockData())
                okhttp3.Response.Builder()
                    .request(chain.request())
                    .protocol(Protocol.HTTP_1_1)
                    .code(200)
                    .body(body)
                    .message("OK")
                    .build()
            }.build()

        Retrofit.Builder()
            // 注释掉 interceptor 后:
            // 1. 模拟 failed to connect xxx, 走 onFailure()
            // .baseUrl("https://xxx.com/")
            // 2. 模拟 404, 走 onResponse()
            //    但是 isSuccessful 为 false 且 response.body() 为空且 response.errorBody() 不为空
            .baseUrl("https://www.baidu.com/")
            .client(client)
            .addConverterFactory(GsonConverterFactory.create())
            .build()
            .create(ApiService::class.java).also {
                Api.mApiService = it
            }
    }

    private fun mockData(): String {
        when (mDataType) {
            // normal
            0 -> {
                return """
                    {
                        "code": 200,
                        "data": [
                            {"name": "this is 0"},
                            {"name": "this is 1"},
                            {"name-error": "this is 2"},
                            {"name": "this is 3"},
                            {"name": "this is 4"}
                        ],
                        "message": "success"
                    }
                """.trimIndent()
            }
            // empty
            1 -> {
                return """
                    {
                        "code": 200,
                        "data": [],
                        "message": "success"
                    }
                """.trimIndent()
            }
            // error
            2 -> {
                return """
                    {
                        "code": 500,
                        "d": [],
                        "message": "success"
                    }
                """.trimIndent()
            }
        }

        return ""
    }
}

class MyViewModel : ViewModel() {
    val mTestData = MutableLiveData<List<Item>?>()

    fun getTestData() {
        Api.mApiService.getTestData().enqueue(SimpleCallback(mTestData))
    }

    val mResultTestData = MutableLiveData<Result<List<Item>?>>()

    fun getResultTestData() {
        Api.mApiService.getTestData().enqueue(ResultCallBack(mResultTestData))
    }
}

private class MyAdapter :
    BaseQuickAdapter<Item, BaseViewHolder>(android.R.layout.simple_list_item_1, null) {
    override fun convert(holder: BaseViewHolder, item: Item) {
        if (item.name == null) {
            holder.setText(android.R.id.text1, "parse error!")
        } else {
            holder.setText(android.R.id.text1, item.name)
        }
    }
}

/**
 * 通常 UI 界面只需要 data 部分
 */
class SimpleCallback<T>(private val mLiveData: MutableLiveData<T?>) : Callback<Result<T?>> {
    override fun onResponse(call: Call<Result<T?>>, response: Response<Result<T?>>) {
        mLiveData.value = Api.handleResponse(response)
    }

    override fun onFailure(call: Call<Result<T?>>, t: Throwable) {
        mLiveData.value = null
        ToastUtils.showShort(t.message)
    }
}

/**
 * 如果确实需要 code 和 message 的，可以用该类
 */
class ResultCallBack<T>(private val mLiveData: MutableLiveData<Result<T?>>) : Callback<Result<T?>> {
    override fun onResponse(call: Call<Result<T?>>, response: Response<Result<T?>>) {
        val result = response.body()
        if (result != null) {
            mLiveData.value = result
        } else {
            mLiveData.value = Result(response.message(), response.code(), null)
        }
    }

    override fun onFailure(call: Call<Result<T?>>, t: Throwable) {
        mLiveData.value = Result(t.message, -1, null)
        ToastUtils.showShort(t.message)
    }
}

object Api {
    lateinit var mApiService: ApiService

    /**
     * 根据 response 获取 Result 中的 data 数据
     */
    fun <T> handleResponse(response: Response<Result<T?>>): T? {
        val result = response.body()
        if (result != null) {
            // 成功: 如 200，即使成功的情况下 data 也可能为 null：
            // 1. 字段解析导致为 null，这是 GsonConverterFactory 解析 json 时导致的
            // 2. 服务端没直接返回 null，理论上没数据应该返回空列表的，
            //    但是服务端硬是返回了 null，这里强制要求服务端返回空列表，
            //    否则客户端不会认为是数据清空（如历史记录）而会认为是发生了错误。

            // 同服务约定 message 不为空时表示需要提示用户, 也可以约定用 code 来判断
            if (result.code != 200 && !result.message.isNullOrEmpty()) {
                ToastUtils.showShort(result.message)
            }

            // data 可能为 null, 这种情况下会不更新列表
            return result.data
        } else {
            // 失败: 如 404/500, 这种情况下不更新列表
            // 另外：204/205 的情况下，result 也为空
            ToastUtils.showShort(response.message())
            return null
        }
    }
}

/**
 * 定义实体类 T 时，其中的非基本数据类型一定要定义为可空的，
 * 因为 GsonConverterFactory 解析 json 时完全有可能对某项数据赋值为空，
 * 如果又定义为了非空，那么使用的时候就可能发生空指针。
 */
data class Result<T>(val message: String?, val code: Int, val data: T?)

/**
 * 内部字段必须定义为可空！
 */
data class Item(val name: String?)

interface ApiService {
    @GET("api/test")
    fun getTestData(): Call<Result<List<Item>?>>
}

4. 效果

效果.gif

5. 最后

鼓掌.png
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 214,377评论 6赞 496
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 91,390评论 3赞 389
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 159,967评论 0赞 349
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 57,344评论 1赞 288
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 66,441评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 50,492评论 1赞 292
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,497评论 3赞 412
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,274评论 0赞 269
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,732评论 1赞 307
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,008评论 2赞 328
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,184评论 1赞 342
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,837评论 4赞 337
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,520评论 3赞 322
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,156评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,407评论 1赞 268
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,056评论 2赞 365
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,074评论 2赞 352