DEV Community: All Things Dev

Simplified Hazelcast AutoConfiguration in Spring Boot

All Things Dev — Wed, 13 Dec 2023 14:51:48 +0000

Hi Everyone,
I have been working with Hazelcast and Spring Boot for at least 6 years. In these years, probably the biggest pain was that the official Spring Boot starter for Hazelcast supported configuration only via XML file. This became cumbersome since we started supporting multiple clients with their own dedicated development, test and production environments.

This starter facilitates configuration of Hazelcast client / server instances through configuration properties within the application.

Here is how you can simplify Hazelcast AutoConfiguration in your Spring Boot projects -

System Requirements

JDK 17
Spring Boot 3.x

Usage

Add the following dependency to your pom.xml file:

<dependency>
    <groupId>dev.all-things.boot</groupId>
    <artifactId>hazelcast-spring-boot-starter</artifactId>
    <version>1.0.0-M2</version>
</dependency>

Configuration Properties

Common Properties

Property	Description
`application.cache.hazelcast.mode`	Whether to configure Hazelcast instance in 'client' or 'server' mode.
`application.cache.hazelcast.cluster-name`	Name of the Hazelcast cluster.
`application.cache.hazelcast.instance-name`	Name of the Hazelcast instance.

Client Properties

Set application.cache.hazelcast.mode = client to use following properties.

Property	Description
`application.cache.hazelcast.client.server-addresses`	Comma-separated list of server addresses.
`application.cache.hazelcast.client.connection-timeout`	Timeout value for nodes to accept client connection requests.
`application.cache.hazelcast.client.smart-routing.enabled`	Whether to enable smart-routing.

Server Properties

Set application.cache.hazelcast.mode = server to use following properties.

Property	Description
`application.cache.hazelcast.server.port`	Hazelcast server port.
`application.cache.hazelcast.server.primary-address`	Hazelcast primary server address.
`application.cache.hazelcast.server.secondary-addresses`	Alternate network addresses for server to bind to.
`application.cache.hazelcast.server.port-auto-increment.enabled`	Whether to enable port auto-increment.
`application.cache.hazelcast.server.cluster.enabled`	Whether to enable clustering mode.
`application.cache.hazelcast.server.cluster.members`	Comma-separated list of well-known cluster members.
`application.cache.hazelcast.server.multicast.enabled`	Whether to enable multicast clustering mode.
`application.cache.hazelcast.server.multicast.group-name`	Name of the multicast group.
`application.cache.hazelcast.server.multicast.port`	Multicast port.
`application.cache.hazelcast.server.multicast.trusted-interfaces`	Comma-separated list of trusted network interfaces.
`application.cache.hazelcast.server.multicast.time-to-live`	Time that a node should wait for a valid multicast response.
`application.cache.hazelcast.server.multicast.timeout`	Time to live for multicast packets.

Considering the variety of practical scenarios, each comma-separated value in
application.cache.hazelcast.server.cluster.members can be specified in different format.

Format	Example
Standard	`10.10.20.20:5701,10.10.20.20:5702,10.10.20.20:5703`
Port-range	`10.10.20.20:[5701-5703]` or `10.10.20.20:[5701-5702;5703;5709-5712]`
Combined	`10.10.10.20:5701,10.10.20.20:[5701-5702;5703;5709-5712]`

Standalone Server Configuration

Minimal standalone server configuration requires following properties in your application.properties file -

# Hazelcast properties
application.cache.hazelcast.mode = server
application.cache.hazelcast.cluster-name = dev
application.cache.hazelcast.instance-name = dev-node-1
application.cache.hazelcast.server.primary-address = 127.0.0.1
application.cache.hazelcast.server.port = 5701

Clustered Server Configuration

Minimal clustered server configuration requires following properties in your application.properties file -

# Hazelcast properties
application.cache.hazelcast.mode = server
application.cache.hazelcast.cluster-name = dev
application.cache.hazelcast.instance-name = dev-node-1
application.cache.hazelcast.server.primary-address = 127.0.0.1
application.cache.hazelcast.server.port = 5701
application.cache.hazelcast.server.cluster.enabled = true
application.cache.hazelcast.server.cluster.members = 127.0.0.1:5702

Client Configuration

Minimal client configuration requires following properties in your application.properties file -

# Hazelcast properties
application.cache.hazelcast.mode = client
application.cache.hazelcast.cluster-name = dev
application.cache.hazelcast.instance-name = dev-node-1
application.cache.hazelcast.client.server-addresses = 127.0.0.1:5701

Source Code

GitHub Project

Keep in Touch

Please follow me on Twitter where I regularly share my experiences with useful tools and frameworks.

Spring Boot Multi-Module Project with Gradle Convention Plugin

All Things Dev — Fri, 25 Aug 2023 20:22:11 +0000

