使用代码读取 build.gradle 中的自定义配置信息

最新推荐文章于 2025-03-13 18:51:10 发布

原创最新推荐文章于 2025-03-13 18:51:10 发布 · 7.1k 阅读

4 ·

CC 4.0 BY-SA版权

文章标签：

#build.gradle #buildTypes #buildConfigField

Android 专栏收录该内容

4 篇文章

订阅专栏

本文介绍如何在Gradle的build.gradle文件中设置BuildConfigField字段来区分不同的构建类型，如发布版、高级版和调试版，并展示了如何通过BuildConfig.CUSTOMIZED_VERSION获取这些配置值。

1. 在build.gradle 中 buildConfigField 的参数有3个第一个类型第二个为名称第三个是值如果是字符串类型请不要忘记双引号!

buildTypes {
        release {
            buildConfigField 'String','CUSTOMIZED_VERSION','"common"'
        }
        advanced {
            buildConfigField 'String','CUSTOMIZED_VERSION','"advanced"'
        }
        debug {

            buildConfigField 'String','CUSTOMIZED_VERSION','"debug"'
        }
    }

2. 重新build项目

3. 直接使用 BuildConfig.CUSTOMIZED_VERSION 就可以获取到配置的值

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

沈阳-施立

关注关注

1
点赞
踩
4

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

专栏目录

【我的Android进阶之旅】如何在build.gradle中动态获取参数选项？

字节卷动

04-03

5950

一、需求描述最近有个需求，需要动态获取参数，来进一步配置相关的build.gradle配置。比如我们APP，可能同一份代码，编译出不同的apk出来，引用的一些库不一样，一些库对应的key之类的都不一样。而且APP工程和下面的library工程都需要对此进行相关的判断，一开始我使用过productFlavors来进行这些处理。参考了下面的链接： https://www.jianshu.com.........

android 自定义 build.gradle,Android 自定义gradle编译

weixin_32889145的博客

05-25

991

我们一起用AndroidStudio写一个自定义的Gradle插件吧注：这篇文章注重实际操作，插图丰富，易于理解上手。对于理论知识的解释我自己也一头雾水，所以跟着我做就好啦。我也慢慢在学嘛我把这个整个过程分为三部创建项目和插件，完善插件内容和配置，打包发布并且正确引用自定义插件一.创建项目和插件我们写一个gradle插件是为了用在android项目中，我们先创建一个android项目起名字叫做D...

参与评论您还未登录，请先登录后发表或查看评论

Jenkins pipeline中获取 gradle项目的版本号配置属性

紫眸的博客

06-28

2955

一种是使用gradlew获取 sh 'chmod + x gradlew' output = sh (script: "./gradlew -q versionName", returnStdout: true).trim() VERSION_NAME = output.split('\n')[1] echo "Version Name: ${VERSION_NAME}" 另一种是自己解析gra...

如何获取Android project下 build.gradle、gradle.properties、local.properties文件中定义的属性或变量

热门推荐

安卓开发-顺的博客

03-06

1万+

