前言

在現代 Android 開發中，網絡請求與 JSON 數據處理是密不可分的。OkHttp 作為強大的 HTTP 客戶端，與 JSON 解析庫（Moshi/Jackson/Gson）的結合使用，可以極大簡化網絡請求與數據解析的流程。本文將詳細介紹如何將 OkHttp 與這三種主流 JSON 庫結合使用，幫助開發者選擇最適合自己項目的技術方案。

一、三種 JSON 庫概覽

1. Gson

• 優點：Google 官方支持，API 簡單易用，社區資源豐富

• 缺點：性能相對較低，缺乏對 Kotlin 的深度支持

2. Jackson

• 優點：性能優異，功能全面，支持多種數據格式

• 缺點：API 較復雜，初始配置繁瑣

3. Moshi

• 優點：專為 Kotlin 設計，輕量高效，與 OkHttp 同屬 Square 產品線

• 缺點：社區相對較小，功能不如 Jackson 全面

二、基礎集成與配置

1. 添加依賴

Gradle 配置：

// OkHttp 核心庫
implementation 'com.squareup.okhttp3:okhttp:4.10.0'// 各 JSON 庫選擇其一即可
implementation 'com.squareup.moshi:moshi:1.14.0'        // Moshi
implementation 'com.squareup.moshi:moshi-kotlin:1.14.0' // Moshi Kotlin 支持
kapt 'com.squareup.moshi:moshi-kotlin-codegen:1.14.0'  // Moshi 代碼生成implementation 'com.fasterxml.jackson.core:jackson-databind:2.14.1' // Jacksonimplementation 'com.google.code.gson:gson:2.10' // Gson

三、OkHttp 與 Moshi 結合使用

1. 基本配置

// 創建 Moshi 實例
val moshi = Moshi.Builder().add(KotlinJsonAdapterFactory()) // 支持 Kotlin 類.build()// 創建 OkHttpClient
val okHttpClient = OkHttpClient.Builder().connectTimeout(30, TimeUnit.SECONDS).build()// 使用示例
suspend fun fetchUser(): User {val request = Request.Builder().url("https://api.example.com/user/1").build()okHttpClient.newCall(request).execute().use { response ->if (!response.isSuccessful) throw IOException("Unexpected code $response")val moshiAdapter = moshi.adapter(User::class.java)return moshiAdapter.fromJson(response.body?.source())!!}
}

2. 配合 Retrofit 使用

val retrofit = Retrofit.Builder().baseUrl("https://api.example.com/").client(okHttpClient).addConverterFactory(MoshiConverterFactory.create(moshi)).build()interface ApiService {@GET("user/{id}")suspend fun getUser(@Path("id") userId: String): User
}

3. 自定義適配器（處理特殊格式）

class DateAdapter {@ToJsonfun toJson(date: Date): String {return SimpleDateFormat("yyyy-MM-dd").format(date)}@FromJsonfun fromJson(dateString: String): Date {return SimpleDateFormat("yyyy-MM-dd").parse(dateString)!!}
}// 使用自定義適配器
val moshi = Moshi.Builder().add(DateAdapter()).add(KotlinJsonAdapterFactory()).build()

四、OkHttp 與 Jackson 結合使用

1. 基本配置

// 創建 ObjectMapper
val objectMapper = ObjectMapper().registerModule(KotlinModule())// 使用示例
fun fetchUser(): User {val request = Request.Builder().url("https://api.example.com/user/1").build()okHttpClient.newCall(request).execute().use { response ->if (!response.isSuccessful) throw IOException("Unexpected code $response")return objectMapper.readValue(response.body?.string(), User::class.java)}
}

2. 配合 Retrofit 使用

val retrofit = Retrofit.Builder().baseUrl("https://api.example.com/").client(okHttpClient).addConverterFactory(JacksonConverterFactory.create(objectMapper)).build()

3. 處理復雜情況

// 配置 ObjectMapper 處理多種情況
val objectMapper = ObjectMapper().apply {registerModule(KotlinModule.Builder().build())configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)dateFormat = SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssZ")
}

五、OkHttp 與 Gson 結合使用

1. 基本配置

// 創建 Gson 實例
val gson = GsonBuilder().setDateFormat("yyyy-MM-dd'T'HH:mm:ssZ").create()// 使用示例
fun fetchUser(): User {val request = Request.Builder().url("https://api.example.com/user/1").build()okHttpClient.newCall(request).execute().use { response ->if (!response.isSuccessful) throw IOException("Unexpected code $response")return gson.fromJson(response.body?.charStream(), User::class.java)}
}

