Spring Boot applications that use Hibernate/JPA often need to log SQL statements for debugging and performance tuning. This tutorial will guide you through the steps to configure your Spring Boot application to show Hibernate/JPA SQL statements.
Prerequisites
- JDK 17 or later
- Maven or Gradle
- IDE (IntelliJ IDEA, Eclipse, etc.)
Step 1: Set Up a Spring Boot Project
1.1 Create a New Spring Boot Project
Use Spring Initializr to create a new project with the following dependencies:
- Spring Web
- Spring Data JPA
- H2 Database (or any other database of your choice)
Download and unzip the project, then open it in your IDE.
1.2 Configure application.properties
Set up the application properties for your project. This file is located in the src/main/resources
directory.
# src/main/resources/application.properties # Server configuration server.port=8080 # H2 Database configuration spring.datasource.url=jdbc:h2:mem:testdb spring.datasource.driverClassName=org.h2.Driver spring.datasource.username=sa spring.datasource.password=password spring.datasource.platform=h2 # JPA configuration spring.jpa.hibernate.ddl-auto=update spring.jpa.show-sql=true spring.jpa.properties.hibernate.format_sql=true # Logging configuration logging.level.org.hibernate.SQL=DEBUG logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE
Explanation:
spring.jpa.show-sql=true
: Enables logging of SQL statements. spring.jpa.properties.hibernate.format_sql=true
: Formats the SQL statements for better readability. logging.level.org.hibernate.SQL=DEBUG
: Sets the logging level for SQL statements to DEBUG. logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE
: Logs the binding of parameters to SQL statements.
Step 2: Create an Entity Class
Create an entity class to represent a table in the database.
package com.example.demo.entity; import javax.persistence.Entity; import javax.persistence.GeneratedValue; import javax.persistence.GenerationType; import javax.persistence.Id; @Entity public class User { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id; private String name; private String email; // Getters and setters public Long getId() { return id; } public void setId(Long id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public String getEmail() { return email; } public void setEmail(String email) { this.email = email; } }
Explanation:
@Entity
: Specifies that the class is an entity and is mapped to a database table. @Id
: Specifies the primary key of the entity. @GeneratedValue(strategy = GenerationType.IDENTITY)
: Indicates that the primary key is generated automatically.
Step 3: Create a Repository Interface
Create a repository interface to perform CRUD operations on the User
entity.
package com.example.demo.repository; import com.example.demo.entity.User; import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.stereotype.Repository; @Repository public interface UserRepository extends JpaRepository<User, Long> { }
Explanation:
@Repository
: Indicates that the interface is a Spring Data repository. JpaRepository<User, Long>
: Extends the JpaRepository
interface to provide CRUD operations for the User
entity.
Step 4: Create a Service Class
Create a service class to handle business logic related to User
entities.
package com.example.demo.service; import com.example.demo.entity.User; import com.example.demo.repository.UserRepository; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; import java.util.List; @Service public class UserService { @Autowired private UserRepository userRepository; public List<User> getAllUsers() { return userRepository.findAll(); } public User createUser(User user) { return userRepository.save(user); } }
Explanation:
@Service
: Marks the class as a service component in Spring. UserRepository
: Injected to interact with the database.
Step 5: Create a REST Controller
Create a REST controller to expose endpoints for interacting with User
entities.
package com.example.demo.controller; import com.example.demo.entity.User; import com.example.demo.service.UserService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RestController; import java.util.List; @RestController public class UserController { @Autowired private UserService userService; @GetMapping("/users") public List<User> getAllUsers() { return userService.getAllUsers(); } @PostMapping("/users") public User createUser(@RequestBody User user) { return userService.createUser(user); } }
Explanation:
@RestController
: Marks the class as a REST controller. @GetMapping("/users")
: Maps HTTP GET requests to the getAllUsers
method. @PostMapping("/users")
: Maps HTTP POST requests to the createUser
method. @RequestBody
: Binds the HTTP request body to the User
parameter.
Step 6: Running and Testing the Application
6.1 Run the Application
Run the Spring Boot application using your IDE or the command line:
./mvnw spring-boot:run
6.2 Test the Endpoints
Use a tool like Postman or your browser to test the endpoints.
GET /users
- URL:
http://localhost:8080/users
- Method: GET
You should see an empty list []
if no users have been added.
POST /users
You should see a response with the created user object, including the generated ID.
6.3 Verify the SQL Statements
Check the console output of your application. You should see the SQL statements being logged, including the parameter bindings. The output will look something like this:
2023-05-17 15:34:45.123 DEBUG 12345 --- [nio-8080-exec-1] org.hibernate.SQL : insert into user (email, name, id) values (?, ?, ?) 2023-05-17 15:34:45.123 TRACE 12345 --- [nio-8080-exec-1] o.h.type.descriptor.sql.BasicBinder : binding parameter [1] as [VARCHAR] - [john.doe@example.com] 2023-05-17 15:34:45.123 TRACE 12345 --- [nio-8080-exec-1] o.h.type.descriptor.sql.BasicBinder : binding parameter [2] as [VARCHAR] - [John Doe] 2023-05-17 15:34:45.123 TRACE 12345 --- [nio-8080-exec-1] o.h.type.descriptor.sql.BasicBinder : binding parameter [3] as [BIGINT] - [1]
Conclusion
In this tutorial, you have learned how to configure your Spring Boot application to show Hibernate/JPA SQL statements. We covered:
- Setting up a Spring Boot project with JPA and H2 database.
- Configuring application properties to enable SQL logging.
- Creating an entity, repository, service, and controller.
- Running the application and verifying the SQL statements in the console output.
By following these steps, you can effectively monitor and debug the SQL queries generated by Hibernate in your Spring Boot application.
Hibernate Framework Related Spring Boot Source Code Examples
Spring Boot Security Login REST API Example Spring Boot Security Login and Registration REST API Role-based Authorization using Spring Boot and Spring Security Spring Boot JWT Authentication and Authorization Example Spring Boot Security JWT Example - Login REST API with JWT Authentication Spring Boot DTO Example Spring Boot DTO ModelMapper Example @GetMapping Spring Boot Example @PostMapping Spring Boot Example @PutMapping Spring Boot Example @DeleteMapping Spring Boot Example @PatchMapping Spring Boot Example @SpringBootApplication - Spring Boot Spring Boot Hello World REST API Example Spring Boot REST API returns Java Bean Create Spring Boot REST API returns List Spring Boot REST API with Path Variable Spring Boot REST API with Request Param Spring Boot Hibernate MySQL CRUD REST API Tutorial Spring Boot Real-Time Project Development using Spring MVC + Spring Security + Thymeleaf and MySQL Database Spring Boot Tutorial - User Login and Registration Backend + Email Verification Spring Boot JUnit and Mockito Example - Service Layer Testing Spring Professional Certification Cost Spring Boot Validate JSON Request Body Spring Boot One to Many CRUD Example | REST Controller Spring Boot Project with Controller Layer + Service Layer + Repository/DAO Layer Spring Boot Reactive MongoDB CRUD Example - WebFlux Spring Boot Amazon S3 - File Upload Download Delete Example Spring Boot RabbitMQ Publisher and Consumer Example Free Spring Boot Open Source Projects for Learning Purposes Spring Boot + Microsoft SQL Server + Hibernate Example Spring Boot Hibernate Thymeleaf MySQL CRUD Example Spring Boot CRUD Example with Spring MVC, Spring Data JPA, ThymeLeaf, Hibernate, MySQL Spring Boot Hibernate RESTful GET POST PUT and DELETE API Tutorial Best YouTube Channels to learn Spring Boot React Spring Boot Example Spring Boot Groovy Thymeleaf Example Tutorial Spring Boot Scala Thymeleaf Example Tutorial Spring Boot Hibernate DAO with MySQL Database Example Spring Boot PostgreSQL CRUD Example Spring Boot CRUD Example with MySQL Spring Boot Starter Parent Spring Boot JdbcTemplate Example Spring Boot PayPal Payment Gateway Integration Example Create Spring Boot REST API How to Create Spring Boot Application Using Maven How to Create Spring Boot Application Using Gradle How to Use Thymeleaf in a Spring Boot Web Application? How to Enable CORS in a Spring Boot Application? Spring Boot + Angular 8 CRUD Example Spring Boot + Angular 9 CRUD Example Spring Boot + Angular + WebSocket Example Spring Boot CRUD Application with Thymeleaf Spring Boot ReactJS CRUD Project - Employee Management App | GitHub Spring Petclinic ReactJS Project | GitHub Spring Boot React JWT Authentication Example Spring Boot React Basic Authentication Example CRUD Example using Spring Boot + Angular + MySQL Spring Boot + React + Redux CRUD Example Spring Boot Project - Sagan Spring Boot Project - ReactJS Spring Boot CRUD Full Stack Application - GitHub Spring Boot Project - Spring Initializr Spring Boot + Angular Project - Employee Management System Spring Boot Thymeleaf Project - Employee Management System Spring Boot MVC Project - Blogs Aggregator Spring Boot Project - Spring Petclinic | GitHub Spring Boot, Spring Cloud Microservice Project - PiggyMetrics | GitHub Spring Boot, Spring Security, JWT, React, and Ant Design - Polling App | GitHub Spring Boot Microservice Project - Shopping Cart App | GitHub Spring Boot, Spring Cloud Microservice Project - Spring Petclinic App | GitHub Microservices with Spring Cloud Project | GitHub Spring Boot Angular Petclinic Project | GitHub Spring Boot Angular Project - BookStore App | GitHub React Springboot Microservices Project | GitHub Spring Boot Microservices, Spring Cloud, and React Project - BookStoreApp | GitHub Spring Boot + Spring Security + JWT Example Spring Boot Hibernate Assign UUID Identifiers Example Spring Boot Angular Project - Reddit Clone Application Spring Boot Step-by-Step Example Spring Boot Starters List Spring Boot E-Commerce Project - Shopizer Spring Data JPA - save() Method Example Spring Data JPA - saveAll() Method Example Spring Data JPA - findById() Method Example Spring Data JPA - findAll() Method Example Spring Data JPA - count() Method Example Spring Data JPA - deleteById() Method Example Spring Data JPA - delete() Method Example Spring Data JPA - deleteAll() Method Example Spring Data JPA - Distinct Query Method Example Spring Data JPA - GreaterThan Query Method Example Spring Data JPA - LessThan Query Method Example Spring Data JPA - Containing Query Method Example Spring Data JPA - Like Query Method Example Spring Data JPA - Between Query Method Example Spring Data JPA - Date Range Between Query Method Example Spring Data JPA - In Clause Query Method Example Unit Test Spring Boot GET REST API using JUnit and Mockito Unit Test Spring Boot POST REST API using JUnit and Mockito Unit Test Spring Boot PUT REST API using JUnit and Mockito Unit Test Spring Boot DELETE REST API using JUnit and Mockito Create REST Client using WebClient for Spring Boot CRUD REST API Spring Boot WebClient GET Request with Parameters Spring Boot WebClient POST Request Example Spring Boot WebClient PUT Request Example Spring Boot WebClient DELETE Request Example Spring Boot RestClient GET Request Example Spring Boot RestClient POST Request Example Spring Boot RestClient PUT Request Example Spring Boot RestClient Delete Request Example Spring Core Annotations with Examples
Spring Boot @Component Example Spring Boot @Autowired Example Spring Boot @Qualifier Example Spring Boot @Primary Example Spring Boot @Bean Example Spring Boot @Lazy Example Spring Boot @Scope Example Spring Boot @PropertySource Example Spring Boot @Transactional Example Spring Boot @Configuration Example Spring Boot @ComponentScan Example Spring Boot @Profile Example Spring Boot @Cacheable Example Spring Boot @DependsOn Example Spring Boot @RestController Example Spring Boot @ResponseBody Example Spring Boot @GetMapping Example Spring Boot @PostMapping Example Spring Boot @PutMapping Example Spring Boot @DeleteMapping Example Spring Boot @PatchMapping Example Spring Boot @PathVariable Example Spring Boot @ResponseStatus Example Spring Boot @Service Example Spring Boot @Repository Example Spring Boot @RequestParam Example Spring Boot @SessionAttribute Example Spring Boot @RequestBody Example Spring Boot @ExceptionHandler Example Spring Boot @InitBinder Example Spring Boot @ModelAttribute Example Spring Boot @RequestMapping Example Spring Boot @CrossOrigin Example Spring Boot @ControllerAdvice Example Spring Boot @RestControllerAdvice Example Spring Boot @SpringBootApplication Example Spring Boot @EnableAutoConfiguration Example Spring Boot @ConditionalOnClass Example Spring Boot @SpringBootConfiguration Example Spring Boot @ConditionalOnProperty Example Spring Boot @ConditionalOnWebApplication Example Spring Boot @ConfigurationProperties Example Spring Boot @Async Example Spring Boot @Scheduled Example Spring Boot @SpringBootTest Example Spring Boot @WebMvcTest Example Spring Boot @DataJpaTest Example Spring Boot @EnableDiscoveryClient Example Spring Boot @EnableFeignClients Example Spring Boot @RefreshScope Example Spring Boot @LoadBalanced Example Spring Boot @Query Example Spring Boot @Modifying Example Spring Boot @Param Example Spring Boot JPA @Transient Example Spring Boot JPA @Enumerated Example Spring Boot JPA @Temporal Example Spring Boot @CreatedBy Example Spring Boot @LastModifiedDate Example Spring Boot @IdClass Example Spring Boot
Comments
Post a Comment