プロジェクトの依存関係を宣言する
さまざまなスコープや種類に応じて、`build.gradle` で依存関係を宣言する方法を学びます。
「プロジェクトの依存関係を宣言する」はCoddyKit上の無料Groovy & Gradle: JVM Automation and Build Engineeringレッスンです。 これはレッスン1/4です。 下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。 これはGroovy & Gradle: JVM Automation and Build Engineering学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 Groovy & Gradle: JVM Automation and Build Engineeringコースには全4レッスンが含まれています。
このレッスンの一部はまだ翻訳されておらず、英語で表示されています。
Project Needs & Dependencies
Modern software projects rarely work in isolation. They often rely on external code, known as dependencies, to perform various tasks.
Think of dependencies as pre-built tools or libraries that save you from writing common functionalities from scratch, like logging, parsing JSON, or connecting to a database.
- Libraries: Collections of code (e.g., Apache Commons).
- Frameworks: Structured foundations for applications (e.g., Spring Boot).
- Modules: Components of a larger system.
Gradle's `dependencies` Block
In Gradle, you declare all your project's dependencies within a dedicated dependencies { ... } block in your build.gradle file.
This block is central to managing what your project needs to compile, test, and run.
/* build.gradle */
plugins {
id 'java'
}
repositories {
mavenCentral()
}
dependencies {
// Your dependencies go here!
}Where Gradle Finds Dependencies
Before Gradle can fetch dependencies, it needs to know where to look. This is defined in the repositories { ... } block.
The most common repository is Maven Central, a vast public repository for Java libraries. By declaring mavenCentral(), you tell Gradle to search there.
/* build.gradle */
repositories {
// Tells Gradle to look for dependencies in Maven Central
mavenCentral()
}`implementation`: The Standard
The implementation configuration is your go-to for most production dependencies. It adds the dependency to the compilation classpath and also to the runtime classpath.
Crucially, implementation dependencies are not exposed to other modules that consume your project, which helps with faster compilation and better encapsulation.
/* build.gradle */
dependencies {
// Adds SLF4J API for logging, used during compile and runtime
implementation 'org.slf4j:slf4j-api:1.7.30'
}Example: Using `implementation`
Let's see a simple Java class that uses a library added with implementation. We'll add the Apache Commons Lang library for string utilities.
/* build.gradle */
plugins {
id 'java'
}
repositories {
mavenCentral()
}
dependencies {
implementation 'org.apache.commons:commons-lang3:3.12.0'
}
/* src/main/java/App.java */
import org.apache.commons.lang3.StringUtils;
public class App {
public static void main(String[] args) {
String text = " Hello CoddyKit ";
System.out.println(StringUtils.trim(text));
}
}`testImplementation`: For Testing Only
Dependencies needed only for running tests (like JUnit 5 or Mockito) should be declared with testImplementation.
These dependencies are added to the test compilation and runtime classpaths but are not included in your final application artifact or exposed to production code.
/* build.gradle */
dependencies {
// Adds JUnit 5 for unit testing
testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1'
testImplementation 'org.junit.jupiter:junit-jupiter-engine:5.8.1'
}`runtimeOnly`: Just for Running
Sometimes, a dependency is only needed when your application actually runs, not during compilation. This is where runtimeOnly comes in.
A common use case is a JDBC driver. Your code compiles against the JDBC API (which is often part of Java or a compileOnly dependency), but the specific driver (e.g., HSQLDB, PostgreSQL) is only needed at runtime.
/* build.gradle */
dependencies {
// JDBC driver for HSQLDB, only needed when the app runs
runtimeOnly 'org.hsqldb:hsqldb:2.5.1'
}`compileOnly`: Compile-Time Helpers
Use compileOnly for dependencies that are required during compilation but should not be packaged with your final application or available at runtime.
Examples include annotation processors like Lombok, or API specifications (e.g., Servlet API) when your application will run in an environment that already provides them.
/* build.gradle */
dependencies {
// Lombok for reducing boilerplate code, not needed at runtime
compileOnly 'org.projectlombok:lombok:1.18.20'
annotationProcessor 'org.projectlombok:lombok:1.18.20'
}Local Files as Dependencies
While generally discouraged, you might sometimes need to include a local JAR file that isn't available in any public repository (e.g., a proprietary library).
You can declare these using the files() method within the dependencies block. Make sure the path is correct relative to your project root.
/* build.gradle */
dependencies {
// Includes a JAR file located in the 'libs' folder
implementation files('libs/my-custom-lib.jar')
}Dependency Configuration Quiz
You are building a web application and need to include:
- A logging library for all code.
- JUnit 5 for unit tests.
- The Servlet API, which your application server already provides.
Which Gradle dependency configurations would you use for these three items?
Recap: Declaring Dependencies
Great job! You've learned the essentials of declaring dependencies in Gradle:
- The
dependencies { ... }block is where you list all external libraries. repositories { ... }tells Gradle where to find these libraries (e.g.,mavenCentral()).implementationfor most production code.testImplementationfor test-specific libraries.runtimeOnlyfor dependencies only needed at runtime.compileOnlyfor compile-time only dependencies not packaged.- You can also include local JARs using
files().
Understanding these configurations helps you build efficient and well-structured projects!
よくある質問
「プロジェクトの依存関係を宣言する」レッスンは無料ですか?
はい。「プロジェクトの依存関係を宣言する」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し(組み込みコードエディタと24時間対応のAIチューター)、Groovy & Gradle: JVM Automation and Build Engineeringコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 Groovy & Gradle: JVM Automation and Build Engineeringコースには全4レッスンが含まれています。
「プロジェクトの依存関係を宣言する」で何を学びますか?
さまざまなスコープや種類に応じて、`build.gradle` で依存関係を宣言する方法を学びます。 ブラウザで直接実行するハンズオンコードでGroovy & Gradle: JVM Automation and Build Engineeringを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。
Groovy & Gradle: JVM Automation and Build Engineeringを始めるのに経験は必要ですか?
事前経験は必要ありません。CoddyKitのGroovy & Gradle: JVM Automation and Build Engineeringは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。 これはレッスン1/4です。
「プロジェクトの依存関係を宣言する」レッスンにはどのくらい時間がかかりますか?
ほとんどのCoddyKitレッスンは約5~10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。
このGroovy & Gradle: JVM Automation and Build Engineeringレッスンでコードを書いて実行できますか?
はい。すべてのGroovy & Gradle: JVM Automation and Build Engineeringレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。
このコースのすべてのレッスン
- プロジェクトの依存関係を宣言する
- 依存関係の解決とキャッシュ
- カスタムリポジトリとBOM
- バージョン競合と依存関係制約の解決