devbox
凡人多烦事01
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

Android——Gradle插件项目根目录settings.gradle和build.gradle

作者：凡人多烦事01 | 2024-03-19 00:11:20

赞

踩

gradle

一、settings.gradle结构分析

项目根目录下的settings.gradle配置文件示例：

  1. pluginManagement {
  2.  
  3.     /**
  4.      * The pluginManagement.repositories block configures the
  5.      * repositories Gradle uses to search or download the Gradle plugins and
  6.      * their transitive dependencies. Gradle pre-configures support for remote
  7.      * repositories such as JCenter, Maven Central, and Ivy. You can also use
  8.      * local repositories or define your own remote repositories. The code below
  9.      * defines the Gradle Plugin Portal, Google's Maven repository,
  10.      * and the Maven Central Repository as the repositories Gradle should use to look for its
  11.      * dependencies.
  12.      */
  13.  
  14.     repositories {
  15.         gradlePluginPortal()
  16.         google()
  17.         mavenCentral()
  18.     }
  19. }
  20. dependencyResolutionManagement {
  21.  
  22.     /**
  23.      * The dependencyResolutionManagement.repositories
  24.      * block is where you configure the repositories and dependencies used by
  25.      * all modules in your project, such as libraries that you are using to
  26.      * create your application. However, you should configure module-specific
  27.      * dependencies in each module-level build.gradle file. For new projects,
  28.      * Android Studio includes Google's Maven repository and the Maven Central
  29.      * Repository by default, but it does not configure any dependencies (unless
  30.      * you select a template that requires some).
  31.      */
  32.  
  33.     repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
  34.     repositories {
  35.         google()
  36.         mavenCentral()
  37.  
  38.         flatDir {
  39.             dirs 'libs'
  40.         }
  41.     }
  42.  
  43.  
  44. }
  45.  
  46. rootProject.name='TestAndroidProject'
  47. include ':AliPay'
  48. include ':app'

（1）pluginManagement配置块

  • 对每个项目和全局的配置。
  • pluginManagement{}块只能出现在两个设置中。 一个是settings.gradle文件，它必须是文件中的第一个代码块，顺序第一出现；另一个是Initialization Scripts，不在本文讨论内。
  1. pluginManagement {
  2.  
  3.     plugins {  //插件配置
  4.  
  5.     
  6.     }
  7.  
  8.     resolutionStrategy {//插件策略配置
  9.  
  10.     }
  11.  
  12.     repositories { //插件运行，依赖的仓库
  13.         //按照配置顺序寻找
  14.  
  15.         gradlePluginPortal()
  16.         google()
  17.         mavenCentral()
  18.         //本地仓库配置
  19.         maven { url 'file://E:/libs/localMaven/' }
  20.         //远程仓库+地址配置
  21.         maven { url 'https://repo1.maven.org/maven2/' }
  22.     }
  23.  
  24. }
  • 具体使用官方网址：Gradle-pluginManagement使用
  • pluginManagement 脚本块中的 repositories 配置 , 对应之前的 buildscript 中的 repositories 配置 

（2）dependencyResolutionManagement配置块

settings.gradle 中部分

  1. //使用Catalog统一依赖版本 开启VERSION_CATALOG
  2. enableFeaturePreview('VERSION_CATALOGS')
  3.  
  4. // 指定Gradle需要的用来搜索或下载【依赖dependency】的代码库
  5. dependencyResolutionManagement {
  6.     // 然而，为了配置一些模块特定的依赖，你需要在每一个模块的模块级build.gradle文件中进行配置说明
  7.     repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
  8.     repositories {
  9.         // 以下是AS默认configure的repositories
  10.         google()
  11.         jcenter()
  12.         mavenCentral()
  13.     }
  14.  
  15.  
  16.     //使用Catalog统一依赖版本
  17.     versionCatalogs{
  18.         libs {
  19.             version('paging', '3.1.1')
  20.             version('glide', '4.14.2')
  21.             version('lifecycle', '2.4.1')
  22.             version('appcompat', '1.4.1')
  23.             alias('paging-runtime').to('androidx.paging', 'paging-runtime').versionRef('paging')
  24.             alias('paging-guava').to('androidx.paging', 'paging-guava').versionRef('paging')
  25.             alias('paging-rxjava2').to('androidx.paging', 'paging-rxjava2').versionRef('paging')
  26.             alias('glide-v4').to('com.github.bumptech.glide', 'glide').versionRef('glide')
  27.             alias('lifecycle-livedata').to('androidx.lifecycle', 'lifecycle-livedata-ktx').versionRef('lifecycle')
  28.             alias('lifecycle-viewmodel').to('androidx.lifecycle', 'lifecycle-viewmodel-ktx').versionRef('lifecycle')
  29.             alias('androidx-appcompat').to('androidx.appcompat', 'appcompat').versionRef('appcompat')
  30.  
  31.         }
  32.     }
  33. }

  • repositoriesMode 模式有两种 :

