Gradle 中 api、implementation、compileOnly、provide 区别与联系

怼烎@ 2024-04-08 11:27 114阅读 0赞

#### Gradle7 ####

在 Gradle 7 中，compile和runtime配置都被删除了。因此，您必须迁移到上面的implementation和api配置。如果您仍在java为 Java 库使用该插件，则需要改为应用该java-library插件。

#### 都属于java库插件 ####

##### java库插件依赖配置 #####

![在这里插入图片描述][4df8bd5f3423418b81d4871a2344988c.png]

*  绿色的配置是用户应该用来声明依赖关系的配置
 *  粉红色的配置是组件编译或针对库运行时使用的配置
 *  蓝色的配置是组件内部的，供自己使用

##### 测试配置 #####

![在这里插入图片描述][b749d0c5859c4042bbcfa30467e93834.png]

##### java库插件配置表 #####

<table> 
 <thead> 
  <tr> 
   <th>配置名称</th> 
   <th>使用及描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>api</td> 
   <td>该依赖方式会传递所依赖的库，当其他module依赖了该module时，可以使用该module下使用api依赖的库。（传递依赖）用于编译时和运行时。（取代以前的<strong>compile</strong>）</td> 
  </tr> 
  <tr> 
   <td>implementation</td> 
   <td>只能用于当前模块下，模块内部使用 取代以前的 <strong>compile</strong>，使用该方式依赖的库将会参与编译和打包</td> 
  </tr> 
  <tr> 
   <td>compileOnly</td> 
   <td>代替以前的<strong>provided</strong> ，只在编译时有效，不会参与打包可以在自己的moudle中使用该方式依赖一些比如com.android.support，gson这些使用者常用的库，避免冲突。</td> 
  </tr> 
  <tr> 
   <td>compileOnlyApi</td> 
   <td>这是您声明模块和使用者在编译时需要但在运行时不需要的依赖项的地方。这通常包括在运行时发现时被遮蔽的依赖项。</td> 
  </tr> 
  <tr> 
   <td>runtimeOnly</td> 
   <td>只在生成apk的时候参与打包，编译时不会参与，很少用。代替以前的 <strong>apk</strong></td> 
  </tr> 
  <tr> 
   <td>testImplementation</td> 
   <td>只在单元测试代码的编译以及最终打包测试apk时有效。代替以前版本的<strong>testCompile</strong></td> 
  </tr> 
  <tr> 
   <td>testCompileOnly</td> 
   <td>这是您声明依赖项的地方，这些依赖项仅在测试编译时需要，但不应泄漏到运行时。这通常包括在运行时发现时被遮蔽的依赖项。</td> 
  </tr> 
  <tr> 
   <td>testRuntimeOnly</td> 
   <td>这是您声明依赖项的地方，这些依赖项仅在测试运行时需要，而不是在测试编译时需要。</td> 
  </tr> 
 </tbody> 
</table>

##### 常见配置升级 #####

<table> 
 <thead> 
  <tr> 
   <th>删除的配置</th> 
   <th>新配置</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>compile</td> 
   <td>api或者implementation</td> 
  </tr> 
  <tr> 
   <td>runtime</td> 
   <td>runtimeOnly</td> 
  </tr> 
  <tr> 
   <td>testRuntime</td> 
   <td>testRuntimeOnly</td> 
  </tr> 
  <tr> 
   <td>testCompile</td> 
   <td>testImplementation</td> 
  </tr> 
  <tr> 
   <td>Runtime</td> 
   <td>RuntimeOnly</td> 
  </tr> 
  <tr> 
   <td>Compile</td> 
   <td>Implementation</td> 
  </tr> 
 </tbody> 
</table>

[4df8bd5f3423418b81d4871a2344988c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/51fff16c91e147a995791cb9a654382c.png
[b749d0c5859c4042bbcfa30467e93834.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/18533f15653a405cbb5d11f1d15a70c9.png