Getting started with Micronaut using Gradle

Getting started

In this tutorial, we will create a Micronaut application using Gradle.

Github Link

What you will need

• Java installed on your machine
• Gradle installed on your machine
• Text Editor

Steps

First create your project folder, we will make a folder called "micronaut-project" for this tutorial.

The second step is to add the build.gradle file inside the project folder.

This will contain a script to build the Micronaut application.

Now update the build.gradle file.

1. Add following plugin

plugins {
    id("com.github.johnrengelman.shadow") version "7.1.1"
    id("io.micronaut.application") version "3.2.0"

}

This will help to build application executable jars.
     
2. Next, add dependencies.

dependencies {
   annotationProcessor("io.micronaut:micronaut-http-validation")
    implementation("io.micronaut:micronaut-http-client")
    implementation("io.micronaut:micronaut-jackson-databind")
    implementation("io.micronaut:micronaut-runtime")
    implementation("jakarta.annotation:jakarta.annotation-api")
    runtimeOnly("ch.qos.logback:logback-classic")
    implementation("io.micronaut:micronaut-validation")
    implementation("io.micronaut:micronaut-http-server-netty")
}

3. To download and install these dependencies, you need to configure the repository.

repositories {
    mavenCentral()
}

4. Include a micronaut task to configure the application's runtime and Micronaut annotations.

micronaut {
    runtime("netty")

    processing {
        incremental(true)
        annotations("com.tutorial.project.*")
    }
}

NOTE: com.tutorial.project is the project package name. Replace it with your project package name.

5. To enable the Micornaut application starter, add the following configuration:

application {
    mainClass.set("com.tutorial.project.Application")
}

NOTE: com.tutorial.project is the project package name. Replace it with your project package name. 

6. Now create Application class and add following code

package com.tutorial.project;

import io.micronaut.runtime.Micronaut;

public class Application {
    public static void main(String[] args) {
        Micronaut.run(Application.class, args);
    }
}

NOTE: location of this file should be in micronaut-project/src/main/java/com/tutorial/project

 
7. The last step is to create a gradle.properties file and add the following configuration.

micronautVersion=3.3.0

 8. Now run the following command to build the application and create executable jars.

gradle build

It will create application jars in build/lib folder.

Use the following command to launch the application

java -jar build/libs/micronaut-project-all.jar 

Github Link