Làm cách nào để xem các truy vấn SQL do JPA ban hành?

Khi mã của tôi phát hành một cuộc gọi như thế này:

entityManager.find(Customer.class, customerID);

Làm thế nào tôi có thể thấy truy vấn SQL cho cuộc gọi này? Giả sử tôi không có quyền truy cập vào máy chủ cơ sở dữ liệu để lập hồ sơ / giám sát các cuộc gọi, có cách nào để đăng nhập hoặc xem trong IDE của tôi các truy vấn SQL tương ứng do các cuộc gọi JPA đưa ra không? Tôi đang chống lại SQL Server 2008 R2 bằng trình điều khiển jTDS.

Tùy chọn đăng nhập là nhà cung cấp cụ thể. Bạn cần biết bạn thực hiện JPA nào.

• Ngủ đông ( xem tại đây ):

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

• EclipseLink ( xem tại đây ):

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

• OpenJPA ( xem tại đây ):

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

• DataNucleus ( xem tại đây ):

  Đặt danh mục nhật ký DataNucleus.Datastore.Nativeở mức, như DEBUG.

Ngoài ra, nếu bạn đang sử dụng EclipseLink và muốn xuất các giá trị tham số SQL, bạn có thể thêm thuộc tính này vào tệp tệp Persence.xml của mình:

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

Nếu bạn sử dụng hibernate và logback làm logger, bạn có thể sử dụng các mục sau (chỉ hiển thị các ràng buộc chứ không hiển thị kết quả):

<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 in Truy vấn

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

org.hibernate.type = TRACE in các liên kết và thông thường các kết quả sẽ bị loại bỏ thông qua bộ lọc tùy chỉnh

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

Bạn cần phụ thuộc janino (http://logback.qos.ch/manual/filters.html#JaninoEventEvaluator):

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

Trong EclipseLink để nhận SQL cho một Truy vấn cụ thể khi chạy, bạn có thể sử dụng 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();

SQL này sẽ chứa? cho các tham số. Để có được SQL dịch với các đối số, bạn cần một DatabaseRecord với các giá trị tham số.

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

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

Nguồn: Cách nhận SQL cho truy vấn

Để xem tất cả SQL và các tham số trong OpenJPA, hãy đặt hai tham số này vào tệp Persence.xml:

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

Nếu bạn muốn xem các truy vấn chính xác hoàn toàn với các giá trị tham số và trả về giá trị, bạn có thể sử dụng trình điều khiển proxy jdbc. Nó sẽ chặn tất cả các cuộc gọi jdbc và ghi lại giá trị của chúng. Một số proxy:

• log4jdbc
• jdbcspy

Họ cũng có thể cung cấp một số tính năng bổ sung, như đo thời gian thực hiện cho các truy vấn và thu thập số liệu thống kê.

Ví dụ sử dụng 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>

Ngoài ra, nếu sử dụng WildFly / JBoss, hãy đặt mức ghi nhật ký của org.hibernate thành DEBUG

Một tùy chọn tốt khác nếu bạn có quá nhiều nhật ký và bạn chỉ muốn đặt dưới dạng tạm thời System.out.println(), bạn có thể, tùy thuộc vào nhà cung cấp của bạn làm:

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

Nếu bạn đang sử dụng Spring framework. Sửa đổi tệp application.properIES của bạn như dưới đây

#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  

Tôi đã tạo ra một mánh gian lận mà tôi nghĩ có thể hữu ích cho người khác. Trong tất cả các ví dụ, bạn có thể loại bỏformat_sql tính nếu bạn muốn giữ các truy vấn đã ghi trên một dòng (không in đẹp).

Các truy vấn SQL được in ra chuẩn để không có tham số của các câu lệnh được chuẩn bị và không tối ưu hóa khung đăng nhập :

application.properties tập tin:

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

application.yml tập tin:

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

Các truy vấn SQL in đẹp với các tham số của các câu lệnh được chuẩn bị bằng cách sử dụng khung ghi nhật ký :

application.properties tập tin:

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

application.yml tập tin:

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

Các truy vấn SQL in đẹp mà không có tham số của các câu lệnh được chuẩn bị bằng cách sử dụng khung ghi nhật ký :

application.properties tập tin:

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

application.yml tập tin:

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

Nguồn (và biết thêm chi tiết): https://www.baeldung.com/sql-logging-spring-boot

Xem Không thể khiến chế độ ngủ đông ngừng hiển thị SQL bằng Bộ điều hợp nhà cung cấp Spring JPA

Với Spring Boot, chỉ cần thêm: spring.jpa.show-sql = true vào application.properIES. Điều này sẽ hiển thị truy vấn nhưng không có các tham số thực tế (bạn sẽ thấy? Thay vì từng tham số).

Trong quá trình phát triển khám phá và để tập trung ghi nhật ký gỡ lỗi SQL vào phương thức cụ thể mà tôi muốn kiểm tra, tôi trang trí phương thức đó bằng các câu lệnh logger sau:

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 để xuất SQL (cấu hình bền vững):

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

Có một tệp có tên là bền vững Nhấn Ctrl + Shift + R và tìm thấy nó, sau đó, có một nơi được viết giống như showQuery.

Cứ nói như thật

Tôi không chắc máy chủ có phải được khởi động ở chế độ Gỡ lỗi không. Kiểm tra các SQL được tạo trên bàn điều khiển.