多进程初始化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

//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?, selection: String?, selectionArgs: Array?, sortOrder: String?) = null
    override fun update(uri: Uri, values: ContentValues?, selection: String?, selectionArgs: Array?) = 0
    override fun delete(uri: Uri, selection: String?, selectionArgs: Array?) = 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：

4、总结

1. 您不需要引入静态变量
2. 您将只运行一次全局任务，而不是每个进程运行一次
3. 您将在全局入口点而不是本地的Activity