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#endWHERE 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 fileSELECT *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#endWHERE 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,borndateFROM 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腳本的使用教程詳解(推薦),希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回復大家的。在此也非常感謝大家對武林網網站的支持！