MyBatis中OGNL的使用教程详解

时间:2019-03-30
本文章向大家介绍MyBatis中OGNL的使用教程详解,主要包括MyBatis中OGNL的使用教程详解使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。

前言

本文主要给大家讲如何在MyBatis中使用OGNL的相关内容,分享出来供大家参考学习,感兴趣的朋友们下面来一起看看详细的介绍:

如果我们搜索OGNL相关的内容,通常的结果都是和Struts有关的,你肯定搜不到和MyBatis有关的,虽然和Struts中的用法类似但是换种方式理解起来就有难度。

MyBatis常用OGNL表达式

  • e1 or e2
  • e1 and e2
  • e1 == e2,e1 eq e2
  • e1 != e2,e1 neq e2
  • e1 lt e2:小于
  • e1 lte e2:小于等于,其他gt(大于),gte(大于等于)
  • e1 in e2
  • e1 not in e2
  • e1 + e2,e1 * e2,e1/e2,e1 - e2,e1%e2
  • !e,not e:非,求反
  • e.method(args)调用对象方法
  • e.property对象属性值
  • e1[ e2 ]按索引取值,List,数组和Map
  • @class@method(args)调用类的静态方法
  • @class@field调用类的静态字段值

上述内容只是合适在MyBatis中使用的OGNL表达式,完整的表达式点击这里

MyBatis中什么地方可以使用OGNL?

如果你看过深入学习MyBatis参数,也许会有印象,因为这篇文章中提到了OGNL和一些特殊用法。

如果没看过,建议找时间看看,上面这篇博客不是很容易理解,但是理解后会很有用。

MyBatis中可以使用OGNL的地方有两处:

  • 动态SQL表达式中
  • ${param}参数中

上面这两处地方在MyBatis中处理的时候都是使用OGNL处理的。

下面通过举例来说明这两种情况的用法。

1.动态SQL表达式中

例一,MySQL like 查询:

<select id="xxx" ...>
 select id,name,... from country
 <where>
 <if test="name != null and name != ''">
  name like concat('%', #{name}, '%')
 </if>
 </where>
</select>

上面代码中test的值会使用OGNL计算结果。

例二,通用 like 查询:

<select id="xxx" ...>
 select id,name,... from country
 <bind name="nameLike" value="'%' + name + '%'"/>
 <where>
 <if test="name != null and name != ''">
  name like #{nameLike}
 </if>
 </where>
</select>

这里<bind>的value值会使用OGNL计算。

注:对<bind参数的调用可以通过#{}${} 方式获取,#{}可以防止注入。

在通用Mapper中支持一种UUID的主键,在通用Mapper中的实现就是使用了<bind>标签,这个标签调用了一个静态方法,大概方法如下:

<bind name="username_bind" 
 value='@java.util.UUID@randomUUID().toString().replace("-", "")' />

这种方式虽然能自动调用静态方法,但是没法回写对应的属性值,因此使用时需要注意。

2.${param}参数中

上面like的例子中使用下面这种方式最简单

<select id="xxx" ...>
 select id,name,... from country
 <where>
 <if test="name != null and name != ''">
  name like '${'%' + name + '%'}'
 </if>
 </where>
</select>

这里注意写的是${'%' + name + '%'} ,而不是%${name}% ,这两种方式的结果一样,但是处理过程不一样。

在MyBatis中处理${}的时候,只是使用OGNL计算这个结果值,然后替换SQL中对应的${xxx} ,OGNL处理的只是${这里的表达式}。

这里表达式可以是OGNL支持的所有表达式,可以写的很复杂,可以调用静态方法返回值,也可以调用静态的属性值。

例子:使用OGNL实现单表的分表功能

上面说的是OGNL简单的使用方法。这里举个OGNL实现数据库分表的例子。

分表这个功能是通用Mapper中的新功能,允许在运行的时候指定一个表名,通过指定的表名对表进行操作。这个功能实现就是使用了OGNL。

首先并不是所有的表都需要该功能,因此定义了一个接口,当参数(接口方法只有实体类一个参数)对象继承该接口的时候,就允许使用动态表名。

public interface IDynamicTableName {

 /**
 * 获取动态表名 - 只要有返回值,不是null和'',就会用返回值作为表名
 *
 * @return
 */
 String getDynamicTableName();
}

然后在XML中写表名的时候使用:

<if test="@tk.mybatis.mapper.util.OGNL@isDynamicParameter(_parameter) 
  and dynamicTableName != null 
  and dynamicTableName != ''">
 ${dynamicTableName}
</if>
<if test="@tk.mybatis.mapper.util.OGNL@isNotDynamicParameter(_parameter) 
  or dynamicTableName == null 
  or dynamicTableName == ''">
 defaultTableName
</if>

由于我需要判断_parameter是否继承了IDynamicTableName接口,简单的写法已经无法实现,所以使用了静态方法,这两个方法如下:

/**
 * 判断参数是否支持动态表名
 *
 * @param parameter
 * @return true支持,false不支持
 */
public static boolean isDynamicParameter(Object parameter) {
 if (parameter != null && parameter instanceof IDynamicTableName) {
 return true;
 }
 return false;
}

/**
 * 判断参数是否b支持动态表名
 *
 * @param parameter
 * @return true不支持,false支持
 */
public static boolean isNotDynamicParameter(Object parameter) {
 return !isDynamicParameter(parameter);
}

根据<if>判断的结果来选择使用那个表名。

另外注意XML判断中有一个dynamicTableName,这个参数是根据getDynamicTableName方法得到的,MyBatis使用属性对应的getter方法来获取值,不是根据field来获取值。

最后

如果你真想了解MyBatis中的OGNL用法,自己多写几个例子测试玩玩,动手测试是一种好的学习方式。

好了,以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作能带来一定的帮助,如有疑问大家可以留言交流,谢谢大家对脚本之家的支持。