استفاده از Dagger hilt به صورت پروژه محور (قسمت اول)

بعد از چند وقت تصمیم گرفتم که یک سری مقاله برای تکمیل کردن دوره توسعه اپلیکیشن های مدرن اندرویدی منتشر کنم. در دوره قبلی به علت کمبود وقت، Dagger 2 رو آموزش ندادم و به جای اون از KOIN استفاده کردم؛ اما چند وقت پیش با شنیدن ارائه Dagger Hilt این فکر به سرم زد که بیام و ی مقاله پروژه محور(سورس کد بعد از دوره در گیتهاب قرار خواهد گرفت) راجبش منتشر کنم. با ی سرچ ساده ی آموزش ساده از MindOrks پیدا کردم که خیلی ساده آموزشو پیش برده که برای این سری مقاله اکثر قسمتاشو مثل اون پیش میریم!

قسمت ها:

قدم اول: کار اپلیکیشن

برای اینکه اپلیکیشن تقریبا واقعی به نظر بیاد، به یک Web API نیاز داریم. با ی سرچ ساده، دو API برای یکی از سریال های محبوبم Game of thrones پیاده کردم?:

An API of Ice And Fire

Game of Thrones Quotes API

قدم دوم: ساخت پروژه

شروع به ساخت یک اپلیکیشن در اندروید استدیو کردم و اسم پروژه رو Ice and Fire گذاشتم.

ساختار پوشه بندی اصلی:

کتابخانه های اضافه شده:

 implementation 'androidx.constraintlayout:constraintlayout:2.0.0-rc1' 

برای استفاده از Motion layout از ورژن ۲ کانسترینت لایوت استفاده می کنم.

کتاب خانه های جت پک

//android Arch components:
    implementation &quotandroidx.concurrent:concurrent-futures-ktx:1.1.0-rc01&quot
 def lifecycle_version = &quot2.2.0&quot
 def arch_version = &quot2.1.0&quot
 // ViewModel
    implementation &quotandroidx.lifecycle:lifecycle-viewmodel-ktx:$lifecycle_version&quot
 // LiveData
    implementation &quotandroidx.lifecycle:lifecycle-livedata-ktx:$lifecycle_version&quot
 // Annotation processor
    kapt &quotandroidx.lifecycle:lifecycle-compiler:$lifecycle_version&quot
    def nav_version = &quot2.3.0&quot
 //navigation
    implementation &quotandroidx.navigation:navigation-fragment-ktx:$nav_version&quot
 implementation &quotandroidx.navigation:navigation-ui-ktx:$nav_version&quot

رتروفیت:

//retrofit
implementation 'com.squareup.retrofit2:retrofit:2.9.0'
implementation 'com.squareup.retrofit2:converter-gson:2.9.0'

دگر هیلت و ماژول لایف سایکل ( برای ویومدل):

//dagger hilt
implementation 'com.google.dagger:hilt-android:2.28-alpha'
kapt 'com.google.dagger:hilt-android-compiler:2.28-alpha'
//android lifecycle
implementation 'androidx.hilt:hilt-lifecycle-viewmodel:1.0.0-alpha02'
kapt 'androidx.hilt:hilt-compiler:1.0.0-alpha02'

در فایل Build.gradle ماژول پروژه و در قسمت Dependencies:

classpath 'com.google.dagger:hilt-android-gradle-plugin:2.28-alpha'

و در قسمت repositories :

repositories {
 google()
 jcenter()
 mavenCentral()
} 

و در فایل Build.gradle ماژول اپ:

apply plugin: 'kotlin-kapt'
apply plugin: 'dagger.hilt.android.plugin'

پس از انجام این مراحل، گریدل خود را Sync کنید!

قدم سوم: ساخت لایه نتورک

برای شروع،دو کلاس برای برای اعلام وضعیت بین لایه نتورک و یو ای میسازیم و اسم اونو Resource و RequestStatus میذاریم:

