mybatis拦截器中boundsql对象介绍与使用

在上一篇文里，我们简单介绍了mybatis拦截器的使用。这次作者将介绍在拦截器中处理代码业务时，常用到的一个重要的类——BoundSql。

本文用拦截StatementHandler类方法为主介绍BoundSql相关内容。

1、定义一个拦截器

写一个自定义的拦截器，拦截类型为StatementHandler，拦截方法为prepare。注解代码如下：

@Intercepts(@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class}))

2、获取BoundSql类型对象

在拦截器的intercept(Invocation invocation)方法里，获取BoundSql对象进行下一步操作。代码如下：

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        StatementHandler statementHandler = (StatementHandler) invocation.getTarget();
        BoundSql boundSql = statementHandler.getBoundSql();
        Object parameterObject = boundSql.getParameterObject();
        String sql = boundSql.getSql();
        //业务代码
        do_some_thing(boundSql);
        return invocation.proceed();
    }

3、BoundSql对象的属性和方法

整体上来说，常用的参数有三个：

• 解析后的sql保存在sql对象中；
• 请求参数保存在parameterObject对象中；
• #{ }key属性以及相对应的参数映射，比如javaType，jdbcType等信息均保存至BoundSql的parameterMapping属性中。供最后的域表达式对象PrepareStatement赋值使用。
  

BoundSql对象中的sql对象

对动态标签解析后的完全可执行的sql。

select count(0) 
from
 (select
  c.id as id, category_type,category_name,parent_category_id,icon,is_origin, c.create_time as create_time,c.update_time as update_time,created_by, c.org_unit_id, u.user_real_name as user_name 
  from 
  rpm_category c left join rm_user u on c.created_by = u.id 
  WHERE ( c.created_by = 1 ) and c.category_type in ( ? , ? ) and c.id != 20 order by c.id DESC) tmp_count;

BoundSql—ParameterObject对象

该对象为sql执行的参数。也就是我们传入的参数。因为可能使用了@param注解，故有多种方式可以获取到value的值。
若上传一个参数对象时：为该参数的类型；
若上传多个参数对象时：为ParamMap对象，由于我们使用了@Param注解，故可以使用注解的key，也可以使用param1取出变量。
若上传的为Criteria对象时（如下图）：也是为该对象的类型，但是获取对象的方法又不相同。

BoundSql—ParameterMapping对象

采用#{var}的形式来引用变量时，其中的变量会在解析Mapper.xml文件中的语句时，就被替换成占位符“？”，同时通过ParameterMapping类记录对应的变量信息。在真正执行对应语句的时候回传递真实的参数。根据parameterMapping信息给ParameterStatement设置参数。

BoundSql—additionalParameters对象

若是使用Criteria对象时的sql，那么在additionalParameters中便有值，我们可以从中获取参数值。在一些框架比如tk-mybatis和标签如<bind>中使用了这个对象。

BoundSql—MetaObject对象

MetaObject类相当于一个工具类，Mybatis在sql参数设置和结果集映射里经常使用到这个对象。

参考文档：

自定义拦截器（下）对象详解
metaObject对象使用实例