{"id":820,"date":"2023-10-19T15:43:46","date_gmt":"2023-10-19T12:43:46","guid":{"rendered":"https:\/\/barisuslucan.com\/en\/?p=820"},"modified":"2023-10-19T16:02:28","modified_gmt":"2023-10-19T13:02:28","slug":"implementing-dependency-injection-in-workmanager-with-hilt-in-kotlin","status":"publish","type":"post","link":"https:\/\/barisuslucan.com\/en\/kotlin\/implementing-dependency-injection-in-workmanager-with-hilt-in-kotlin\/","title":{"rendered":"Injecting Dependencies in WorkManager with Hilt in Kotlin"},"content":{"rendered":"

WorkManager utilizes a Worker class, and WorkManager automatically invokes the Worker.doWork() method in a background thread. Worker.doWork() is a synchronous call. it is expected that you perform and complete all your background work in a blocking manner until the method exits. Since WorkManager operates independently of the activity in the background, the dependency to be injected cannot be directly injected with Hilt\u2019s \u201c@Inject\u201d. We need to provide the dependencies we will inject.<\/p>\n

In this blog post, we will use Hilt\u2019s work dependency. Firstly, add the dependency in your build.gradle (app level) file:<\/p>\n\n\n

<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
implementation<\/span>(<\/span>"androidx.hilt:hilt-work:1.0.0"<\/span>)<\/span><\/span><\/code><\/pre><\/div>\n\n\n

At present, we wish to utilize the DataManager class within our WorkerManager and would like to incorporate it through dependency injection.<\/p>\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
@Module<\/span><\/span>\n@InstallIn(SingletonComponent::<\/span>class<\/span>)<\/span><\/span>\nclass<\/span> <\/span>AppModule<\/span> {<\/span><\/span>\n    @Provides<\/span><\/span>\n    @Singleton<\/span><\/span>\n    <\/span>fun<\/span> <\/span>provideSharedPreferences<\/span>(@ApplicationContext context: Context) : SharedPreferences {<\/span><\/span>\n        <\/span>return<\/span> context.<\/span>getSharedPreferences<\/span>(<\/span>"saved_data_preferences"<\/span>, Context.MODE_PRIVATE)<\/span><\/span>\n    }<\/span><\/span>\n<\/span>\n    @Provides<\/span><\/span>\n    @Singleton<\/span><\/span>\n    <\/span>fun<\/span> <\/span>provideDataManager<\/span>(sharedPreferences: SharedPreferences) : DataManager {<\/span><\/span>\n        <\/span>return<\/span> <\/span>Data<\/span>(sharedPreferences)<\/span><\/span>\n    }<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
class<\/span> <\/span>DataManager<\/span> @Inject <\/span>constructor<\/span>(<\/span>private<\/span> <\/span>val<\/span> sharedPreferences: SharedPreferences) {<\/span><\/span>\n    <\/span>val<\/span> SAVED_DATA <\/span>=<\/span> <\/span>"SAVED_DATA"<\/span><\/span>\n    <\/span><\/span>\n    <\/span>fun<\/span> <\/span>saveData<\/span>(<\/span>data<\/span>: String) {<\/span><\/span>\n        <\/span>val<\/span> editor <\/span>=<\/span> sharedPreferences.<\/span>edit<\/span>()<\/span><\/span>\n        editor.<\/span>putString<\/span>(SAVED_DATA, <\/span>data<\/span>)<\/span><\/span>\n        editor.<\/span>apply<\/span>()<\/span><\/span>\n    }<\/span><\/span>\n    <\/span><\/span>\n    <\/span>fun<\/span> <\/span>getData<\/span>(): String {<\/span><\/span>\n        <\/span>return<\/span> sharedPreferences.<\/span>getString<\/span>(SAVED_DATA, <\/span>""<\/span>) ?: <\/span>""<\/span><\/span>\n    }<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n

Currently, our objective is to utilize the DataManager class within our WorkerManager, and we intend to inject it therein. In order to inject our dependency on worker we will use “@AssistedInject” anatation.<\/p>\n
“@AssistedInject” is used to annotate the constructor of an object and @Assisted is used to annotate any parameters that need to be provided at runtime. This is particularly useful when you have some dependencies that can be provided by Hilt\u2019s dependency injection and others that are only available at runtime.<\/p>\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
@HiltWorker<\/span><\/span>\nclass<\/span> <\/span>DataSavingWorker<\/span> @AssistedInject <\/span>constructor<\/span>(<\/span><\/span>\n@Assisted dataManager: DataManager,<\/span><\/span>\n@Assisted workerParams: WorkerParameters<\/span><\/span>\n) : Worker(workerParams) {<\/span><\/span>\n    <\/span>override<\/span> <\/span>fun<\/span> <\/span>doWork<\/span>(): Result {<\/span><\/span>\n        <\/span>try<\/span> {<\/span><\/span>\n            dataManager.<\/span>saveData<\/span>(<\/span>"123456"<\/span>)<\/span><\/span>\n            <\/span>return<\/span> Result.<\/span>success<\/span>()<\/span><\/span>\n<\/span>\n        } <\/span>catch<\/span> (e: Exception) {<\/span><\/span>\n            <\/span>return<\/span> Result.<\/span>failure<\/span>()<\/span><\/span>\n        }<\/span><\/span>\n    }<\/span><\/span>\n  }<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n

And then we should provide this dependency manually in HiltApplication class.<\/p>\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
@HiltAndroidApp<\/span><\/span>\nclass<\/span> <\/span>HiltApplication<\/span> : Application(), Configuration.<\/span>Provider<\/span> {<\/span><\/span>\n    @Inject<\/span><\/span>\n    <\/span>lateinit<\/span> <\/span>var<\/span> customWorkerFactory: CustomWorkerFactory<\/span><\/span>\n    <\/span><\/span>\n    <\/span>override<\/span> <\/span>fun<\/span> <\/span>getWorkManagerConfiguration<\/span>(): Configuration {<\/span><\/span>\n        <\/span>return<\/span> Configuration.<\/span>Builder<\/span>()<\/span><\/span>\n            .<\/span>setMinimumLoggingLevel<\/span>(Log.DEBUG)<\/span><\/span>\n            .<\/span>setWorkerFactory<\/span>(customWorkerFactory)<\/span><\/span>\n            .<\/span>build<\/span>()<\/span><\/span>\n    }<\/span><\/span>\n}<\/span><\/span>\n<\/span>\nclass<\/span> <\/span>CustomWorkerFactory<\/span> @Inject <\/span>constructor<\/span>(<\/span>private<\/span> <\/span>val<\/span> dataManager: DataManager) : WorkerFactory() {<\/span><\/span>\n    <\/span>override<\/span> <\/span>fun<\/span> <\/span>createWorker<\/span>(<\/span><\/span>\n        appContext: Context,<\/span><\/span>\n        workerClassName: String,<\/span><\/span>\n        workerParameters: WorkerParameters<\/span><\/span>\n    ): ListenableWorker <\/span>=<\/span> <\/span>DataSavingWorker<\/span>(dataManager <\/span>=<\/span> DataManager, workerParams <\/span>=<\/span> workerParameters)<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n

Ultimately, you should add the provider to your AndroidManifest.xml file within the <application> tag<\/p>\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
   <\/span><<\/span>provider<\/span><\/span>\n            android:name<\/span>=<\/span>"androidx.startup.InitializationProvider"<\/span><\/span>\n            android:authorities<\/span>=<\/span>"<\/span>${<\/span>applicationId<\/span>}<\/span>.androidx-startup"<\/span><\/span>\n            tools:node<\/span>=<\/span>"remove"<\/span>\/><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"excerpt":{"rendered":"
WorkManager utilizes a Worker class, and WorkManager automatically invokes the Worker.doWork() method in a background thread. Worker.doWork() is a synchronous call. it is expected that you perform and complete all your background work in a blocking manner until the method exits. Since WorkManager operates independently of the activity in the background, the dependency to be injected cannot be directly injected with Hilt\u2019s \u201c@Inject\u201d. We need to provide the dependencies we will inject. In this blog post, we will use Hilt\u2019s work dependency. Firstly, add the dependency in your build.gradle (app level) file: At present, we wish to utilize the DataManager…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"om_disable_all_campaigns":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[29],"tags":[],"class_list":["post-820","post","type-post","status-publish","format-standard","hentry","category-kotlin"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/posts\/820","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/comments?post=820"}],"version-history":[{"count":5,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/posts\/820\/revisions"}],"predecessor-version":[{"id":831,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/posts\/820\/revisions\/831"}],"wp:attachment":[{"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/media?parent=820"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/categories?post=820"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/tags?post=820"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}