如何让Android库在编译时校验主应用的targetSdkVersion以避免兼容崩溃

当然可以实现编译时校验！我之前维护Android库的时候也碰到过一模一样的场景——旧版本库在高targetSdk下崩溃，用户还没跑起来就踩坑，确实头疼。下面给你两种实用的方案，都是在编译阶段就能把问题拦下来的：

方案一：用Gradle脚本直接做编译检查 #

这是最直接的方式，在你的库模块的build.gradle（或build.gradle.kts）里加一段自定义逻辑，在Gradle构建周期里检查主应用的targetSdkVersion，一旦发现不兼容的组合就抛出编译错误。

举个具体的Groovy示例，假设你的库从2.0版本开始才支持targetSdk27：

android {
    // 你的库的常规配置...

    afterEvaluate {
        // 遍历所有依赖当前库的模块（主应用或其他依赖库）
        rootProject.subprojects.each { subproject ->
            if (subproject.plugins.hasPlugin('com.android.application')) {
                subproject.android {
                    def appTargetSdk = defaultConfig.targetSdkVersion.apiLevel
                    def minLibraryVersionForSdk27 = "2.0"

                    // 找到主应用中依赖当前库的条目
                    def libraryDependency = subproject.configurations.implementation.dependencies.find {
                        it.group == "你的库的groupId" && it.name == "你的库的artifactId"
                    }

                    if (libraryDependency != null) {
                        def usedLibraryVersion = libraryDependency.version
                        // 这里的版本比较逻辑要适配你的版本命名规则，比如语义化版本可以用字符串比较或工具类
                        if (usedLibraryVersion < minLibraryVersionForSdk27 && appTargetSdk >= 27) {
                            throw new GradleException("⚠️ 兼容性错误：你的应用targetSdkVersion为${appTargetSdk}，但使用的${libraryDependency.group}:${libraryDependency.name}:${usedLibraryVersion}版本不支持该SDK版本，请升级库到${minLibraryVersionForSdk27}及以上！")
                        }
                    }
                }
            }
        }
    }
}

注意：版本比较的逻辑要根据你实际的版本号规则调整，如果是带前缀的版本（比如v1.2.3），记得先处理掉前缀再比较。

方案二：自定义Android Lint规则（更专业的方式） #

如果想让校验更贴合Android官方的代码检查流程，可以自定义Lint规则，打包进你的库中。用户编译应用时，Lint会自动扫描并给出明确的错误/警告提示。

核心步骤和示例代码如下：

1. 在你的库项目中创建Lint规则模块
2. 编写检测逻辑，同时检查主应用的targetSdkVersion和当前库的版本：

class TargetSdkCompatDetector : Detector(), Detector.XmlScanner {
    override fun getApplicableElements() = setOf("manifest")

    override fun visitElement(context: XmlContext, element: Element) {
        // 获取主应用的targetSdkVersion
        val appTargetSdk = context.project.targetSdkVersion
        // 从Gradle变量中获取当前库的版本（需要在构建脚本中传递）
        val libraryVersion = context.project.properties["libraryVersion"] as String
        val minSupportedVersion = "2.0"

        if (appTargetSdk >= 27 && libraryVersion < minSupportedVersion) {
            context.report(
                issue = COMPAT_ISSUE,
                location = context.getLocation(element),
                message = "应用targetSdkVersion为${appTargetSdk}，但当前库版本${libraryVersion}不支持该版本，会导致运行崩溃，请升级到${minSupportedVersion}及以上"
            )
        }
    }

    companion object {
        val COMPAT_ISSUE = Issue.create(
            id = "TargetSdkCompatibility",
            briefDescription = "库版本与应用targetSdk不兼容",
            explanation = "旧版本库未适配Android Oreo（API 27），在高targetSdk下会触发崩溃",
            category = Category.CORRECTNESS,
            priority = 10,
            severity = Severity.ERROR,
            implementation = Implementation(
                TargetSdkCompatDetector::class.java,
                Scope.MANIFEST_SCOPE
            )
        )
    }
}

这种方式的优势是用户可以通过Android Studio的Lint面板直观看到问题，还能配置错误级别（警告或强制错误）。

补充建议 #

除了编译时校验，建议在旧版本库中加一层运行时兜底判断，哪怕用户绕过了编译检查，也能避免崩溃：

if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
    // 做兼容降级处理，或者提示用户升级库
    Log.e("库名称", "当前库版本不支持Android Oreo，请升级到2.0及以上版本")
} else {
    // 旧版本逻辑
}

内容的提问来源于stack exchange，提问作者Mahdi