Quickstart

The quickstart documentation will demonstrate how to install and use Sakura Boot with the cache module to create a simple API application with cache.

Prerequisites

See Requirements for prerequisites.

Base application

If a base application is needed before this quickstart, see the basic quickstart section.

Project structure

The project structure is the same as the basic module quickstart.

To initialize a Spring Boot application, go to https://start.spring.io/. From there, it will be easier to create a new project.

Installation

To install with predefined dependencies for a production-ready application, add one starter to the project dependencies:

With Maven:

This includes the basic functionalities of sakura boot, the necessary spring boot starter, and a runtime postgresql. And the cache module for the second dependency.

<dependency>
    <groupId>org.sansenshimizu.sakuraboot</groupId>
    <artifactId>sakura-boot-starter-predefined-basic</artifactId>
    <version>0.1.1</version>
</dependency>
<dependency>
    <groupId>org.sansenshimizu.sakuraboot</groupId>
    <artifactId>sakura-boot-cache</artifactId>
    <version>0.1.1</version>
</dependency>

This includes all the modules of sakura boot, the necessary spring boot starter, mapstruct, ehcache3 as cache provider, and a runtime postgresql.

<dependency>
    <groupId>org.sansenshimizu.sakuraboot</groupId>
    <artifactId>sakura-boot-starter-predefined-all-module</artifactId>
    <version>0.1.1</version>
</dependency>

With Gradle:

This includes the basic functionalities of sakura boot, the necessary spring boot starter, and a runtime postgresql. And the cache module for the second dependency.

implementation("org.sansenshimizu.sakuraboot:sakura-boot-starter-predefined-basic:0.1.1")
implementation("org.sansenshimizu.sakuraboot:sakura-boot-cache:0.1.1")

This includes all the modules of sakura boot, the necessary spring boot starter, mapstruct, ehcache3 as cache provider, and a runtime postgresql.

implementation("org.sansenshimizu.sakuraboot:sakura-boot-starter-predefined-all-module:0.1.1")

Maven is recommended for developers who never use both Maven and Gradle.

Here is a simple pom.xml file that includes the predefined basic module starter and the cache module with lombok, spring boot devtools, and spring boot docker compose:

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>3.3.1</version>
    <relativePath/>
  </parent>
  <groupId>com.example</groupId>
  <artifactId>demo</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <name>demo</name>
  <description>Demo project for Sakura Boot</description>
  <properties>
    <java.version>21</java.version>
  </properties>
  <dependencies>
    <dependency>
        <groupId>org.sansenshimizu.sakuraboot</groupId>
        <artifactId>sakura-boot-starter-predefined-basic</artifactId>
        <version>0.1.1</version>
    </dependency>
    <dependency>
        <groupId>org.sansenshimizu.sakuraboot</groupId>
        <artifactId>sakura-boot-cache</artifactId>
        <version>0.1.1</version>
    </dependency>

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-devtools</artifactId>
      <scope>runtime</scope>
      <optional>true</optional>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-docker-compose</artifactId>
      <scope>runtime</scope>
      <optional>true</optional>
    </dependency>
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <optional>true</optional>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
        <configuration>
          <excludes>
            <exclude>
              <groupId>org.projectlombok</groupId>
              <artifactId>lombok</artifactId>
            </exclude>
          </excludes>
        </configuration>
      </plugin>
      <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.10.0</version>
            <configuration>
                <source>21</source>
                <target>21</target>
                <annotationProcessorPaths>
                    <path>
                        <groupId>org.projectlombok</groupId>
                        <artifactId>lombok</artifactId>
                    </path>
                </annotationProcessorPaths>
            </configuration>
        </plugin>
    </plugins>
  </build>
</project>

Here is an equivalent simple build.gradle.kts.

build.gradle.kts

plugins {
  java
  id("org.springframework.boot") version "3.3.1"
  id("io.spring.dependency-management") version "1.1.6"
}

group = "com.example"
version = "0.0.1-SNAPSHOT"

java {
  toolchain {
    languageVersion = JavaLanguageVersion.of(21)
  }
}

