Gradle依赖项配置

Gradle 3.0引入了以下变化:

compile -> api api keyword is the same as deprecated compile which expose this dependency for all levels compile -> implementation Is preferable way because has some advantages. implementation expose dependency only for one level up at build time (the dependency is available at runtime). As a result you have a faster build(no need to recompile consumers which are higher then 1 level up) provided -> compileOnly This dependency is available only in compile time(the dependency is not available at runtime). This dependency can not be transitive and be .aar. It can be used with compile time annotation processor[About] and allows you to reduce a final output file compile -> annotationProcessor Very similar to compileOnly but also guarantees that transitive dependency are not visible for consumer apk -> runtimeOnly Dependency is not available in compile time but available at runtime.

[POM依赖类型]

这个答案将演示项目中的实现、api和编译之间的区别。

---

假设我有一个有三个Gradle模块的项目:

app (Android应用程序) myandroidlibrary(一个Android库) myjavalibrary(一个Java库)

应用程序有myandroidlibrary作为依赖项。Myandroidlibrary有myjavlibrary作为依赖项。

myjavlibrary有一个MySecret类

public class MySecret {

    public static String getSecret() {
        return "Money";
    }
}

myandroidlibrary中有MyAndroidComponent类，用于操作MySecret类的值。

public class MyAndroidComponent {

    private static String component = MySecret.getSecret();

    public static String getComponent() {
        return "My component: " + component;
    }    
}

最后，app只对myandroidlibrary的值感兴趣

TextView tvHelloWorld = findViewById(R.id.tv_hello_world);
tvHelloWorld.setText(MyAndroidComponent.getComponent());

---

现在，让我们谈谈依赖关系……

应用需要消耗:myandroidlibrary，所以在应用构建中。Gradle使用实现。

(注意:你也可以使用api/compile。但请稍等片刻。)

dependencies {
    implementation project(':myandroidlibrary')      
}

你认为myandroidlibrary构建了什么?Gradle应该是什么样子?我们应该使用哪个作用域?

我们有三个选择:

dependencies {
    // Option #1
    implementation project(':myjavalibrary') 
    // Option #2
    compile project(':myjavalibrary')      
    // Option #3
    api project(':myjavalibrary')           
}

它们之间的区别是什么，我应该用什么?

编译或Api(选项#2或#3)

如果你使用的是编译器或者api。我们的Android应用现在可以访问myandroidcomponent依赖，这是一个MySecret类。

TextView textView = findViewById(R.id.text_view);
textView.setText(MyAndroidComponent.getComponent());
// You can access MySecret
textView.setText(MySecret.getSecret());

实现(选项#1)

如果您正在使用实现配置，MySecret将不会公开。

TextView textView = findViewById(R.id.text_view);
textView.setText(MyAndroidComponent.getComponent());
// You can NOT access MySecret
textView.setText(MySecret.getSecret()); // Won't even compile

---

那么，应该选择哪种配置呢?那要看你的要求了。

如果你想公开依赖关系，请使用api或compile。

如果你不想公开依赖关系(隐藏你的内部模块)，那么使用实现。

注意:

这只是Gradle配置的一个要点，参见表49.1。Java库插件-用于声明依赖关系的配置，以获得更详细的解释。

这个答案的示例项目可以在https://github.com/aldoKelvianto/ImplementationVsCompile上找到

简单的解决方案:

更好的方法是用实现依赖替换所有编译依赖。只有在泄露模块接口时，才应该使用api。这应该会减少大量的重新编译。

 dependencies {
         implementation fileTree(dir: 'libs', include: ['*.jar'])
 
         implementation 'com.android.support:appcompat-v7:25.4.0'
         implementation 'com.android.support.constraint:constraint-layout:1.0.2'
         // …
 
         testImplementation 'junit:junit:4.12'
         androidTestImplementation('com.android.support.test.espresso:espresso-core:2.2.2', {
             exclude group: 'com.android.support', module: 'support-annotations'
         })
 }

---

解释:

在Android Gradle插件3.0之前:我们遇到了一个大问题，即一个代码更改导致所有模块被重新编译。造成这种情况的根本原因是Gradle不知道你是否通过另一个模块泄露了一个模块的接口。

在Android Gradle插件3.0之后:最新的Android Gradle插件现在要求你显式定义是否泄露了模块的接口。在此基础上，它可以对应该重新编译的内容做出正确的选择。

因此，compile依赖项已被弃用，并被两个新的依赖项所取代:

Api:你通过你自己的接口泄露了这个模块的接口，这意味着和旧的编译依赖完全一样 实现:你只在内部使用这个模块，不会通过你的接口泄露它

所以现在你可以显式地告诉Gradle重新编译一个模块，如果使用的模块的接口改变与否。

由Jeroen Mols博客提供

门外汉术语的简单区别是:

如果你正在处理一个接口或模块，它通过公开所声明的依赖关系的成员来为其他模块提供支持，你应该使用'api'。 如果你正在创建一个应用程序或模块，要在内部实现或使用声明的依赖项，请使用'implementation'。 'compile'与'api'工作方式相同，但是，如果你只是实现或使用任何库，'implementation'将更好地工作并节省资源。

阅读@aldok的回答以获得一个全面的示例。

在继续之前先做一些笔记;compile已弃用，并且文档声明您应该使用implementation，因为compile将在Gradle 7.0版本中被删除。 如果你使用——warning-mode运行Gradle构建，你会看到以下消息:

对于依赖项声明，compile配置已弃用。这将失败，并在Gradle 7.0中出现错误。请改用实现配置。

---

只要看看帮助页上的图片，就很有意义了。

你有蓝色框compileClasspath和runtimeClassPath。 当运行gradle build时，compileClasspath是成功构建所必需的。编译时将出现在类路径上的库将是在gradle构建中使用compileOnly或implementation配置的所有库。

然后我们有runtimeClasspath，这些都是使用实现或runtimeOnly添加的包。所有这些库都将添加到您部署到服务器上的最终构建文件中。

如图所示，如果您希望一个库既用于编译，又希望将它添加到构建文件中，那么应该使用实现。

runtimeOnly的示例可以是数据库驱动程序。 compileOnly的一个例子可以是servlet-api。 实现的一个例子是spring-core。

编译配置已弃用，应由实现或api取代。

你可以在API和实现分离部分阅读文档。

简短的部分是

The key difference between the standard Java plugin and the Java Library plugin is that the latter introduces the concept of an API exposed to consumers. A library is a Java component meant to be consumed by other components. It's a very common use case in multi-project builds, but also as soon as you have external dependencies. The plugin exposes two configurations that can be used to declare dependencies: api and implementation. The api configuration should be used to declare dependencies which are exported by the library API, whereas the implementation configuration should be used to declare dependencies which are internal to the component.

进一步的解释请参考这张图片。