Example JPA Envers

In this example you can see how to use Envers for Auditing your tables.

Requirements:

• Java 17.x e.g.: sdk install java 17.0.9-amznsdk install java 17.0.9-amzn
• Gradle 8.x e.g. you can use the embedded wrapper gradlew or install sdk install gradle 8.5
• Docker 26.x
• MySQL 8.2.x. Check the Docker section
• Postman (or any rest client)

Description:

This is based on Spring Boot Application 3.2.1, and it is configured with mysql database.

There are the following entities:

0. AuditEnversInfo --> auditory master table
1. Person --> this entity can be a customer or employee.
2. Order
3. Product
4. OrderDetail

For each table (entity) the framework will create the auditory tables.

Docker

Download database

docker run --name mysql-db -p 3306:3306 -e MYSQL_ROOT_PASSWORD=jcalvopinam -d mysql:8.2.0

Start container

docker start mysql-db

Stop container

docker stop mysql-db

How to run?

1. Since the current version, it is not necessary create manually the schema, when the application startup, it will create the schema and the entities. Anyway you can find the script in src/main/resources/db/scripts/database.sql as well as the script with the DDL of tables tables.sql

2. Compile the project with the following command:

./gradlew clean build

3. You can run the application inside your ide from src/main/java/com/jcalvopinam/SampleEnversApplication.java or from terminal with the following command:

./gradlew bootRun

Rest endpoints

I used the postman application as a client to test the endpoints, you can import the collection:

ll src/main/resources/endpoints/collection\[postmanv2.1\].json

Or if you prefer, you can look at the Controllers inside of com.jcalvopinam.web package and the DTOs inside of com.jcalvopinam.dto