Skip to content

Latest commit

 

History

History
127 lines (92 loc) · 3.5 KB

README.md

File metadata and controls

127 lines (92 loc) · 3.5 KB
Raw

Spring Boot + Spring data JPA + PostgreSQL example

Framework

  • Spring Boot 3.1.2
  • Spring Data JPA (Hibernate 6 is the default JPA implementation)
  • PostgreSQL 15
  • Java 17
  • Maven 3
  • JUnit 5
  • Spring Tests (REST Assured)
  • Docker, Testcontainers (for Spring integration tests using a PostgreSQL container)

How to run it

$ git clone [email protected]:SolisAmicus/Spring-Boot-Spring-Data-JPA-PostgreSQL-example.git
$ cd spring-data-jpa-postgresql
$ docker run --name ${container_name} -p ${local_port}:${container_port} -e POSTGRES_USER=${user_name} -e POSTGRES_PASSWORD=${password} -e POSTGRES_DB=${database_name} -d postgres:15-alpine
  • --name ${container_name}: Set the name of the container
  • -p ${local_port}:${container_port}: Local port mapping to container port
  • -e: Environment variables
    • -e POSTGRES_USER=${user_name} – Set the username for the PostgreSQL superuser
    • -e POSTGRES_PASSWORD=${password} – Set the password for the PostgreSQL superuser
    • -e POSTGRES_DB=${database_name} – Set the name of the database
  • -d: Run the container in the background
  • postgres:15-alpine: Docker images——PostgreSQL 15, based on Alpine Linux

application.properties:

spring.datasource.url=jdbc:postgresql://${host}:${port}/${database_name}
spring.datasource.username=${user_name}
spring.datasource.password=${password}

⭐ ​Example:

  • Assume that you start the container locally.
$ docker run --name datasource_PostgreSQL -p 5432:5432 -e POSTGRES_USER=solisamicus -e POSTGRES_PASSWORD=password -e POSTGRES_DB=mydb -d postgres:15-alpine
  • Modify application.properties.
spring.datasource.url=jdbc:postgresql://local:5432/mydb
spring.datasource.username=solisamicus
spring.datasource.password=password
  • Build and run:
$ ./mvnw clean package -Dmaven.test.skip=true
$ ./mvnw spring-boot:run


  • Create a new book:
$ curl -X POST -H "Content-Type: application/json" -d '{"title":"Book E", "price":49.99, "publishDate":"2024-04-01"}' "http://localhost:8080/books"

http://localhost:8080/books

Integration Testing

  1. Make sure the Docker daemon is configured correctly:

/etc/docker/daemon.json

{
  "hosts": ["tcp://0.0.0.0:2375", "unix:///var/run/docker.sock"]
}

  1. Make sure the environment variable DOCKER_HOST is set so that Testcontainers can connect to the remote Docker daemon:

  2. Make sure the firewall on the remote server allows communication between the Docker daemon and Testcontainers.

  3. Make sure Spring Boot's application.properties configuration file is correct, mainly including the configuration to connect to PostgreSQL

$ DOCKER_HOST=tcp://${host}:2375 ./mvnw test -Dtest=BookControllerTest