通过Spring AOP 拦截 SQL

本文介绍如何利用Spring AOP技术实现对SQL语句的日志记录,通过配置BeanNameAutoProxyCreator来为目标对象创建代理,从而在不侵入业务代码的前提下记录SQL执行情况。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

sql 的重要性,开发人员都很清除,并不是所有人和时刻都记得log sql ,为了不侵入原来已经写好的代码,亦为了将来可以方便移走log,采用spring 的AOP 来记录log 是件很有意义的事情。配置如下

  <bean id="theTracingBeforeAdvice" class="your.com.TracingBeforeAdvice"/>
  <bean class="org.springframework.aop.framework.autoproxy.BeanNameAutoProxyCreator">
  <property name="proxyTargetClass">
   <value>true</value>
  </property>

  <property name="interceptorNames">
   <list>
    <value>theTracingBeforeAdvice</value>
   </list>
  </property>
  <property name="beanNames">
   <list>
    <value>jdbcTemplate</value>
   </list>
  </property>
 </bean> 

 <bean id="jdbcTemplate"
  class="org.springframework.jdbc.core.JdbcTemplate">
  <property name="dataSource">
   <ref bean="dataSource" />
  </property>
 </bean>

 <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
  <property name="driverClassName" value="com.mysql.jdbc.Driver" />
  <property name="url" value="jdbc:mysql://localhost/mytest?useUnicode=true&amp;characterEncoding=utf-8" />
  <property name="username" value="root" />
  <property name="password" value="123456" />
  <property name="maxActive" value="100" />
  <property name="maxIdle" value="30" />
  <property name="maxWait" value="1000" />
  <property name="defaultAutoCommit" value="true" />
  <property name="removeAbandoned" value="true" />
  <property name="removeAbandonedTimeout" value="60" />
 </bean>

 有一点是很重要,spring 自动代理默认为接口,如果要代理类,需要在属性中指出,如上面的粗体

实现类

public class TracingBeforeAdvice implements MethodBeforeAdvice {
 private Logger logger = Logger.getLogger(TracingBeforeAdvice.class);
 public void before(Method m, Object[] args, Object target) throws Throwable {
  
  if (args != null) {
   logger.warn( target.getClass().getName() + "." + m.getName() );
   logger.warn(target.getClass().getName());
   
   if (args.length>0)
   {
    for(int i=0;i<args.length;i++)
    logger.warn( args[i]);
   }
  }
  
 }

}

### 如何在 Java 中通过 AOP 拦截 MyBatis 执行的 SQL 语句 在 Spring 应用程序中,可以通过 AOP 和 MyBatis 插件相结合的方式来拦截 MyBatis 的 SQL 执行。具体来说,MyBatis 提供了插件机制用于拦截 Executor、ParameterHandler、ResultSetHandler 和 StatementHandler 等组件的行为[^2]。与此同时,Spring AOP 能够在方法调用前或后执行额外逻辑。 以下是实现这一功能的关键点: #### 使用 MyBatis 插件拦截 SQL MyBatis 插件允许开发者拦截其内部的核心接口行为。例如,`Executor.query()` 方法可以在查询操作发生时被拦截。下面是一个简单的 `SqlInterceptor` 实现示例: ```java @Intercepts({ @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}) }) public class SqlInterceptor implements Interceptor { @Override public Object intercept(Invocation invocation) throws Throwable { // 获取当前执行的目标对象及其参数 MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0]; Object parameter = invocation.getArgs()[1]; String sql = mappedStatement.getBoundSql(parameter).getSql(); System.out.println("Before executing SQL: " + sql); try { // 继续执行原始方法 return invocation.proceed(); } finally { System.out.println("After executing SQL."); } } @Override public Object plugin(Object target) { return Plugin.wrap(target, this); } @Override public void setProperties(Properties properties) {} } ``` 上述代码展示了如何通过 MyBatis 插件捕获 SQL 查询语句,并在其执行前后记录日志。 --- #### 结合 Spring AOP 进一步增强控制 如果希望更灵活地处理业务场景下的 SQL 日志或其他需求,则可以借助 Spring AOP 来补充 MyBatis 插件的功能。例如,在服务层方法调用期间加入额外的日志记录或性能监控。 以下是一个基于 Spring AOP 的切面类示例: ```java @Aspect @Component public class SqlExecutionAopInterceptor { private static final Logger logger = LoggerFactory.getLogger(SqlExecutionAopInterceptor.class); @Around("@within(org.springframework.transaction.annotation.Transactional)") public Object logSqlExecutionTime(ProceedingJoinPoint joinPoint) throws Throwable { long startTime = System.currentTimeMillis(); try { // 执行原生方法 return joinPoint.proceed(); } finally { long elapsedTime = System.currentTimeMillis() - startTime; logger.info("Method {} executed in {} ms.", joinPoint.getSignature().getName(), elapsedTime); } } } ``` 此切面会在带有 `@Transactional` 注解的服务方法周围增加计时器逻辑,从而帮助分析 SQL 执行效率[^5]。 --- #### 防止重复执行问题 关于是否会因多次调用 `invocation.proceed()` 或 `joinPoint.proceed()` 导致 SQL 多次执行的问题:只要这两个拦截器分别作用于不同的层次(即 MyBatis 插件负责底层 SQL 层级,而 Spring AOP 则针对服务层),就不会引发冲突[^1]。这是因为它们的工作范围互不重叠——前者专注于数据库交互细节,后者则关注应用层面的操作流程。 不过需要注意的是,若两个拦截器都试图在同一阶段干预同一资源(比如同时尝试修改最终发送给数据库的实际 SQL 字符串),可能会引起不可预测的结果。因此建议合理规划两者的职责边界。 --- ### 总结 为了有效拦截 MyBatis 的 SQL 执行过程,推荐采用如下策略: 1. **使用 MyBatis 插件**捕捉具体的 SQL 请求; 2. **结合 Spring AOP**扩展更高阶的应用逻辑支持; 3. 明确划分两者的作用域以防潜在冲突。 ---
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值