RepositoriesMode.PREFER_PROJECT : 解析依赖库时 , 优先使用本地仓库 , 本地仓库没有该依赖 , 则使用远程仓库 ;
RepositoriesMode.FAIL_ON_PROJECT_REPOS : 解析依赖库时 , 强行使用远程仓库 , 不管本地仓库有没有该依赖库 ;

  • dependencyResolutionManagement 脚本块中的 repositories 配置 , 对应之前的 allprojects 中的 repositories 配置 ;

参考文章1文章浏览阅读7.4k次，点赞52次，收藏45次。一、settings.gradle 构建脚本分析1、Maven 远程仓库配置2、目录配置3、完整代码示例二、根目录下 build.gradle 构建脚本分析_android settings.gradlehttps://blog.csdn.net/shulianghan/article/details/129802390

（3）settings.gradle对应Settings对象实例

settings.gradle 文件对应的gradle api中Settings对象实例，其api如下

Settings对象实例Api (Gradle API 8.4)icon-default.png?t=N7T8https://docs.gradle.org/current/javadoc/org/gradle/api/initialization/Settings.htmlsettings.gradle文件配置项，实际上及时调用该api中的方法和属性

二、build.gradle结构分析（根目录）

  • build.gradle是gradle构建脚本文件，支持java、groovy等语言。
  • 每个gradle项目或模块都会有一个build.gradle文件，该文件是项目构建的入口，可配置版本、插件依赖库等信息。
  • 每个build文件都有一个对应的project实例，配置build.gradle文件，实际就是设置project实例里面的属性，或者调用里面的方法。
  • 根项目的project实例可以获取到所有子项目或子模块的project实例，因此我们可以在根项目的build.gradle文件中对子项目进行统一配置，比如应用插件、依赖的maven中心仓库等，常见的build.gradle属性及方法如下所示

（1）项目根目录build.gradle

  1. // 构建脚本
  2. buildscript {
  3.  
  4.     // 定义全局变量，常用于版本管理
  5.     // 变量在子模块的build.gradle中直接以： $NAME 的形式调用
  6.     ext {
  7.         compose_version = '1.0.1'
  8.         lifecycleVersion = '2.3.1'
  9.         kotlinVersion = '1.5.21'
  10.         ktlintVersion = '0.41.0'
  11.         coroutines = '1.5.0'
  12.         moshi_version = '1.12.0'
  13.     }
  14. }
  15.  
  16. // 依赖URL
  17. // 之前于settings.gradle定义的是整体的仓库位置，而这里可以视为定义具体的依赖位置
  18. // plugins定义项目中所有模块共用的 Gradle 依赖项
  19. // apply false 不可以用于子模块的build.gradle
  20. plugins {
  21.     id 'com.android.application' version '7.1.0-rc01' apply false
  22.     id 'com.android.library' version '7.1.0-rc01' apply false
  23.     id 'org.jetbrains.kotlin.android' version '1.5.21' apply false
  24. }
  25.  
  26. // 定义清理build目录的对应方法
  27. task clean(type: Delete) {
  28.     delete rootProject.buildDir
  29. }

  • buildscript

需要注意的是：
1）、buildscript代码段必须是build.gradle文件的第一个代码段；
2）、对于多模块构建，项目的buildscript代码段声明的依赖关系可用于所有子模块的构建脚本；
3）、构建脚本的依赖可能是gradle插件

