如何在创建Android模块时模板化build.gradle文件？

我已经通过顶层build.gradle统一配置了所有子模块的Android编译参数，同时用buildSrc集中管理版本和依赖常量。现在创建新模块时，IDE自动生成的build.gradle包含大量重复配置，希望能在创建模块时直接生成极简的模板（比如库模块仅保留plugins声明和空的android块）。

现有配置 #

顶层build.gradle内容：

// Top-level build file where you can add configuration options common to all sub-projects/modules.
buildscript {
    repositories {
        google()
        jcenter()

    }
    dependencies {
        classpath Deps.tools_gradleandroid
        classpath Deps.tools_kotlin
        classpath 'org.jetbrains.kotlin:kotlin-gradle-plugin:1.7.10'
    }
}

subprojects {
    afterEvaluate { project ->
        if (project.hasProperty('android')) {
            android {
                buildToolsVersion Config.buildTools
                compileSdkVersion Config.compileSdk

                defaultConfig {
                    minSdkVersion Config.minSdk
                    targetSdkVersion Config.targetSdk
                    testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
                }

                buildTypes {
                    release {
                        minifyEnabled false
                        proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
                    }
                }

                compileOptions {
                    sourceCompatibility Config.javaVersion
                    targetCompatibility Config.javaVersion
                }

                kotlinOptions {
                    jvmTarget = Config.javaVersion.toString()
                }

            }
        }
    }
}

期望生成的模块build.gradle（库模块） #

plugins {
    id 'com.android.library'
    id 'org.jetbrains.kotlin.android'
}

android {

}

当前创建模块时自动生成的build.gradle #

plugins {
    id 'com.android.application'
    id 'org.jetbrains.kotlin.android'
}

android {
    compileSdk 32

    defaultConfig {
        applicationId "com.company.newmodule"
        minSdk 21
        targetSdk 32
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }

    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
    kotlinOptions {
        jvmTarget = '1.8'
    }
}

dependencies {

    implementation 'androidx.core:core-ktx:1.7.0'
    implementation 'androidx.appcompat:appcompat:1.5.0'
    implementation 'com.google.android.material:material:1.6.1'
    testImplementation 'junit:junit:4.13.2'
    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
}

解决方案 #

方法1：修改Android Studio默认模板 #

直接修改IDE内置的模块模板，让创建模块时直接生成目标内容：

1. 找到Android Studio的模板目录：
   • Windows：Android Studio安装目录\plugins\android\lib\templates\gradle-projects\NewAndroidModule\root
   • macOS：/Applications/Android Studio.app/Contents/plugins/android/lib/templates/gradle-projects/NewAndroidModule/root
2. 打开build.gradle.ftl（FreeMarker模板文件），替换为你需要的内容。比如库模块的模板可改为：

plugins {
    id 'com.android.library'
    id 'org.jetbrains.kotlin.android'
}

android {

}

3. 重启Android Studio，后续创建新模块时就会使用修改后的模板生成build.gradle。

方法2：Gradle脚本自动清理冗余配置 #

如果不想修改IDE模板，可以通过Gradle脚本在模块创建后自动清理重复配置：
在顶层build.gradle的subprojects块中添加以下逻辑：

subprojects {
    afterEvaluate { project ->
        def buildFile = file("${project.projectDir}/build.gradle")
        if (!buildFile.exists()) return

        def pluginApplied = project.plugins.hasPlugin('com.android.library') || project.plugins.hasPlugin('com.android.application')
        if (pluginApplied) {
            def content = buildFile.text
            // 替换android块为极简内容
            content = content.replaceAll(/(?s)android \{.*?\}/, 'android {\n}')
            // 移除dependencies块（如果已在顶层统一配置）
            content = content.replaceAll(/(?s)dependencies \{.*?\}/, '')
            buildFile.text = content
        }
    }
}

该方法会在模块评估完成后自动修改build.gradle，清理冗余内容。

方法3：自定义Gradle任务创建模块 #

通过自定义Gradle任务，基于自定义模板创建模块，完全绕过IDE的默认生成流程：

1. 在项目根目录创建templates文件夹，添加自定义模板文件library-build.gradle.template：

plugins {
    id 'com.android.library'
    id 'org.jetbrains.kotlin.android'
}

android {

}

2. 在顶层build.gradle中添加创建模块的任务：

task createLibraryModule(type: Copy) {
    def moduleName = project.findProperty('moduleName') ?: 'newlibrary'
    from 'templates/library-build.gradle.template'
    into "${project.rootDir}/${moduleName}"
    rename { it.replace('.template', '') }
    // 可扩展：复制AndroidManifest.xml、res目录等基础文件
}

3. 执行命令创建模块：

./gradlew createLibraryModule -PmoduleName=mylibrary

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