今天小编就为大家分享一篇关于MyBatis执行动态sql的方法,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
大家基本上都知道如何使用 MyBatis 执行任意 sql,使用方法很简单,例如在一个 XXMapper.xml 中:
${_parameter}
你可以如下调用:
sqlSession.selectList("executesql", "select * from sysuser where enabled = 1");
或者你可以在 XXMapper.java 接口中定义如下方法:
xxMapper.executesql("select * from sysuser where enabled = 1");
上面这些内容可能都会,下面在此基础上再复杂一点。
假如像上面sql中的enabled = 1我想使用参数方式传值,也就是写成enabled = #{enabled},如果你没有遇到过类似这种需求,可能不明白为什么要这么写,举个例子,要实现一种动态查询,可以在前台通过配置 sql,提供一些查询条件就能实现一个查询的功能(为了安全,这些配置肯定是开发或者实施做的,不可能让用户直接操作数据库)。
针对这个功能,使用 MyBatis 实现起来相当容易。配置 sql 肯定要执行,用上面讲的这种方式肯定可以执行 sql,如何提供参数呢?参数就是enabled = #{enabled}中的#{enabled}部分。如果再多一些条件,一个配置好的 sql 如下:
select * from sysuser where enabled = #{enabled} and userName like concat('%',#{userName},'%')
这种情况下,该怎么用 MyBatis 实现呢?
首先 XML 中修改如下:
${sql}
List executesql(Map map);
Map map = new HashMap(); //这里的 sql 对应 XML 中的 ${sql} map.put("sql", "select * from sysuser " + " where enabled = #{enabled} " + " and userName like concat('%',#{userName},'%')"); //#{enabled} map.put("enabled", 1); //#{userName} map.put("userName", "admin"); //接口方式调用 List list = xxMapper.executesql(map); //sqlSession方式调用 sqlSession.selectList("executesql", map);
有了这个sql之后,就可以将 enabled 和 userName 作为条件提供给用户。这两个条件显然是必填的。如果是可选的,那该怎么写?
也许有人想到了是不是可以用 MyBatis 中的动态 sql,使用标签等等?
再回答这个问题前,我们先看处理动态 sql 的DynamicsqlSource中的代码:
@Override public Boundsql getBoundsql(Object parameterObject) { DynamicContext context = new DynamicContext(configuration, parameterObject); rootsqlNode.apply(context); sqlSourceBuilder sqlSourceParser = new sqlSourceBuilder(configuration); Class >parameterType = parameterObject == null ? Object.class: parameterObject.getClass(); sqlSource sqlSource = sqlSourceParser.parse(context.getsql(), parameterType, context.getBindings()); Boundsql boundsql = sqlSource.getBoundsql(parameterObject); for (Map.Entry entry: context.getBindings().entrySet()) { boundsql.setAdditionalParameter(entry.getKey(), entry.getValue()); } return boundsql; }
MyBatis 处理动态 sql 时,所有动态 sql 的标签都会处理为 sqlNode (这里的rootsqlNode)对象,包含${}的也会处理为TextsqlNode对象,在上面方法的前两行,就是 MyBatis 处理动态 sql 的地方。
${sql} 中的内容包含嵌套的${}和,等标签时,他们在 MyBatis 解析 XML 为 sqlNode 对象时,XML 元素包含的内容只有${sql},只有${sql}会被解析,在运行时这个参数字符串中可能包含的${}和,等标签,但是这都发生在 MyBatis 解析后,因此当这些内容作为字符串中的一部分出现时,他们不会被特殊处理,他们只是sql中的一部分,只是原样输出(由于数据库不认会报错)无法被处理,因此没法通过 MyBatis 自带的这种方式来写动态 sql。
在上面的代码中:
sqlSourceParser.parse(context.getsql(), parameterType, context.getBindings());
这一段代码是处理动态参数(#{})的
这个处理在动态 sql 处理之后,
因此可以在 sql 中使用这种类型的参数。
既然不能用 MyBatis 动态 sql 方式,该怎么实现动态 sql 呢?
这里提供一个简单的思路,在 sql 中使用模板标记语言来实现动态sql(例如freemarker),在 sql 交给 MyBatis 执行之前,使用模板对 sql 进行处理生成最终执行的 sql(需要避免处理#{}参数),将这个sql交给 MyBatis 执行。
举一个Freemarker模板的例子,仍然以上面的sql为基础:
select * from sysuser where 1 = 1 enabled = #{enabled} #if> and userName like concat('%',#{userName},'%') #if>
注意,这里的是Freemarker的元素。在不考虑sql注入的情况下,上面的sql还可以写成:
select * from sysuser where 1 = 1 enabled = #{enabled} #if> and userName like '%${userName}%' #if>
区别就是'%${userName}%',因为 Freemarker 也会处理${userName},也会用实际的值来替换这里的参数。
//#{enabled} map.put("enabled", 1); //#{userName} map.put("userName", "admin"); //这里的 sql 对应 XML 中的 ${sql} String sql = "上面两个复杂sql中的一个"; //使用Freemarker处理sql sql = processsqlByFreemarker(sql, map); //将处理后的sql放到map中 map.put("sql", sql); //执行方法 List list = xxMapper.executesql(map);
注:processsqlByFreemarker方法就是根据map中的数据来处理sql字符串,实现方式可以自己搜索。
不知道有没有更贪心的人,你会不会想,上面返回值都是List类型,能不能返回一个我指定的实体类呢?
例如在map中:
map.put("class", "tk.mybatis.model.SysUser");
能不能通过这种方式让返回值变成SysUser类型呢?由于这篇文章耗时已经太长,这里就提供一个方案,不深入。
你可以使用拦截器实现,获取MappedStatement后,复制一份,然后修改resultMaps中resultMap的type属性为你指定的class类型就能实现,说起来容易,实际操作起来能有 pageHelper 分页插件 1/10 左右的工作量。
注:如果是动态的update,insert,delete 语句,可以将上面的改为(不需要使用和),返回值用int,比select的情况容易很多。
总结