MyBatis實現(xiàn)SQL映射文件
1 SQL 映射文件介紹
映射器是 MyBatis 中最復雜并且是最重要的組件。它由一個接口和 SQL 映射文件(或者注解)組成。在映射器中我們可以配置各類 SQL、動態(tài) SQL、緩存、存儲過程、級聯(lián)等復雜的內(nèi)容。
以下是 SQL 映射文件的部分元素介紹
元素 | 描述 |
---|---|
cache | 該命名空間的緩存配置 |
cache-ref | 引用其它命名空間的緩存配置 |
resultMap | 描述如何從數(shù)據(jù)庫結(jié)果集中加載對象,它是最復雜也是最強大的元素 |
sql | 可被其它語句引用的可重用語句塊 |
select | 映射查詢語句 |
insert | 映射插入語句 |
update | 映射更新語句 |
delete | 映射刪除語句 |
2 select 元素
select 元素表示 SQL 的 select 語句,用于查詢,以下是 select 元素的部分屬性
屬性 | 描述 |
---|---|
id | 在命名空間中唯一的標識符,可以被用來引用這條語句 |
parameterType | 將會傳入這條語句的參數(shù)類的全類名或別名。這個屬性是可選的,因為 MyBatis 可以通過類型處理器(TypeHandler) 推斷出具體傳入語句的參數(shù),默認值為未設置(unset) |
resultType | 從這條語句中返回的期望類型的類的全類名或別名。 注意如果返回的是集合,那應該設置為集合包含的類型,而不是集合本身。可以使用 resultType 或 resultMap,但不能同時使用 |
resultMap | 外部 resultMap 的命名引用。結(jié)果集的映射是 MyBatis 最強大的特性,如果你對其理解透徹,許多復雜映射的情形都能迎刃而解??梢允褂?resultMap 或 resultType,但不能同時使用 |
flushCache | 將其設置為 true 后,只要語句被調(diào)用,都會導致本地緩存和二級緩存被清空,默認值:false |
useCache | 將其設置為 true 后,將會導致本條語句的結(jié)果被二級緩存緩存起來,默認值:對 select 元素為 true |
timeout | 這個設置是在拋出異常之前,驅(qū)動程序等待數(shù)據(jù)庫返回請求結(jié)果的秒數(shù)。默認值為未設置(unset)(依賴驅(qū)動) |
fetchSize | 這是一個給驅(qū)動的提示,嘗試讓驅(qū)動程序每次批量返回的結(jié)果行數(shù)和這個設置值相等。 默認值為未設置(unset)(依賴驅(qū)動) |
statementType | STATEMENT,PREPARED 或 CALLABLE 中的一個。這會讓 MyBatis 分別使用 Statement,PreparedStatement 或 CallableStatement,默認值:PREPARED |
resultSetType | FORWARD_ONLY,SCROLL_SENSITIVE, SCROLL_INSENSITIVE 或 DEFAULT(等價于 unset) 中的一個,默認值為 unset (依賴驅(qū)動) |
databaseId | 如果配置了數(shù)據(jù)庫廠商標識 (databaseIdProvider) 并且存在兩個相同的語句,一個帶 databaseId 而另一個不帶,MyBatis 會優(yōu)先加載帶有 databaseId 的語句。如果 databaseId 與當前數(shù)據(jù)庫匹配,則不帶 databaseId 的相同語句將被忽略。未設置 databaseId 使用通用 SQL 規(guī)則 |
resultOrdered | resultOrdered:這個設置僅對嵌套結(jié)果 select 語句適用:如果為 true,就是假設包含了嵌套結(jié)果集或是分組,這樣的話當返回一個主結(jié)果行的時候,就不會發(fā)生有對前面結(jié)果集的引用的情況。 這就使得在獲取嵌套的結(jié)果集的時候不至于導致內(nèi)存不夠用。默認值:false |
resultSets | 這個設置僅對多結(jié)果集的情況適用。它將列出語句執(zhí)行后返回的結(jié)果集并給每個結(jié)果集一個名稱,名稱是逗號分隔的 |
3 insert 元素
屬性 | 描述 |
---|---|
id | 在命名空間中唯一的標識符,可以被用來引用這條語句 |
parameterType | 將會傳入這條語句的參數(shù)的類全限定名或別名。這個屬性是可選的,因為 MyBatis 可以通過類型處理器(TypeHandler)推斷出具體傳入語句的參數(shù),默認值為未設置(unset) |
flushCache | 將其設置為 true 后,只要語句被調(diào)用,都會導致本地緩存和二級緩存被清空,默認值:(對 insert、update 和 delete 語句)true |
timeout | 這個設置是在拋出異常之前,驅(qū)動程序等待數(shù)據(jù)庫返回請求結(jié)果的秒數(shù)。默認值為未設置(unset)(依賴數(shù)據(jù)庫驅(qū)動) |
statementType | 可選 STATEMENT,PREPARED 或 CALLABLE。這會讓 MyBatis 分別使用 Statement,PreparedStatement 或 CallableStatement,默認值:PREPARED |
useGeneratedKeys | (僅適用于 insert 和 update)這會令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法來取出由數(shù)據(jù)庫內(nèi)部生成的主鍵(比如:像 MySQL 和 SQL Server 這樣的關(guān)系型數(shù)據(jù)庫管理系統(tǒng)的自動遞增字段),默認值:false |
keyProperty | (僅適用于 insert 和 update)指定能夠唯一識別對象的屬性,MyBatis 會使用 getGeneratedKeys 的返回值或 insert 語句的 selectKey 子元素設置它的值,默認值:未設置(unset)。如果生成列不止一個,可以用逗號分隔多個屬性名稱。不能和keyColumn連用 |
keyColumn | (僅適用于 insert 和 update)設置生成鍵值在表中的列名,在某些數(shù)據(jù)庫(像 PostgreSQL)中,當主鍵列不是表中的第一列的時候,是必須設置的。如果生成列不止一個,可以用逗號分隔多個屬性名稱。不能和keyProperty連用 |
databaseId | 同 select 元素 |
主鍵回填
在 MyBatis 中,若表中的主鍵設置為自增,插入數(shù)據(jù)時沒有插入主鍵,但是又想獲得數(shù)據(jù)庫中該條數(shù)據(jù)的主鍵,那么可以通過設置 useGeneratedKeys=”true”,然后再把 keyProperty 設置到目標屬性(如 User 類中的 id 屬性)上來獲得該值。
<insert id="insertUser" parameterType="com.entity.User" useGeneratedKeys="true" keyProperty="id"> insert into person(name, age, sex) values (#{name}, #{age}, #{sex}); </insert>
//添加一個用戶數(shù)據(jù) @Test public void testInsertUser() { String statement = "com.mapper.UserMapper.insertUser"; User user = new User(); user.setName("孫尚香"); user.setAge(24); user.setSex("女"); int i = sqlSession.insert(statement, user); System.out.println( (i>0)? "添加成功!":"添加失??!"); //提交插入的數(shù)據(jù) sqlSession.commit(); sqlSession.close(); // 輸出返回的主鍵值 System.out.println("返回的主鍵值=" + user.getId()); }
自定義主鍵并且可以在 Java 中通過屬性獲得該值
在 MyBatis 中可以通過 selectKey 元素自定義主鍵,以下是其屬性介紹
- keyProperty:selectKey 需要設置的目標屬性
- resultType:結(jié)果類型
- order:可以設置為 BEFORE 或 AFTER ,表示先設置主鍵,后執(zhí)行插入語句或先執(zhí)行插入語句,后設置主鍵
<insert id="insertUser" parameterType="com.entity.User" > <selectKey keyProperty="id" resultType="int" order="BEFORE"> select ROUND(RAND()*1000) </selectKey> insert into person(id, name, age, sex) values (#{id}, #{name}, #{age}, #{sex}); </insert>
@Test public void testInsertUser() { String statement = "com.mapper.UserMapper.insertUser"; User user = new User(); user.setName("鄭旦"); user.setAge(24); user.setSex("女"); int i = sqlSession.insert(statement, user); System.out.println( (i>0)? "添加成功!":"添加失?。?); //提交插入的數(shù)據(jù) sqlSession.commit(); sqlSession.close(); // 輸出返回的主鍵值 System.out.println("返回的主鍵值=" + user.getId()); }
4 update 和 delete 元素
update 和 delete 元素在使用上比較簡單,所以這里把它們放在一起論述。它們和 insert 元素的屬性差不多,執(zhí)行完后也會返回一個整數(shù),用來表示該 SQL 語句影響了多少條數(shù)據(jù)庫記錄。
<!-- 根據(jù) id 更新用戶 --> <update id="updateUser"> update person set name = #{name}, age = #{age},sex = #{sex} where id = #{id} </update> <!-- 根據(jù) id 刪除用戶 --> <delete id="deleteUser" parameterType="int"> delete from person where id = #{id} </delete>
5 sql 元素
sql 元素是用來定義可重用的 sql 代碼片段,這樣在字段比較多的時候,以便在其它語句中使用。需要結(jié)合 include 元素一起使用,以下是代碼示例。
<!--定義sql代碼片段--> <sql id="userCols"> id,username,age,sex </sql> <!-- 查詢所有用戶 --> <select id="selectAllUser" resultType="com.entity.User"> select <include refid="userCols"/> from person </select>
6 parameterType 元素
parameterType 元素可以輸入以下類型:
- Java 基本數(shù)據(jù)類型
- POJO 類型
- Map 類型
<!-- 通過 普通數(shù)據(jù)類型 int 查詢一個用戶 --> <select id="selectUserById" parameterType="int" resultType="com.entity.User"> select * from person where id = #{id}; </select> <!-- 通過 POJO 類型 User 添加用戶--> <insert id="insertUser" parameterType="com.entity.User"> insert into person(id,username,age,sex) values (#{id},#{username},#{age},#{sex}); </insert> <!-- 通過 嵌套 POJO 類型 查詢一個用戶,QueryVo 類中定義了 User user 屬性 --> <select id="selectUserByUserNameAndAge" parameterType="com.entity.QueryVo" resultType="com.entity.User"> select * from person where name = #{user.name} and age = #{user.age}; </select> <!-- 通過 Map 類型 查詢一個用戶, HashMap<String, Object> map = new HashMap<>(); map.put("name","趙飛燕"); map.put("age",24); 通過 key 獲得 map 中的 value--> <select id="selectUserByMap" parameterType="hashmap" resultType="com.entity.User"> select * from person where name = #{name} and age = #{age}; </select>
7 resultType 元素
resultType 元素和 parameterType 元素用法差不多,一個是輸出,一個是輸入。resultType 元素可以輸出以下類型:
- Java 基本數(shù)據(jù)類型
- POJO 對象
- POJO 對象列表
- Map 對象列表
<!-- 統(tǒng)計用戶總數(shù)量,輸出為一個整數(shù) int --> <select id="countUsers" resultType="int"> select count(1) from person </select> <!-- 通過 id 查詢一個用戶,輸出為一個 User --> <select id="selectUserById" parameterType="int" resultType="com.entity.User"> select * from personwhere id = #{id}; </select> <!-- 查詢所有用戶,輸出為一個 List<User> 列表 --> <select id="selectAllUser" resultType="com.entity.User"> select * from person </select> <!-- 查詢所有用戶, 輸出為一個 List<HashMap<String, Object>> Map 列表--> <select id="selectAllUser" resultType="hashmap"> select * from person </select>
8 resultMap 元素(重要)
我們在使用 resultType 的時候,需要保證數(shù)據(jù)庫表中的字段名和表對應實體類的屬性名稱一致才行(包括駝峰命名規(guī)則)。那不一致怎么辦,查詢的時候可以給列名起個別名,但是一般不建議這樣做,而是通過 resultMap 元素進行一個轉(zhuǎn)換。
<!-- id:唯一標識,type:需要映射的 Java 類型--> <resultMap id="userMap" type="com.entity.User"> <!-- 與主鍵字段的對應,property對應實體屬性,column對應表字段 --> <id property="userId" column="id"/> <!-- 與非主鍵字段的對應,property對應實體屬性,column對應表字段 --> <result property="userName" column="username"/> <result property="userAge" column="age"/> <result property="userSex" column="sex"/> </resultMap> <!-- 查詢所有用戶,返回集為resultMap類型,resultMap的value上面配置的 id=userMap 要一致--> <select id="selectAllUser" resultMap="userMap"> select * from person </select>
上述代碼是不是很眼熟,在 MyBatis 案例中使用了 @ResultMap 注解來實現(xiàn)上述代碼
resultMap 元素的組成
<!-- autoMapping:指定是否自動映射查詢結(jié)果的列到 Java 對象的屬性。 默認為開啟(true),如果設置為 false,則需要手動配置每個屬性的映射關(guān)系 --> <resultMap id="標識" type="輸出類型" extends="繼承其他 <resultMap>" autoMapping="自動映射"> <constructor><!--構(gòu)造器注入屬性值--> <!-- 構(gòu)造器標識,一般為主鍵 --> <!-- column對應表字段,name對應實體屬性 --> <idArg column="id" name="userId" javaType="int"/> <!-- 構(gòu)造器參數(shù) --> <arg column="username" name="userName" javaType="string"/> </constructor> <!-- id 與主鍵字段的對應,property對應實體屬性,column對應表字段 --> <id property="userId" column="id"/> <!-- result 與非主鍵字段的對應,property對應實體屬性,column對應表字段 --> <result property="userName" column="username"/> <association/><!--高級映射,一對一映射--> <collection /><!--高級映射,一對多映射--> <discriminator> <case/> </discriminator><!--根據(jù)返回的字段的值封裝不同的類型--> </resultMap>
9 參考文檔
到此這篇關(guān)于MyBatis實現(xiàn)SQL映射文件的文章就介紹到這了,更多相關(guān)MyBatis SQL映射文件內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Spring MVC之mvc:resources如何處理靜態(tài)資源
這篇文章主要介紹了Spring MVC之mvc:resources如何處理靜態(tài)資源問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2025-03-03SpringBoot整合Mybatis實現(xiàn)多數(shù)據(jù)源配置與跨數(shù)據(jù)源事務實例
開發(fā)中經(jīng)常有這樣的需要: 讀寫分離。微服務環(huán)境下可以實現(xiàn)一個服務讀取一個數(shù)據(jù)庫,另一個服務寫庫。但是在實際應用中有時也需要在一個服務中讀寫不同的數(shù)據(jù)庫??梢栽谝粋€SpringBoot單體項目中配置多個數(shù)據(jù)源解決讀寫庫分離2022-11-11springboot新建項目jdk只有17/21,無法選中1.8解決辦法
最近博主也有創(chuàng)建springboot項目,發(fā)現(xiàn)了IntelliJ IDEA在通過Spring Initilizer初始化項目的時候已經(jīng)沒有java8版本的選項了,這里給大家總結(jié)下,這篇文章主要給大家介紹了springboot新建項目jdk只有17/21,無法選中1.8的解決辦法,需要的朋友可以參考下2023-12-12深入理解Java并發(fā)編程之LinkedBlockingQueue隊列
本文主要介紹了Java并發(fā)編程之LinkedBlockingQueue隊列,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2022-04-04解決springboot 連接 mysql 時報錯 using password: NO的方案
在本篇文章里小編給大家整理了關(guān)于解決springboot 連接 mysql 時報錯 using password: NO的方案,有需要的朋友們可以學習下。2020-01-01