统一添加默认参数，Retrofit网络请求更方便

2023-12-11 11:50:55

使用Retrofit为网络请求添加默认参数：终极指南

简介

Retrofit 作为一款广受欢迎的 Android 网络请求框架，以其简洁性和高效率而闻名。然而，在实际项目中，我们经常需要向网络请求中添加一些默认参数，比如 Token、API 版本和 App 版本等。一个个手动添加这些参数不仅繁琐耗时，还容易出错。

解决方案：Retrofit 的强大功能

Retrofit 提供了优雅的解决方案，允许我们统一添加默认参数，从而极大地简化了网络请求流程，提高了开发效率。本文将深入探讨如何在 Retrofit 中添加默认参数，并提供详细的步骤和代码示例。

方式一：自定义拦截器

Retrofit 允许我们创建拦截器来拦截和修改网络请求。我们可以利用这一特性创建一个拦截器，在每次请求发送前，向请求中添加默认参数。

步骤：

创建拦截器类：

class AddDefaultParametersInterceptor : Interceptor {
    override fun intercept(chain: Interceptor.Chain): Response {
        // 从 chain 中获取请求
        val originalRequest = chain.request()

        // 创建一个新的 RequestBuilder
        val newRequestBuilder = originalRequest.newBuilder()

        // 添加默认参数
        newRequestBuilder.addHeader("token", "YOUR_TOKEN")
        newRequestBuilder.addHeader("api_version", "1.0")
        newRequestBuilder.addHeader("app_version", "1.0.1")

        // 构建新的请求
        val newRequest = newRequestBuilder.build()

        // 继续发送请求并返回响应
        return chain.proceed(newRequest)
    }
}

将自定义拦截器添加到 Retrofit 客户端：

val retrofit = Retrofit.Builder()
    .baseUrl("https://api.example.com")
    .addInterceptor(AddDefaultParametersInterceptor())
    .build()

方式二：自定义 CallAdapter.Factory

对于更复杂的场景，比如需要根据不同的请求类型添加不同的默认参数，我们可以使用自定义的 CallAdapter.Factory 。CallAdapter.Factory 负责将网络请求和响应数据进行转换，我们可以通过自定义 CallAdapter.Factory ，在转换过程中添加默认参数。

步骤：

创建自定义 CallAdapter.Factory：

class AddDefaultParametersCallAdapterFactory : CallAdapter.Factory() {
    override fun get(returnType: Type, annotations: Array<out Annotation>, retrofit: Retrofit): CallAdapter<*, *>? {
        // 获取原始的 CallAdapter
        val originalCallAdapter = retrofit.nextCallAdapter(this, returnType, annotations)

        // 创建一个新的 CallAdapter，并添加默认参数
        return object : CallAdapter<Any, Any> {
            override fun adapt(call: Call<Any>): Any {
                // 获取原始的调用
                val originalCall = call.clone()

                // 添加默认参数
                originalCall.request().newBuilder()
                    .addHeader("token", "YOUR_TOKEN")
                    .addHeader("api_version", "1.0")
                    .addHeader("app_version", "1.0.1")
                    .build()

                // 返回原始的调用，并进行转换
                return originalCallAdapter.adapt(originalCall)
            }
        }
    }
}

将自定义 CallAdapter.Factory 添加到 Retrofit 客户端：

val retrofit = Retrofit.Builder()
    .baseUrl("https://api.example.com")
    .addCallAdapterFactory(AddDefaultParametersCallAdapterFactory())
    .build()