1、读取project下 build.gradle 属性： ext { compileSdk = 28 minSdk = 17 targetSdk = 28 support = "28.0.0" buildTools = "28.0.0" supportLibraryVersion = "28.0.0" versionCode = 4 ...

Java Gradle入门指南之依赖管理（添加依赖、仓库、版本冲突）

agr21673的博客

03-19

717

Android Studio 如何读取自定义配置的Gradle

xueyoubangbang的博客

04-02

1545

工程build.gradle文件的内容可以使用变量的形式定义，这样是为了统一管理版本号，特别是对于模块化开发的大项目，这一功能能大大降低版本的不一致性 1.首先在根目录下创建文件：config.gradle，内容如下：随便取一个名字就行 2.创建gradle文件（已我的为列） ext { ------------这个名字不能改，固定的 ...

Gradle 进阶学习之 build.gradle 文件

cnzzs的博客

07-19

859

build.gradle 是什么？想象一下，你有一个大型的乐高项目，你需要一个清单来列出所有的乐高积木和它们如何组合在一起。在软件开发中，build.gradle 就是这个清单，它告诉计算机如何构建(组合)你的软件项目。为什么每个项目都有一个 build.gradle 文件？每个项目都像是一个独立的乐高套装，每个套装都...

Android通过build.gradle自定义task读取Manifest配置信息

技术小白的博客园

06-08

3498

Android通过build.gradle自定义task读取Manifest配置信息主要的应用场景：在打线上包的时候进行检测在Manifest文件中配置的各种信息的key是否为标准的线上环境key。主要是通过自定义的gradle task来读取对应meta-data对应的字段的值对比标准的值，可以自行去修改或者仅检测抛出异常。 class GetManifest extend...

AndroidStudio中build.gradle脚本和业务代码共用全局变量实现方案BuildConfig类

HuanWen_Cheng的博客

03-13

854

在app的build.gradle文件的buildTypes或productFlavors闭包中，使用buildConfigField添加自定义字段。

Gradle系列——Gradle的build.gradle文件详情，项目发布（基于Gradle文档7.5）day3-3

qq_51553982的博客

08-02

1853

Project和Task都允许用户添加额外的自定义属性，要添加额外的属性，通过应用所属对象的ext属性即可实现。添加之后可以通过ext属性对自定义属性读取和设置，如果要同时添加多个自定义属性,可以通过ext代码块ext{我们使用的时候直接使用$取值即可。...

android 项目build.gradle,Android build.gradle 配置详解

weixin_36269724的博客

05-27

6020

8种机械键盘轴体对比本人程序员，要买一个写代码的键盘，请问红轴和茶轴怎么选？Gradle 简介Android Studio 是采用 Gradle 来构建项目的。Gradle 是一个非常先进的项目构建工具，若想用 Gradle 构建 Android 项目，需要创建一个脚本，此脚本被称为 build.gradle。Gradle 构建脚本并非基于传统的 XML 文件(如Ant和Maven)，而是 Gr...

Gradle读取配置属性

01-17

6316

前言最近刚换了家公司，太忙了就没怎么写东西、这眼看马上就可以回家过年了，所以抽点时间写写东西啦。 JavaEE开发目前主流还是使用Maven进行构建，但是Gradle也是非常火的了，尤其是在Android开发上，因为我之前也是做过Android开发的，所以更加能体会gradle的强大，笑:)Maven读取属性在使用Maven进行构建时，可以通过<properties></properties>

Gradle 中 buildConfigField的巧妙应用

weixin_30455365的博客

01-24

558

当用AndroidStudio来进行Android项目开发时，build.gradle就是这个工具的核心部分，所有的依赖，debug/release设置，混淆等都在这里进行配置。下面就主要来记录下利用buildConfigField来为我们的项目进行动态配置的目的 eg:debug:打印日志，在内网测试，利用签名 release:关闭日志，外网，签名等先贴出一个完事的build.gradle文...

Android build.gradle读取String中文件及gradle.properties数据

Android

10-25

1142

在网上找了好久没有一个完整的学习文档，自己总结下，方便后面使用，话不多说直接上代码。读取gradle.properties。

31、Android获取meta-data和build.gradle的值

FDoubleman的博客

12-20

1820

需求：项目中有一个需求希望

如何在子模块中获取BuildConfig.DEBUG值

一座小楼的专栏

03-01

5192

我们一般可以通过设定一个布尔类型达常量，来标记软件为Debug模式还是Release模式。 ADT 17版本以后，我们可以通过读取build/BuildConfig.java文件里DEBUG常量来判断。

gradle文件利用java解析_使用文件读取Gradle Multi项目构建

weixin_30465747的博客

02-28

560

嗨，我有2个项目的文件如下：project1\- build.gradleproject2\- build.gradle\- build.propertiesproject1: build.gradleapply from: '/home/project2/build.gradletest/test2/build.gradle'task test1 {println "Running task t...

Android studio build.gradle通过占位符动态配置Androidmanifest

chuyouyinghe的专栏

04-28

1647

概述随着组件化的推进，在抽取推送模块的时候，想通过 build.gradle 动态配置 Androidmanifest 中应用包名，Log日志是否开启，以及推送 module 中配置平台申请的key（ debug和release模式key值不同），如此就大大简化了一个组件的集成。注意 library 默认是不支持debug模式的，也就是说在library中的build.gradle，debug模式的相关配置是不起作用的。Log日志要求debug模式开启；release模式关闭，也就不能实现了。平台

java读取gradle属性,java – Gradle：从其他项目中获取属性

weixin_42510060的博客

03-10

658

是否可以在项目A中定义一个额外的属性并使其在项目B中可见？根项目显然包括两者.我尝试将它放在项目A的build.gradle中：ext {myProps = 'something to say'}这在项目B的build.gradle中：task('X', dependsOn: [':A:someTask']){println(project('A').myProps)}但我得到：FAILURE: ...

Android build.gradle中配置的三方ID和key 怎么封装到另一个

最新发布

06-18

<think>我们面对的问题：如何将Android项目build.gradle中的第三方ID和密钥封装到另一个文件或模块中，以提高安全性和可维护性。分析：在build.gradle中直接写入敏感信息（如API密钥、签名密钥等）是不安全的，尤其是当代码需要上传到公共仓库时。同时，分散的配置也不利于维护。解决方案：1.使用单独的属性文件（如gradle.properties或自定义配置文件）存储敏感信息。2.使用环境变量。3.使用密钥管理服务（但通常需要更复杂的设置，这里不展开）。我们重点讨论第一种方法，因为它在Android项目中比较常见且易于实现。步骤：方法一：使用gradle.properties文件项目根目录下的gradle.properties文件是Gradle的默认配置文件，我们可以在这里定义属性，然后在build.gradle中引用。优点：简单，无需额外配置。缺点：如果该文件被提交到版本控制系统，敏感信息仍然可能泄露。因此，建议将包含敏感信息的gradle.properties文件添加到.gitignore中。方法二：使用单独的配置文件（例如secrets.properties）在项目根目录下创建一个新的配置文件（如secrets.properties），然后在build.gradle中读取该文件。优点：可以更灵活地管理配置文件，同样需要将该文件添加到.gitignore中。方法三：使用本地模块（例如一个Java/Kotlin对象）来提供密钥，但这种方法在构建阶段可能无法直接使用，通常需要结合资源文件或构建脚本。我们以方法二为例，详细说明如何将第三方ID和密钥封装到另一个文件中：步骤1：在项目根目录下创建secrets.properties文件（如果使用版本控制，请将其加入.gitignore）。内容示例：API_KEY="your_api_key"ADMOB_APP_ID="your_admob_app_id"//其他密钥步骤2：在模块的build.gradle文件中读取这个配置文件。步骤3：在build.gradle中使用这些属性。详细代码示例：1.创建secrets.properties文件（位于项目根目录，与app模块的build.gradle同级目录）例如，文件内容：MY_APP_API_KEY="1234567890abcdef"MY_APP_ADMOB_ID="ca-app-pub-1234567890123456~1234567890"2.在app模块的build.gradle文件中，首先读取该文件：//读取secrets.propertiesdefsecretsPropertiesFile=rootProject.file("secrets.properties")defsecretsProperties=newProperties()if(secretsPropertiesFile.exists()){secretsProperties.load(newFileInputStream(secretsPropertiesFile))}else{//如果文件不存在，可以设置默认值或抛出异常，但通常我们建议文件必须存在（除了自动构建服务器可能用环境变量）//这里为了安全，我们建议在本地开发时必须存在该文件，否则构建失败thrownewGradleException("secrets.propertiesfilenotfound")}3.在build.gradle中使用这些属性，例如在defaultConfig中设置manifestPlaceholders，或者在buildTypes中设置resValue等。例如，将API_KEY传递给AndroidManifest.xml：android{defaultConfig{//从secretsProperties中获取MY_APP_API_KEY，如果不存在则使用空字符串manifestPlaceholders=[API_KEY:secretsProperties.getProperty('MY_APP_API_KEY','""')]}}或者在构建类型中设置：buildTypes{release{//使用secretsProperties中的值resValue"string","admob_app_id",secretsProperties.getProperty('MY_APP_ADMOB_ID','""')}}4.如果密钥用于构建配置（例如在dependencies中使用的插件版本控制），则可以直接引用：dependencies{implementationsecretsProperties.getProperty('SOME_LIBRARY_DEPENDENCY','')}但是注意：通常依赖库的版本我们不建议放在这里，因为版本号并不是敏感信息。这里主要存放密钥。另一种常见情况：签名配置我们也可以将签名信息放在secrets.properties中：STORE_FILE_PATH=../my.keystoreSTORE_PASSWORD=myStorePasswordKEY_ALIAS=myKeyAliasKEY_PASSWORD=myKeyPassword然后在build.gradle的signingConfigs中使用：android{signingConfigs{release{storeFilefile(secretsProperties.getProperty('STORE_FILE_PATH'))storePasswordsecretsProperties.getProperty('STORE_PASSWORD')keyAliassecretsProperties.getProperty('KEY_ALIAS')keyPasswordsecretsProperties.getProperty('KEY_PASSWORD')}}buildTypes{release{signingConfigsigningConfigs.release...}}}注意事项：-确保secrets.properties不被提交到版本控制系统（.gitignore中添加）。-在团队协作中，可以通过模板（如secrets.properties.template）来指导其他开发人员创建自己的配置文件。-在持续集成（CI）系统中，通常使用环境变量来替代配置文件，因此我们也可以在构建脚本中优先检查环境变量，如果存在则使用环境变量，否则使用配置文件。改进：支持环境变量我们可以修改读取逻辑，先尝试从环境变量读取，如果环境变量不存在，再读取secrets.properties文件。例如：defgetApiKey={->//先尝试从环境变量读取defenvApiKey=System.getenv("MY_APP_API_KEY")if(envApiKey!=null){returnenvApiKey}//环境变量不存在，再读取secrets.propertiesif(secretsProperties.containsKey('MY_APP_API_KEY')){returnsecretsProperties['MY_APP_API_KEY']}return'""'}然后在需要的地方使用：manifestPlaceholders=[API_KEY:getApiKey()]这样，在CI服务器上，我们可以设置环境变量，而本地开发则使用配置文件。总结：通过将敏感信息移出build.gradle文件，我们提高了项目的安全性和可维护性。同时，通过支持环境变量，使得持续集成构建更加方便。根据问题，我们生成了以下相关问题：§§相关问题§§1.如何将Android项目的签名配置封装到单独的文件中？2.在Android项目中，如何通过环境变量传递构建配置？3.如何防止敏感信息（如API密钥）被意外提交到Git仓库？4.在团队协作中，如何安全地共享Android项目的密钥配置文件？5.AndroidGradle构建中，manifestPlaceholders和resValue有什么区别？</think>### Android项目中封装第三方ID和密钥的方法在Android项目中，将`build.gradle`中的敏感信息（如第三方SDK的ID、API密钥等）封装到单独文件中，可通过以下方法实现： #### 方法1：使用 `gradle.properties` 文件（推荐） **步骤：** 1. 在**项目根目录**创建/修改 `gradle.properties` 文件 ```properties # 示例内容 MAPS_API_KEY = "your_google_maps_api_key" ADMOB_APP_ID = "ca-app-pub-xxxxxxxx~yyyyyyyy" ``` 2. 在 `build.gradle` 中引用这些变量： ```groovy android { defaultConfig { // 直接使用变量 manifestPlaceholders = [ mapsApiKey: MAPS_API_KEY ] resValue "string", "admob_app_id", ADMOB_APP_ID } } ``` 3. 在 `AndroidManifest.xml` 中使用密钥： ```xml <meta-data android:name="com.google.android.geo.API_KEY" android:value="${mapsApiKey}" /> ``` #### 方法2：创建自定义配置文件（更灵活） **步骤：** 1. 在项目根目录创建 `secrets.properties` 文件（添加到 `.gitignore`） ```properties # 敏感信息 API_KEY = "your_api_key_here" CLIENT_SECRET = "your_secret_here" ``` 2. 在 `build.gradle` 中加载配置文件： ```groovy // 读取配置文件 def secretsPropertiesFile = rootProject.file("secrets.properties") def secretsProperties = new Properties() secretsProperties.load(new FileInputStream(secretsPropertiesFile)) android { defaultConfig { buildConfigField "String", "API_KEY", secretsProperties["API_KEY"] resValue "string", "client_secret", secretsProperties["CLIENT_SECRET"] } } ``` 3. 在代码中通过 `BuildConfig` 访问： ```java String apiKey = BuildConfig.API_KEY; ``` #### 方法3：使用环境变量（适合CI/CD环境） **步骤：** 1. 在 `build.gradle` 中读取系统环境变量： ```groovy android { defaultConfig { buildConfigField "String", "API_KEY", "\"${System.getenv("API_KEY")}\"" } } ``` 2. 运行Gradle时传递环境变量： ```bash API_KEY=your_key ./gradlew assembleRelease ``` #### 安全增强建议 1. **忽略配置文件**：将 `secrets.properties` 添加到 `.gitignore` 防止泄露 ``` # .gitignore /secrets.properties ``` 2. **加密敏感信息**（高级）： - 使用 [Android Keystore](https://developer.android.com/training/articles/keystore) 加密密钥 - 或通过 [Gradle Secrets Plugin](https://github.com/google/secrets-gradle-plugin) 管理 3. **模块化配置**：为密钥创建独立模块 ```groovy // settings.gradle include ':security-config' ``` ```groovy // app/build.gradle implementation project(':security-config') ``` #### 示例文件结构 ``` ├── app/ │ └── build.gradle # 引用外部配置 ├── gradle.properties # 存储非敏感配置 ├── secrets.properties # 存储敏感密钥（.gitignore） └── local.properties # 自动生成，可存SDK路径[^2] ``` ### 优势对比 | 方法 | 安全性 | 维护性 | CI/CD支持 | |--------------------|--------|--------|-----------| | `gradle.properties`| 中 | 高 | 需手动配置| | 自定义配置文件 | 高 | 高 | 优秀 | | 环境变量 | 极高 | 中 | 完美支持 | > **最佳实践**：开发环境使用自定义配置文件，生产环境使用CI/CD注入环境变量，结合资源过滤避免密钥硬编码[^5]。 --- ### 相关问题 1. 如何在 Android 项目中安全地管理签名密钥（如 keystore 密码）？ 2. Gradle 属性文件(`gradle.properties`)与本地属性文件(`local.properties`)有什么区别？ 3. 如何在持续集成(CI)流程中自动注入 Android 项目的敏感信息？ 4. 使用 `BuildConfigField` 和 `resValue` 配置变量有何优缺点？ 5. 如何防止 Android 项目中的 API 密钥被反编译泄露？

使用 代码 读取 build.gradle 中的自定义配置信息

使用代码读取 build.gradle 中的自定义配置信息