多进程初始化WorkManager

1、背景

WorkManager用于处理Android中复杂的异步工作。WorkManager插件足以替换JobScheduler、Firebase JobDispatcher或Alarm Manager来完成这项工作。

假设一个应用有多进程,在初始化WorkManager,除了主进程,还包含子进程,我们命名为remote。

当在Application.onCreate创建 PeriodicWorkRequest ,这是最简单的启动方式。这时候会抛出异常

Process: com.example:remote PID: 12707
java.lang.IllegalStateException: WorkManager is not initialized properly. The most likely cause is that you disabled WorkManagerInitializer in your manifest but forgot to call WorkManager#initialize in your Application#onCreate or a ContentProvider.
at androidx.work.WorkManager.getInstance(WorkManager.java:134)

why?

2、初始化

上述例外情况的发生是由于项目中同时存在的两个原因:

1、默认情况下,WorkManager在名为WorkManagerInitializer的单独提供程序中初始化

2、我们有两个进程应用程序,在Application.onCreate中启动WorkRequest

由于我们有多进程应用程序,每个进程都需要调用Application.onCreate 。不要忘记,默认情况下,ContentProvider在主进程中只调用一次。--found it

所以主进程在WorkManager初始化的开始处启动WorkManagerInitializer。然后在主进程调用Application.onCreate ,从而启动WorkRequest。一切都很好,因为WorkRequest是在WorkManager初始化之后启动的。然后第二个进程(在我们的例子中是remote进程)初始化Application.onCreate(没有 provider started),将创建另一个WorkRequest,但WorkManager在remote进程中未初始化。因此,出现上述错误。

现在有3个方案供参考

3、解决方案

3.1、使用静态标志

下面是一段代码

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        
        //do process independent tasks here
        
        if (IS_MAIN_PROCESS) {
            //do main process dependent tasks here
        }
    }
    companion object {
        var IS_MAIN_PROCESS = false
    }
}
class ActivationContentProvider : ContentProvider() {
    override fun onCreate(): Boolean {
        MyApplication.IS_MAIN_PROCESS = true
        
        //do you other content provider stuff if needed
    }
    
    //implement other content provider methods

每个进程都有自己的应用程序实例和自己的类声明,所以IS_MAIN_PROCESS只对主进程有效。对于其他人来说,是错误的,因为ActivationContentProvider只在主进程中运行。

3.2 启动 WorkManager时机

这个解决方案,您可以从manifest文件中禁用WorkManagerInitializer provider程序,并将默认初始化在Application.onCreate 。

//Manifest
<provider
    android:name="androidx.work.impl.WorkManagerInitializer"
    android:authorities="com.gpn.azs.workmanager-init"
    android:enabled="false"/>
//Application
class MyApplication : Application() {
 
    override fun onCreate() {
        super.onCreate()
        //...
 
        WorkManager.initialize(this, Configuration.Builder().build())
        //run work manager requests
    }
}

虽然这是一个有效的解决方案,但对于多进程应用程序来说,这并不是一个好的解决方案,因为每个进程都将初始化自己的WorkManager实例并运行所需的任务。

例如,若您有一些独特的任务需要在应用程序中运行,那个么使用这种方法,您实际上可以运行它两次。方法enqueuUniquePeriodicWork实际上可以帮助您只运行一个任务,因为它将具有唯一标识符,所以下次工作将不会启动或将替换以前的工作。但它仍然不干净。

3.3、不在Application.onCreate运行WorkRequest

您可以不在Application.onCreate中执行WorkRequest,比如您可以在第一个Activity中运行它。但在这里我们需要小心。若我们有一些周期性的工作要做(比如大约每天一次),那个么我们需要在应用Application.onCreate时运行它。

3.4、终结方案

class MyWorkManagerInitializer : DummyContentProvider() {
    override fun onCreate(): Boolean {
        WorkManager.initialize(context!!, Configuration.Builder().build())
        //run your tasks here
        return true
    }
}
//where 
abstract class DummyContentProvider : ContentProvider() {
    override fun onCreate() = true
 
    override fun insert(uri: Uri, values: ContentValues?) = null
    override fun query(uri: Uri, projection: Array<String>?, selection: String?, selectionArgs: Array<String>?, sortOrder: String?) = null
    override fun update(uri: Uri, values: ContentValues?, selection: String?, selectionArgs: Array<String>?) = 0
    override fun delete(uri: Uri, selection: String?, selectionArgs: Array<String>?) = 0
 
    override fun getType(uri: Uri) = null
}

不要关注DummyContentProvider,因为它只是一个简单的抽象继承器,它提供了所有必需方法的虚拟实现。因此,我们的MyWorkManagerInitializer看起来与WorkManagerInitializer非常相似。此外,它通过对所需任务的初始化来扩展WorkManagerInitializer,但我们不能仅扩展WorkManagerInitializer,因为它具有受限的访问权限:

/**
 * The {@link ContentProvider} responsible for initializing {@link WorkManagerImpl}.
 *
 * @hide
 */
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public class WorkManagerInitializer extends ContentProvider {
    @Override
    public boolean onCreate() {
        // Initialize WorkManager with the default configuration.
        WorkManager.initialize(getContext(), new Configuration.Builder().build());
        return true;
    }
    //dummy implementations of all content provider abstract methods
}

然后我们需要在manifest文件中禁用WorkManagerInitializer并启用MyWorkManagerInitializer:

<provider
    android:name="androidx.work.impl.WorkManagerInitializer"
    android:authorities="com.sample.workmanager-init"
    android:enabled="false"/>
 
<provider
    android:name=".MyWorkManagerInitializer"
    android:authorities="com.sample.MyWorkManagerInitializer"/>

4、总结

4.1您不需要引入静态变量

4,2您将只运行一次全局任务,而不是每个进程运行一次

4.3您将在全局入口点而不是本地的Activity

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 228,646评论 6 533
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 98,595评论 3 418
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 176,560评论 0 376
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 63,035评论 1 314
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 71,814评论 6 410
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 55,224评论 1 324
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 43,301评论 3 442
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 42,444评论 0 288
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 48,988评论 1 335
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 40,804评论 3 355
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 42,998评论 1 370
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 38,544评论 5 360
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 44,237评论 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 34,665评论 0 26
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 35,927评论 1 287
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 51,706评论 3 393
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 47,993评论 2 374

推荐阅读更多精彩内容