enum class RequestStatus {
 SUCCESS,
    ERROR,
    LOADING
}

data class Resource<out T>(val status: RequestStatus, val data: T?, val Message: String?) {

 companion object {
 fun <T> success(data: T?): Resource<T> {
 return Resource(RequestStatus.SUCCESS,data,null)
  }

 fun <T> error(msg: String, data: T?): Resource<T> {
 return Resource(RequestStatus.ERROR,data,msg)
  }

 fun <T> loading(data: T?): Resource<T> {
 return Resource(RequestStatus.LOADING,data,null)
  }
 }

}

سپس طبق مستندات API بالا، دیتاکلاس های نتورک رو میسازیم:

data class Book(
 @SerializedName(&quotauthors&quot)
 val authors: List<String>,
 @SerializedName(&quotcharacters&quot)
 val characters: List<String>,
 @SerializedName(&quotcountry&quot)
 val country: String,
 @SerializedName(&quotisbn&quot)
 val isbn: String,
 @SerializedName(&quotmediaType&quot)
 val mediaType: String,
 @SerializedName(&quotname&quot)
 val name: String,
 @SerializedName(&quotnumberOfPages&quot)
 val numberOfPages: Int,
 @SerializedName(&quotpovCharacters&quot)
 val povCharacters: List<String>,
 @SerializedName(&quotpublisher&quot)
 val publisher: String,
 @SerializedName(&quotreleased&quot)
 val released: String,
 @SerializedName(&quoturl&quot)
 val url: String
)

data class Character(
 @SerializedName(&quotaliases&quot)
 val aliases: List<String>,
 @SerializedName(&quotallegiances&quot)
 val allegiances: List<Any>,
 @SerializedName(&quotbooks&quot)
 val books: List<String>,
 @SerializedName(&quotborn&quot)
 val born: String,
 @SerializedName(&quotculture&quot)
 val culture: String,
 @SerializedName(&quotdied&quot)
 val died: String,
 @SerializedName(&quotfather&quot)
 val father: String,
 @SerializedName(&quotmother&quot)
 val mother: String,
 @SerializedName(&quotname&quot)
 val name: String,
 @SerializedName(&quotplayedBy&quot)
 val playedBy: List<String>,
 @SerializedName(&quotpovBooks&quot)
 val povBooks: List<String>,
 @SerializedName(&quotspouse&quot)
 val spouse: String,
 @SerializedName(&quottitles&quot)
 val titles: List<String>,
 @SerializedName(&quottvSeries&quot)
 val tvSeries: List<String>,
 @SerializedName(&quoturl&quot)
 val url: String
)

data class House(
 @SerializedName(&quotancestralWeapons&quot)
 val ancestralWeapons: List<String>,
 @SerializedName(&quotcadetBranches&quot)
 val cadetBranches: List<String>,
 @SerializedName(&quotcoatOfArms&quot)
 val coatOfArms: String,
 @SerializedName(&quotcurrentLord&quot)
 val currentLord: String,
 @SerializedName(&quotdiedOut&quot)
 val diedOut: String,
 @SerializedName(&quotfounded&quot)
 val founded: String,
 @SerializedName(&quotfounder&quot)
 val founder: String,
 @SerializedName(&quotheir&quot)
 val heir: String,
 @SerializedName(&quotname&quot)
 val name: String,
 @SerializedName(&quotoverlord&quot)
 val overlord: String,
 @SerializedName(&quotregion&quot)
 val region: String,
 @SerializedName(&quotseats&quot)
 val seats: List<String>,
 @SerializedName(&quotswornMembers&quot)
 val swornMembers: List<String>,
 @SerializedName(&quottitles&quot)
 val titles: List<String>,
 @SerializedName(&quoturl&quot)
 val url: String,
 @SerializedName(&quotwords&quot)
 val words: String
)