（2）子目录下build.gradle

  1. // 子模块的plugins
  2. // 请注意！这里就不可以定义apply false了
  3. plugins {
  4.     id 'com.android.application'
  5.     id 'org.jetbrains.kotlin.android'
  6.     id 'dagger.hilt.android.plugin'
  7. }
  8.  
  9. // 应用插件 Kapt
  10. // 这是一款kotlin专用的依赖管理插件，推荐每个项目都添加！
  11. apply plugin: 'kotlin-kapt'
  12.  
  13. // android
  14. // 定义所有模块构建设置
  15. android {
  16.  
  17.     // 定义编译SDK
  18.     // 表示你的项目可以使用低于（或等于）该版本的所有API
  19.     compileSdk 32
  20.  
  21.     // 定义默认配置
  22.     defaultConfig {
  23.         // 工件ID
  24.         applicationId "com.example.character"
  25.         // 最低可接受SDK版本
  26.         minSdk 21
  27.         // 最高可接受SDK版本
  28.         targetSdk 32
  29.         // 给开发者看的项目版本
  30.         versionCode 1
  31.         // 给客户看的项目版本
  32.         versionName "1.0"
  33.  
  34.  
  35.         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
  36.         vectorDrawables {
  37.             useSupportLibrary true
  38.         }
  39.     }
  40.  
  41.     // 定义构建类型
  42.     // 默认的构建类型有两种：debug(构建时会默认打上debug签名) release(构建时默认不打任何签名)
  43.     buildTypes {
  44.         release {
  45.             minifyEnabled false
  46.             proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
  47.         }
  48.     }
  49.  
  50.     // 如果你用的是JDK8，那么请添加这个两个配置以提供支持
  51.     compileOptions {
  52.         sourceCompatibility JavaVersion.VERSION_1_8
  53.         targetCompatibility JavaVersion.VERSION_1_8
  54.     }
  55.     kotlinOptions {
  56.         jvmTarget = '1.8'
  57.     }
  58.  
  59.     // 构建特性
  60.     buildFeatures {
  61.         compose true
  62.     }
  63.     // compose设置
  64.     composeOptions {
  65.         kotlinCompilerExtensionVersion compose_version
  66.     }
  67.     // 资源文件配置
  68.     packagingOptions {
  69.         resources {
  70.             excludes += '/META-INF/{AL2.0,LGPL2.1}'
  71.         }
  72.     }
  73. }
  74.  
  75. // 在这里直接把你需要添加的依赖贴进去就好了
  76. // 贴完后点sync即可
  77. dependencies {
  78.  
  79.     implementation 'androidx.core:core-ktx:1.7.0'
  80.     implementation "androidx.compose.ui:ui:$compose_version"
  81.     implementation "androidx.compose.material:material:$compose_version"
  82.     implementation "androidx.compose.ui:ui-tooling-preview:$compose_version"
  83.     implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.3.1'
  84.     implementation 'androidx.activity:activity-compose:1.3.1'
  85.     testImplementation 'junit:junit:4.13.2'
  86.     androidTestImplementation 'androidx.test.ext:junit:1.1.3'
  87.     androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
  88.     androidTestImplementation "androidx.compose.ui:ui-test-junit4:$compose_version"
  89.     debugImplementation "androidx.compose.ui:ui-tooling:$compose_version"
  90.     // dagger -hilt
  91.     implementation "com.google.dagger:hilt-android:2.38.1"
  92.     kapt "com.google.dagger:hilt-android-compiler:2.38.1"
  93.     kapt "androidx.hilt:hilt-compiler:1.0.0"
  94.  
  95.     // Lifecycle components
  96.     implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:$lifecycleVersion"
  97.     implementation "androidx.lifecycle:lifecycle-viewmodel-compose:2.4.0"
  98.     implementation "androidx.lifecycle:lifecycle-livedata-ktx:$lifecycleVersion"
  99.     implementation "androidx.lifecycle:lifecycle-common-java8:$lifecycleVersion"
  100.  
  101.     // Kotlin components
  102.     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlinVersion"
  103.     implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:$coroutines"
  104.  
  105.     // networking
  106.     implementation 'com.squareup.retrofit2:retrofit:2.9.0'
  107.     implementation 'com.squareup.retrofit2:converter-moshi:2.9.0'
  108.     implementation("com.squareup.okhttp3:okhttp:4.9.0")
  109.     implementation("com.squareup.okhttp3:logging-interceptor:4.9.0")
  110.     implementation "com.squareup.moshi:moshi-kotlin:$moshi_version"
  111.     kapt "com.squareup.moshi:moshi-kotlin-codegen:$moshi_version"
  112.     // coil
  113.     implementation("io.coil-kt:coil-compose:1.4.0")
  114. }

三、settings和build组合搭配方式

