前言
有些基于 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
,不会抛出异常导致项目无法构建。