Question

当我的代码发出如下调用时：

entityManager.find(Customer.class, customerID);

如何查看此调用的SQL查询？假设我没有访问数据库服务器来分析/监控调用，是否可以在我的IDE中记录或查看JPA调用发出的相应SQL查询？我使用jTDS驱动程序反对SQL Server 2008 R2。

Answer 1

日志记录选项是特定于提供程序的。你需要知道你使用哪个JPA实现。

休眠（see here）：

<property name = "hibernate.show_sql" value = "true" />

EclipseLink（see here）：

<property name="eclipselink.logging.level" value="FINE"/>

OpenJPA（see here）：

<property name="openjpa.Log" value="DefaultLevel=WARN, Runtime=INFO, Tool=INFO, SQL=TRACE"/>

DataNucleus（see here）：

将日志类别DataNucleus.Datastore.Native设置为某个级别，例如DEBUG。

Answer 2

此外，如果您正在使用EclipseLink并希望输出SQL参数值，则可以将此属性添加到persistence.xml文件中：

<property name="eclipselink.logging.parameters" value="true"/>

Answer 3

如果您使用hibernate和logback作为记录器，则可以使用以下内容（仅显示绑定而不显示结果）：

<appender
    name="STDOUT"
    class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} -
            %msg%n</pattern>
    </encoder>
    <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
        <evaluator>
            <expression>return message.toLowerCase().contains("org.hibernate.type") &amp;&amp;
                logger.startsWith("returning");</expression>
        </evaluator>
        <OnMismatch>NEUTRAL</OnMismatch>
        <OnMatch>DENY</OnMatch>
    </filter>
</appender>

org.hibernate.SQL = DEBUG 打印查询

<logger name="org.hibernate.SQL">
    <level value="DEBUG" />
</logger>

org.hibernate.type = TRACE 打印绑定，通常是结果，这些结果将通过自定义过滤器进行抑制

<logger name="org.hibernate.type">
    <level value="TRACE" />
</logger>

您需要janino依赖（http://logback.qos.ch/manual/filters.html#JaninoEventEvaluator）：

<dependency>
    <groupId>org.codehaus.janino</groupId>
    <artifactId>janino</artifactId>
    <version>2.6.1</version>
</dependency>

Answer 4

在EclipseLink中，为了在运行时获取特定Query的SQL，您可以使用DatabaseQuery API：

Query query = em.createNamedQuery("findMe"); 
Session session = em.unwrap(JpaEntityManager.class).getActiveSession(); 
DatabaseQuery databaseQuery = ((EJBQueryImpl)query).getDatabaseQuery(); 
databaseQuery.prepareCall(session, new DatabaseRecord());

String sqlString = databaseQuery.getSQLString();

这个SQL会包含什么？用于参数。要使用参数转换SQL，需要带有参数值的DatabaseRecord。

DatabaseRecord recordWithValues= new DatabaseRecord();
recordWithValues.add(new DatabaseField("param1"), "someValue");

String sqlStringWithArgs = 
         databaseQuery.getTranslatedSQLString(session, recordWithValues);

来源：How to get the SQL for a Query

Answer 5

为了查看OpenJPA中的所有SQL和参数，请将这两个参数放在persistence.xml中：

<property name="openjpa.Log" value="DefaultLevel=WARN, Runtime=INFO, Tool=INFO, SQL=TRACE"/>
<property name="openjpa.ConnectionFactoryProperties" value="PrintParameters=true" />

Answer 6

如果要查看与参数值和返回值完全相同的查询，可以使用jdbc代理驱动程序。它将拦截所有jdbc调用并记录它们的值。一些代理：

log4jdbc
jdbcspy

他们还可能提供一些额外的功能，例如测量查询的执行时间和收集统计信息。

Answer 7

使用log4j（ src \ log4j.xml ）的示例：

<?xml version="1.0" encoding="UTF-8" ?>

<appender name="CA" class="org.apache.log4j.AsyncAppender">
    <param name="BufferSize" value="512"/>
    <appender-ref ref="CA_OUTPUT"/>
</appender>
<appender name="CA_OUTPUT" class="org.apache.log4j.ConsoleAppender">
    <layout class="org.apache.log4j.PatternLayout">
        <param name="ConversionPattern" value="[%p] %d %c %M - %m%n"/>
    </layout>
</appender>

<logger name="org.hibernate.SQL" additivity="false">
    <level value="DEBUG"/>
    <appender-ref ref="CA"/>
