自动检测ARouter路由地址分组使用冲突问题

背景

以Activity路由为例，通过注解，编译后在对应模块路径下生成的文件名为Arouter$$Group$$GroupName1.java文件。其中GroupName1为分组名。具体路径为：

/build/generated/source/kapt/变体/com/alibaba/android/arouter/routes/
复制代码

网上查了下，发现同样问题，其他人也有遇到，具体问题描述GitHub上ARouter项目中issues等：

* What went wrong:
Execution failed for task ':app:transformClassesWithJarMergingForDevDebug'.
> com.android.build.api.transform.TransformException: java.util.zip.ZipException: duplicate entry: com/alibaba/android/arouter/routes/ARouter$$Group$$trans_second.class
复制代码

但如果直接通过./gradlew命令方式构建，是可以直接出现如上错误提示的。大多数情况下，项目开发中直接通过run构建，使得此问题直接被隐藏。

分析与解决

对比两者实际上构建流程上的差异，发现通过./gradlew命令方式构建，在执行taskapp:transformClassesWithJarMergingForDevDebug时会抛出duplicate entry class错误，但Android Studio直接run则没有执行。

为了兼容Android Studio直接run形式，在开发人员开发阶段早些发现此类问题，可以自己实现一个task，加入到构建过程中的适当阶段，以自动检测在不同模块下ARouter生成的文件重复问题。

具体思路：
分别统计项目中各个模块中ARouter生成的java文件，并计次数（需要区分构建类型，一个构建类型算唯一的一次即可，否则对于多个变体情况下会重复计算），对于同一构建类型，同样的文件名，生成的文件次数多余1，显然应该直接构建失败，并给出具体提示。

实现：
1，首先自定义task，实现次数检测和统计：

task checkARouterDuplicatedJavaFiles {
    doLast {
        def fileMap = [:]
        def buildTypeList = []
        def hasPathBuildTypeList = []

        project.extensions.findByName("android").applicationVariants.all { variant ->
            def buildTypeName = variant.buildType.name
            if(!buildTypeList.contains(buildTypeName)) {
                buildTypeList.add(buildTypeName)
            }
        }

        project.rootProject.subprojects { subProject ->
            def subProjectBuildDir

            try {
                subProjectBuildDir = subProject.buildDir

                if (subProjectBuildDir == null) return

                subProjectBuildDir.eachFileRecurse(FileType.DIRECTORIES) { dir ->
                    if (dir.path.contains("/generated/source/kapt/") && dir.path.endsWith("com/alibaba/android/arouter/routes")) {
                        def filePrefix = ""
                        for (buildType in buildTypeList) {
                            if(dir.path.toLowerCase().contains(buildType + "/")
                                    && !hasPathBuildTypeList.contains(subProject.getName() + "/generated/source/kapt/" + buildType + "/")){

                                filePrefix = buildType + "/"
                                dir.eachFile(FileType.FILES) { file ->
                                    if (fileMap[filePrefix + file.name] == null) {
                                        fileMap[filePrefix + file.name] = 0
                                    }
                                    fileMap[filePrefix + file.name]++
                                }

                                hasPathBuildTypeList.add(subProject.getName() + "/generated/source/kapt/" + filePrefix)
                                return
                            }
                        }
                    }
                }
            } catch (Exception e) {
                // ignore
                println e.toString()
            }
        }

        fileMap.each { key, value ->
            if (value > 1) {
                throw new GradleException("ARouter: " + key + " fileCount: " + value + " ,路由地址设置有误！")
            }
        }
    }
}
复制代码

上述代码中的hasPathBuildTypeList逻辑是因为app module中的变体与library module中的变体设置不一样，以处理对应的兼容逻辑。

2，将此task加入到构建流程的适当阶段。通过对比实际的构建过程中执行的task列表，最终决定将名称为“assembleDevDebug”的task依赖自定义的checkARouterDuplicatedJavaFilestask，并将自定义的task依赖名称为“transformClassesWithCom.alibaba.arouterForDevDebug”的task。具体实现为：

project.tasks.whenTaskAdded { Task task ->
    if (task.name == "assembleDevDebug") {
        task.dependsOn(checkARouterDuplicatedJavaFiles)
    } else if (task.name == "transformClassesWithCom.alibaba.arouterForDevDebug") {
        checkARouterDuplicatedJavaFiles.dependsOn(task)
    }
}
复制代码

其中，DevDebug为我们开发环境下默认的构建变体。

最终可以确保自定义的checkARouterDuplicatedJavaFilestask可以在构建过程中完成对应的检测。如果通过./gradlew命令构建，依然可以达到以系统taskapp:transformClassesWithJarMergingForDevDebug为先。

通过Android Studio run，如果重现此类情形，最终效果为：

org.gradle.api.tasks.TaskExecutionException: Execution failed for task ':app:checkARouterDuplicatedJavaFiles'.
	at org.gradle.api.internal.tasks.execution.ExecuteActionsTaskExecuter.executeActions(ExecuteActionsTaskExecuter.java:100)
	...
	at java.lang.Thread.run(Thread.java:745)
Caused by: org.gradle.api.GradleException: ARouter: release/ARouter$$Group$$GroupName1.java fileCount: 2 ,路由地址设置有误！
	at build_4p6esrqwzg61igroldd1aht2w$_run_closure5$_closure42.doCall(/Users/corn/AndroidStudioProjects/MyCorn/app/build.gradle:395)
	...

复制代码

构建失败，并给出提示。

全部栏目

自动检测ARouter路由地址分组使用冲突问题

背景

分析与解决

结语