data class Quote(
 @SerializedName(&quotcharacter&quot)
 val character: String,
 @SerializedName(&quotquote&quot)
 val quote: String
)

حالا نوبت میرسه به ساخت interface ها:

interface IceAndFireApiHelper {


 suspend fun getBooks(): Response<List<Book>>

 suspend fun getBook(
 bookID: Int
 ): Response<Book>



 suspend fun getCharacters(): Response<List<Character>>


 suspend fun filterCharacters(
 name: String?,
        gender: String?,
        culture: String?,
        isAlive: Boolean?
 ): Response<List<Character>>

 suspend fun getCharacter(characterID: Int): Response<Character>

 suspend fun getHouses(): Response<List<House>>

 suspend fun getHouse(houseID: Int): Response<House>
} 

 class IceAndFireApiImpl(private val service: IceAndFireApiService) : IceAndFireApiHelper {

 override suspend fun getBooks(): Response<List<Book>> = service.getBooks()

 override suspend fun getBook(bookID: Int): Response<Book> = service.getBook(bookID)

 override suspend fun getCharacters(): Response<List<Character>> = service.getCharacters()

 override suspend fun filterCharacters(
 name: String?,
        gender: String?,
        culture: String?,
        isAlive: Boolean?
 ): Response<List<Character>> = service.filterCharacters(name,gender,culture,isAlive)

 override suspend fun getCharacter(characterID: Int): Response<Character> = service.getCharacter(characterID)

 override suspend fun getHouses(): Response<List<House>> = service.getHouses()

 override suspend fun getHouse(houseID: Int): Response<House> = service.getHouse(houseID)

}

interface IceAndFireApiService {

 @GET(&quotapi/books&quot)
 suspend fun getBooks(): Response<List<Book>>


 @GET(&quotapi/books/{id}&quot)
 suspend fun getBook(
 @Path(&quotid&quot) bookID: Int
 ): Response<Book>


 @GET(&quotapi/characters&quot)
 suspend fun getCharacters(): Response<List<Character>>

 @GET(&quotapi/characters&quot)
 suspend fun filterCharacters(
 @Query(&quotname&quot) name: String?,
 @Query(&quotgender&quot) gender: String?,
 @Query(&quotculture&quot) culture: String?,
 @Query(&quotisAlive&quot) isAlive: Boolean?
 ): Response<List<Character>>

 @GET(&quotapi/characters/{id}&quot)
 suspend fun getCharacter(@Path(&quotid&quot) characterID: Int): Response<Character>


 @GET(&quotapi/houses&quot)
 suspend fun getHouses(): Response<List<House>>

 @GET(&quotapi/houses/{id}&quot)
 suspend fun getHouse(@Path(&quotid&quot) houseID: Int): Response<House>

} 

 interface QuotesApiHelper {

 suspend fun getQuotes(): Response<Quote>

 suspend fun filterQuotes(
 character: String
 ): Response<Quote>
}

class QuotesApiImpl(private val service: QuotesApiService): QuotesApiHelper {

 override suspend fun getQuotes(): Response<Quote> = service.getQuotes()

 override suspend fun filterQuotes(character: String): Response<Quote> = service.filterQuotes(character)

} 

interface QuotesApiService {

 @GET(&quotquotes&quot)
 suspend fun getQuotes(): Response<Quote>

 @GET(&quotquotes&quot)
 suspend fun filterQuotes(
 @Query(&quotchar&quot) character: String
 ): Response<Quote>
}

برای استفاده از coroutines از suspend fun استفاده میکنیم، و حتما در نظر داشته باشید که از ورژن 2.6+ رتروفیت استفاده کنید که کروتینز رو پشتیبانی کنه!

خب برای این قسمت فک کنم تا اینجا کافی باشه! در قسمت بعدی مفاهیم دگر رو به صورت کلی بررسی خواهیم کرد و پروژه رو با دگر کانفیگ میکنیم!