</logger>

<root>
    <level value="WARN"/>
    <appender-ref ref="CA"/>
</root>

Answer 8

此外，如果使用WildFly / JBoss，请将org.hibernate的日志记录级别设置为DEBUG

Answer 9

JPA提供程序可以为您设置它-如果有人不想通过JPA属性进行控制

public static JpaProperties properties() {
        final JpaProperties jpaProperties = new JpaProperties();
        jpaProperties.setShowSql(true);

Answer 10

有一个名为persistence.xml的文件按Ctrl + Shift + R找到它，然后就会出现类似showSQL的地方。

只需将其视为真实

我不确定服务器是否必须作为调试模式启动。检查在控制台上创建的SQL。

Answer 11

EclipseLink输出SQL（persistence.xml配置）：

<property name="eclipselink.logging.level.sql" value="FINE" />

Answer 12

我制作了一份备忘单，我认为对其他人有用。在所有示例中，如果要将记录的查询保持在单行上（无需打印），可以删除format_sql属性。

用于标准输出的参数的漂亮打印SQL查询，无需优化日志记录框架：

application.properties文件：

spring.jpa.show-sql=true
spring.jpa.properties.hibernate.format_sql=true

application.yml文件：

spring:
  jpa:
    show-sql: true
    properties:
      hibernate:
        format_sql: true

使用日志记录框架使用已准备好的语句的参数漂亮的打印SQL查询：

application.properties文件：

spring.jpa.properties.hibernate.format_sql=true logging.level.org.hibernate.SQL=DEBUG logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE

application.yml文件：

spring: jpa: properties: hibernate: format_sql: true logging: level: org: hibernate: SQL: DEBUG type: descriptor: sql: BasicBinder: TRACE

使用日志记录框架漂亮的打印SQL查询没有预准备语句的参数：

application.properties文件：

spring.jpa.properties.hibernate.format_sql=true logging.level.org.hibernate.SQL=DEBUG

application.yml文件：

spring: jpa: properties: hibernate: format_sql: true logging: level: org: hibernate: SQL: DEBUG

来源（以及更多详细信息）：https://www.baeldung.com/sql-logging-spring-boot

Answer 13

在进行探索性开发期间，为了将SQL调试日志记录集中在我要检查的特定方法上，我用以下logger语句装饰了该方法：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ch.qos.logback.classic.Level;

((ch.qos.logback.classic.Logger) LoggerFactory.getLogger("org.hibernate.SQL")).setLevel(Level.DEBUG);
entityManager.find(Customer.class, customerID);
((ch.qos.logback.classic.Logger) LoggerFactory.getLogger("org.hibernate.SQL")).setLevel(Level.INFO);

Answer 14

如果您正在使用Spring框架。如下修改您的 application.properties 文件

#Logging JPA Queries, 1st line Log Query. 2nd line Log parameters of prepared statements 
logging.level.org.hibernate.SQL=DEBUG  
logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE  

#Logging JdbcTemplate Queries, 1st line Log Query. 2nd line Log parameters of prepared statements 
logging.level.org.springframework.jdbc.core.JdbcTemplate=DEBUG  
logging.level.org.springframework.jdbc.core.StatementCreatorUtils=TRACE

Answer 15

使用Spring Boot，只需在application.properties中添加spring.jpa.show-sql = true即可。这将显示查询，但没有实际参数（您会看到？而不是每个参数）。

Answer 16

另一个good option如果你有太多的日志，并且你只想作为一个时间System.out.println()，你可以，根据你的提供者做：

CriteriaBuilder criteriaBuilder = getEntityManager().getCriteriaBuilder();
CriteriaQuery<ExaminationType> criteriaQuery = criteriaBuilder.createQuery(getEntityClass()); 

/* For Hibernate */
System.out.println(getEntityManager().createQuery(criteriaQuery).unwrap(org.hibernate.Query.class).getQueryString());

/* For OpenJPA */ 
System.out.println(getEntityManager().createQuery(criteriaQuery).unwrap(org.apache.openjpa.persistence.QueryImpl.class).getQueryString());

/* For EclipseLink */
System.out.println(getEntityManager().createQuery(criteriaQuery).unwrap(JpaQuery.class).getSQLString());

Answer 17

请参阅Can't make hibernate stop showing SQL using Spring JPA Vendor Adapter

如何查看JPA发出的SQL查询？

17 个答案: