Mybatis velocity脚本的使用教程详解(推荐)
可能很多童鞋都还不是很清楚在mybatis可以使用各种脚本语言来定义mapper文件里面的动态sql;目前mybatis支持的脚本语言有xml(默认的);velocity和freemarker三种。使用不同的脚本语言来完成mapper文件的编写,第一是使用自己熟悉的脚本语言,第二是能够定义更多丰富的自定义指令来简化mapper的开发,关于mybatis支持脚本的原理分析,自定义脚本指令后面再写文章分析,本文先介绍mybatis中velocity脚本的使用方式。
mybatis-velocity项目可以允许你方便的使用velocity作为脚本语言来完成mapper文件中各种动态sql的编写。
注意,在脚本中大量使用velocity开发,如果不熟悉,可以先去看看velocity脚本;
安装
在maven中添加
<dependency> <groupid>org.mybatis.scripting</groupid> <artifactid>mybatis-velocity</artifactid> <version>1.2</version> </dependency>
注意我们使用的是mybatis-velocity1.2版本,该版本需要mybatis3.3支持;
在mybatis配置文件中,将velocity脚本引擎设置为默认的mapper文件引擎:
<typealiases> ... <typealias type="org.mybatis.scripting.velocity.driver" alias="velocity"/> </typealiases> <settings> ... <setting name="defaultscriptinglanguage" value="velocity"/> </settings>
配置即完成。
接下来就可以在mapper文件中使用velocity脚本了:
<select id="findperson" lang="velocity"> #set( $pattern = $_parameter.name + '%' ) select * from person where name like @{pattern, jdbctype=varchar} </select>
注意:
如果使用了velocity,参数要使用@{}来引用,因为velocity的指令就是以#开头的,比如#set #if等;
使用velocity脚本,在参数中也可以配置对应的javatype和jdbctype;配置格式为:@{ property, attr1=val1, attr2=val2, ... };可配置项有javatype, jdbctype, mode, numericscale, resultmap, typehandler, jdbctypename;
在velocity的指令中使用context中的变量,需要使用$_parameter来作为前缀引用,比如
#if($_parameter.name) #set($_name = '%'+$_parameter.name+'%') and name like @{_name} #end
mybatis-velocity内建的指令
除了velocity的指令,mybatis-velocity项目为mybatis定义了一些内建的velocity指令:
trim
#trim( prefix prefixoverrides suffix suffixoverrides ) body #end
其中的参数含义同xml的trim参数含义相同;
一个例子:
#trim(" where " " and| or") #if($_parameter.name) #set($_name = '%'+$_parameter.name+'%') and name like @{_name} #end #end
where
#where() body #end #where()同xml中的<where>相同,可以替换条件前的and/or,替换为where;注意一定是\where()有括号的;
mset
#mset() body #end #mset前面加一个m,为的是和velocity本身的#set指令区别,#mset等同于xml中的<set>元素,可以在条件前加上set语句,并且去掉set块最后的分号;
一个例子:
<update id="update"> update user #mset() #if($_parameter.name) name=@{name}, #end #if($_parameter.age) age=@{age}, #end #if($_parameter.borndate) borndate=@{borndate} #end #end where id = @{id} </update>
repeat
#repeat( collection var separator open close ) body #end #repeat指令和xml中的<foreach>元素相同,能够方便的遍历集合/数组类型元素,并使用其中的每一个元素:
一个例子:
select *from city #where() #repeat( $_parameter.ids $id "," " state_id in (" ")" ) @{id} #end #end
in
#in( collection var field ) body #end
#in指令是一个新的指令,能够快速的专门针对sql中的in条件生成对应的field in()语句;参数列表中,collection代表要遍历的in中的内容;var代表遍历中的每一个对象的临时引用名称;field代表在in语句之前生成的字段名称;
一个例子:
select *from city #where() #in( $_parameter.ids $id "state_id" ) @{id} #end #end
自定义指令
mybatis-velocity允许你方便的自定义自己的指令用于简化开发,自定义指令的步骤为:
在classpath中添加一个 mybatis-velocity.properties配置文件;
创建自己的velocity指令解析类;
将自己创建的velocity指令解析类添加到配置文件中;
在mapper.xml文件中使用指令;
一个例子:
// user defined directivepackage com.myproject.directives; //自定义的指令类需要继承directive类; public class mydirective extends directive { } //mybatis-velocity.properties //如果有多个自定义指令类,使用分号隔开; userdirective=com.myproject.directives.mydirective; // mapper xml file select *from city #mydirective() ...... #end
综合使用
如果使用velocity-mybatis,一个典型的crud的mapper就可以看起来是这个样子:
<mapper namespace="mybatis.com._520it.mybatis.usermapper"> <resultmap type="user" id="user_mapping"> <id column="id" property="id"/> <result column="name" property="name"/> <result column="age" property="age"/> <result column="borndate" property="borndate"/> </resultmap> <insert id="add" keycolumn="id" keyproperty="id" usegeneratedkeys="true"> insert into user(name,age,borndate) values (@{name,javatype=string,jdbctype=varchar},@{age},@{borndate}) </insert> <update id="update"> update user #mset() #if($_parameter.name) name=@{name}, #end #if($_parameter.age) age=@{age}, #end #if($_parameter.borndate) borndate=@{borndate} #end #end where id = @{id} </update> <delete id="delete" parametertype="long"> delete from user where id = @{id} </delete> <sql id="user_column"> id,name,age,borndate </sql> <select id="get" resultmap="user_mapping"> select <include refid="user_column"/> from user where id = @{id} </select> <select id="list" resultmap="user_mapping"> select <include refid="user_column"/> from user </select> <select id="listbyname" resultmap="user_mapping" parametertype="string"> select <include refid="user_column"/> from user where name = @{name} </select> <select id="queryby" resultmap="user_mapping"> select id,name,age,borndate from user #where() #if($_parameter.name) #set($_name = '%'+$_parameter.name+'%') and name like @{_name} #end #end #if($_parameter.orderby) order by @{orderby} @{ordertype} #end #if($_parameter.pagesize>-1) limit @{start},@{pagesize} #end </select> </mapper>
以上所述是小编给大家介绍的mybatis velocity脚本的使用教程详解(推荐),希望对大家有所帮助
上一篇: php出租房数据管理及搜索页面