Skip to content
The Chat Archive
gpt-3.5-turbo-0301· OpenAI WildChat-4.8M (AI2)

springboot APO JPAQueryFactory 记录执行的SQL

  1. User

    springboot APO JPAQueryFactory 记录执行的SQL

  2. Assistant

    在 SpringBoot 中使用 APO JPAQueryFactory 记录执行的 SQL 可以通过以下步骤来实现:

    1. 首先,在 SpringBoot 项目中添加依赖:
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-aop</artifactId>
    </dependency>
    
    <dependency>
        <groupId>com.querydsl</groupId>
        <artifactId>querydsl-jpa</artifactId>
        <version>${querydsl.version}</version>
    </dependency>
    

    其中,${querydsl.version} 可以根据实际情况进行替换。

    1. 在需要记录 SQL 执行的类上添加 @Aspect 和 @Component 注解:
    @Aspect
    @Component
    public class SqlAspect {
    
    }
    
    1. 在 SqlAspect 类中定义切点和通知方法,并且使用 JpaQueryFactory 对象来记录 SQL 执行:
    @Pointcut("execution(* com.example.repository.*.*(..))")
    public void pointcut() {}
    
    @Around("pointcut()")
    public Object recordSql(ProceedingJoinPoint joinPoint) throws Throwable {
        JpaQueryFactory factory = new JPAQueryFactory(entityManager);
        factory.getTemplates().setPrintSchema(true);
    
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        String methodName = signature.getName();
        Class<?>[] parameterTypes = signature.getParameterTypes();
    
        // use factory to record sql
    
        return joinPoint.proceed();
    }
    

    在上面的代码中,pointcut() 方法定义了一个切点,它匹配了 com.example.repository 包中所有方法的执行。recordSql() 方法则是一个通知方法,在切点匹配到方法执行时会被调用。在该方法中,我们使用 JpaQueryFactory 对象来记录执行的 SQL,然后调用 joinPoint.proceed() 继续执行原来的方法。

    1. 最后,需要在 application.properties 文件中添加如下配置:
    logging.level.org.hibernate.SQL=debug
    logging.level.org.hibernate.type.descriptor.sql=trace
    

    以上配置可将 Hibernate 输出的 SQL 日志打印到控制台或日志文件中。需要注意的是,该配置只能用于开发环境调试,不应该在生产环境中使用。

  3. User

    springboot APO监控SQL

  4. Assistant

    在 SpringBoot 中使用 AOP 监控 SQL 执行可以通过以下步骤来实现:

    1. 首先,在 SpringBoot 项目中添加依赖:
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-aop</artifactId>
    </dependency>
    
    <dependency>
        <groupId>org.aspectj</groupId>
        <artifactId>aspectjweaver</artifactId>
        <version>${aspectj.version}</version>
    </dependency>
    
    <dependency>
        <groupId>org.aspectj</groupId>
        <artifactId>aspectjrt</artifactId>
        <version>${aspectj.version}</version>
    </dependency>
    

    其中,${aspectj.version} 可以根据实际情况进行替换。

    1. 在需要监控 SQL 执行的类上添加 @Aspect 和 @Component 注解:
    @Aspect
    @Component
    public class SqlMonitorAspect {
    
    }
    
    1. 在 SqlMonitorAspect 类中定义切点和通知方法,并且使用 org.hibernate.Interceptor 接口来监控 SQL 执行:
    @Pointcut("execution(* com.example.repository.*.*(..))")
    public void pointcut() {}
    
    @Around("pointcut()")
    public Object monitorSql(ProceedingJoinPoint joinPoint) throws Throwable {
        Object result = null;
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        String methodName = signature.getName();
        Class<?>[] parameterTypes = signature.getParameterTypes();
    
        // get hibernate session from entity manage
        Session session = entityManager.unwrap(Session.class);
    
        // set interceptor to monitor sql
        Interceptor interceptor = new SqlMonitorInterceptor();
        session.getSessionFactory().withOptions().interceptor(interceptor).openSession();
    
        try {
            result = joinPoint.proceed();
        } catch (Throwable e) {
            throw e;
        } finally {
            session.close();
        }
    
        return result;
    }
    

    在上面的代码中,pointcut() 方法定义了一个切点,它匹配了 com.example.repository 包中所有方法的执行。monitorSql() 方法则是一个通知方法,在切点匹配到方法执行时会被调用。在该方法中,我们使用 org.hibernate.Interceptor 接口来监控 SQL 执行,首先获取 Hibernate 的 Session,然后通过 session.getSessionFactory() 获取 SessionFactory,最后调用 withOptions().interceptor(interceptor).openSession() 设置拦截器并打开 Session。SqlMonitorInterceptor 是自定义的一个拦截器,用来监控 SQL 执行并将结果打印出来。在方法执行后,我们需要关闭 Session。

    1. 自定义一个 SqlMonitorInterceptor 类:
    public class SqlMonitorInterceptor extends EmptyInterceptor {
        private static final long serialVersionUID = 1L;
        private static final Logger logger = LoggerFactory.getLogger(SqlMonitorInterceptor.class);
        private static final ThreadLocal<Long> startTimeThreadLocal = new ThreadLocal<>();
    
        @Override
        public String onPrepareStatement(String sql) {
            Long startTime = startTimeThreadLocal.get();
            if (startTime != null) {
                long endTime = System.currentTimeMillis();
                long elapsedTime = endTime - startTime;
                logger.info("SQL: [{}] took [{}] ms to execute", sql, elapsedTime);
            }
            return super.onPrepareStatement(sql);
        }
    
        @Override
        public boolean onFlushDirty(Object entity, Serializable id, Object[] currentState, Object[] previousState, String[] propertyNames, Type[] types) {
            startTimeThreadLocal.set(System.currentTimeMillis());
            return super.onFlushDirty(entity, id, currentState, previousState, propertyNames, types);
        }
    
        @Override
        public boolean onSave(Object entity, Serializable id, Object[] state, String[] propertyNames, Type[] types) {
            startTimeThreadLocal.set(System.currentTimeMillis());
            return super.onSave(entity, id, state, propertyNames, types);
        }
    }
    

    SqlMonitorInterceptor 类继承自 EmptyInterceptor,并重写了 onPrepareStatement()、onFlushDirty() 和 onSave() 方法。在 onPrepareStatement() 方法中,我们获取当前线程的执行开始时间,并计算出执行的时间,然后将 SQL 和执行时间打印出来;在 onFlushDirty() 和 onSave() 方法中,我们记录下当前线程的执行开始时间。

    1. 最后,需要在 application.properties 文件中添加如下配置:
    logging.level.org.hibernate.SQL=debug
    logging.level.org.hibernate.type.descriptor.sql=trace
    

    以上配置可将 Hibernate 输出的 SQL 日志打印到控制台或日志文件中。需要注意的是,该配置只能用于开发环境调试,不应该在生产环境中使用。