Jak wyświetlić zapytania SQL wysłane przez JPA?

Kiedy mój kod wywołuje takie wywołanie:

entityManager.find(Customer.class, customerID);

Jak mogę zobaczyć zapytanie SQL dla tego wywołania? Zakładając, że nie mam dostępu do serwera bazy danych w celu profilowania / monitorowania połączeń, czy istnieje sposób na rejestrowanie lub przeglądanie w moim IDE odpowiednich zapytań SQL wysyłanych przez wywołania JPA? Idę na SQL Server 2008 R2 używając sterownika jTDS.

Opcje rejestrowania są zależne od dostawcy. Musisz wiedzieć, której implementacji JPA używasz.

• Hibernacja ( patrz tutaj ):

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

• EclipseLink ( patrz tutaj ):

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

• OpenJPA ( patrz tutaj ):

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

• DataNucleus ( patrz tutaj ):

  Ustaw kategorię dziennika DataNucleus.Datastore.Nativena poziom, na przykład DEBUG.

Ponadto, jeśli używasz EclipseLink i chcesz wyprowadzić wartości parametrów SQL, możesz dodać tę właściwość do swojego pliku persistence.xml:

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

Jeśli używasz hibernacji i logowania jako loggera, możesz użyć następujących elementów (pokazuje tylko powiązania, a nie wyniki):

<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 drukuje zapytanie

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

org.hibernate.type = TRACE wypisuje powiązania i normalnie wyniki, które zostaną pominięte przez niestandardowy filtr

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

Potrzebujesz zależności janino (http://logback.qos.ch/manual/filters.html#JaninoEventEvaluator):

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

W EclipseLink, aby uzyskać SQL dla konkretnego zapytania w czasie wykonywania, możesz użyć interfejsu API DatabaseQuery:

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();

Ten SQL będzie zawierał? dla parametrów. Aby uzyskać tłumaczenie SQL z argumentami, potrzebujesz DatabaseRecord z wartościami parametrów.

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

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

Źródło: jak uzyskać kod SQL do zapytania

Aby wyświetlić wszystkie SQL i parametry w OpenJPA, umieść te dwa parametry w pliku persistence.xml:

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

Jeśli chcesz zobaczyć dokładne zapytania wraz z wartościami parametrów i zwracanymi wartościami, możesz użyć sterownika proxy jdbc. Przechwytuje wszystkie wywołania jdbc i rejestruje ich wartości. Niektóre serwery proxy:

• log4jdbc
• jdbcspy

Mogą również zapewniać dodatkowe funkcje, takie jak mierzenie czasu wykonywania zapytań i zbieranie statystyk.

Przykład z użyciem 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>

Zrobiłem ściągawkę, która moim zdaniem może być przydatna dla innych. We wszystkich przykładach możesz usunąć format_sqlwłaściwość, jeśli chcesz zachować zarejestrowane zapytania w jednej linii (bez ładnego drukowania).

Ładnie drukuj zapytania SQL, aby ustandaryzować bez parametrów przygotowanych instrukcji i bez optymalizacji struktury logowania :

application.properties plik:

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

application.yml plik:

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

Ładnie drukowane zapytania SQL z parametrami przygotowanych instrukcji przy użyciu struktury logowania :

application.properties plik:

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

application.yml plik:

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

Ładnie drukowane zapytania SQL bez parametrów przygotowanych instrukcji za pomocą struktury logowania :

application.properties plik:

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

application.yml plik:

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

Źródło (i więcej szczegółów): https://www.baeldung.com/sql-logging-spring-boot

Dodatkowo, jeśli używasz WildFly / JBoss, ustaw poziom rejestrowania org.hibernate na DEBUG

Inna dobra opcja, jeśli masz za dużo dziennika i chcesz umieścić tylko tymczasowy System.out.println(), możesz, w zależności od dostawcy, zrobić:

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());

Jeśli używasz Spring Framework. Zmodyfikuj plik application.properties jak poniżej

#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  

Zobacz temat Nie można zatrzymać hibernacji i wyświetlać kod SQL przy użyciu adaptera Spring JPA Vendor Adapter

W przypadku Spring Boot wystarczy dodać: spring.jpa.show-sql = true do application.properties. Spowoduje to wyświetlenie zapytania, ale bez rzeczywistych parametrów (zobaczysz? Zamiast każdego parametru).

Podczas opracowywania eksploracyjnego i aby skupić się na rejestrowaniu debugowania SQL na określonej metodzie, którą chcę sprawdzić, dekoruję tę metodę następującymi instrukcjami rejestratora:

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);

EclipseLink do wyprowadzenia kodu SQL (persistence.xml config):

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

Jest plik o nazwie persistence.xml Naciśnij Ctrl + Shift + R i znajdź go, a następnie jest miejsce napisane coś w rodzaju showSQL.

Po prostu powiedz to jako prawdę

Nie jestem pewien, czy serwer musi być uruchomiony w trybie debugowania. Sprawdź SQL utworzone na konsoli.