[譯] 2019 年的 Android 網絡 —— Retrofit 與 Kotlin 協程

private val authInterceptor = Interceptor {chain->
val newUrl = chain.request().url()
.newBuilder()
.addQueryParameter(“api_key”, AppConstants.tmdbApiKey)
.build()

val newRequest = chain.request()
.newBuilder()
.url(newUrl)
.build()

chain.proceed(newRequest)
}

//OkhttpClient for building http request url
private val tmdbClient = OkHttpClient().newBuilder()
.addInterceptor(authInterceptor)
.build()

fun retrofit() : Retrofit = Retrofit.Builder()
.client(tmdbClient)
.baseUrl(“https://api.themoviedb.org/3/”)
.addConverterFactory(MoshiConverterFactory.create())
.addCallAdapterFactory(CoroutineCallAdapterFactory())
.build()

val tmdbApi : TmdbApi = retrofit().create(TmdbApi::class.java)

}

看一下我們在 ApiFactory.kt 文件中做了什麼。

• 首先，我們創建了一個用以給所有請求添加 api_key 參數的網絡攔截器，名為 authInterceptor。
• 然後我們用 OkHttp 創建了一個網絡客戶端，並添加了 authInterceptor。
• 接下來，我們用 Retrofit 將所有內容連接起來構建 Http 請求的構造器和處理器。此處我們加入了之前創建好的網絡客戶端、基礎 URL、一個轉換器和一個適配器工廠。 首先是 MoshiConverter，用以輔助 JSON 解析並將響應的 JSON 轉化為 Kotlin 數據類，如有需要，可進行選擇性解析。 第二個是 CoroutineCallAdaptor，它的類型是 Retorofit2 中的 CallAdapter.Factory，用於處理 Kotlin 協程中的 Deferred。
• 最後，我們只需將 TmdbApi 類（下節中創建） 的一個引用傳入之前建好的 retrofit 類中就可以創建我們的 tmdbApi。

探索 Tmdb API

調用 /movie/popular 接口我們得到了如下響應。該響應中返回了 results，這是一個 movie 對象的數組。這正是我們關注的地方。

{
“page”: 1,
“total_results”: 19848,
“total_pages”: 993,
“results”: [
{
“vote_count”: 2109,
“id”: 297802,
“video”: false,
“vote_average”: 6.9,
“title”: “Aquaman”,
“popularity”: 497.334,
“poster_path”: “/5Kg76ldv7VxeX9YlcQXiowHgdX6.jpg”,
“original_language”: “en”,
“original_title”: “Aquaman”,
“genre_ids”: [
28,
14,
878,
12
],
“backdrop_path”: “/5A2bMlLfJrAfX9bqAibOL2gCruF.jpg”,
“adult”: false,
“overview”: “Arthur Curry learns that he is the heir to the underwater kingdom of Atlantis, and must step forward to lead his people and be a hero to the world.”,
“release_date”: “2018-12-07”
},
{
“vote_count”: 625,
“id”: 424783,
“video”: false,
“vote_average”: 6.6,
“title”: “Bumblebee”,
“popularity”: 316.098,
“poster_path”: “/fw02ONlDhrYjTSZV8XO6hhU3ds3.jpg”,
“original_language”: “en”,
“original_title”: “Bumblebee”,
“genre_ids”: [
28,
12,
878
],
“backdrop_path”: “/8bZ7guF94ZyCzi7MLHzXz6E5Lv8.jpg”,
“adult”: false,
“overview”: “On the run in the year 1987, Bumblebee finds refuge in a junkyard in a small Californian beach town. Charlie, on the cusp of turning 18 and trying to find her place in the world, discovers Bumblebee, battle-scarred and broken. When Charlie revives him, she quickly learns this is no ordinary yellow VW bug.”,
“release_date”: “2018-12-15”
}
]
}

因此現在我們可以根據該 JSON 創建我們的 Movie 數據類和 MovieResponse 類。

// Data Model for TMDB Movie item
data class TmdbMovie(
val id: Int,
val vote_average: Double,
val title: String,
val overview: String,
val adult: Boolean
)

// Data Model for the Response returned from the TMDB Api
data class TmdbMovieResponse(
val results: List
)

//A retrofit Network Interface for the Api
interface TmdbApi{
@GET(“movie/popular”)
fun getPopularMovie(): Deferred<Response>
}

TmdbApi 接口：

創建了數據類後，我們創建 TmdbApi 接口，在前面的小節中我們已經將其引用添加至 retrofit 構建器中。在該接口中，我們添加了所有必需的 API 調用，如有必要，可以給這些調用添加任意參數。例如，為了能够根據 id 獲取一部電影，我們在接口中添加了如下方法：

interface TmdbApi{

@GET(“movie/popular”)
fun getPopularMovies() : Deferred<Response>

@GET(“movie/{id}”)
fun getMovieById(@Path(“id”) id:Int): Deferred<Response>

}

最後，進行網絡調用

接著，我們最終發出一個用以獲取所需數據的請求，我們可以在 DataRepository 或者 ViewModel 或者直接在 Activity 中進行此調用。

密封 Result 類

這是用來處理網絡響應的類。它可能成功返回所需的數據，也可能發生异常而出錯。

sealed class Result {
data class Success(val data: T) : Result()
data class Error(val exception: Exception) : Result()
}

構建用來處理 safeApiCall 調用的 BaseRepository

open class BaseRepository{

suspend fun safeApiCall(call: suspend () -> Response, errorMessage: String): T? {

val result : Result = safeApiResult(call,errorMessage)
var data : T? = null

when(result) {
is Result.Success ->
data = result.data
is Result.Error -> {
Log.d(“1.DataRepository”, “$errorMessage & Exception - ${result.exception}”)
}
}

return data

}

private suspend fun <T

Any> safeApiResult(call: suspend ()-> Response, errorMessage: String) : Result{
val response = call.invoke()
if(response.isSuccessful) return Result.Success(response.body()!!)

return Result.Error(IOException(“Error Occurred during getting safe Api result, Custom ERROR - $errorMessage”))
}
}

構建 MovieRepository

class MovieRepository(private val api : TmdbApi) : BaseRepository() {

fun getPopularMovies() : MutableList?{

//safeApiCall is defined in BaseRepository.kt (https://gist.github.com/navi25/67176730f5595b3f1fb5095062a92f15)
val movieResponse = safeApiCall(
call = {api.getPopularMovie().await()},
errorMessage = “Error Fetching Popular Movies”
)

return movieResponse?.results.toMutableList();

}

}

創建 ViewModel 來獲取數據

class TmdbViewModel : ViewModel(){

private val parentJob = Job()

private val coroutineContext: CoroutineContext
get() = parentJob + Dispatchers.Default

private val scope = CoroutineScope(coroutineContext)

private val repository : MovieRepository = MovieRepository(ApiFactory.tmdbApi)

val popularMoviesLiveData = MutableLiveData<MutableList>()

fun fetchMovies(){
scope.launch {
val popularMovies = repository.getPopularMovies()
popularMoviesLiveData.postValue(popularMovies)
}
}

fun cancelAllRequests() = coroutineContext.cancel()