Android FireBase 支持不同环境
前言
一种常见的使用场景是为开发和生产环境设置不同的 Firebase 项目。
避免在GitHub上分支切换的时候频繁的替换访问服务器的Base_Url、Storage_Url和FireBase的google-services.json配置文件,所以我们开始使用gradle的自动构建项目。
项目介绍
app/build.gradle下buildTypes(构建类型):
- release:发布版本
- debug:测试版本
自动构建的内容
- Base_Url: 访问服务器的URL
- Storage_Url:上传文件和图片的存储地址
- google-services.json:Firebase的配置文件
根据生成的APk访问不同的URL
1. 配置构建类型
在使用Android Studio生成项目的他会自动生成release这种构建类型
android {
...
defaultConfig {...}
buildTypes {
release {
minifyEnabled true
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
}
这里需要根据我们项目的环境来增加对应的构建类型,比如我们的项目就分为
- release:用于上线版本
- debug: 用于测试版本
- release_debug:用于上线前内部测试版本
buildTypes {
release {
debuggable false
minifyEnabled true
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
debug {
debuggable true
minifyEnabled true
getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
signingConfig signingConfigs.debug_config
}
release_debug {
debuggable true
minifyEnabled true
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
signingConfig signingConfigs.debug_release_config
}
}
2. 配置URL访问地址
1.定义访问的URL了
def API_REL_HOST = "\"www.liliLearn.com\""
def API_DEV_HOST = "\"www-dev.liliLearn.com\""
def API_STG_HOST = "\"www-stg.liliLearn.com\""
2.在app/build.gradle的buildTypes引用对应的URL
buildConfigField "String", "API_HOST", "${API_REL_HOST}"
buildTypes {
release {
debuggable false
minifyEnabled true
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
buildConfigField "String", "API_HOST", "${API_REL_HOST}"
buildConfigField "String", "STORAGE_URL", "${REL_STORAGE_URL}"
}
debug {
debuggable true
minifyEnabled true
buildConfigField "String", "API_HOST", "${API_DEV_HOST}"
buildConfigField "String", "STORAGE_URL", "${DEV_STORAGE_URL}"
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
signingConfig signingConfigs.debug_config
}
release_debug {
debuggable true
minifyEnabled true
buildConfigField "String", "API_HOST", "${API_STG_HOST}"
buildConfigField "String", "STORAGE_URL", "${REL_STORAGE_URL}"
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
signingConfig signingConfigs.debug_release_config
}
}
3.在项目Constants类中通过BuildConfig引用对应的配置
public class ApiConstants {
public static final String BASE_URL = BuildConfig.API_HOST;
...
}
我们也可以生成Apk来进行测试
点击 IDE 窗口右侧的 Gradle 。
导航至 ProjectNmae > :App > build 并双击 assemble。
Gradle就会在/app/build/outputs/Apks下生成对应buildTypes的Apk,他们的访问的Url也会根据配置的buildTypes替换成不同的URL
使用源集替换不同的FireBase配置
源集定义:按逻辑关系将每个模块的源代码和资源进行分组,这个分组叫做源集。
Note:在项目中我们可能一个Apk会分为收费版本和免费版本,收费版本可能比免费版本多更多的功能和配置。Gradle提供了使用源集来管理编译过程中应用的代码和资源,收费版本会有更多的代码和资源。main Module源集包括其所有构建变体共用的代码和资源,这个的意思是main Module的代码和资源是所有人共用的,我们只需要抽取出不同的代码,然后配置源集Gradle在Build过程中就会把源集的代码加入Mian Module中编译。
例如:
我们的免费版本的代码和资源我们都放入src/main/中而收费版本的扩展代码我们就放入src/full/中
src/full/(产品风味源集)
src/main/(主源集)
源集按照构建类别(buildType)、产品倾向(productFlavor)等,生成对应的Apk。简单来说就是根据一系列规则和配置来应用不同文件下的代码。。。。。
利用源集管理FireBase的google-services.json
上面我们已经知道了源集的概念,这里就能解决我们正式环境使用一个google-services.json测试环境使用一个google-services.json
通过将 google-services.json 文件放在应用模块根目录下为每个构建变体指定的专用目录中,您可以为不同变体添加多个google-services.json 文件。例如,如果您有“开发”和“发布”两个版本,则可以按如下方式组织您的配置:
app/
google-services.json
src/debug/google-services.json
src/release/google-services.json
...
1.新建源集Folder
2.选择对应的构建类别(buildType)、产品倾向(productFlavor)
-
把google-services.json放入对应的Folder
我们就完成了自动构建不同环境的FireBase。
请参考:
FireBase文档:https://firebase.google.com/docs/configure/?hl=zh-cn
Android Studio文档:https://developer.android.com/studio/build/build-variants.html?hl=zh-cn#build-types
如文中有文字错误和勘误,请留言指出!谢谢。