VShop

Online Shop Application created for educational purpose to test different technologies, architectural and design styles. VShop "V" stands for Vertically sliced design. For the sake of simplicity the entire application is implemented as a modular monolith. Business functions are layered in separate packages (vertically sliced modules / per function or per domain) and can be extracted to separate microservices when needed later on.

• VShop
  • Architecture
    • Infrastructure
    • Functional modules (Domain)
  • Prerequisites
  • Run the app TL;DR;
  • Initialize the infrastructure
    • 1. Docker configuration
    • 2. Build the project
    • 3. Start the infrastructure
    • 4. Database initialization
  • Run the application
  • Accessing the application
    • Example HTTP requests

Architecture

Infrastructure

• Infinispan 14 (connected to Oracle XE) Infinispan is not used in the current version of the project
• Oracle 21c XE
  • Two users are created on first setup (vshop and vshopcache) - see SQL init scripts
    • vshopcache user is dedicated to the Infinispan JDBC persistent storage
    • vshop user is the application user
• MongoDB 6 (with vshop user)

Functional modules (Domain)

The whole application for the development simplicity is stored in the one project (and the deployment package). However, the application is vertically sliced into the separate functional modules (domains). Modules are expressed as packages.

As the project is under development and for the learning purposes the modules will be added gradually. The following modules are already implemented:

• products - the module works with 4 spring profiles: JPA, SODA, JSON, MONGO. Each profile uses different persistence layer.

Prerequisites

• Docker
• JDK 17 (ensure that JAVA_HOME points to JDK 17 dir - required by the Gradle Wrapper)

Run the app TL;DR;

Running Oracle profiles (JPA, SODA, JSON):

gradlew initDocker
docker-compose -f vshop-docker\docker-compose.yaml up -d oracle
gradlew initDB
gradlew build
gradlew bootRun --args='--spring.profiles.active=JSON'

Running MongoDB profile (MONGO):

gradlew initDocker
docker-compose -f vshop-docker\docker-compose.yaml up -d mongo
gradlew build
gradlew bootRun --args='--spring.profiles.active=MONGO'

⚠️ The first build may take a little longer as the project uses the Testcontainers. Hence, the first build will download the Docker images for Oracle and Mongo.

Initialize the infrastructure

1. Docker configuration

Before you run the docker compose command please initialize the project:

gradlew initDocker

It will download the Oracle JDBC jar for you (from the Maven Central) placing it to the vshop-docker/infinispan/server/lib. This folder is dedicated to the Infinispan 3rd party libraries. Read more about the Infinispan server folder https://infinispan.org/docs/stable/titles/server/server.html#server_root_directory

2. Build the project

To build the project just run the following command:

gradlew build

⚠️ The first build may take a little longer as the project uses the Testcontainers. Hence, the first build will download the Docker images for Oracle and Mongo.

3. Start the infrastructure

Go to the vshop-docker and run the following command

docker-compose up -d

It will start 3 containers:

• Oracle 21c XE
• Infinispan 14 (connected to the Oracle DB) Infinispan is not used in the current version of the project
• MongoDB 6

If you want to start only the Oracle DB or MongoDB you can run the following command:

docker-compose up -d oracle
docker-compose up -d mongo

4. Database initialization

Before you run the application you need to initialize the database. The following task will create all the necessary tables for all Oracle spring profiles (JPA, SODA, JSON).

gradlew initDB

Run the application

The application is configured to run with the following profiles: JPA, SODA, JSON, MONGO.

• JPA profile is used to run the application with the JPA (Hibernate) persistence layer.

gradlew bootRun --args='--spring.profiles.active=JPA'

• SODA profile is used to run the application with the Oracle SODA persistence layer.

gradlew bootRun --args='--spring.profiles.active=SODA'

• JSON profile is used to run the application with the Oracle JSON persistence layer.

gradlew bootRun --args='--spring.profiles.active=JSON'

• MONGO profile is used to run the application with the MongoDB persistence layer.

gradlew bootRun --args='--spring.profiles.active=MONGO'

Accessing the application

At the time the only way to access application is to use the Swagger UI. The Swagger UI is available under the following URL: http://localhost:8080/swagger-ui/index.html

Example HTTP requests

The following request will generate 1000 products and store them in the database:

POST http://localhost:8080/products/generate
Accept: application/json
Content-Type: application/json

{
  "numberOfProducts": 1000
}

Then you can search the products using the following request:

GET http://localhost:8080/products?textContains=whaleboat