configurations {
  compileOnly {
    extendsFrom(configurations.annotationProcessor.get())
  }
}

repositories {
  mavenCentral()
}

dependencies {
  implementation("org.sansenshimizu.sakuraboot:sakura-boot-starter-predefined-basic:0.1.1")
  implementation("org.sansenshimizu.sakuraboot:sakura-boot-cache:0.1.1")
  compileOnly("org.projectlombok:lombok")
  developmentOnly("org.springframework.boot:spring-boot-devtools")
  developmentOnly("org.springframework.boot:spring-boot-docker-compose")
  annotationProcessor("org.projectlombok:lombok")
}

Configuration

The configuration of the project, like any Spring Boot application, is done in the application.properties (or application.yml) file.

The Spring Boot properties can be configured in this file with the new Sakura Boot properties.

Here is an example of an application.properties file.

application.properties

# SPRING
spring.application.name = demo
spring.threads.virtual.enabled = true
# activate virtual threads

# Controller
server.servlet.context-path = /api

# Cache
sakuraboot.cache.active_L2_cache = true
# Sakura Boot property to activate L2 cache
spring.jpa.properties.hibernate.cache.use_second_level_cache = true

# Database
spring.jpa.open-in-view = false
spring.datasource.url = jdbc:postgresql://postgres:5432/database
spring.datasource.username = sa
spring.datasource.password = password

# LOG
logging.file.path = ./log/
logging.file.name = ${logging.file.path}${spring.application.name}.log

# Debug
spring.jpa.hibernate.ddl-auto = create-drop
#spring.jpa.show-sql = true
#sakuraboot.exception.showStackTrace = true
#logging.level.com.example.demo = DEBUG
#logging.level.org.sansenshimizu.sakuraboot = DEBUG
#logging.level.root = warn

Those properties are all optional or with a default value.
But it can be a good start for any application.
The Sakura Boot properties work with their related modules. If the module is not used by the application, it can be removed.

For a production-ready application, remove the spring.jpa.hibernate.ddl-auto property.

Create the application

The next part is to write the application code.
The application will use UUID as the primary key of the entity. It is possible to use any other primary key (e.g., Long, String, etc).

Again, if a base application is needed before this quickstart, see the basic quickstart section.

Service

The service in SimpleService.java can change based on the modules that are used.

Here is an example of the service that uses the cache module.

SimpleService.java

package com.example.demo.business;

import java.util.UUID;

import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.stereotype.Service;

import org.sansenshimizu.sakuraboot.basic.api.business.BasicService;
import org.sansenshimizu.sakuraboot.cache.api.Cacheable;
import org.sansenshimizu.sakuraboot.cache.api.CachingUtil;

import com.example.demo.persistence.SimpleEntity;
import com.example.demo.persistence.SimpleRepository;

@Service
public class SimpleService
    implements BasicService<SimpleEntity, UUID>, Cacheable {

    private final SimpleRepository repository;

    private final ObjectMapper objectMapper;

    private final CachingUtil cachingUtil;

    @Override
    public Class<Simple> getEntityClass() {

        return Simple.class;
    }

    @Override
    public String[] getCacheNames() {

        return new String[] {
            "Simple"
        };
    }

    // Required arg constructor, getters, etc. if lombok is not used.
}

For lombok users, add the annotation on top of the class:

@Getter
@RequiredArgsConstructor
@Service

The simple application with the cache module is now ready to be used.

Usage

The usage is the same as the basic quickstart section.

Next steps

For more information on how to build and run a Spring Boot application, see here.

For more information about the spring-boot-docker-compose for local development with docker support, see here.

The quickstart application creates only one entity. The next step could be to add more entities with the necessary fields. For each new entity follow the same steps.

When building an application with different entities, it is possible to create relations between them.
For more information, see the Relationship section.

When building an application, it is important to also create tests.
Sakura Boot provides a test framework that can be used to test the application. It supports unit tests, integration tests, and functional tests.
For more information, see the Testing section.

To customize the configuration for the application requirements, see the Configuration section.

If the quickstart section is not sufficient, other examples are available at the Examples section.