- 資訊首頁(yè) > 開(kāi)發(fā)技術(shù) >
- MyBatis常用標簽以及使用技巧總結
MyBatis常用標簽及標簽使用技巧
MyBatis的常用標簽有很多,比如
<sql id="">:預定義可以復用的sql語(yǔ)句
<include refid="">:根據id引用定義的sql語(yǔ)句
<trim>:空白補全,配合<if>標簽使用
<if test="">:條件判斷,該語(yǔ)句返回的true,則該標簽內的語(yǔ)句就生效
<bind name="" value="">:創(chuàng )建一個(gè)變量,并且可以綁定到上下文
通過(guò)我暫時(shí)的開(kāi)發(fā)經(jīng)驗來(lái)說(shuō),我認為對一張表增刪改操作,起碼包括:增加一條記錄、刪除一條記錄、修改一條記錄。所以一張表的操作起碼包括:增刪改。
增加一條是主鍵id自增,刪除一條記錄是根據主鍵id刪除,修改一條記錄是根據主鍵id修改,返回值都是Integer類(lèi)型的成功增刪改的記錄條數。以User對象為例:
UserMapper.java:
@Mapper @Repository public interface UserMapper { /** * 增加一條記錄 * @param user 用戶(hù)對象 * @return 增加成功的記錄數 */ Integer insertOne(User user); /** * 刪除一條記錄 * @param user 用戶(hù)對象 * @return 刪除成功的記錄數 */ Integer deleteOne(User user); /** * 修改用戶(hù) * @param user 用戶(hù)對象 * @return 修改成功的記錄數 */ Integer updateOne(User user); }
則對應的UserMapper.xml:
<mapper namespace="UserMapper"> <!--update的條件sql(除了自增主鍵id)--> <sql id="updateCondition"> <if test=" uuid!=null and uuid!='' "> uuid = #{uuid}, </if> <if test=" username!=null and username!='' "> username = #{username}, </if> <if test=" password!=null and password!='' "> password = #{password}, </if> </sql> <!--新增一條--> <insert id="insertOne" keyProperty="id" useGeneratedKeys="true" parameterType="User"> INSERT INTO user (uuid,username,password) VALUES (#{uuid},#{username},#{password}) </insert> <!--刪除一條--> <delete id="deleteOne" parameterType="User"> DELETE FROM user WHERE id = #{id} </delete> <!--修改一條(根據id主鍵)--> <update id="updateOne" parameterType="User"> UPDATE user <trim prefix="SET" suffixOverrides=","> <include refid="updateCondition"></include> </trim> WHERE id = #{id} </update> </mapper>
由于一般修改語(yǔ)句是根據id,所以在<update>標簽中,WHERE id = #{id}是寫(xiě)死了的。一般修改的話(huà),是除了id可以修改其余都是可以修改的,所以一般字段會(huì )比較多,利用<sql>標簽預定義好除了id的字段,并且利用<if>標簽包裹起來(lái),同時(shí)特別注意:最后要加上逗號。然后在<trim>標簽中利用<include>標簽引用預定義的修改語(yǔ)句的條件。<include>標簽就相當于直接把該id的sql語(yǔ)句直接粘貼到這里,這里是為了看起整體排版比較舒服所以才這么做的。
通過(guò)我暫時(shí)的開(kāi)發(fā)經(jīng)驗來(lái)說(shuō),我認為對一張表查詢(xún)操作,起碼包括:查詢(xún)多條記錄(可分頁(yè)可條件)、查詢(xún)一條記錄(可條件),查詢(xún)該表的總記錄數。所以一張表的操作起碼包括:三個(gè)查詢(xún)。
查詢(xún)列表、單個(gè)查詢(xún)、查詢(xún)該表的總記錄數,同樣是以User對象為例:
UserMapper.java:
@Mapper @Repository public interface UserMapper { /** * 查詢(xún)所有user集合(可分頁(yè),可多條件,可單條件) * @param user 用戶(hù)對象 * @return user集合 */ List<User> selectList(User user); /** * 查詢(xún)一條user記錄(可多條件,可單條件) * @param user * @return 一條用戶(hù)對象 */ User selectOne(User user); /** * 查詢(xún)記錄數(可條件查詢(xún)) * @param user 用戶(hù)對象 * @return 記錄數 */ Long count(User user); }
分別返回User集合、單個(gè)User對象以及記錄數。
對應的UserMapper.xml:
<mapper namespace="UserMapper"> <!--select的條件sql(全有)--> <sql id="selectCondition"> <if test=" id!=null and id!='' "> AND u.id = #{id} </if> <if test=" uuid!=null and uuid!='' "> AND u.uuid = #{uuid} </if> <if test=" username!=null and username!='' "> AND u.username = #{username} </if> <if test=" password!=null and password!='' "> AND u.password = #{password} </if> </sql> <!--分頁(yè)的條件sql(當前頁(yè),每頁(yè)記錄數)--> <sql id="limitCondition"> <if test=" currentPage!=null and currentPage!='' and pageSize!=null and pageSize!='' "> <bind name="offset" value="pageSize*(currentPage-1)"/> <bind name="rows" value="pageSize"/> #{offset},#{rows} </if> </sql> <!--user表的別名--> <sql id="userAs"> u.id AS uId, u.uuid AS uUuid, u.username AS uUsername, u.password AS uPassword </sql> <!--返回的結果集--> <resultMap id="userMap" type="User"> <id column="uId" property="id"/> <result column="uUuid" property="uuid"/> <result column="uUsername" property="username"/> <result column="uPassword" property="password"/> </resultMap> <!--查詢(xún)所有(可分頁(yè),可單條件,可多條件)--> <select id="selectList" parameterType="User" resultMap="userMap"> SELECT <include refid="userAs"></include> FROM user u <trim prefix="WHERE" prefixOverrides="AND"> <include refid="selectCondition"></include> </trim> ORDER BY u.id <trim prefix="LIMIT"> <include refid="limitCondition"></include> </trim> </select> <!--查詢(xún)一條(可單條件,可多條件)--> <select id="selectOne" parameterType="User" resultMap="userMap"> SELECT <include refid="userAs"></include> FROM user u <trim prefix="WHERE" prefixOverrides="AND"> <include refid="selectCondition"></include> </trim> </select> <!--查詢(xún)記錄數(可單條件,可多條件)--> <select id="count" parameterType="User" resultType="long"> SELECT count(u.id) FROM user u <trim prefix="WHERE" prefixOverrides="AND"> <include refid="selectCondition"></include> </trim> </select> </mapper>
根據三個(gè)需求:查詢(xún)全表、查詢(xún)單個(gè)兩個(gè)都可以用到條件查詢(xún),所以都可以用到同樣的sql,所以就可以使用同樣的<sql>標簽來(lái)預定義然后復用。小結一下就是:
得益于<trim>標簽和<if>標簽的配合(if標簽判斷條件是否成立,如果成立則if標簽內部語(yǔ)句生效,trim判斷內部是否有語(yǔ)句,如果有則trim生效),沒(méi)有條件傳入就查詢(xún)全表,沒(méi)有分頁(yè)傳入的時(shí)候就不分頁(yè),做到了有條件則查條件,無(wú)條件則全查,有分頁(yè)則查分頁(yè),無(wú)分頁(yè)則全查。同時(shí)定義好結果集映射(column是查出來(lái)的列,property是Pojo對象的屬性,需要對應好)以及配置好查詢(xún)字段的別名(AS)。定義結果集和配置查詢(xún)字段的別名是方便以后擴展。
條件查詢(xún)的<sql>需要注意的是利用AND連接。
分頁(yè)的<sql>需要注意的是利用<bind>標簽來(lái)定義變量,注意變量的換算,一般采用的是傳入當前頁(yè)(currentPage)和每頁(yè)記錄數(pageSize),而數據庫中limit語(yǔ)句的參數是limit offset,rows,offset(偏移量,也就是從表中的第幾個(gè)元素開(kāi)始,0是首位),rows(記錄數,也就是返回多少個(gè)),總的來(lái)說(shuō)就是從第幾個(gè)開(kāi)始,返回第條記錄。然后利用簡(jiǎn)單的數學(xué)換算,將currentPage和pageSize轉換為offset和rows。
<trim>標簽的使用,利用<include>標簽引入相應的sql語(yǔ)句后,再用<trim>標簽包圍,注意好prefix、suffix、prefixOverrides和suffixOverrides。
注意
SQL語(yǔ)句中各關(guān)鍵字的順序
最后將增刪改和查詢(xún)總結合并起來(lái)就是:
UserMapper.java:
@Mapper @Repository public interface UserMapper { /** * 增加一條記錄 * @param user 用戶(hù)對象 * @return 增加成功的記錄數 */ Integer insertOne(User user); /** * 刪除一條記錄 * @param user 用戶(hù)對象 * @return 刪除成功的記錄數 */ Integer deleteOne(User user); /** * 修改用戶(hù) * @param user 用戶(hù)對象 * @return 修改成功的記錄數 */ Integer updateOne(User user); /** * 查詢(xún)所有user集合(可分頁(yè),可多條件,可單條件) * @param user 用戶(hù)對象 * @return user集合 */ List<User> selectList(User user); /** * 查詢(xún)一條user記錄(可多條件,可單條件) * @param user * @return 一條用戶(hù)對象 */ User selectOne(User user); /** * 查詢(xún)記錄數(可條件查詢(xún)) * @param user 用戶(hù)對象 * @return 記錄數 */ Long count(User user); }
UserMapper.xml:
<mapper namespace="UserMapper"> <!--select的條件sql(全有)--> <sql id="selectCondition"> <if test=" id!=null and id!='' "> AND u.id = #{id} </if> <if test=" uuid!=null and uuid!='' "> AND u.uuid = #{uuid} </if> <if test=" username!=null and username!='' "> AND u.username = #{username} </if> <if test=" password!=null and password!='' "> AND u.password = #{password} </if> </sql> <!--update的條件sql(除了自增主鍵id)--> <sql id="updateCondition"> <if test=" uuid!=null and uuid!='' "> uuid = #{uuid}, </if> <if test=" username!=null and username!='' "> username = #{username}, </if> <if test=" password!=null and password!='' "> password = #{password}, </if> </sql> <!--分頁(yè)的條件sql(當前頁(yè),每頁(yè)記錄數)--> <sql id="limitCondition"> <if test=" currentPage!=null and currentPage!='' and pageSize!=null and pageSize!='' "> <bind name="offset" value="pageSize*(currentPage-1)"/> <bind name="rows" value="pageSize"/> #{offset},#{rows} </if> </sql> <!--user表的別名--> <sql id="userAs"> u.id AS uId, u.uuid AS uUuid, u.username AS uUsername, u.password AS uPassword </sql> <!--返回的結果集--> <resultMap id="userMap" type="User"> <id column="uId" property="id"/> <result column="uUuid" property="uuid"/> <result column="uUsername" property="username"/> <result column="uPassword" property="password"/> </resultMap> <!--新增一條--> <insert id="insertOne" keyProperty="id" useGeneratedKeys="true" parameterType="User"> INSERT INTO user (uuid,username,password) VALUES (#{uuid},#{username},#{password}) </insert> <!--刪除一條--> <delete id="deleteOne" parameterType="User"> DELETE FROM user WHERE id = #{id} </delete> <!--修改一條(根據id主鍵)--> <update id="updateOne" parameterType="User"> UPDATE user <trim prefix="SET" suffixOverrides=","> <include refid="updateCondition"></include> </trim> WHERE id = #{id} </update> <!--查詢(xún)所有(可分頁(yè),可單條件,可多條件)--> <select id="selectList" parameterType="User" resultMap="userMap"> SELECT <include refid="userAs"></include> user u JOIN role r on u.roleId = r.id <trim prefix="WHERE" prefixOverrides="AND"> <include refid="selectCondition"></include> </trim> ORDER BY u.id <trim prefix="LIMIT"> <include refid="limitCondition"></include> </trim> </select> <!--查詢(xún)一條(可單條件,可多條件)--> <select id="selectOne" parameterType="User" resultMap="userMap"> SELECT <include refid="userAs"></include> FROM user u <trim prefix="WHERE" prefixOverrides="AND"> <include refid="selectCondition"></include> </trim> </select> <!--查詢(xún)記錄數(可單條件,可多條件)--> <select id="count" parameterType="User" resultType="long"> SELECT count(u.id) FROM user u <trim prefix="WHERE" prefixOverrides="AND"> <include refid="selectCondition"></include> </trim> </select> </mapper>
對一張表的操作最起碼就應該包括以上:增加一條記錄、刪除一條記錄、修改一條記錄、查詢(xún)列表(可條件、可分頁(yè))、查詢(xún)一條(可條件)、查詢(xún)記錄數(可條件)。
總結后觀(guān)察到,每張表都有這6個(gè)操作,并且代碼基本上都大致相同,差別只是對象的名字和表中字段不一樣,那我每次創(chuàng )建Mapper文件都需要手敲嗎?NoNoNo,可以利用IDEA的Code Templates功能,預先定義好Mapper Java和Mapper Xml的大致結構,然后利用傳參傳入對象名就可以了,這樣每次就能自動(dòng)生成大量代碼,然后只需要修改極少部分代碼就可以了。
Code Templates文件的創(chuàng )建:
打開(kāi)IDEA,左上角依次點(diǎn)擊:File->搜索template->找到File and Code Templates,在右側創(chuàng )建新文件,輸入文件名,擴展名Java:
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "") package ${PACKAGE_NAME};#end import org.apache.ibatis.annotations.Mapper; import org.springframework.stereotype.Repository; import java.util.List; #parse("File Header.java") @Mapper @Repository public interface ${NAME} { /** * 增加一條記錄 * @param ${pojo} ${name}對象 * @return 增加成功的記錄數 */ Integer insertOne(${Pojo} ${pojo}); /** * 刪除一條記錄 * @param ${pojo} ${name}對象 * @return 刪除成功的記錄數 */ Integer deleteOne(${Pojo} ${pojo}); /** * 修改一條記錄 * @param ${pojo} ${name}對象 * @return 修改成功的記錄數 */ Integer updateOne(${Pojo} ${pojo}); /** * 查詢(xún)所有集合(可分頁(yè),可多條件,可單條件) * @param ${pojo} ${name}對象 * @return ${pojo}集合 */ List<${Pojo}> selectList(${Pojo} ${pojo}); /** * 查詢(xún)一條${pojo}記錄(可多條件,可單條件) * @param ${pojo} ${name}對象 * @return 一條${name}對象 */ ${Pojo} selectOne(${Pojo} ${pojo}); /** * 查詢(xún)記錄數(可條件查詢(xún)) * @param ${pojo} ${name}對象 * @return 記錄數 */ Long count(${Pojo} ${pojo}); }
${Pojo}:Pojo對象的類(lèi)名
${pojo}:Pojo對象的變量名
這樣下次在新建Mapper.java文件的時(shí)候直接利用該template創(chuàng )建就可以了。
同樣的,Mapper.xml:
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="${PRE}.mapper.${NAME}"> <!--select的條件sql(全有)--> <sql id="selectCondition"> <if test=" arg!=null and arg!='' "> AND arg = #{arg} </if> </sql> <!--update的條件sql(除了自增主鍵id)--> <sql id="updateCondition"> <if test=" arg!=null and arg!='' "> arg = #{arg}, </if> </sql> <!--分頁(yè)的條件sql(當前頁(yè),每頁(yè)記錄數)--> <sql id="limitCondition"> <if test=" currentPage!=null and currentPage!='' and pageSize!=null and pageSize!='' "> <bind name="offset" value="pageSize*(currentPage-1)"/> <bind name="rows" value="pageSize"/> #{offset},#{rows} </if> </sql> <!--返回的結果集--> <resultMap id="${Pojo}Map" type="${PRE}.pojo.${Pojo}"> <id column="id" property="id"/> <result column="" property=""/> </resultMap> <!--新增一條記錄--> <insert id="insertOne" keyProperty="id" useGeneratedKeys="true" parameterType="${PRE}.pojo.${Pojo}"> INSERT INTO ${TABLE_NAME} () VALUES () </insert> <!--刪除一條記錄--> <delete id="deleteOne" parameterType="${PRE}.pojo.${Pojo}"> DELETE FROM ${TABLE_NAME} WHERE id = #{id} </delete> <!--修改一條記錄(根據id主鍵)--> <update id="updateOne" parameterType="${PRE}.pojo.${Pojo}"> UPDATE ${TABLE_NAME} <trim prefix="SET" suffixOverrides=","> <include refid="updateCondition"></include> </trim> WHERE id = #{id} </update> <!--查詢(xún)所有(可分頁(yè),可單條件,可多條件)--> <select id="selectList" parameterType="${PRE}.pojo.${Pojo}" resultMap="${Pojo}Map"> SELECT * FROM ${TABLE_NAME} <trim prefix="WHERE" prefixOverrides="AND"> <include refid="selectCondition"></include> </trim> ORDER BY id <trim prefix="LIMIT"> <include refid="limitCondition"></include> </trim> </select> <!--查詢(xún)一條(可單條件,可多條件)--> <select id="selectOne" parameterType="${PRE}.pojo.${Pojo}" resultMap="${Pojo}Map"> SELECT * FROM ${TABLE_NAME} <trim prefix="WHERE" prefixOverrides="AND"> <include refid="selectCondition"></include> </trim> </select> <!--根據主鍵id(效率高)查詢(xún)記錄數(可單條件,可多條件)--> <select id="count" parameterType="${PRE}.pojo.${Pojo}" resultType="long"> SELECT count(id) FROM ${TABLE_NAME} <trim prefix="WHERE" prefixOverrides="AND"> <include refid="selectCondition"></include> </trim> </select> </mapper>
${PRE}:包的前綴
${Pojo}:對象的類(lèi)名
${TABLE_NAME}:表名
即可以非??焖俚厣蒑apper.java和Mapper.xml了
因為Mybatis的特性,它可以連表查詢(xún)。同樣的,我們利用上述的方法創(chuàng )建好RoleMapper,如果想要在UserMapper中使用RoleMapper中定義好的sql,那么直接使用<include refid="包名+id">,下面是在UserMapper.xml中使用user表和role表連表查詢(xún)列表舉例:
<!--查詢(xún)所有(可分頁(yè),可單條件,可多條件)--> <select id="selectList" parameterType="com.fangaoxs.userserver.pojo.User" resultMap="userMap"> SELECT <include refid="userAs"></include>, <include refid="com.xxx.userserver.mapper.RoleMapper.roleAs"></include> FROM user u JOIN role r on u.roleId = r.id <trim prefix="WHERE" prefixOverrides="AND"> <include refid="selectCondition"></include> </trim> ORDER BY u.id <trim prefix="LIMIT"> <include refid="limitCondition"></include> </trim> </select>
那么,這樣就實(shí)現了user表和role的聯(lián)合查詢(xún),并且roleMapper.xml中的<sql>也在userMapper.xml中得到了復用。
到此這篇關(guān)于MyBatis常用標簽以及使用技巧總結的文章就介紹到這了,更多相關(guān)MyBatis常用標簽使用技巧內容請搜索腳本之家以前的文章或繼續瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
免責聲明:本站發(fā)布的內容(圖片、視頻和文字)以原創(chuàng )、來(lái)自本網(wǎng)站內容采集于網(wǎng)絡(luò )互聯(lián)網(wǎng)轉載等其它媒體和分享為主,內容觀(guān)點(diǎn)不代表本網(wǎng)站立場(chǎng),如侵犯了原作者的版權,請告知一經(jīng)查實(shí),將立刻刪除涉嫌侵權內容,聯(lián)系我們QQ:712375056,同時(shí)歡迎投稿傳遞力量。
Copyright ? 2009-2022 56dr.com. All Rights Reserved. 特網(wǎng)科技 特網(wǎng)云 版權所有 特網(wǎng)科技 粵ICP備16109289號
域名注冊服務(wù)機構:阿里云計算有限公司(萬(wàn)網(wǎng)) 域名服務(wù)機構:煙臺帝思普網(wǎng)絡(luò )科技有限公司(DNSPod) CDN服務(wù):阿里云計算有限公司 百度云 中國互聯(lián)網(wǎng)舉報中心 增值電信業(yè)務(wù)經(jīng)營(yíng)許可證B2
建議您使用Chrome、Firefox、Edge、IE10及以上版本和360等主流瀏覽器瀏覽本網(wǎng)站