Stock Management by Spring Boot

This project aim to learn Spring Boot best practice, architecture design, and improve my skill. Concept of this project for simulate manage stock system feature to know how it's work and what design is.

Prerequisite

• Homebrew
• Maven 3.9.5
• Amazon Corretto 17
• Java version manager
• Docker Desktop
• IntelliJ IDEA Community
• Google Java Format
• SonarLint
• CommitLint
• GPG signing key

Important

If you need to contribute with the project, first step, you need to set up commitlint for verify the commit message. I prepare for these steps for setting up by open terminal and run make setup-commitlint.

Configuration

Go to src/main/resourse file application.yml

Datasource Connection

Port 5432 is default port of the PostgreSQL

• localhost - Local environment is not using docker network
• postgres - Local environment is using docker network

Credentials of the PostgreSQL to establish connection

• postgres is a setting value for username and password

Redis Connection

Port 6379 is default port of the Redis

• localhost - Local environment is not using docker network
• redis - Local environment is using docker network

Credentials of the Redis to establish connection

• default is default username of the Redis.
• redis is setting value in the docker compose --requirepass argument

How to run

Note: change datasource config correctly before start application.

1. Start database container at first.

docker compose up -d postgres --build

2. Check docker image

docker image ls

3. Check docker container running

docker container ls

4. Start application from terminal

mvn spring-boot:run

5. Stop docker compose and remove container

docker compose down

URLs Resource

In this section, we define the API endpoint & URLs for any resource as a Swagger. Please run the service and access API specification via web browser.

http://localhost:8080/swagger-ui/index.html

Basic Knowledge

General

• Conventional Commit
• Java Code Style Guild
• Read request body in SNAKE
• Data Transfer Object(DTO)

Code Pattern

• [SOLID]
• Facade
• [Builder]

Design System

• Database Entity of Inventory System
• Writing Address in English
• Database Naming Convention Best Practice
  • Stack Overflow
  • Microsoft SQL Server Sample - GitHub

Development

• Spring Boot
• Postgresql
• [Unit test in Spring Boot]
• [Integration test in Spring Boot]

Deployment

• Logging Format - Better Stack
• [Log Level]
• OpenTelemetry Logging
• Three pillars of Observability
• Setup OpenTelemetry in Spring Boot
• [Spring Boot with Actuator]
• [Kubernetes]

Technical Challenge

Java

• BigDecimal ใน Java

Spring Boot

• API Security
  • [Long-live Credentials]
  • [Authentication & Authorization]
• API Performance
  • Spring Data Redis
• Aspect Oriented Programming
  • Spring AOP Tutorial
  • Config Spring AOP
  • Spring AOP for Logging
  • Spring docs @ControllerAdvice
  • Github issue @ControllerAdvice
• Race Condition

Spring Email

• Amazon SES
• Baedung Spring Email

Spring Data JPA

• Getting started with Spring Data JPA
• Advanced Spring Data JPA - Specifications and Querydls
• Advanced Spring Data JPA - Specification
• JPA Metamodel Generator
• JPA Metamodel Generator - Baedung
• Spring Data REST Relationship

Redis Cache

• Connect to Redis server via Redisinsight
• [Redis Sentinal]
• [Redis Cluster with Leader-Follower]

RabbitMQ

• [Dead-Letter Message]

Reference

• PostgreSQL with docker volume
• Redisinsight tool
• No validator could be found for constraint 'NotEmpty' validating type 'Integer'