क्रिप्टोफ़ोलियो ऐप सीरीज़ — भाग 5
इन दिनों लगभग हर Android ऐप डेटा प्राप्त करने/भेजने के लिए इंटरनेट से जुड़ता है। आपको निश्चित रूप से सीखना चाहिए कि रीस्टफुल वेब सेवाओं को कैसे संभालना है, क्योंकि आधुनिक ऐप्स बनाते समय उनका सही कार्यान्वयन मुख्य ज्ञान है।
यह हिस्सा जटिल होने वाला है। हम एक कार्य परिणाम प्राप्त करने के लिए एक साथ कई पुस्तकालयों को संयोजित करने जा रहे हैं। मैं इंटरनेट अनुरोधों को संभालने के लिए देशी एंड्रॉइड तरीके के बारे में बात नहीं करने जा रहा हूं, क्योंकि वास्तविक दुनिया में कोई भी इसका उपयोग नहीं करता है। हर अच्छा ऐप पहिया को फिर से शुरू करने की कोशिश नहीं करता है, बल्कि आम समस्याओं को हल करने के लिए सबसे लोकप्रिय तीसरे पक्ष के पुस्तकालयों का उपयोग करता है। इन अच्छी तरह से निर्मित पुस्तकालयों की कार्यक्षमता को फिर से बनाना बहुत जटिल होगा।
श्रृंखला सामग्री
- परिचय:2018–2019 में एक आधुनिक Android ऐप बनाने का रोडमैप
- भाग 1:ठोस सिद्धांतों का परिचय
- भाग 2:अपना Android ऐप कैसे बनाना शुरू करें:मॉकअप, UI और XML लेआउट बनाना
- भाग 3:उस आर्किटेक्चर के बारे में सब कुछ:विभिन्न आर्किटेक्चर पैटर्न की खोज करना और उन्हें अपने ऐप में कैसे उपयोग करना है
- भाग 4:डैगर 2 के साथ अपने ऐप में डिपेंडेंसी इंजेक्शन कैसे लागू करें
- भाग 5:Retrofit, OkHttp, Gson, Glide और Coroutines (आप यहां हैं) का उपयोग करके RESTful वेब सेवाओं को संभालें
रेट्रोफिट, OkHttp और Gson क्या है?
रेट्रोफिट जावा और एंड्रॉइड के लिए एक आरईएसटी क्लाइंट है। यह पुस्तकालय, मेरी राय में, सीखने के लिए सबसे महत्वपूर्ण है, क्योंकि यह मुख्य कार्य करेगा। यह REST आधारित webservice के माध्यम से JSON (या अन्य संरचित डेटा) को पुनः प्राप्त करना और अपलोड करना अपेक्षाकृत आसान बनाता है।
रेट्रोफिट में आप कॉन्फ़िगर करते हैं कि डेटा क्रमांकन के लिए किस कनवर्टर का उपयोग किया जाता है। आम तौर पर JSON से और उसके लिए वस्तुओं को क्रमबद्ध और deserialize करने के लिए आप एक ओपन-सोर्स जावा लाइब्रेरी - Gson का उपयोग करते हैं। इसके अलावा, यदि आपको आवश्यकता है, तो आप एक्सएमएल या अन्य प्रोटोकॉल को संसाधित करने के लिए कस्टम कन्वर्टर्स को रेट्रोफिट में जोड़ सकते हैं।
HTTP अनुरोध करने के लिए रेट्रोफिट OkHttp लाइब्रेरी का उपयोग करता है। OkHttp एक शुद्ध HTTP/SPDY क्लाइंट है जो किसी भी निम्न-स्तरीय नेटवर्क संचालन, कैशिंग, अनुरोध और प्रतिक्रिया हेरफेर के लिए जिम्मेदार है। इसके विपरीत, रेट्रोफिट ओकेएचटीपी के शीर्ष पर एक उच्च स्तरीय आरईएसटी एब्स्ट्रैक्शन बिल्ड है। रेट्रोफिट दृढ़ता से OkHttp के साथ जुड़ा हुआ है और इसका गहन उपयोग करता है।
अब जब आप जानते हैं कि सब कुछ निकट से संबंधित है, तो हम इन सभी 3 पुस्तकालयों का एक साथ उपयोग करने जा रहे हैं। हमारा पहला लक्ष्य इंटरनेट से रेट्रोफिट का उपयोग करके सभी क्रिप्टोकरेंसी सूची प्राप्त करना है। सर्वर पर कॉल करते समय हम CoinMarketCap API प्रमाणीकरण के लिए एक विशेष OkHttp इंटरसेप्टर क्लास का उपयोग करेंगे। हम एक JSON डेटा परिणाम वापस प्राप्त करेंगे और फिर इसे Gson लाइब्रेरी का उपयोग करके परिवर्तित करेंगे।
Retrofit 2 के लिए त्वरित सेटअप बस इसे पहले आज़माने के लिए
कुछ नया सीखते समय, मैं इसे जितनी जल्दी हो सके अभ्यास में आज़माना पसंद करता हूँ। हम आपके लिए इसे और अधिक तेज़ी से समझने के लिए रेट्रोफिट 2 के साथ एक समान दृष्टिकोण लागू करेंगे। कोड गुणवत्ता या किसी प्रोग्रामिंग सिद्धांत या अनुकूलन के बारे में अभी चिंता न करें - हम अपने प्रोजेक्ट में रेट्रोफिट 2 को काम करने के लिए बस कुछ कोड लिखेंगे और चर्चा करेंगे कि यह क्या करता है।
My Crypto Coins ऐप प्रोजेक्ट पर रेट्रोफिट 2 सेट करने के लिए इन चरणों का पालन करें:
सबसे पहले, ऐप के लिए इंटरनेट की अनुमति दें
हम इंटरनेट के माध्यम से सुलभ सर्वर पर HTTP अनुरोधों को निष्पादित करने जा रहे हैं। इन पंक्तियों को अपनी मेनिफेस्ट फ़ाइल में जोड़कर यह अनुमति दें:
<manifest xmlns:android="https://schemas.android.com/apk/res/android"
package="com.baruckis.mycryptocoins">
<uses-permission android:name="android.permission.INTERNET" />
...
</manifest>तब आपको लाइब्रेरी निर्भरताएं जोड़नी चाहिए
नवीनतम रेट्रोफिट संस्करण खोजें। आपको यह भी पता होना चाहिए कि रेट्रोफिट एक एकीकृत JSON कनवर्टर के साथ शिप नहीं करता है। चूंकि हमें JSON प्रारूप में प्रतिक्रियाएँ मिलेंगी, इसलिए हमें निर्भरता में भी कनवर्टर को मैन्युअल रूप से शामिल करना होगा। हम नवीनतम Google के JSON कनवर्टर Gson संस्करण का उपयोग करने जा रहे हैं। आइए इन पंक्तियों को अपनी ग्रेडल फ़ाइल में जोड़ें:
// 3rd party
// HTTP client - Retrofit with OkHttp
implementation "com.squareup.retrofit2:retrofit:$versions.retrofit"
// JSON converter Gson for JSON to Java object mapping
implementation "com.squareup.retrofit2:converter-gson:$versions.retrofit"जैसा कि आपने मेरी टिप्पणी से देखा, ओकेएचटीपी निर्भरता पहले से ही रेट्रोफिट 2 निर्भरता के साथ भेज दी गई है। संस्करण सुविधा के लिए केवल एक अलग ग्रेडल फ़ाइल है:
def versions = [:]
versions.retrofit = "2.4.0"
ext.versions = versionsअगला रेट्रोफिट इंटरफ़ेस सेट करें
यह एक इंटरफ़ेस है जो हमारे अनुरोधों और उनके प्रकारों की घोषणा करता है। यहां हम क्लाइंट साइड पर एपीआई को परिभाषित करते हैं।
/**
* REST API access points.
*/
interface ApiService {
// The @GET annotation tells retrofit that this request is a get type request.
// The string value tells retrofit that the path of this request is
// baseUrl + v1/cryptocurrency/listings/latest + query parameter.
@GET("v1/cryptocurrency/listings/latest")
// Annotation @Query is used to define query parameter for request. Finally the request url will
// look like that https://sandbox-api.coinmarketcap.com/v1/cryptocurrency/listings/latest?convert=EUR.
fun getAllCryptocurrencies(@Query("convert") currency: String): Call<CryptocurrenciesLatest>
// The return type for this function is Call with its type CryptocurrenciesLatest.
}और डेटा वर्ग सेट करें
डेटा क्लास पीओजेओ (सादे पुराने जावा ऑब्जेक्ट) हैं जो एपीआई कॉल की प्रतिक्रियाओं का प्रतिनिधित्व करते हैं जो हम करने जा रहे हैं।
/**
* Data class to handle the response from the server.
*/
data class CryptocurrenciesLatest(
val status: Status,
val data: List<Data>
) {
data class Data(
val id: Int,
val name: String,
val symbol: String,
val slug: String,
// The annotation to a model property lets you pass the serialized and deserialized
// name as a string. This is useful if you don't want your model class and the JSON
// to have identical naming.
@SerializedName("circulating_supply")
val circulatingSupply: Double,
@SerializedName("total_supply")
val totalSupply: Double,
@SerializedName("max_supply")
val maxSupply: Double,
@SerializedName("date_added")
val dateAdded: String,
@SerializedName("num_market_pairs")
val numMarketPairs: Int,
@SerializedName("cmc_rank")
val cmcRank: Int,
@SerializedName("last_updated")
val lastUpdated: String,
val quote: Quote
) {
data class Quote(
// For additional option during deserialization you can specify value or alternative
// values. Gson will check the JSON for all names we specify and try to find one to
// map it to the annotated property.
@SerializedName(value = "USD", alternate = ["AUD", "BRL", "CAD", "CHF", "CLP",
"CNY", "CZK", "DKK", "EUR", "GBP", "HKD", "HUF", "IDR", "ILS", "INR", "JPY",
"KRW", "MXN", "MYR", "NOK", "NZD", "PHP", "PKR", "PLN", "RUB", "SEK", "SGD",
"THB", "TRY", "TWD", "ZAR"])
val currency: Currency
) {
data class Currency(
val price: Double,
@SerializedName("volume_24h")
val volume24h: Double,
@SerializedName("percent_change_1h")
val percentChange1h: Double,
@SerializedName("percent_change_24h")
val percentChange24h: Double,
@SerializedName("percent_change_7d")
val percentChange7d: Double,
@SerializedName("market_cap")
val marketCap: Double,
@SerializedName("last_updated")
val lastUpdated: String
)
}
}
data class Status(
val timestamp: String,
@SerializedName("error_code")
val errorCode: Int,
@SerializedName("error_message")
val errorMessage: String,
val elapsed: Int,
@SerializedName("credit_count")
val creditCount: Int
)
}कॉल करते समय प्रमाणीकरण के लिए एक विशेष इंटरसेप्टर क्लास बनाएं सर्वर
यह किसी भी एपीआई के लिए विशेष रूप से मामला है जिसे सफल प्रतिक्रिया प्राप्त करने के लिए प्रमाणीकरण की आवश्यकता होती है। इंटरसेप्टर आपके अनुरोधों को अनुकूलित करने का एक शक्तिशाली तरीका है। हम वास्तविक अनुरोध को इंटरसेप्ट करने जा रहे हैं और व्यक्तिगत अनुरोध हेडर जोड़ने जा रहे हैं, जो CoinMarketCap Professional API डेवलपर पोर्टल द्वारा प्रदान की गई API कुंजी के साथ कॉल को मान्य करेगा। अपना पाने के लिए, आपको वहां पंजीकरण करना होगा।
/**
* Interceptor used to intercept the actual request and
* to supply your API Key in REST API calls via a custom header.
*/
class AuthenticationInterceptor : Interceptor {
override fun intercept(chain: Interceptor.Chain): Response {
val newRequest = chain.request().newBuilder()
// TODO: Use your API Key provided by CoinMarketCap Professional API Developer Portal.
.addHeader("X-CMC_PRO_API_KEY", "CMC_PRO_API_KEY")
.build()
return chain.proceed(newRequest)
}
}आखिरकार, रेट्रोफिट को काम करते देखने के लिए इस कोड को हमारी गतिविधि में जोड़ें
मैं चाहता था कि आपके हाथ जल्द से जल्द गंदे हो जाएं, इसलिए मैंने सब कुछ एक जगह रख दिया। यह सही तरीका नहीं है, लेकिन केवल एक दृश्य परिणाम को जल्दी से देखने के बजाय यह सबसे तेज़ है।
class AddSearchActivity : AppCompatActivity(), Injectable {
private lateinit var listView: ListView
private lateinit var listAdapter: AddSearchListAdapter
...
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
...
// Later we will setup Retrofit correctly, but for now we do all in one place just for quick start.
setupRetrofitTemporarily()
}
...
private fun setupRetrofitTemporarily() {
// We need to prepare a custom OkHttp client because need to use our custom call interceptor.
// to be able to authenticate our requests.
val builder = OkHttpClient.Builder()
// We add the interceptor to OkHttpClient.
// It will add authentication headers to every call we make.
builder.interceptors().add(AuthenticationInterceptor())
val client = builder.build()
val api = Retrofit.Builder() // Create retrofit builder.
.baseUrl("https://sandbox-api.coinmarketcap.com/") // Base url for the api has to end with a slash.
.addConverterFactory(GsonConverterFactory.create()) // Use GSON converter for JSON to POJO object mapping.
.client(client) // Here we set the custom OkHttp client we just created.
.build().create(ApiService::class.java) // We create an API using the interface we defined.
val adapterData: MutableList<Cryptocurrency> = ArrayList<Cryptocurrency>()
val currentFiatCurrencyCode = "EUR"
// Let's make asynchronous network request to get all latest cryptocurrencies from the server.
// For query parameter we pass "EUR" as we want to get prices in euros.
val call = api.getAllCryptocurrencies("EUR")
val result = call.enqueue(object : Callback<CryptocurrenciesLatest> {
// You will always get a response even if something wrong went from the server.
override fun onFailure(call: Call<CryptocurrenciesLatest>, t: Throwable) {
Snackbar.make(findViewById(android.R.id.content),
// Throwable will let us find the error if the call failed.
"Call failed! " + t.localizedMessage,
Snackbar.LENGTH_INDEFINITE).show()
}
override fun onResponse(call: Call<CryptocurrenciesLatest>, response: Response<CryptocurrenciesLatest>) {
// Check if the response is successful, which means the request was successfully
// received, understood, accepted and returned code in range [200..300).
if (response.isSuccessful) {
// If everything is OK, let the user know that.
Toast.makeText(this@AddSearchActivity, "Call OK.", Toast.LENGTH_LONG).show();
// Than quickly map server response data to the ListView adapter.
val cryptocurrenciesLatest: CryptocurrenciesLatest? = response.body()
cryptocurrenciesLatest!!.data.forEach {
val cryptocurrency = Cryptocurrency(it.name, it.cmcRank.toShort(),
0.0, it.symbol, currentFiatCurrencyCode, it.quote.currency.price,
0.0, it.quote.currency.percentChange1h,
it.quote.currency.percentChange7d, it.quote.currency.percentChange24h,
0.0)
adapterData.add(cryptocurrency)
}
listView.visibility = View.VISIBLE
listAdapter.setData(adapterData)
}
// Else if the response is unsuccessful it will be defined by some special HTTP
// error code, which we can show for the user.
else Snackbar.make(findViewById(android.R.id.content),
"Call error with HTTP status code " + response.code() + "!",
Snackbar.LENGTH_INDEFINITE).show()
}
})
}
...
}आप यहां कोड का पता लगा सकते हैं। याद रखें कि विचार को बेहतर बनाने के लिए यह केवल एक प्रारंभिक सरलीकृत कार्यान्वयन संस्करण है।
OkHttp 3 और Gson के साथ रेट्रोफिट 2 के लिए अंतिम सही सेटअप
ठीक है एक त्वरित प्रयोग के बाद, इस रेट्रोफिट कार्यान्वयन को अगले स्तर पर लाने का समय आ गया है। हमें पहले ही डेटा सफलतापूर्वक मिल गया है लेकिन सही ढंग से नहीं। हम लोडिंग, त्रुटि और सफलता जैसे राज्यों को याद कर रहे हैं। हमारा कोड चिंताओं को अलग किए बिना मिश्रित है। अपने सभी कोड को किसी गतिविधि या खंड में लिखना एक सामान्य गलती है। हमारा गतिविधि वर्ग UI आधारित है और इसमें केवल तर्क शामिल होना चाहिए जो UI और ऑपरेटिंग सिस्टम इंटरैक्शन को संभालता है।
दरअसल, इस क्विक सेटअप के बाद मैंने काफी काम किया और कई बदलाव किए। लेख में बदले गए सभी कोड डालने का कोई मतलब नहीं है। इसके बजाय आपको अंतिम भाग 5 कोड रेपो यहां ब्राउज़ करना चाहिए। मैंने सब कुछ बहुत अच्छी तरह से टिप्पणी की है और मेरा कोड स्पष्ट होना चाहिए ताकि आप समझ सकें। लेकिन मैं उन सबसे महत्वपूर्ण चीजों के बारे में बात करने जा रहा हूं जो मैंने की हैं और मैंने उन्हें क्यों किया।
सुधार के लिए पहला कदम डिपेंडेंसी इंजेक्शन का उपयोग शुरू करना था। पिछले भाग से याद रखें कि हमारे पास पहले से ही परियोजना के अंदर डैगर 2 को सही ढंग से लागू किया गया है। इसलिए मैंने इसे रेट्रोफिट सेटअप के लिए इस्तेमाल किया।
/**
* AppModule will provide app-wide dependencies for a part of the application.
* It should initialize objects used across our application, such as Room database, Retrofit, Shared Preference, etc.
*/
@Module(includes = [ViewModelsModule::class])
class AppModule() {
...
@Provides
@Singleton
fun provideHttpClient(): OkHttpClient {
// We need to prepare a custom OkHttp client because need to use our custom call interceptor.
// to be able to authenticate our requests.
val builder = OkHttpClient.Builder()
// We add the interceptor to OkHttpClient.
// It will add authentication headers to every call we make.
builder.interceptors().add(AuthenticationInterceptor())
// Configure this client not to retry when a connectivity problem is encountered.
builder.retryOnConnectionFailure(false)
// Log requests and responses.
// Add logging as the last interceptor, because this will also log the information which
// you added or manipulated with previous interceptors to your request.
builder.interceptors().add(HttpLoggingInterceptor().apply {
// For production environment to enhance apps performance we will be skipping any
// logging operation. We will show logs just for debug builds.
level = if (BuildConfig.DEBUG) HttpLoggingInterceptor.Level.BODY else HttpLoggingInterceptor.Level.NONE
})
return builder.build()
}
@Provides
@Singleton
fun provideApiService(httpClient: OkHttpClient): ApiService {
return Retrofit.Builder() // Create retrofit builder.
.baseUrl(API_SERVICE_BASE_URL) // Base url for the api has to end with a slash.
.addConverterFactory(GsonConverterFactory.create()) // Use GSON converter for JSON to POJO object mapping.
.addCallAdapterFactory(LiveDataCallAdapterFactory())
.client(httpClient) // Here we set the custom OkHttp client we just created.
.build().create(ApiService::class.java) // We create an API using the interface we defined.
}
...
}अब जैसा कि आप देख रहे हैं, रेट्रोफिट गतिविधि वर्ग से अलग हो गया है जैसा कि होना चाहिए। इसे केवल एक बार इनिशियलाइज़ किया जाएगा और ऐप-वाइड इस्तेमाल किया जाएगा।
जैसा कि आपने रेट्रोफिट बिल्डर इंस्टेंस बनाते समय देखा होगा, हमने addCallAdapterFactory का उपयोग करके एक विशेष रेट्रोफिट कॉल एडेप्टर जोड़ा है। . डिफ़ॉल्ट रूप से, रेट्रोफिट एक Call<T> देता है , लेकिन हमारे प्रोजेक्ट के लिए हमें इसे LiveData<T> . लौटाने की आवश्यकता है प्रकार। ऐसा करने के लिए हमें LiveDataCallAdapter . जोड़ना होगा LiveDataCallAdapterFactory . का उपयोग करके ।
/**
* A Retrofit adapter that converts the Call into a LiveData of ApiResponse.
* @param <R>
</R> */
class LiveDataCallAdapter<R>(private val responseType: Type) :
CallAdapter<R, LiveData<ApiResponse<R>>> {
override fun responseType() = responseType
override fun adapt(call: Call<R>): LiveData<ApiResponse<R>> {
return object : LiveData<ApiResponse<R>>() {
private var started = AtomicBoolean(false)
override fun onActive() {
super.onActive()
if (started.compareAndSet(false, true)) {
call.enqueue(object : Callback<R> {
override fun onResponse(call: Call<R>, response: Response<R>) {
postValue(ApiResponse.create(response))
}
override fun onFailure(call: Call<R>, throwable: Throwable) {
postValue(ApiResponse.create(throwable))
}
})
}
}
}
}
}class LiveDataCallAdapterFactory : CallAdapter.Factory() {
override fun get(
returnType: Type,
annotations: Array<Annotation>,
retrofit: Retrofit
): CallAdapter<*, *>? {
if (CallAdapter.Factory.getRawType(returnType) != LiveData::class.java) {
return null
}
val observableType = CallAdapter.Factory.getParameterUpperBound(0, returnType as ParameterizedType)
val rawObservableType = CallAdapter.Factory.getRawType(observableType)
if (rawObservableType != ApiResponse::class.java) {
throw IllegalArgumentException("type must be a resource")
}
if (observableType !is ParameterizedType) {
throw IllegalArgumentException("resource must be parameterized")
}
val bodyType = CallAdapter.Factory.getParameterUpperBound(0, observableType)
return LiveDataCallAdapter<Any>(bodyType)
}
}
अब हमें मिलेगा LiveData<T> Call<T> . के बजाय ApiService . में परिभाषित रेट्रोफिट सेवा विधियों से वापसी प्रकार के रूप में इंटरफ़ेस।
बनाने के लिए एक और महत्वपूर्ण कदम रिपोजिटरी पैटर्न का उपयोग शुरू करना है। मैंने इसके बारे में भाग 3 में बात की है। यह याद रखने के लिए कि यह कहाँ जाता है, उस पोस्ट से हमारी एमवीवीएम आर्किटेक्चर स्कीमा देखें।
जैसा कि आप चित्र में देख रहे हैं, डेटा के लिए रिपोजिटरी एक अलग परत है। डेटा प्राप्त करने या भेजने के लिए यह हमारे संपर्क का एकमात्र स्रोत है। जब हम रिपोजिटरी का उपयोग करते हैं, तो हम चिंता सिद्धांत के पृथक्करण का पालन कर रहे हैं। हमारे पास अलग-अलग डेटा स्रोत हो सकते हैं (जैसे हमारे मामले में SQLite डेटाबेस से लगातार डेटा और वेब सेवाओं से डेटा), लेकिन रिपॉजिटरी हमेशा सभी ऐप डेटा के लिए सत्य का एकल स्रोत होने वाला है।
अपने रेट्रोफिट कार्यान्वयन के साथ सीधे संवाद करने के बजाय, हम इसके लिए रिपोजिटरी का उपयोग करने जा रहे हैं। प्रत्येक प्रकार की इकाई के लिए, हमारे पास एक अलग भंडार होगा।
/**
* The class for managing multiple data sources.
*/
@Singleton
class CryptocurrencyRepository @Inject constructor(
private val context: Context,
private val appExecutors: AppExecutors,
private val myCryptocurrencyDao: MyCryptocurrencyDao,
private val cryptocurrencyDao: CryptocurrencyDao,
private val api: ApiService,
private val sharedPreferences: SharedPreferences
) {
// Just a simple helper variable to store selected fiat currency code during app lifecycle.
// It is needed for main screen currency spinner. We set it to be same as in shared preferences.
var selectedFiatCurrencyCode: String = getCurrentFiatCurrencyCode()
...
// The Resource wrapping of LiveData is useful to update the UI based upon the state.
fun getAllCryptocurrencyLiveDataResourceList(fiatCurrencyCode: String, shouldFetch: Boolean = false, callDelay: Long = 0): LiveData<Resource<List<Cryptocurrency>>> {
return object : NetworkBoundResource<List<Cryptocurrency>, CoinMarketCap<List<CryptocurrencyLatest>>>(appExecutors) {
// Here we save the data fetched from web-service.
override fun saveCallResult(item: CoinMarketCap<List<CryptocurrencyLatest>>) {
val list = getCryptocurrencyListFromResponse(fiatCurrencyCode, item.data, item.status?.timestamp)
cryptocurrencyDao.reloadCryptocurrencyList(list)
myCryptocurrencyDao.reloadMyCryptocurrencyList(list)
}
// Returns boolean indicating if to fetch data from web or not, true means fetch the data from web.
override fun shouldFetch(data: List<Cryptocurrency>?): Boolean {
return data == null || shouldFetch
}
override fun fetchDelayMillis(): Long {
return callDelay
}
// Contains the logic to get data from the Room database.
override fun loadFromDb(): LiveData<List<Cryptocurrency>> {
return Transformations.switchMap(cryptocurrencyDao.getAllCryptocurrencyLiveDataList()) { data ->
if (data.isEmpty()) {
AbsentLiveData.create()
} else {
cryptocurrencyDao.getAllCryptocurrencyLiveDataList()
}
}
}
// Contains the logic to get data from web-service using Retrofit.
override fun createCall(): LiveData<ApiResponse<CoinMarketCap<List<CryptocurrencyLatest>>>> = api.getAllCryptocurrencies(fiatCurrencyCode)
}.asLiveData()
}
...
fun getCurrentFiatCurrencyCode(): String {
return sharedPreferences.getString(context.resources.getString(R.string.pref_fiat_currency_key), context.resources.getString(R.string.pref_default_fiat_currency_value))
?: context.resources.getString(R.string.pref_default_fiat_currency_value)
}
...
private fun getCryptocurrencyListFromResponse(fiatCurrencyCode: String, responseList: List<CryptocurrencyLatest>?, timestamp: Date?): ArrayList<Cryptocurrency> {
val cryptocurrencyList: MutableList<Cryptocurrency> = ArrayList()
responseList?.forEach {
val cryptocurrency = Cryptocurrency(it.id, it.name, it.cmcRank.toShort(),
it.symbol, fiatCurrencyCode, it.quote.currency.price,
it.quote.currency.percentChange1h,
it.quote.currency.percentChange7d, it.quote.currency.percentChange24h, timestamp)
cryptocurrencyList.add(cryptocurrency)
}
return cryptocurrencyList as ArrayList<Cryptocurrency>
}
}
जैसा कि आप CryptocurrencyRepository . में देखते हैं क्लास कोड, मैं NetworkBoundResource . का उपयोग कर रहा हूं सार वर्ग। यह क्या है और हमें इसकी आवश्यकता क्यों है?
NetworkBoundResource एक छोटा लेकिन बहुत महत्वपूर्ण सहायक वर्ग है जो हमें स्थानीय डेटाबेस और वेब सेवा के बीच एक सिंक्रनाइज़ेशन बनाए रखने की अनुमति देगा। हमारा लक्ष्य एक आधुनिक एप्लिकेशन बनाना है जो हमारे डिवाइस के ऑफ़लाइन होने पर भी सुचारू रूप से काम करेगा। साथ ही इस क्लास की मदद से हम विभिन्न नेटवर्क स्टेट्स जैसे एरर या लोडिंग को यूजर के लिए नेत्रहीन रूप से प्रस्तुत करने में सक्षम होंगे।
NetworkBoundResource संसाधन के लिए डेटाबेस को देखकर शुरू होता है। जब प्रविष्टि को पहली बार डेटाबेस से लोड किया जाता है, तो यह जांचता है कि क्या परिणाम भेजने के लिए पर्याप्त है या यदि इसे नेटवर्क से पुनः प्राप्त किया जाना चाहिए। ध्यान दें कि ये दोनों स्थितियां एक ही समय में हो सकती हैं, यह देखते हुए कि आप शायद कैश्ड डेटा को नेटवर्क से अपडेट करते समय दिखाना चाहते हैं।
यदि नेटवर्क कॉल सफलतापूर्वक पूरा हो जाता है, तो यह डेटाबेस में प्रतिक्रिया को सहेजता है और स्ट्रीम को फिर से शुरू करता है। यदि नेटवर्क अनुरोध विफल हो जाता है, तो NetworkBoundResource सीधे विफलता भेजता है।
/**
* A generic class that can provide a resource backed by both the sqlite database and the network.
*
*
* You can read more about it in the [Architecture
* Guide](https://developer.android.com/arch).
* @param <ResultType> - Type for the Resource data.
* @param <RequestType> - Type for the API response.
</RequestType></ResultType> */
// It defines two type parameters, ResultType and RequestType,
// because the data type returned from the API might not match the data type used locally.
abstract class NetworkBoundResource<ResultType, RequestType>
@MainThread constructor(private val appExecutors: AppExecutors) {
// The final result LiveData.
private val result = MediatorLiveData<Resource<ResultType>>()
init {
// Send loading state to UI.
result.value = Resource.loading(null)
@Suppress("LeakingThis")
val dbSource = loadFromDb()
result.addSource(dbSource) { data ->
result.removeSource(dbSource)
if (shouldFetch(data)) {
fetchFromNetwork(dbSource)
} else {
result.addSource(dbSource) { newData ->
setValue(Resource.successDb(newData))
}
}
}
}
@MainThread
private fun setValue(newValue: Resource<ResultType>) {
if (result.value != newValue) {
result.value = newValue
}
}
// Fetch the data from network and persist into DB and then send it back to UI.
private fun fetchFromNetwork(dbSource: LiveData<ResultType>) {
val apiResponse = createCall()
// We re-attach dbSource as a new source, it will dispatch its latest value quickly.
result.addSource(dbSource) { newData ->
setValue(Resource.loading(newData))
}
// Create inner function as we want to delay it.
fun fetch() {
result.addSource(apiResponse) { response ->
result.removeSource(apiResponse)
result.removeSource(dbSource)
when (response) {
is ApiSuccessResponse -> {
appExecutors.diskIO().execute {
saveCallResult(processResponse(response))
appExecutors.mainThread().execute {
// We specially request a new live data,
// otherwise we will get immediately last cached value,
// which may not be updated with latest results received from network.
result.addSource(loadFromDb()) { newData ->
setValue(Resource.successNetwork(newData))
}
}
}
}
is ApiEmptyResponse -> {
appExecutors.mainThread().execute {
// reload from disk whatever we had
result.addSource(loadFromDb()) { newData ->
setValue(Resource.successDb(newData))
}
}
}
is ApiErrorResponse -> {
onFetchFailed()
result.addSource(dbSource) { newData ->
setValue(Resource.error(response.errorMessage, newData))
}
}
}
}
}
// Add delay before call if needed.
val delay = fetchDelayMillis()
if (delay > 0) {
Handler().postDelayed({ fetch() }, delay)
} else fetch()
}
// Called when the fetch fails. The child class may want to reset components
// like rate limiter.
protected open fun onFetchFailed() {}
// Returns a LiveData object that represents the resource that's implemented
// in the base class.
fun asLiveData() = result as LiveData<Resource<ResultType>>
@WorkerThread
protected open fun processResponse(response: ApiSuccessResponse<RequestType>) = response.body
// Called to save the result of the API response into the database.
@WorkerThread
protected abstract fun saveCallResult(item: RequestType)
// Called with the data in the database to decide whether to fetch
// potentially updated data from the network.
@MainThread
protected abstract fun shouldFetch(data: ResultType?): Boolean
// Make a call to the server after some delay for better user experience.
protected open fun fetchDelayMillis(): Long = 0
// Called to get the cached data from the database.
@MainThread
protected abstract fun loadFromDb(): LiveData<ResultType>
// Called to create the API call.
@MainThread
protected abstract fun createCall(): LiveData<ApiResponse<RequestType>>
}
हुड के तहत, NetworkBoundResource क्लास MediatorLiveData और एक साथ कई LiveData स्रोतों को देखने की इसकी क्षमता का उपयोग करके बनाई गई है। यहां हमारे पास दो लाइवडेटा स्रोत हैं:डेटाबेस और नेटवर्क कॉल प्रतिक्रिया। उन दोनों LiveData को एक MediatorLiveData में लपेटा गया है जिसे NetworkBoundResource . द्वारा उजागर किया गया है ।
आइए करीब से देखें कि कैसे NetworkBoundResource हमारे ऐप में काम करेगा। कल्पना कीजिए कि उपयोगकर्ता ऐप लॉन्च करेगा और निचले दाएं कोने पर एक फ्लोटिंग एक्शन बटन पर क्लिक करेगा। ऐप ऐड क्रिप्टो कॉइन स्क्रीन लॉन्च करेगा। अब हम NetworkBoundResource . का विश्लेषण कर सकते हैं इसके अंदर का उपयोग।
यदि ऐप नए सिरे से इंस्टॉल किया गया है और यह इसका पहला लॉन्च है, तो स्थानीय डेटाबेस के अंदर कोई डेटा संग्रहीत नहीं होगा। क्योंकि दिखाने के लिए कोई डेटा नहीं है, एक लोडिंग प्रगति बार UI दिखाया जाएगा। इस बीच, ऐप सभी क्रिप्टोकरेंसी सूची प्राप्त करने के लिए एक वेब सेवा के माध्यम से सर्वर से एक अनुरोध कॉल करने जा रहा है।
यदि प्रतिक्रिया असफल होती है तो त्रुटि संदेश UI एक बटन दबाकर कॉल को पुनः प्रयास करने की क्षमता के साथ दिखाया जाएगा। जब एक अनुरोध कॉल अंत में सफल होता है, तो प्रतिक्रिया डेटा स्थानीय SQLite डेटाबेस में सहेजा जाएगा।
अगर हम अगली बार उसी स्क्रीन पर वापस आते हैं, तो ऐप फिर से इंटरनेट पर कॉल करने के बजाय डेटाबेस से डेटा लोड करेगा। लेकिन उपयोगकर्ता पुल-टू-रीफ्रेश कार्यक्षमता को लागू करके एक नया डेटा अपडेट मांग सकता है। नेटवर्क कॉल होने पर पुरानी डेटा जानकारी दिखाई जाएगी। यह सब NetworkBoundResource . की मदद से किया जाता है ।
हमारे रिपोजिटरी और LiveDataCallAdapter . में उपयोग किया जाने वाला एक अन्य वर्ग जहां सारा "जादू" होता है ApiResponse . दरअसल ApiResponse Retrofit2.Response . के आसपास बस एक साधारण सामान्य आवरण है क्लास जो हर प्रतिक्रिया को LiveData के इंस्टेंस में बदल देती है।
/**
* Common class used by API responses. ApiResponse is a simple wrapper around the Retrofit2.Call
* class that convert responses to instances of LiveData.
* @param <CoinMarketCapType> the type of the response object
</T> */
@Suppress("unused") // T is used in extending classes
sealed class ApiResponse<CoinMarketCapType> {
companion object {
fun <CoinMarketCapType> create(error: Throwable): ApiErrorResponse<CoinMarketCapType> {
return ApiErrorResponse(error.message ?: "Unknown error.")
}
fun <CoinMarketCapType> create(response: Response<CoinMarketCapType>): ApiResponse<CoinMarketCapType> {
return if (response.isSuccessful) {
val body = response.body()
if (body == null || response.code() == 204) {
ApiEmptyResponse()
} else {
ApiSuccessResponse(body = body)
}
} else {
// Convert error response to JSON object.
val gson = Gson()
val type = object : TypeToken<CoinMarketCap<CoinMarketCapType>>() {}.type
val errorResponse: CoinMarketCap<CoinMarketCapType> = gson.fromJson(response.errorBody()!!.charStream(), type)
val msg = errorResponse.status?.errorMessage ?: errorResponse.message
val errorMsg = if (msg.isNullOrEmpty()) {
response.message()
} else {
msg
}
ApiErrorResponse(errorMsg ?: "Unknown error.")
}
}
}
}
/**
* Separate class for HTTP 204 resposes so that we can make ApiSuccessResponse's body non-null.
*/
class ApiEmptyResponse<CoinMarketCapType> : ApiResponse<CoinMarketCapType>()
data class ApiSuccessResponse<CoinMarketCapType>(val body: CoinMarketCapType) : ApiResponse<CoinMarketCapType>()
data class ApiErrorResponse<CoinMarketCapType>(val errorMessage: String) : ApiResponse<CoinMarketCapType>()
इस रैपर वर्ग के अंदर, यदि हमारी प्रतिक्रिया में कोई त्रुटि है, तो हम त्रुटि को JSON ऑब्जेक्ट में बदलने के लिए Gson लाइब्रेरी का उपयोग करते हैं। हालाँकि, यदि प्रतिक्रिया सफल रही, तो JSON से POJO ऑब्जेक्ट मैपिंग के लिए Gson कनवर्टर का उपयोग किया जाता है। GsonConverterFactory . के साथ रेट्रोफिट बिल्डर इंस्टेंस बनाते समय हमने इसे पहले ही जोड़ दिया है डैगर के अंदर AppModule फ़ंक्शन provideApiService ।
छवि लोड करने के लिए ग्लाइड
ग्लाइड क्या है? डॉक्स से:
ग्लाइड एंड्रॉइड के लिए एक तेज़ और कुशल ओपन सोर्स मीडिया प्रबंधन और छवि लोडिंग ढांचा है जो मीडिया डिकोडिंग, मेमोरी और डिस्क कैशिंग, और संसाधन पूलिंग को एक सरल और उपयोग में आसान इंटरफ़ेस में लपेटता है।
ग्लाइड का प्राथमिक ध्यान किसी भी प्रकार की छवियों की सूची को यथासंभव आसान और तेज़ स्क्रॉल करने पर है, लेकिन यह लगभग किसी भी मामले के लिए भी प्रभावी है जहां आपको दूरस्थ छवि लाने, आकार बदलने और प्रदर्शित करने की आवश्यकता होती है।
एक जटिल पुस्तकालय की तरह लगता है जो कई उपयोगी सुविधाएँ प्रदान करता है जिन्हें आप स्वयं विकसित नहीं करना चाहेंगे। माई क्रिप्टो कॉइन्स ऐप में, हमारे पास कई सूची स्क्रीन हैं जहां हमें कई क्रिप्टोकुरेंसी लोगो दिखाने की आवश्यकता होती है - इंटरनेट से एक ही बार में ली गई तस्वीरें - और फिर भी उपयोगकर्ता के लिए एक आसान स्क्रॉलिंग अनुभव सुनिश्चित करती है। अतः यह पुस्तकालय हमारी आवश्यकताओं के अनुकूल है। साथ ही यह लाइब्रेरी Android डेवलपर्स के बीच बहुत लोकप्रिय है।
My Crypto Coins ऐप प्रोजेक्ट पर ग्लाइड सेटअप करने के चरण:
निर्भरता घोषित करें
नवीनतम ग्लाइड संस्करण प्राप्त करें। फिर से संस्करण एक अलग फ़ाइल है versions.gradle परियोजना के लिए।
// Glide
implementation "com.github.bumptech.glide:glide:$versions.glide"
kapt "com.github.bumptech.glide:compiler:$versions.glide"
// Glide's OkHttp3 integration.
implementation "com.github.bumptech.glide:okhttp3-integration:$versions.glide"+"@aar"
चूंकि हम सभी नेटवर्क संचालन के लिए अपने प्रोजेक्ट में नेटवर्किंग लाइब्रेरी OkHttp का उपयोग करना चाहते हैं, इसलिए हमें डिफ़ॉल्ट के बजाय इसके लिए विशिष्ट ग्लाइड एकीकरण को शामिल करना होगा। चूंकि ग्लाइड इंटरनेट के माध्यम से छवियों को लोड करने के लिए एक नेटवर्क अनुरोध करने जा रहा है, इसलिए हमें अनुमति शामिल करने की आवश्यकता है INTERNET हमारे AndroidManifest.xml . में फ़ाइल - लेकिन हमने पहले ही रेट्रोफिट सेटअप के साथ ऐसा कर लिया है।
AppGlideModule बनाएं
ग्लाइड v4, जिसका हम उपयोग करेंगे, अनुप्रयोगों के लिए एक उत्पन्न एपीआई प्रदान करता है। यह एक एपीआई उत्पन्न करने के लिए एक एनोटेशन प्रोसेसर का उपयोग करेगा जो अनुप्रयोगों को ग्लाइड के एपीआई का विस्तार करने की अनुमति देता है और एकीकरण पुस्तकालयों द्वारा प्रदान किए गए घटकों को शामिल करता है। किसी भी ऐप के लिए जेनरेट किए गए ग्लाइड एपीआई को एक्सेस करने के लिए हमें उचित रूप से एनोटेट किया गया AppGlideModule शामिल करना होगा। कार्यान्वयन। जेनरेट किए गए एपीआई का केवल एक ही कार्यान्वयन हो सकता है और केवल एक AppGlideModule . हो सकता है प्रति आवेदन।
आइए AppGlideModule . का विस्तार करने वाली एक क्लास बनाएं आपके ऐप प्रोजेक्ट में कहीं:
/**
* Glide v4 uses an annotation processor to generate an API that allows applications to access all
* options in RequestBuilder, RequestOptions and any included integration libraries in a single
* fluent API.
*
* The generated API serves two purposes:
* Integration libraries can extend Glide’s API with custom options.
* Applications can extend Glide’s API by adding methods that bundle commonly used options.
*
* Although both of these tasks can be accomplished by hand by writing custom subclasses of
* RequestOptions, doing so is challenging and produces a less fluent API.
*/
@GlideModule
class AppGlideModule : AppGlideModule()
भले ही हमारा एप्लिकेशन कोई अतिरिक्त सेटिंग नहीं बदल रहा हो या AppGlideModule . में किसी भी तरीके को लागू नहीं कर रहा हो , हमें अभी भी ग्लाइड का उपयोग करने के लिए इसके कार्यान्वयन की आवश्यकता है। आपको AppGlideModule . में किसी भी तरीके को लागू करने की आवश्यकता नहीं है एपीआई उत्पन्न करने के लिए। आप कक्षा को तब तक खाली छोड़ सकते हैं जब तक वह AppGlideModule का विस्तार करती है और @GlideModule . के साथ एनोटेट किया गया है ।
ग्लाइड-जनरेटेड API का उपयोग करें
AppGlideModule using का उपयोग करते समय , एप्लिकेशन GlideApp.with() . के साथ सभी लोड प्रारंभ करके API का उपयोग कर सकते हैं . यह वह कोड है जो दिखाता है कि कैसे मैंने सभी क्रिप्टोकरंसी सूची में क्रिप्टो कॉइन स्क्रीन को जोड़ने के लिए क्रिप्टोक्यूरेंसी लोगो को लोड करने और दिखाने के लिए ग्लाइड का उपयोग किया है।
class AddSearchListAdapter(val context: Context, private val cryptocurrencyClickCallback: ((Cryptocurrency) -> Unit)?) : BaseAdapter() {
...
override fun getView(position: Int, convertView: View?, parent: ViewGroup?): View {
...
val itemBinding: ActivityAddSearchListItemBinding
...
// We make an Uri of image that we need to load. Every image unique name is its id.
val imageUri = Uri.parse(CRYPTOCURRENCY_IMAGE_URL).buildUpon()
.appendPath(CRYPTOCURRENCY_IMAGE_SIZE_PX)
.appendPath(cryptocurrency.id.toString() + CRYPTOCURRENCY_IMAGE_FILE)
.build()
// Glide generated API from AppGlideModule.
GlideApp
// We need to provide context to make a call.
.with(itemBinding.root)
// Here you specify which image should be loaded by providing Uri.
.load(imageUri)
// The way you combine and execute multiple transformations.
// WhiteBackground is our own implemented custom transformation.
// CircleCrop is default transformation that Glide ships with.
.transform(MultiTransformation(WhiteBackground(), CircleCrop()))
// The target ImageView your image is supposed to get displayed in.
.into(itemBinding.itemImageIcon.imageview_front)
...
return itemBinding.root
}
...
}जैसा कि आप देखते हैं, आप कोड की कुछ पंक्तियों के साथ ग्लाइड का उपयोग शुरू कर सकते हैं और इसे आपके लिए पूरी मेहनत करने दें। यह बहुत सीधा है।
Kotlin Coroutines
इस ऐप का निर्माण करते समय, हम उन परिस्थितियों का सामना करने जा रहे हैं जब हम समय लेने वाले कार्यों को चलाएंगे जैसे कि डेटाबेस में डेटा लिखना या उससे पढ़ना, नेटवर्क से डेटा प्राप्त करना और अन्य। इन सभी सामान्य कार्यों को पूरा होने में Android फ्रेमवर्क के मुख्य सूत्र द्वारा अनुमत से अधिक समय लगता है।
मुख्य धागा एक एकल धागा है जो यूआई के सभी अपडेट को संभालता है। डेवलपर्स के लिए आवश्यक है कि वे ऐप को फ़्रीज़ होने से बचाने के लिए या एप्लिकेशन नॉट रिस्पॉन्डिंग डायलॉग के साथ क्रैश होने से बचाने के लिए इसे ब्लॉक न करें। Kotlin coroutines मुख्य थ्रेड सुरक्षा की शुरुआत करके हमारे लिए इस समस्या को हल करने जा रहा है। यह आखिरी गायब टुकड़ा है जिसे हम My Crypto Coins ऐप में जोड़ना चाहते हैं।
Coroutines एक कोटलिन सुविधा है जो डेटाबेस या नेटवर्क एक्सेस जैसे लंबे समय तक चलने वाले कार्यों के लिए async कॉलबैक को अनुक्रमिक कोड में परिवर्तित करती है। कोरआउट्स के साथ, आप एसिंक्रोनस कोड लिख सकते हैं, जो परंपरागत रूप से एक सिंक्रोनस शैली का उपयोग करके कॉलबैक पैटर्न का उपयोग करके लिखा गया था। किसी फ़ंक्शन का रिटर्न मान एसिंक्रोनस कॉल का परिणाम प्रदान करेगा। क्रमिक रूप से लिखा गया कोड आमतौर पर पढ़ने में आसान होता है, और अपवाद जैसी भाषा सुविधाओं का भी उपयोग कर सकता है।
इसलिए हम इस ऐप में हर जगह कोरटाइन का उपयोग करने जा रहे हैं, जहां हमें लंबे समय से चल रहे कार्य से परिणाम उपलब्ध होने तक और निष्पादन जारी रखने के लिए प्रतीक्षा करने की आवश्यकता है। आइए हमारे व्यूमोडेल के लिए एक सटीक कार्यान्वयन देखें जहां हम मुख्य स्क्रीन पर प्रस्तुत हमारी क्रिप्टोक्यूर्यूशंस के लिए सर्वर से नवीनतम डेटा प्राप्त करने का पुनः प्रयास करेंगे।
प्रोजेक्ट में सबसे पहले कोरआउट्स जोड़ें:
// Coroutines support libraries for Kotlin.
// Dependencies for coroutines.
implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:$versions.coroutines"
// Dependency is for the special UI context that can be passed to coroutine builders that use
// the main thread dispatcher to dispatch events on the main thread.
implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:$versions.coroutines"फिर हम एब्सट्रैक्ट क्लास बनाएंगे जो किसी भी व्यूमोडेल के लिए इस्तेमाल होने वाला बेस क्लास बन जाएगा, जिसे हमारे मामले में कोरआउटिन जैसी सामान्य कार्यक्षमता की आवश्यकता होती है:
abstract class BaseViewModel : ViewModel() {
// In Kotlin, all coroutines run inside a CoroutineScope.
// A scope controls the lifetime of coroutines through its job.
private val viewModelJob = Job()
// Since uiScope has a default dispatcher of Dispatchers.Main, this coroutine will be launched
// in the main thread.
val uiScope = CoroutineScope(Dispatchers.Main + viewModelJob)
// onCleared is called when the ViewModel is no longer used and will be destroyed.
// This typically happens when the user navigates away from the Activity or Fragment that was
// using the ViewModel.
override fun onCleared() {
super.onCleared()
// When you cancel the job of a scope, it cancels all coroutines started in that scope.
// It's important to cancel any coroutines that are no longer required to avoid unnecessary
// work and memory leaks.
viewModelJob.cancel()
}
}
यहां हम विशिष्ट coroutine स्कोप बनाते हैं, जो अपने कार्य के माध्यम से coroutines के जीवनकाल को नियंत्रित करेगा। जैसा कि आप देखते हैं, स्कोप आपको एक डिफ़ॉल्ट डिस्पैचर निर्दिष्ट करने की अनुमति देता है जो नियंत्रित करता है कि कौन सा थ्रेड कोरआउटिन चलाता है। जब ViewModel का उपयोग नहीं किया जाता है, तो हम viewModelJob . को रद्द कर देते हैं और इसके साथ ही प्रत्येक कोरआउट की शुरुआत uiScope . से होती है भी रद्द कर दिया जाएगा।
अंत में, पुन:प्रयास करने की कार्यक्षमता लागू करें:
/**
* The ViewModel class is designed to store and manage UI-related data in a lifecycle conscious way.
* The ViewModel class allows data to survive configuration changes such as screen rotations.
*/
// ViewModel will require a CryptocurrencyRepository so we add @Inject code into ViewModel constructor.
class MainViewModel @Inject constructor(val context: Context, val cryptocurrencyRepository: CryptocurrencyRepository) : BaseViewModel() {
...
val mediatorLiveDataMyCryptocurrencyResourceList = MediatorLiveData<Resource<List<MyCryptocurrency>>>()
private var liveDataMyCryptocurrencyResourceList: LiveData<Resource<List<MyCryptocurrency>>>
private val liveDataMyCryptocurrencyList: LiveData<List<MyCryptocurrency>>
...
// This is additional helper variable to deal correctly with currency spinner and preference.
// It is kept inside viewmodel not to be lost because of fragment/activity recreation.
var newSelectedFiatCurrencyCode: String? = null
// Helper variable to store state of swipe refresh layout.
var isSwipeRefreshing: Boolean = false
init {
...
// Set a resource value for a list of cryptocurrencies that user owns.
liveDataMyCryptocurrencyResourceList = cryptocurrencyRepository.getMyCryptocurrencyLiveDataResourceList(cryptocurrencyRepository.getCurrentFiatCurrencyCode())
// Declare additional variable to be able to reload data on demand.
mediatorLiveDataMyCryptocurrencyResourceList.addSource(liveDataMyCryptocurrencyResourceList) {
mediatorLiveDataMyCryptocurrencyResourceList.value = it
}
...
}
...
/**
* On retry we need to run sequential code. First we need to get owned crypto coins ids from
* local database, wait for response and only after it use these ids to make a call with
* retrofit to get updated owned crypto values. This can be done using Kotlin Coroutines.
*/
fun retry(newFiatCurrencyCode: String? = null) {
// Here we store new selected currency as additional variable or reset it.
// Later if call to server is unsuccessful we will reuse it for retry functionality.
newSelectedFiatCurrencyCode = newFiatCurrencyCode
// Launch a coroutine in uiScope.
uiScope.launch {
// Make a call to the server after some delay for better user experience.
updateMyCryptocurrencyList(newFiatCurrencyCode, SERVER_CALL_DELAY_MILLISECONDS)
}
}
// Refresh the data from local database.
fun refreshMyCryptocurrencyResourceList() {
refreshMyCryptocurrencyResourceList(cryptocurrencyRepository.getMyCryptocurrencyLiveDataResourceList(cryptocurrencyRepository.getCurrentFiatCurrencyCode()))
}
// To implement a manual refresh without modifying your existing LiveData logic.
private fun refreshMyCryptocurrencyResourceList(liveData: LiveData<Resource<List<MyCryptocurrency>>>) {
mediatorLiveDataMyCryptocurrencyResourceList.removeSource(liveDataMyCryptocurrencyResourceList)
liveDataMyCryptocurrencyResourceList = liveData
mediatorLiveDataMyCryptocurrencyResourceList.addSource(liveDataMyCryptocurrencyResourceList)
{ mediatorLiveDataMyCryptocurrencyResourceList.value = it }
}
private suspend fun updateMyCryptocurrencyList(newFiatCurrencyCode: String? = null, callDelay: Long = 0) {
val fiatCurrencyCode: String = newFiatCurrencyCode
?: cryptocurrencyRepository.getCurrentFiatCurrencyCode()
isSwipeRefreshing = true
// The function withContext is a suspend function. The withContext immediately shifts
// execution of the block into different thread inside the block, and back when it
// completes. IO dispatcher is suitable for execution the network requests in IO thread.
val myCryptocurrencyIds = withContext(Dispatchers.IO) {
// Suspend until getMyCryptocurrencyIds() returns a result.
cryptocurrencyRepository.getMyCryptocurrencyIds()
}
// Here we come back to main worker thread. As soon as myCryptocurrencyIds has a result
// and main looper is available, coroutine resumes on main thread, and
// [getMyCryptocurrencyLiveDataResourceList] is called.
// We wait for background operations to complete, without blocking the original thread.
refreshMyCryptocurrencyResourceList(
cryptocurrencyRepository.getMyCryptocurrencyLiveDataResourceList
(fiatCurrencyCode, true, myCryptocurrencyIds, callDelay))
}
...
}
यहां हम एक विशेष कोटलिन कीवर्ड suspend . के साथ चिह्नित फ़ंक्शन को कॉल करते हैं कोरटाइन्स के लिए। इसका मतलब यह है कि फ़ंक्शन परिणाम तैयार होने तक निष्पादन को निलंबित कर देता है, फिर यह फिर से शुरू होता है जहां परिणाम के साथ छोड़ा था। हालांकि परिणाम की प्रतीक्षा में इसे निलंबित कर दिया जाता है, लेकिन यह उस थ्रेड को अनवरोधित कर देता है जिस पर वह चल रहा है।
साथ ही, एक सस्पेंड फंक्शन में हम दूसरे सस्पेंड फंक्शन को कॉल कर सकते हैं। जैसा कि आप देख सकते हैं कि हम withContext . के रूप में चिह्नित नए सस्पेंड फ़ंक्शन को कॉल करके ऐसा करते हैं जिसे अलग-अलग थ्रेड पर निष्पादित किया जाता है।
इस सभी कोड का विचार यह है कि हम अच्छे दिखने वाले अनुक्रमिक कोड बनाने के लिए कई कॉलों को जोड़ सकते हैं। सबसे पहले हम स्थानीय डेटाबेस से क्रिप्टो करेंसी की आईडी प्राप्त करने का अनुरोध करते हैं और प्रतिक्रिया की प्रतीक्षा करते हैं। इसे प्राप्त करने के बाद ही हम उन अद्यतन क्रिप्टोकुरेंसी मूल्यों को प्राप्त करने के लिए रेट्रोफिट के साथ एक नई कॉल करने के लिए प्रतिक्रिया आईडी का उपयोग करते हैं। यही हमारी पुन:प्रयास की कार्यक्षमता है।
हमने इसे बनाया! अंतिम विचार, संग्रह, ऐप और प्रस्तुति
बधाई हो, अगर आप अंत तक पहुंचने में कामयाब रहे तो मुझे खुशी है। इस ऐप को बनाने के सभी महत्वपूर्ण बिंदुओं को कवर किया गया है। इस भाग में बहुत कुछ नया किया गया था और उनमें से बहुत कुछ इस लेख द्वारा कवर नहीं किया गया है, लेकिन मैंने अपने कोड को हर जगह बहुत अच्छी तरह से टिप्पणी की है ताकि आप इसमें खो न जाएं। इस भाग 5 के लिए अंतिम कोड यहाँ GitHub पर देखें:
GitHub पर स्रोत देखें।
मेरे लिए व्यक्तिगत रूप से सबसे बड़ी चुनौती नई तकनीकों को सीखना नहीं था, ऐप को विकसित करना नहीं था, बल्कि इन सभी लेखों को लिखना था। दरअसल मैं खुद से बहुत खुश हूं कि मैंने यह चैलेंज पूरा किया। दूसरों को पढ़ाने की तुलना में सीखना और विकसित करना आसान है, लेकिन यही वह जगह है जहां आप विषय को और भी बेहतर समझ सकते हैं। मेरी सलाह है कि अगर आप नई चीजें सीखने का सबसे अच्छा तरीका ढूंढ रहे हैं तो तुरंत कुछ खुद बनाना शुरू कर दें। मैं वादा करता हूँ कि आप बहुत कुछ और जल्दी सीखेंगे।
ये सभी लेख "क्रिप्टोफोलियो" (पहले "माई क्रिप्टो कॉइन्स") ऐप के संस्करण 1.0.0 पर आधारित हैं, जिसे आप यहां एक अलग एपीके फ़ाइल के रूप में डाउनलोड कर सकते हैं। लेकिन मुझे बहुत खुशी होगी अगर आप सीधे स्टोर से नवीनतम ऐप संस्करण को इंस्टॉल और रेट करते हैं:
इसे Google Play पर प्राप्त करें
कृपया बेझिझक इस सरल प्रस्तुति वेबसाइट पर जाएँ जो मैंने इस परियोजना के लिए बनाई है:
Kriptofolio.app
आशी! पढ़ने के लिए धन्यवाद! मैंने मूल रूप से इस पोस्ट को अपने निजी ब्लॉग www.baruckis.com के लिए 11 मई 2019 को प्रकाशित किया था।