Springboot JPA打印SQL及参数，还原真实执行过程

2022-11-12 19:38:55

如何使用 Spring Boot 中的 JPA 打印 SQL 语句及其参数

在使用 Spring Boot 进行数据库操作时，打印出实际执行的 SQL 语句及其参数非常有用。这可以帮助您：

调试应用程序： 查看实际执行的 SQL 语句，以确定是否存在性能问题或其他问题。
优化性能： 查看实际执行的 SQL 语句，以确定是否存在不必要的查询或其他性能问题。
理解数据库操作： 查看实际执行的 SQL 语句，以更好地理解应用程序如何与数据库交互。

打印 SQL 语句的方法

在 Spring Boot 中，有几种方法可以打印 SQL 语句及其参数：

1. 使用 org.hibernate.SQLQuery 和 org.hibernate.Query 类

Query query = entityManager.createQuery("select u from User u where u.name = :name");
query.setParameter("name", "John Doe");
query.unwrap(SQLQuery.class)
     .addComment("This is a comment");
List<User> users = query.getResultList();

2. 使用 org.springframework.orm.jpa.JpaTransactionManager 类

JpaTransactionManager transactionManager = new JpaTransactionManager();
transactionManager.setDataSource(dataSource);
transactionManager.setEntityManagerFactory(entityManagerFactory);
transactionManager.setDebugSql(true);

3. 使用 org.springframework.orm.jpa.JpaVendorAdapter 类

JpaVendorAdapter vendorAdapter = new HibernateJpaVendorAdapter();
vendorAdapter.setShowSql(true);
LocalContainerEntityManagerFactoryBean factoryBean = new LocalContainerEntityManagerFactoryBean();
factoryBean.setDataSource(dataSource);
factoryBean.setJpaVendorAdapter(vendorAdapter);
EntityManagerFactory entityManagerFactory = factoryBean.getObject();

4. 使用 AOP（面向方面编程）

@Aspect
@Component
public class SqlLoggingAspect {

    @Pointcut("execution(* javax.persistence.EntityManager.createQuery(..))")
    public void sqlQuery() {}

    @Around("sqlQuery()")
    public Object logSql(ProceedingJoinPoint joinPoint) throws Throwable {
        Query query = (Query) joinPoint.getArgs()[0];
        System.out.println("SQL: " + query.unwrap(SQLQuery.class).getQueryString());
        return joinPoint.proceed();
    }
}