2. 配合 Retrofit 使用

val retrofit = Retrofit.Builder().baseUrl("https://api.example.com/").client(okHttpClient).addConverterFactory(GsonConverterFactory.create(gson)).build()

3. 自定義類型適配器

val gson = GsonBuilder().registerTypeAdapter(Date::class.java, object : JsonDeserializer<Date> {override fun deserialize(json: JsonElement,typeOfT: Type,context: JsonDeserializationContext): Date {return SimpleDateFormat("yyyy-MM-dd").parse(json.asString)!!}}).create()

六、三種方案對比與選型建議

1. 性能對比

• Jackson：解析速度最快，內存占用最低

• Moshi：性能接近 Jackson，略優于 Gson

• Gson：性能相對較低，但在大多數場景足夠

2. 功能對比

3. 選型建議

• 新項目（Kotlin）：優先選擇 Moshi，特別是與 OkHttp/Retrofit 配套使用

• 大型復雜項目：考慮 Jackson，特別是需要處理復雜 JSON 結構時

• 維護舊項目：繼續使用 Gson，特別是項目已經大量依賴 Gson 時

七、高級技巧與最佳實踐

1. 統一錯誤處理

inline fun <reified T> OkHttpClient.parseResponse(request: Request): T {this.newCall(request).execute().use { response ->val body = response.body?.string() ?: throw IOException("Empty response")if (!response.isSuccessful) {// 嘗試解析錯誤信息val errorResponse = moshi.adapter(ErrorResponse::class.java).fromJson(body)throw ApiException(code = response.code,message = errorResponse?.message ?: "Unknown error")}return moshi.adapter(T::class.java).fromJson(body)!!}
}

2. 緩存網絡響應

inline fun <reified T> OkHttpClient.parseResponse(request: Request): T {this.newCall(request).execute().use { response ->val body = response.body?.string() ?: throw IOException("Empty response")if (!response.isSuccessful) {// 嘗試解析錯誤信息val errorResponse = moshi.adapter(ErrorResponse::class.java).fromJson(body)throw ApiException(code = response.code,message = errorResponse?.message ?: "Unknown error")}return moshi.adapter(T::class.java).fromJson(body)!!}
}

3. 日志攔截器

class JsonPrettyPrintInterceptor : Interceptor {override fun intercept(chain: Interceptor.Chain): Response {val request = chain.request()val response = chain.proceed(request)val content = response.body?.string() ?: return responsetry {val prettyJson = when {content.startsWith("{") -> JsonParser.parseString(content).toString()content.startsWith("[") -> JsonParser.parseString(content).toString()else -> content}Log.d("Network", prettyJson)} catch (e: Exception) {Log.d("Network", content)}return response.newBuilder().body(content.toResponseBody(response.body?.contentType())).build()}
}

八、常見問題解決方案

1. 處理 JSON 字段與 Kotlin 屬性名不一致

Moshi:

@Json(name = "user_name") 
val userName: String

Jackson:

@JsonProperty("user_name")
val userName: String

Gson:

@SerializedName("user_name")
val userName: String

2. 處理 null 值

Moshi:

val moshi = Moshi.Builder().add(KotlinJsonAdapterFactory()).add(NullToEmptyStringAdapter()).build()class NullToEmptyStringAdapter {@FromJson fun fromJson(reader: JsonReader): String {return if (reader.peek() == JsonReader.Token.NULL) {reader.nextNull()""} else {reader.nextString()}}
}

3. 處理多態類型

Jackson:

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME,include = JsonTypeInfo.As.PROPERTY,property = "type"
)
@JsonSubTypes(JsonSubTypes.Type(value = Dog::class, name = "dog"),JsonSubTypes.Type(value = Cat::class, name = "cat")
)
abstract class Animal

九、總結

OkHttp 與 JSON 解析庫的結合為 Android 開發提供了強大的網絡數據處理能力。通過本文的介紹，我們可以看到：

1. Moshi?是與 Kotlin 最契合的選擇，特別適合新項目開發

2. Jackson?在性能和處理復雜場景方面表現優異

3. Gson?仍然是不錯的選擇，特別是對已有項目的維護

無論選擇哪種方案，都應考慮項目的具體需求、團隊熟悉度和長期維護成本。正確配置和使用這些工具可以顯著提高開發效率和應用程序性能。

在實際開發中，建議：

• 新項目優先考慮 Moshi

• 性能敏感型項目考慮 Jackson

• 保持項目的一致性，避免混用多種 JSON 庫

• 合理利用各種高級特性處理復雜場景