IDEA 下 Gradle 刪除多餘無用依賴的處理方法

2022-03-31 16:01:10

簡介

專案中經過很久開發，會有很多當初引入後來又不再使用的依賴，靠肉眼很難分辨刪除。

這時候，我們可以使用分析無用依賴外掛進行處理：gradle-lint-plugin

如何使用

注意：他可能存在刪除錯誤的參照依賴，需要刪除後進行檢查和測試

並且，這裡僅支援單模組專案，如果是多模組專案請參考官方檔案進行處理

官方檔案地址： https://github.com/nebula-plugins/gradle-lint-plugin/wiki

1.引入外掛

在專案的 build.gradle 中參照該外掛, 最新版本號可以點選這裡檢視:

plugins {
  id 'nebula.lint' version '17.7.0'
}

如何你專案中本身已經有外掛，則可以在後面追加，例如我的：

plugins {
    id 'org.springframework.boot' version '2.3.5.RELEASE'
    id 'io.spring.dependency-management' version '1.0.10.RELEASE'
    id 'java'
    id 'nebula.lint' version '17.7.0'
}

2.應用外掛

在 build.gradle 應用該外掛，並在任意位置，設定檢測規則：

apply plugin :"nebula.lint"
gradleLint.rules=['unused-dependency']

3.使用 Gradle 進行重新載入專案

IDEA 使用 Gradle 進行重新載入專案，則會出現 Lint 選單, 如下圖所示：

4.生成報告

點選 lint -> generateGradleLintReport, 可以生成報告。

報告僅保留不同型別的省略結果，可以看到有以下四種報告結果：

one or more classes are required by your code directly (no auto-fix available)
this dependency is unused and can be removed
this dependency should be removed since its artifact is empty (no auto-fix available)
this dependency is a service provider unused at compileClasspath time and can be moved to the runtimeOnly configuration (no auto-fix available)

其中， this dependency is unused and can be removed 表示可以刪除的依賴。

Executing 'generateGradleLintReport'...
> Task :generateGradleLintReport
Generated a report containing information about 83 lint violations in this project
> Task :autoLintGradle
This project contains lint violations. A complete listing of the violations follows.
Because none were serious, the build's overall status was unaffected.
warning unused-dependency one or more classes in org.mockito:mockito-core:3.3.3 are required by your code directly (no auto-fix available)
warning unused-dependency this dependency should be removed since its artifact is empty (no auto-fix available)
build.gradle:59
implementation 'org.springframework.boot:spring-boot-starter-actuator'
warning unused-dependency this dependency is a service provider unused at compileClasspath time and can be moved to the runtimeOnly configuration (no auto-fix available)
build.gradle:69
compileOnly 'org.projectlombok:lombok'
warning unused-dependency this dependency is unused and can be removed
build.gradle:101
compile group: 'ch.qos.logback', name: 'logback-core', version: '1.2.3'
✖ 83 problems (0 errors, 83 warnings)
To apply fixes automatically, run fixGradleLint, review, and commit the changes.

5. 刪除無用依賴

我們可以看到報告的最後一句話，

To apply fixes automatically, run fixGradleLint, review, and commit the changes.

最後，可以執行 fixGradleLint 自動刪除無用依賴。

修復報告如下，我們可以看到除了無用的依賴，還有一些其他的依賴也被刪除了，原因是因為，他認為我們可以直接引入其對應的依賴而不是整個依賴包。

例如，compile group: 'com.baomidou', name: 'mybatis-plus-boot-starter', version: '3.3.1' 中我們只用了整個 starter 包的一部分依賴，可以僅依賴這一部分依賴，而不是整個 starter 包。這個也可以不按照他的推薦，直接手動選擇保留。

Executing 'fixGradleLint'...
> Task :compileJava
> Task :processResources UP-TO-DATE
> Task :classes
> Task :compileTestJava
> Task :fixGradleLint
This project contains lint violations. A complete listing of my attempt to fix them follows. Please review and commit the changes.
needs fixing unused-dependency one or more classes in com.baomidou:mybatis-plus-core:3.3.1 are required by your code directly
fixed unused-dependency this dependency is unused and can be removed
build.gradle:105
compile 'org.ehcache:ehcache'
build.gradle:106
compile 'javax.cache:cache-api'
build.gradle:107
compile 'org.mybatis:mybatis-typehandlers-jsr310:1.0.2'
build.gradle:112
testImplementation 'org.springframework.security:spring-security-test'
Corrected 17 lint problems

特殊情況

Lombok

Lombok 是一個編譯時自動生成 Getter/Setter 和構造器的工具。

Nebula Lint 依舊會檢測無用的依賴，紀錄檔如下：

> Task :lintGradle FAILED
This project contains lint violations. A complete listing of the violations follows.
Because none were serious, the build's overall status was unaffected.
warning unused-dependency this dependency is a service provider unused at compile time and can be moved to the runtime configuration

處理方式(修改版本號)：

gradleLint.ignore('unused-dependency') {
		compileOnly group: 'org.projectlombok', name: 'lombok', version:'1.16.20'
	}

總結

使用該外掛可以一定程度上幫助我們刪除無用依賴，但是也可能會多刪除有用的依賴。

需要在使用外掛自動修復後手動檢測專案，驗證是否會出現問題，避免導致上線釋出錯誤的負優化。

到此這篇關於IDEA 下 Gradle 刪除多餘無用依賴的文章就介紹到這了,更多相關idea Gradle 刪除依賴內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！