依赖版本管理的几种方式

讲下如何管理依赖版本&＃xff0c;以及如何管理正式环境与测试环境的变量&＃xff0c;最后讲下如何封装并控制依赖版本。

管理版本的方式不止我列出的几种&＃xff0c;我只是写出了个人认为比较方便的方法。也是自用的方法&＃xff0c;仅供各位高工参考。如有不正还请指出&＃xff01;

一. 使用gradle文件管理如dependent.gradle

dependent.gradle中定义一些依赖库的版本&＃xff0c;然后在项目的跟build.gradle中引入&＃xff0c;这样全部模块都可以使用到dependent.gradle中的值。
dependent.gradle&＃xff1a;

ext {deps &＃61; [//android和kt依赖资源android: ["appcompat" : "androidx.appcompat:appcompat:1.3.1","design" : "com.google.android.material:material:1.4.0","constraint_layout" : "androidx.constraintlayout:constraintlayout:2.0.3","recyclerview" : "androidx.recyclerview:recyclerview:1.2.0",&＃39;fragment_ktx&＃39; : &＃39;androidx.fragment:fragment-ktx:1.3.6&＃39;,&＃39;multidex&＃39; : &＃39;androidx.multidex:multidex:2.0.1&＃39;,"kt_ktx" : &＃39;androidx.core:core-ktx:1.6.0&＃39;,"ktx_coroutines_core" : &＃39;org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.2&＃39;,"ktx_coroutines_android": &＃39;org.jetbrains.kotlinx:kotlinx-coroutines-android:1.5.2&＃39;,"lifecycle" : &＃39;androidx.lifecycle:lifecycle-runtime-ktx:2.3.1&＃39;,"lifecycle_ktx" : &＃39;androidx.lifecycle:lifecycle-livedata-ktx:2.3.1&＃39;,"junit" : &＃39;junit:junit:4.12&＃39;,"test_junit" : &＃39;androidx.test.ext:junit:1.1.1&＃39;,"test_espresso" : &＃39;androidx.test.espresso:espresso-core:3.2.0&＃39;,],//第三方support: ["glide" : &＃39;com.github.bumptech.glide:glide:4.12.0&＃39;,"glide_annotation" : &＃39;com.github.bumptech.glide:annotations:4.12.0&＃39;,"glide_integration" : &＃39;com.github.bumptech.glide:okhttp3-integration:4.12.0&＃39;,"glide_compiler" : &＃39;com.github.bumptech.glide:compiler:4.12.0&＃39;,"gif_drawable" : &＃39;pl.droidsonroids.gif:android-gif-drawable:1.2.10&＃39;,"hilt" : &＃39;com.google.dagger:hilt-android:2.38.1&＃39;,"hilt_kapt" : &＃39;com.google.dagger:hilt-android-compiler:2.38.1&＃39;,"arouter" : &＃39;com.alibaba:arouter-api:1.5.2&＃39;,"arouter_kapt" : &＃39;com.alibaba:arouter-compiler:1.5.2&＃39;,"retrofit2" : &＃39;com.squareup.retrofit2:retrofit:2.9.0&＃39;,"retrofit_gson" : &＃39;com.squareup.retrofit2:converter-gson:2.9.0&＃39;,&＃39;gson_factory&＃39; : &＃39;com.github.getActivity:GsonFactory:5.2&＃39;, //Gson转换容错处理...]]versions &＃61; [&＃39;minSdk&＃39; : 21,&＃39;targetSdk&＃39; : 31,&＃39;compileSdk&＃39;: 31,]}


build.gradle:

//直接引用
apply from: "dependent.gradle"
apply from: "config.gradle"
...


在Lib库中就能直接使用了&＃xff0c;如下&＃xff1a;

apply from: "../lib_default_config.gradle"
apply plugin: &＃39;dagger.hilt.android.plugin&＃39;dependencies {//noinspection GradleDependencyapi "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"//路由api project(&＃39;:cs_router&＃39;)//AndroidXapi deps.android.appcompatapi deps.android.constraint_layoutapi deps.android.recyclerviewapi deps.android.designapi deps.android.multidex...


二. 使用java-gradle-plugin插件的方式管理

这一种方法&＃xff0c;使用插件的方式&＃xff0c;可以在依赖的地方跳转到指定的位置&＃xff0c;并且由于不是在gradle文件中修改的&＃xff0c;所以修改值之后可以不需要build。

代码如上&＃xff0c;需要在项目中创建一个projcet。定义它的build.gradle为java-gradle-plugin类型。

buildscript {repositories {jcenter()google()}dependencies {classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.4.21"}
}apply plugin: &＃39;kotlin&＃39;
apply plugin: &＃39;java-gradle-plugin&＃39; //既不是lib也不是application,指定类型为gradle插件repositories {jcenter()google()
}dependencies {implementation gradleApi()implementation "org.jetbrains.kotlin:kotlin-gradle-plugin:1.4.21"
}compileKotlin {kotlinOptions {jvmTarget &＃61; "1.8"}
}
compileTestKotlin {kotlinOptions {jvmTarget &＃61; "1.8"}
}gradlePlugin {plugins {version {id &＃61; &＃39;com.hongyegroup.version&＃39;implementationClass &＃61; &＃39;com.hongyegroup.version.DependencyVersionPlugin&＃39;}}
}


入口文件&＃xff1a;

class DependencyVersionPlugin : Plugin {override fun apply(project: Project) {//入口文件-空实现}
}


定义版本的单例类&＃xff1a;

object BuildConfig {const val compileSdkVersion &＃61; 29const val buildToolsVersion &＃61; "30.0.1"const val minSdkVersion &＃61; 21const val targetSdkVersion &＃61; 29const val versionCode &＃61; 100const val versionName &＃61; "1.0.0"
}


使用的时候&＃xff1a;可以很清楚的看到不同的依赖方式都已经注明。

android {compileSdkVersion BuildConfig.compileSdkVersionbuildToolsVersion BuildConfig.buildToolsVersiondefaultConfig {minSdkVersion versions.minSdk //使用dependent.gradle的依赖无法跳转targetSdkVersion versions.targetSdk //修改gradle文件中的值&＃xff0c;需要buildversionCode BuildConfig.versionCode //使用version方式管理的依赖&＃xff0c;可以跳转versionName BuildConfig.versionName //修改其中的值&＃xff0c;无需buildtestInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"consumerProguardFiles &＃39;consumer-rules.pro&＃39;multiDexEnabled truevectorDrawables.useSupportLibrary &＃61; true}
}

三. gradle配合BuildConfig管理正式环境和测试环境变量

相信很多同学都是这么管理正式环境与测试环境的吧。

public class Constants {// //测试环境
// public static final String API_BASE_URL &＃61; "http://baidu-api-dev.guabean.com";
// //IM测试环境
// public static final int TIMSDK_APPID &＃61; 123456789;//正式环境public static final String API_BASE_URL &＃61; "http://api.baidu.com";//IM正式环境public static final int TIMSDK_APPID &＃61; 987654321;//推送的正式环境//推送的测试环境//Web的正式环境 等等
}


一旦项目大了&＃xff0c;需要配置的东西多了&＃xff0c;那切换环境的时候岂不是要断手。其实我们可以在gradle中配置&＃xff0c;配合BuildConfig的方式来配置正式与测试环境的变量。

config.gradle:

ext {// isLocalRelease &＃61; true //本地打包环境 release设置trueisLocalRelease &＃61; false //本地打包环境 debug设置false// isReleaseUrl &＃61; true //使用的服务器域名的环境&＃xff0c; 正式环境设置trueisReleaseUrl &＃61; false //使用的服务器域名的环境&＃xff0c;测试环境设置false (线上环境)// 测试环境的域名baseUrl_dev &＃61; &＃39;http://baidu-api-dev.guabean.com&＃39;// 正式环境的域名baseUrl_relese &＃61; &＃39;https://api.baidu.com&＃39;//极光测试环境keyjpush_key_dev &＃61; &＃39;12345678&＃39;//极光正式环境keyjpush_key_relese &＃61; &＃39;87654321&＃39;//Web地址等等
}


使用&＃xff1a;我们在底层库中&＃xff0c;拿到它的全部值&＃xff0c;根据是否是测试环境&＃xff0c;来配置不同的值。 如cptServer的build.gradle&＃xff1a;

apply from: "../lib_default_config.gradle"
apply plugin: &＃39;dagger.hilt.android.plugin&＃39;android {defaultConfig {//读取配置表的值boolean mIsReleaseUrl &＃61; rootProject.ext.isReleaseUrl//判断是正式环境还是测试环境if (mIsReleaseUrl) {String baseUrlRelese &＃61; rootProject.ext.baseUrl_relesebuildConfigField &＃39;String&＃39;, &＃39;Base_Url&＃39;, "\"${baseUrlRelese}\""} else {String baseUrlDev &＃61; rootProject.ext.baseUrl_devbuildConfigField &＃39;String&＃39;, &＃39;Base_Url&＃39;, "\"${baseUrlDev}\""}}}dependencies {//底层api project(&＃39;:cs_baselib&＃39;)
}


当我们使用的时候&＃xff1a;就可以直接拿BuildConfig中的值

public class Constants {public static final String BASE_URL &＃61; BuildConfig.Base_Url;...
}


我们切换环境的时候&＃xff0c;也只需要修改config.gradle的环境true和false就行了。这样就算再多的web和api key都可以很方便的管理。

四. gradle文件的继承与封装&＃xff0c;完全的统一组件的依赖版本

组件化开发的过程中&＃xff0c;各个组件的build.gradle依赖不同的库&＃xff0c;导致各个版本不同&＃xff0c;容易导致不兼容的问题。

如图&＃xff0c;我们封装了gradle的内部实现&＃xff0c;不同的级别模块依赖不同的gradle。

例如lib库依赖 lib_default_config.gradle。

子组件依赖模块 module_default_config.gradle。

运行模块如app或者独立子模块运行模块依赖 runing_default_config.gradle。

lib_base_config.gradle中定义了常规的gradle配置&＃xff0c;和一些指定版本的配置。这个是用于其他的gradle继承的&＃xff0c;一般不单独使用&＃xff0c;代码如下&＃xff1a;

apply plugin: &＃39;dagger.hilt.android.plugin&＃39;//基类的gradle配置
kapt { //ARouter的编译配置arguments {arg("AROUTER_MODULE_NAME", project.getName())}
}android {compileSdk versions.compileSdkdefaultConfig {minSdk versions.minSdktargetSdk versions.targetSdkversionCode 1versionName "1.0"testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"consumerProguardFiles &＃39;consumer-rules.pro&＃39;multiDexEnabled truevectorDrawables.useSupportLibrary &＃61; truejavaCompileOptions { //Hilt的编译配置annotationProcessorOptions {arguments &＃43;&＃61; ["foo" : "bar"]}}}buildTypes {release {minifyEnabled falsemultiDexKeepProguard file(&＃39;multidex-config.pro&＃39;)proguardFiles getDefaultProguardFile(&＃39;proguard-android-optimize.txt&＃39;), &＃39;proguard-rules.pro&＃39;}debug {multiDexKeepProguard file(&＃39;multidex-config.pro&＃39;)}}compileOptions {sourceCompatibility JavaVersion.VERSION_1_8targetCompatibility JavaVersion.VERSION_1_8}kotlinOptions {freeCompilerArgs &＃61; [&＃39;-Xjvm-default&＃61;enable&＃39;]jvmTarget &＃61; JavaVersion.VERSION_1_8useIR &＃61; true}lintOptions {checkReleaseBuilds false}packagingOptions {resources {excludes &＃43;&＃61; &＃39;/META-INF/{AL2.0,LGPL2.1}&＃39;}}}configurations.all {resolutionStrategy.force &＃39;androidx.multidex:multidex:2.0.1&＃39;resolutionStrategy.force &＃39;androidx.annotation:annotation:1.2.0&＃39;resolutionStrategy.force &＃39;androidx.transition:transition:1.3.1&＃39;resolutionStrategy.force &＃39;androidx.lifecycle:lifecycle-common:2.3.1&＃39;resolutionStrategy.force &＃39;androidx.recyclerview:recyclerview:1.2.0&＃39;
}dependencies {api fileTree(dir: &＃39;libs&＃39;, include: [&＃39;*.jar&＃39;])//每个模块都要实现的依赖//TesttestImplementation deps.android.junitandroidTestImplementation deps.android.test_junitandroidTestImplementation deps.android.test_espresso//依赖注入implementation deps.support.hiltkapt deps.support.hilt_kapt//ARouter路由implementation (deps.support.arouter){exclude group: &＃39;com.android.support&＃39;exclude group: &＃39;androidx.appcompat&＃39;exclude group: &＃39;com.google.android.material&＃39;exclude group: &＃39;androidx.activity&＃39;}//ARouter的注解处理器kapt deps.support.arouter_kapt}


lib_default_config.gradle的配置&＃xff0c;用于Lib库的使用

//底层依赖库的gradle配置&＃xff0c;可以依赖这个配置 再配置别的依赖
apply plugin: &＃39;com.android.library&＃39;
apply plugin: &＃39;kotlin-android&＃39;
apply plugin: &＃39;kotlin-kapt&＃39;apply from: rootProject.file(&＃39;lib_base_config.gradle&＃39;) //重复的配置统一由基类提供


使用&＃xff1a;比如我引用一个lib_popup库&＃xff0c;它的build.gradle:

apply from: "../lib_default_config.gradle"dependencies {//继承了之前的dependencies&＃xff0c;再定义一些我需要的依赖库implementation deps.android.appcompatapi deps.support.easy_adapter
}


module_default_config.gradle的配置&＃xff0c;用于子组件的使用

//默认的模块初始化gradle配置&＃xff0c;可以依赖这个配置 再配置别的依赖
apply plugin: &＃39;com.android.library&＃39;
apply plugin: &＃39;kotlin-android&＃39;
apply plugin: &＃39;kotlin-kapt&＃39;apply from: rootProject.file(&＃39;lib_base_config.gradle&＃39;) //重复的配置统一由基类提供android {buildFeatures {dataBinding &＃61; trueviewBinding &＃61; true}
}dependencies {implementation project(&＃39;:cs_cptServices&＃39;) //Module模块默认添加Service模块的
}


如cpt_newsfeed&＃xff0c;朋友圈组件的build.gradle

apply from: "../module_default_config.gradle"dependencies {//九宫格控件implementation project(&＃39;:cs_ninegrid&＃39;)
}


runing_default_config.gradle的配置用于子组件独立运行模块或者app模块。

//运行模块初始化gradle配置&＃xff0c;可以依赖这个配置 再配置别的依赖
apply plugin: &＃39;com.android.application&＃39;
apply plugin: &＃39;kotlin-android&＃39;
apply plugin: &＃39;kotlin-kapt&＃39;
apply plugin: &＃39;dagger.hilt.android.plugin&＃39;//运行模块可以添加路由
apply plugin: &＃39;com.alibaba.arouter&＃39;apply from: rootProject.file(&＃39;lib_base_config.gradle&＃39;) //重复的配置统一由基类提供android {defaultConfig {versionCode 100versionName "1.0.0"applicationId "com.hongyegroup.running"}buildFeatures {dataBinding &＃61; trueviewBinding &＃61; true}
}dependencies {//依赖注入implementation deps.support.hiltkapt deps.support.hilt_kaptimplementation project(&＃39;:cs_cptServices&＃39;) //运行模块默认添加Service模块的
}


使用的时候&＃xff0c;如app模块&＃xff0c;程序的入口&＃xff0c;它的build.gradle如下&＃xff1a;

apply from: "../runing_default_config.gradle"android {defaultConfig {versionCode 100versionName "1.0.0"applicationId "com.xxgroup.xxapp"}
}dependencies {//依赖模块implementation project(&＃39;:cs_cptServices&＃39;)implementation project(&＃39;:cpt_auth&＃39;)implementation project(&＃39;:cpt_main&＃39;)implementation project(&＃39;:cpt_parttime&＃39;)implementation project(&＃39;:cpt_newsfeed&＃39;)implementation project(&＃39;:cpt_ewallet&＃39;)implementation project(&＃39;:cpt_im&＃39;)implementation project(&＃39;:cpt_profile&＃39;)
}


这样就很方便的管理Gradle版本&＃xff0c;配置等信息&＃xff0c;一旦有修改也不至于全部的模块的gradle文件都要改。

我们再基类的gradle配置中指定了版本&＃xff0c;那么全部的模块都是使用统一的版本&＃xff0c;再配合引入库的时候exclude的操作&＃xff0c;完全不用担心引入多个版本导致兼容性的问题。

版本管理源码在此&＃xff0c;最后感谢完结了。

作者&＃xff1a;newki
链接&＃xff1a;https://juejin.cn/post/7098878694449479688
来源&＃xff1a;稀土掘金
著作权归作者所有。商业转载请联系作者获得授权&＃xff0c;非商业转载请注明出处。