Gradle build.gradle 引入敏感信息的友好方式,避免 unknown property

前言

有些基于 Gradle 构建的项目需要发布中央仓库,发布操作需要配置中央仓库的账号密码等敏感信息。
如果是在开源项目或其他不便于公开的场景,敏感信息不适合直接写死在 gradle.build 文件内。

解决方案

通过 gradle.properties 引入

敏感信息可以在 gradle.properties 文件中定义。

例如,我们在 gradle.properties 中定义了以下内容:

NEXUS_USERNAME=my_username
NEXUS_PASSWORD=my_password

写法一:直接引入属性(不推荐)

以下方式可以引入定义的属性:

credentials {
    username NEXUS_USERNAME
    password NEXUS_PASSWORD
}

但是,以上方式存在一定问题。

NEXUS_USERNAME, NEXUS_PASSWORD 等属性的值是敏感数据,被定义在特定环境(例如:作者自己的电脑中)的文件中,当其他环境没有定义该属性,则会出现 unknown property 的错误,导致项目无法构建:

A problem occurred evaluating root project 'camel-rocketmq'.
> Could not get unknown property 'NEXUS_USERNAME' for Credentials [username: null] of type org.gradle.internal.credentials.DefaultPasswordCredentials_Decorated.

写法二:通过 project.properties 引入属性

以下引入方式避免了写法一的问题:

credentials {
    username project.properties.NEXUS_USERNAME
    password project.properties.NEXUS_PASSWORD
}

当相关属性没有定义时,project.properties.NEXUS_USERNAME 仅会获取到 null 而不会抛出异常,不会造成项目无法构建。

通过环境变量引入

获取环境变量也是个很容易的操作,因此也可以通过环境变量传递敏感信息:

credentials {
    username System.getenv("NEXUS_USERNAME")
    password System.getenv("NEXUS_PASSWORD")
}

当相关环境变量没有定义时,System.getenv("NEXUS_PASSWORD")获取到 null,不会抛出异常导致项目无法构建。

Build file 'D:\WorkSpace\Android\SuanSuan\app\build.gradle' line: 11 A problem occurred configuring project ':app'. > groovy.lang.MissingPropertyException: Could not get unknown property 'is' for ApkVariantOutputImpl_Decorated{variantOutput=VariantOutputImpl(versionCode=property(java.lang.Integer, map(java.lang.Integer provider(?) check-type())), versionName=property(java.lang.String, map(java.lang.String provider(?) check-type())), enabled=property(java.lang.Boolean, fixed(class java.lang.Boolean, true)), variantOutputConfiguration=VariantOutputConfigurationImpl(isUniversal=false, filters=[]), baseName=debug, fullName=debug, outputFileName=property(java.lang.String, fixed(class java.lang.String, app-debug.apk)))} of type com.android.build.gradle.internal.api.ApkVariantOutputImpl. * Try: > Run with --info or --debug option to get more log output. > Run with --scan to get full insights. * Exception is: org.gradle.api.ProjectConfigurationException: A problem occurred configuring project ':app'. at org.gradle.configuration.project.LifecycleProjectEvaluator.wrapException(LifecycleProjectEvaluator.java:84) at org.gradle.configuration.project.LifecycleProjectEvaluator.addConfigurationFailure(LifecycleProjectEvaluator.java:77) at org.gradle.configuration.project.LifecycleProjectEvaluator.access$400(LifecycleProjectEvaluator.java:55) at org.gradle.configuration.project.LifecycleProjectEvaluator$NotifyAfterEvaluate.run(LifecycleProjectEvaluator.java:255) at org.gradle.internal.operations.DefaultBuildOperationRunner$1.execute(DefaultBuildOperationRunner.java:29) at org.gradle.internal.operations.DefaultBuildOperationRunner$1.execute(DefaultBuildOperationRunner.java:26) at org.gradle.internal.operations.DefaultBuildOperationRunner$2.execute(DefaultBuildOperationRunner.java:66) at org.gradle.internal.operations.DefaultBuildOperationRunner$2.execute(DefaultBuildOperationRunner.java:59) at org.gradle.internal.operations.DefaultBuildOperationRunner.execute(DefaultBuild
最新发布
03-14
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

wuweijie@apache.org

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值