プロジェクト間の依存関係

In a multi-project Gradle build, different subprojects often need to work together. One subproject might produce a library that another subproject uses.

This is where inter-project dependencies come in! They define how subprojects rely on each other, ensuring the correct build order and artifact sharing.

• Inter-project dependencies: How one subproject uses code or outputs from another subproject.
• Crucial for modular applications.

Declaring that one subproject depends on another is straightforward in Gradle. You use the project() function within your dependencies block.

For example, if your app subproject needs code from your lib subproject, you'd add this to app/build.gradle:

// app/build.gradle
dependencies {
    implementation project(':lib')
}

The :lib part refers to the path of the lib subproject relative to the root.

Let's imagine a simple multi-project setup. We'll have a root project, an app subproject, and a lib subproject.

Your settings.gradle would look like this:

// settings.gradle
rootProject.name = 'my-multi-project'
include 'app', 'lib'

This tells Gradle about our two subprojects, app and lib.

When declaring inter-project dependencies, you'll typically use configurations like implementation or api.

• implementation: The most common choice. The dependency is used internally by the subproject and is not exposed to consumers of that subproject.
• api: Exposes the dependency to consumers. If app depends on lib via api, and otherApp depends on app, then otherApp will also see lib's API.

For internal use between subprojects, implementation is generally preferred for better encapsulation and faster builds.

First, let's create a simple class in our lib subproject that the app subproject will use. This class will provide a basic utility.

Inside lib/src/main/groovy/com/coddykit/LibUtils.groovy:

Now, let's make our app subproject use the LibUtils class from our lib subproject. Remember, we declared implementation project(':lib') in app/build.gradle.

Try running this example:

One of the biggest advantages of declaring inter-project dependencies is that Gradle automatically figures out the correct build order.

• If app depends on lib, Gradle ensures that lib is compiled and its artifacts are available before app starts its compilation.
• This saves you from manually managing build sequences, especially in complex multi-project setups.

When you run gradle build from the root, Gradle will build lib first, then app.

What if your lib subproject itself depends on another subproject, say common?

// lib/build.gradle
dependencies {
    implementation project(':common')
}

// app/build.gradle
dependencies {
    implementation project(':lib')
}

If app depends on lib, and lib depends on common, Gradle will ensure that common is also built and its artifacts are available transitively to app's classpath for compilation, but not necessarily for its API if implementation is used for lib.

To keep your multi-project builds manageable and efficient, follow these best practices:

• Minimal Dependencies: Only declare dependencies on subprojects you truly need.
• Use implementation: Prefer implementation over api for internal subproject dependencies to improve encapsulation and reduce rebuilds.
• Clear Boundaries: Design your subprojects with clear responsibilities to avoid circular dependencies.
• Avoid Deep Paths: Keep subproject paths concise (e.g., :module:submodule is fine, but avoid excessively long paths).

You have a multi-project build with a web subproject and a core subproject. The web subproject needs to use classes from the core subproject for its internal logic, but not expose core's API to any further consumers of web.

Great job! In this lesson, you learned how to manage dependencies between subprojects in a Gradle multi-project build.

• We covered how to declare dependencies using project(':subproject').
• We discussed the importance of implementation for internal use.
• You saw how Gradle automatically handles build order.
• We explored best practices for clean dependency management.

Mastering inter-project dependencies is key to building large, modular applications efficiently with Gradle!