Best way to add Gradle support to IntelliJ Project

java

gradle

intellij

build-tools

byAnton Shumikhin·Nov 5, 2024

Integrate an IntelliJ project with Gradle by following these steps:

Position a build.gradle file at the project's root:

// Who's the 'java' ninjas? Here we are
plugins {
    id 'java'
}

repositories {
    // MavenCentral - beats like a heart of our project's dependencies!
    mavenCentral()
}

dependencies {
    // JUnit 5 - chilling in a "testImplementation" style
    testImplementation 'org.junit.jupiter:junit-jupiter:5.7.0'
}

Venture into IntelliJ, head to File > New > Module from Existing Sources, choose your build.gradle, then comply with the import wizard's wishes.

This embeds Gradle capabilities smoothly, easing dependency management and build automation.

Collaborative prowess with Gradle

Promote smooth sailing within your team by applying the idea plugin in the build.gradle:

// IDEA - you're it!
apply plugin: 'idea'

Upon adding this treasured plugin, invoke gradle cleanIdea idea from your terminal to invigorate IntelliJ's configuration files. Ensure that the team is beholding the same settings and avoiding project recreation stress.

Seamless Gradle integration

Shut the door on your IntelliJ project before you embark.
Erase any lingering *.iml files and the .idea directory to wipe the slate clean.
With the steps outlined in the Fast answer, reboot your project. For IntelliJ IDEA versions 2017.2.4 and beyond, they'll cuddle up to the build.gradle file on project reopening.

If your project and Maven were once an item, introduce Maven to gradle init to engage Gradle in a snap:

// Initiating a Maven-Gradle matrimony
gradle init --type pom

Next, run gradle build to certify that the project has accepted Gradle wholeheartedly.

Gradle's edge: Updates & Plugins

Keep up with the Joneses by checking for Gradle updates and adorning your project with new and shiny plugins regularly.

Extra Gradle configurations: Enhance your experience

Establish a uniform environment

Normalise the environment by creating an init.gradle in your GRADLE_USER_HOME directory. This sets the stage for default configurations such as:

Repository lodgings
JVM arguments and
Project properties

// Sometimes things just need to be a certain way, you know?
allprojects {
    repositories {
        maven {
            // Custom path - because we like to make a difference!
            url 'http://repo.mycompany.com/maven2'
        }
    }
}

Tips and tricks for common problems

When push comes to shove, consider these:

Build errors ruining your parade? Mismatched Gradle version and plugins are often the culprits.
Gradle sync issues playing hide-and-seek? It might be your network settings, especially if you're behind a proxy.
Can't find those dependencies? Double-check your repositories' state of affairs.