Hi Everyone,
I have been working with Java and Maven for over a decade. Recently, I started migrating many of my projects to Kotlin and Gradle. Most of these projects are multi-module projects with single parent pom.xml for dependency management.

During my research I learned that Gradle provides similar organization of modules with convention plugin. However, there seems to be no direct guide or reference to create a working Spring Boot multi-module project with Gradle convention plugin configuration. The references that I found were pretty useful in demonstrating the core concepts but nothing which could be directly applicable to our use case. This is the reason I decided to write this article.

Project Structure

<PROJECT-ROOT>
|   settings.gradle.kts
|                       
+---buildSrc
|   |   build.gradle.kts
|   |   settings.gradle.kts
|   \---src
|       \---main
|           \---kotlin
|                   dev.all_things.reference.spring-boot-parent.gradle.kts
|                   
\---web-app
    |   build.gradle.kts
    |   
    \---src
        \---main
            +---kotlin
            |   \---config
            |           Application.kt

Convention Plugin Configuration

It refers to a build configuration file which defines set of plugins, dependencies and compiler settings. Each file is a Gradle script with gradle.kts extension. Gradle will expose each configuration as a plugin with file name as identity e.g. dev.all_things.reference.spring-boot-parent.

buildSrc is a special directory where all convention plugin configurations reside. This directory is nothing but a standalone Gradle project with its own independent dependency and repository configuration.

Like any standard Gradle project buildSrc/settings.gradle.kts specifies repositories required for downloading plugings and dependencies.

// Global plugin management
pluginManagement {
    // Project level repositories for plugins
    repositories {

        // Google mirror of Maven Central for optimized performance
        google()

        // Maven Central (primary) plugin repository
        mavenCentral()

        // Gradle plugin repository
        gradlePluginPortal()
    }
}

// Global dependency management
dependencyResolutionManagement {
    /**
     * Project level repositories for dependencies.
     *
     * Gradle uses its own repository by default.
     * Maven repository needs to be explicitly configured.
     */
    repositories {

        // Google mirror of Maven Central for optimized performance
        google()

        // Maven Central (primary) artifact repository
        mavenCentral()
    }
}

buildSrc/build.gradle.kts specifies common dependencies (and corresponding versions) required by the sub-modules.

description = "kotlin-application-parent"

// Convention plugin configuration
plugins {
    // Enables convention definitions in src/main/kotlin
    `kotlin-dsl`
}

// 'buildSrc' specific dependencies
dependencies {

    // Kotlin
    implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.10")
    implementation("org.jetbrains.kotlin:kotlin-allopen:1.9.10")

    // Spring Boot
    implementation("org.springframework.boot:spring-boot-gradle-plugin:3.1.3")
}

Notice that kotlin-dsl is configured as a plugin. This enables Kotlin DSL for creating reusable build configurations.

// Convention plugin configuration
plugins {
    // Enables convention definitions in src/main/kotlin
    `kotlin-dsl`
}

dev.all_things.reference.spring-boot-parent.gradle.kts specifies the actual build configuration that sub-modules can reuse. This file supports all configurations as a standard build.gradle.kts.

// Plugins common for sub-modules
plugins {

    // Spring Boot plugin configuration
    id("org.springframework.boot")

    // Spring Boot dependency management configuration
    id("io.spring.dependency-management")

    // Kotlin compiler plugin for JVM
    kotlin("jvm")

    // Kotlin plugin for Spring
    kotlin("plugin.spring")
}

group = "dev.all_things.reference"
version = "1.0.0-SNAPSHOT"

// Enabled by 'Kotlin' plugin
kotlin {

    // JDK specific toolchain configuration
    jvmToolchain(20)

}

// Dependencies common for sub-modules
dependencies {

    // ..
}

Module Configuration

Now that convention configuration is ready, it can be imported by sub-modules using generated plugin id i.e. dev.all_things.reference.spring-boot-parent in their build.gradle.kts.

plugins {

    // Other module specific plugins
    // ...

    // Spring Boot parent configuration for dependency management
    id("dev.all_things.reference.spring-boot-parent")
}

Conclusion

A project can have multiple convention configurations. Multiple sub-modules in a project can also import one or more such configurations.

Source Code

GitHub Project

Keep in Touch

Please follow me on Twitter where I regularly share my experiences with useful tools and frameworks.

DEV Community: All Things Dev

Simplified Hazelcast AutoConfiguration in Spring Boot

System Requirements

Usage

Configuration Properties

Common Properties

Client Properties

Server Properties

Standalone Server Configuration

Clustered Server Configuration

Client Configuration

Source Code

Keep in Touch

Spring Boot Multi-Module Project with Gradle Convention Plugin

Project Structure

Convention Plugin Configuration

Module Configuration

Conclusion

Source Code

Keep in Touch

References