【Java调试】通过SqlSessionFactory类对象获取mapper文件内的动态SQL在执行时的完整SQL及参数（2种使用方法+测试Demo及结果）

1. 问题

最近开发新功能，调试 mapper.xml 里的SQL，遇到了极其痛苦的事情：

• 没有 p6spy SQL无法输出到工作台。
• mapper 接口没有实现 MyBatis 的 BaseMapper 导致IDEA的插件 MyBatis Log Plugin 工作台不输出SQL。

总之就是不知道数据库执行了什么SQL。

2. 解决方法

【方法 1️⃣ 】初始化 SqlSessionFactory 对象，读取 mapper.xml 文件：

	@Bean(name = "sqlSessionFactory")
	public SqlSessionFactory sqlSessionFactory(@Qualifier("dataSource") DataSource dataSource)
			throws Exception {
		final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
		sessionFactory.setDataSource(dataSource);
		sessionFactory.setMapperLocations(
			new PathMatchingResourcePatternResolver()
			.getResources("classpath:/mapper/**/*.xml")
			// 这个地方要根据mapper文件所在位置进行配置
			// 我的是在【resources/mapper/模块文件夹/】下
			);
		sessionFactory.setConfigLocation(new ClassPathResource("mybatisConfigPath"));
		// 这个configLocation属性 是去加载mybatis的config配置文件
		// 我的是【mybatis.config-location=mybatis.cfg.xml】
		return sessionFactory.getObject();
	}

使用：

public class DataServiceImpl extends BaseServiceImpl implements DataService {
    @Qualifier("sqlSessionFactory")
    @Autowired
    SqlSessionFactory sqlSessionFactory;
    
    @Override
    public Object getTest(Map mapParam) {
    BoundSql boundSql =  
	    sqlSessionFactory
	    .getConfiguration()
	    .getMappedStatement("id")
	    .getBoundSql(mapParam);
		// id是mapper文件内SQL的id值, mapParam是传递给动态SQL的参数值 
        String sql = boundSql.getSql(); // 执行的SQL对象【不包含参数】
        Object parameterObject = boundSql.getParameterObject(); // 执行SQL的参数值
        System.out.println("执行的SQL为：" + sql);
        System.out.println("执行的SQL的参数为：" + parameterObject.toString());
    } 

【方法 2️⃣ 】如果使用的是Mybatis框架，可以直接注入sqlSessionFactory对象：

@Component
public class ViewManager {
    @Autowired
    SqlSessionFactory sqlSessionFactory;
}

3. 测试结果

测试的mapper对象：

    <select id="getDevidViewStr" resultType="java.lang.String">
        SELECT
        GROUP_CONCAT( devid ) AS devid
        FROM
        devid_view
        <where>
            <if test="viewId != null and viewId != ''">
                AND viewid = #{viewId}
            </if>
            <if test="tableName != null and tableName != ''">
                AND tablename = #{tableName}
            </if>
        </where>
        ORDER BY
        devid
    </select>

执行结果：

# 这是打印的结果
执行的SQL为：SELECT
        GROUP_CONCAT( devid ) AS devid
        FROM
        devid_view
         WHERE  viewid = ?
                AND tablename = ? 
        ORDER BY
        devid
执行的SQL的参数为：{tableName=GSMDATA, viewId=6e4a638f0b1b45d980e6f5c4c16e414a}

# 这个是 p6spy 输出的结果
Execute SQL：SELECT GROUP_CONCAT( devid ) AS devid FROM devid_view WHERE viewid = '6e4a638f0b1b45d980e6f5c4c16e414a' AND tablename = 'GSMDATA' ORDER BY devid

至此，执行的mapper内的SQL被执行的同时SQL会被打印出来，当然，不提倡使用System.out.println()来打印，尽量使用log打印。