feat: 增加readme;

Author: feer921

app/src/main/java/com/fee/start/LocalApp.kt

@@ -0,0 +1,43 @@
+package com.fee.start
+
+import android.app.Application
+import com.fee.start.tasks.*
+import com.github.androidstartup.StartupTasksManager
+import java.util.concurrent.Executor
+import java.util.concurrent.SynchronousQueue
+import java.util.concurrent.ThreadPoolExecutor
+import java.util.concurrent.TimeUnit
+
+/**
+ ******************(^_^)***********************<br>
+ * User: fee(QQ/WeiXin:1176610771)<br>
+ * Date: 2023/3/12<br>
+ * Time: 20:49<br>
+ * <P>DESC:
+ *
+ * </p>
+ * ******************(^_^)***********************
+ */
+class LocalApp : Application() {
+
+    override fun onCreate() {
+        super.onCreate()
+        val gloabalExecutor: Executor = ThreadPoolExecutor(
+            1,
+            3,
+            1,
+            TimeUnit.MINUTES,
+            SynchronousQueue()
+        )
+        StartupTasksManager.getTasksManager()
+            .withContext(this) //设置上下文 Context
+            .withTaskExecutor(gloabalExecutor) //配置启动任务的全局 Executor(线程池)
+            .withTask(Task1())
+            .withTask(Task5())
+            .withTask(Task3())
+            .withTask(Task4())
+            .withTask(Task2())
+            .withTask(BuglyInitTask())
+            .startUp() //开始启动任务
+    }
+}

app/src/main/java/com/fee/start/MyApp.java

@@ -8,9 +8,7 @@
 import com.fee.start.tasks.Task4;
 import com.fee.start.tasks.Task5;
 import com.github.androidstartup.StartupTasksManager;
-import com.github.androidstartup.StartupTasksOrganizer;
 
-import java.util.concurrent.ArrayBlockingQueue;
 import java.util.concurrent.Executor;
 import java.util.concurrent.SynchronousQueue;
 import java.util.concurrent.ThreadPoolExecutor;
@@ -34,21 +32,21 @@ public void onCreate() {
                 new SynchronousQueue<>()
                 );
         StartupTasksManager.Builder
-                .addTask(new Task1())
-                .addTask(new Task5())
-                .addTask(new Task3())
-                .addTask(new Task2())
-                .addTask(new Task4())
+                .withTask(new Task1())
+                .withTask(new Task5())
+                .withTask(new Task3())
+                .withTask(new Task2())
+                .withTask(new Task4())
                 .withTaskExecutor(executor)
                 .withContext(this)
                 .startUp();
 
 //        new StartupTasksOrganizer.TasksBuilder()
-//                .addTask(new Task1())
-//                .addTask(new Task5())
-//                .addTask(new Task3())
-//                .addTask(new Task2())
-//                .addTask(new Task4())
+//                .withTask(new Task1())
+//                .withTask(new Task5())
+//                .withTask(new Task3())
+//                .withTask(new Task2())
+//                .withTask(new Task4())
 //                .build(this)
 //                .startUp();
 

app/src/main/java/com/fee/start/tasks/BuglyInitTask.kt

@@ -0,0 +1,36 @@
+package com.fee.start.tasks
+
+import android.content.Context
+import com.github.androidstartup.AStartupTask
+import com.github.androidstartup.IStartupTask
+
+/**
+ ******************(^_^)***********************<br>
+ * User: fee(QQ/WeiXin:1176610771)<br>
+ * Date: 2023/3/12<br>
+ * Time: 21:21<br>
+ * <P>DESC:
+ * 第三方 SDK bugly的初始化任务
+ * </p>
+ * ******************(^_^)***********************
+ */
+class BuglyInitTask: AStartupTask<String>() {
+    /**
+     * 执行任务
+     * @return [T] 执行了启动任务可能的 返回数据
+     */
+    override fun doStartupTask(context: Context): String {
+        return "bugly sdk init finish"
+    }
+
+    /**
+     * 标识启动任务是否依赖主线程的执行
+     */
+    override fun isDependonMainThread(): Boolean {
+        return true
+    }
+
+    override fun dependentTask(): List<Class<out IStartupTask<*>>>? {
+        return listOf(Task1::class.java)
+    }
+}

readme.md

@@ -0,0 +1,39 @@
+# 介绍
+
+本框架目的为提供 **Android**  APP 在启动时的启动流程优化，统一管理和配置各初始化任务按照开发时所规划的依赖顺序和配置执行，可作为组件化的一个公共组件。
+
+# 前言
+
+我们所开发的 **Android** 项目，在APP启动的时候往往需要提前初始化一些业务模块、第三方SDK等，简单的写法是在 项目自定义的 **Application** 的 *onCreate()* 方法中根据可能的先后顺序一股脑的写上初始化代码，这样会让各模块的初始化工作太过于集中执行，可能引起主线程的耗时，因而非常有必要(尤其对于中大型项目来说)将项目中需要初始化的各功能模块及第三方SDK等的初始化任务按照一定的先后依赖顺序、有条理的 按照分任务的方式进行设计、规划。
+
+# 使用
+
+```kotlin
+class LocalApp : Application() {
+    
+    override fun onCreate() {
+        super.onCreate()
+        val gloabalExecutor: Executor = ThreadPoolExecutor(
+            1,
+            3,
+            1,
+            TimeUnit.MINUTES,
+            SynchronousQueue()
+        )
+        StartupTasksManager.getTasksManager()
+            .withContext(this) //设置上下文 Context
+            .withTaskExecutor(gloabalExecutor) //配置启动任务的全局 Executor(线程池)
+            .withTask(Task1())
+            .withTask(Task5())
+            .withTask(Task3())
+            .withTask(Task4())
+            .withTask(Task2())
+            .withTask(BuglyInitTask())
+            .startUp() //开始启动任务
+    }
+}
+```
+
+# ToDo
+
+发布至 **mavenCentral** 以供项目 gradle 依赖

theAndroidStartup/src/main/java/com/github/androidstartup/StartupTasksManager.kt

@@ -38,8 +38,8 @@ class StartupTasksManager private constructor(): ITaskListener{
         /**
          * 添加启动任务
          */
-        fun addTask(startupTask: IStartupTask<*>): StartupTasksManager {
-            return getTasksManager().addTask(startupTask)
+        fun withTask(startupTask: IStartupTask<*>): StartupTasksManager {
+            return getTasksManager().withTask(startupTask)
         }
 
         /**
@@ -153,7 +153,7 @@ class StartupTasksManager private constructor(): ITaskListener{
      * 添加启动任务
      */
     @MainThread
-    fun addTask(startupTask: IStartupTask<*>): StartupTasksManager {
+    fun withTask(startupTask: IStartupTask<*>): StartupTasksManager {
         mAddedTasksList.add(startupTask)
         return this
     }

theAndroidStartup/src/main/java/com/github/androidstartup/StartupTasksOrganizer.kt

@@ -89,7 +89,7 @@ class StartupTasksOrganizer(private val mAppContext: Context?,private val mAdded
 
         private var mContext: Context? = null
 
-        fun addTask(task: IStartupTask<*>): TasksBuilder{
+        fun withTask(task: IStartupTask<*>): TasksBuilder{
             mAddedTasks.add(task)
             return this
         }