/Gradle-Dependencies-Check

梳理并检查项目中多个module的gradle依赖配置是否存在冲突

Primary LanguageGroovyApache License 2.0Apache-2.0

Gradle-Dependencies-Check-Plugin

背景介绍

在平时的开发中,大家经常会遇到因为gradle的构建配置错误引起的各种奇奇怪怪的问题,每次梳理依赖关系都需要很长时间,为了更方便的找出项目中的依赖冲突,专门开发了这个插件。

使用方法:

在项目中添加插件

  • 在项目根目录的build.gradle中添加插件仓库:

      buildscript {
         repositories {
              maven { url "https://repo1.maven.org/maven2" }		    }
          dependencies {
              classpath "com.bihe0832.android:GradleDependenciesCheck:4.1.0"
          }
      }
    
  • 引入插件,并添加插件相关配置

    你可以选择在每个project都添加一份,也可以选择参考demo,在根build.gradle的subprojects中添加

    subprojects {
        /************************** 应用插件 Start ***********************/
        //应用插件
        apply plugin: 'com.bihe0832.gradleDependenciesCheck'
        //配置插件相关配置
        GradleDependenciesCheckConfig {
            /**
             * 检查结果提示类型:
             *  1 以warning形式在命令行提示
             *  2 直接编辑报错,并提示错误
             */
            showResultType = 1
            /**
             * 检查需要排除的检查范围
             *  String 形式添加跳过检查的插件的GroupID,多个用分号分隔
             */
            excludePackage ="com.android.support;org.jetbrains.kotlin"
        }
        /************************** 应用插件 End ***********************/
    
    }
    
  • 将插件添加到其余系统任务中自动执行

      subprojects {
      	afterEvaluate { Project project ->
              project.getTasks().getByName('clean').dependsOn("checkGradleDependencies")
              project.getTasks().getByName('preBuild').dependsOn("checkGradleDependencies")
          }
      }
    

完整的插件使用方式,可以参考项目的事例Sample的根目录的build.gradle### 运行插件

  • 在IED右侧的Gradle窗口选择others,然后点击checkGradleDependencies
  • 直接在命令行运行./gradlew checkGradleDependencies
  • 直接运行已经添加了依赖的系统task

运行效果

  • 在命令行运行效果如下:

      > Task :app:listGradleDependencies FAILED
      listGradleDependencies start ...
      
      FAILURE: Build failed with an exception.
      
      * What went wrong:
      Execution failed for task ':app:listGradleDependencies'.
      > [ERROR] org.jetbrains.kotlin:kotlin-stdlib has different version: 
        	1.3.0 found from: 
        	 	 app:org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.3.0
        	 	 app:Sample:sdk:unspecified
        	1.2.71 found from: 
        	 	 app:org.jetbrains.kotlin:kotlin-compiler-embeddable:1.2.71
      
      
      * Try:
      Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.
      
      * Get more help at https://help.gradle.org
      
      Deprecated Gradle features were used in this build, making it incompatible with Gradle 5.0.
      Use '--warning-mode all' to show the individual deprecation warnings.
      See https://docs.gradle.org/4.10/userguide/command_line_interface.html#sec:command_line_warnings
      
      BUILD FAILED in 1s
      1 actionable task: 1 executed
      [ERROR] org.jetbrains.kotlin:kotlin-stdlib has different version: 
      	1.3.0 found from: 
      	 	 app:org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.3.0
      	 	 app:Sample:sdk:unspecified
      	1.2.71 found from: 
      	 	 app:org.jetbrains.kotlin:kotlin-compiler-embeddable:1.2.71
      
      4:39:17 PM: Task execution finished 'listGradleDependencies'.
    

项目介绍

代码目录

Gradle-Dependencies-Check
	│
	├─── Gradle-Dependencies-Check-Plugin 构建依赖自动检查插件源码
	|
	├─── Sample 构建依赖自动检查插件测试用Demo
	│
	└─── README.md 项目介绍

本地使用方法

  • 如何修改配置及运行工程,请参考本人博客:终端基于gradle的开源项目运行环境配置指引

  • 运行流程:

    • 启动Gradle-Dependencies-Check-Plugin,编辑通过错以后,执行Task uploadArchives

    • 启动Sample,修改根目录build.gradle的repositories,修改后如下:

        repositories {
                maven { url './libs/maven_local' }
        //        maven { url "https://repo1.maven.org/maven2" }			}
      
    • 在Sample运行clean,查看效果

后续规划

  • 检查所有依赖的最新版,然后推荐更新

  • 对于一些需要版本对应的,提示对应。例如:databing compile依赖的版本号与Android Gradle Plugin版本保持一致等

参考及文章