（1）settings.gradle全局配置，根build.gradle不做配置

  • gradle.properties配置全局变量 

  • settings.gradle配置文件

  1. pluginManagement {
  2.  
  3.  
  4.     /**
  5.      * The pluginManagement.repositories block configures the
  6.      * repositories Gradle uses to search or download the Gradle plugins and
  7.      * their transitive dependencies. Gradle pre-configures support for remote
  8.      * repositories such as JCenter, Maven Central, and Ivy. You can also use
  9.      * local repositories or define your own remote repositories. The code below
  10.      * defines the Gradle Plugin Portal, Google's Maven repository,
  11.      * and the Maven Central Repository as the repositories Gradle should use to look for its
  12.      * dependencies.
  13.      */
  14.  
  15.     repositories {
  16.         gradlePluginPortal()
  17.         google()
  18.         mavenCentral()
  19.     }
  20.     resolutionStrategy {
  21.     }
  22.  
  23.     plugins{
  24.         //是用来构建 apk 的 gradle 插件
  25.         id 'com.android.application' version '${agpVersion}' apply false
  26.         //是用来构建 Android Library 的 gradle 插件 （jar, aar）
  27.         id 'com.android.library' version '${agpVersion}' apply false
  28.         // 一个Gradle插件，用于将所有依赖项比如lib文件下依赖的jar包和项目代码打包到单个Jar文件中  官方地址[https://plugins.gradle.org/plugin/com.github.johnrengelman.shadow#groovy-usage]
  29.         id 'com.github.johnrengelman.shadow' version "${agpShadow}" apply false
  30.     }
  31.  
  32. }
  33. dependencyResolutionManagement {
  34.  
  35.     /**
  36.      * The dependencyResolutionManagement.repositories
  37.      * block is where you configure the repositories and dependencies used by
  38.      * all modules in your project, such as libraries that you are using to
  39.      * create your application. However, you should configure module-specific
  40.      * dependencies in each module-level build.gradle file. For new projects,
  41.      * Android Studio includes Google's Maven repository and the Maven Central
  42.      * Repository by default, but it does not configure any dependencies (unless
  43.      * you select a template that requires some).
  44.      */
  45.     /** 
  46.      * RepositoriesMode.PREFER_PROJECT : 解析依赖库时 , 优先使用本地仓库 , 本地仓库没有该依赖 , 则使用远程仓库 ;
  47.      * RepositoriesMode.FAIL_ON_PROJECT_REPOS : 解析依赖库时 , 强行使用远程仓库 , 不管本地仓库有没有该依赖库 ;
  48.      * */
  49.     repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
  50.     repositories {
  51.         google()
  52.         mavenCentral()
  53.  
  54.         flatDir {
  55.             dirs 'libs'
  56.         }
  57.     }
  58.  
  59.  
  60. }
  61.  
  62. rootProject.name='TestAndroidProject'
  63. include ':AliPay'
  64. include ':app'

  • 根目录build.gradle文件

  1.  
  2. plugins{
  3.     //是用来构建 apk 的 gradle 插件
  4.     id 'com.android.application' apply false
  5.     //是用来构建 Android Library 的 gradle 插件 （jar, aar）
  6.     id 'com.android.library' apply false
  7.     // 一个Gradle插件，用于将所有依赖项比如lib文件下依赖的jar包和项目代码打包到单个Jar文件中  官方地址[https://plugins.gradle.org/plugin/com.github.johnrengelman.shadow#groovy-usage]
  8.     id 'com.github.johnrengelman.shadow' apply false
  9. }
  10.  
  11.  
  12.  
  13. task clean(type: Delete) {
  14.     delete rootProject.buildDir
  15. }

（2）根build.gradle配置，setting.gradle仅配置基础

  • settings.gradle配置

  1. rootProject.name='WiFiAndroidProject'
  2. include ':DashboardView'
  3. include ':BluetoothKitlibrary'
  4. include ':niftydialogeffectslibrary'
  5. include ':TwinklingRefreshLayout_library'
  6. include ':AliPay'
  7. include ':app'

  • build.gradle配置

  1. //通常定义了项目中的模块使用的通用插件版本
  2. // Top-level build file where you can add configuration options common to all sub-projects/modules.
  3. buildscript {
  4.     repositories {
  5.         gradlePluginPortal()
  6.         google()
  7.         mavenCentral()
  8.         jcenter()
  9.         maven { url 'https://repo1.maven.org/maven2/' }
  10. //
  11.     }
  12.     dependencies {
  13.         //配置gradle插件
  14.         classpath "com.android.tools.build:gradle:8.1.0"
  15.     }
  16.  
  17. }
  18. allprojects {
  19.     repositories {
  20.  
  21.         flatDir {
  22.             dirs 'libs'
  23.         }
  24.         flatDir {
  25.             dirs project(':AliPay').file('libs')
  26.         }
  27.  
  28.         google()
  29.         mavenCentral()
  30.         maven { url 'https://jitpack.io' }
  31.         maven { url 'https://repo1.maven.org/maven2/' }
  32.     }
  33. }
  34. task clean(type: Delete) {
  35.     delete rootProject.buildDir
  36. }

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/凡人多烦事01/article/detail/266300
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号