當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

mapper命名规范_Mybatis系列全解（五）：全网最全！详解Mybatis的Mapper映射文件

發布時間：2025/4/5 编程问答 59 豆豆

生活随笔收集整理的這篇文章主要介紹了 mapper命名规范_Mybatis系列全解（五）：全网最全！详解Mybatis的Mapper映射文件小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

封面：洛小汐
作者：潘潘

若不是生活所迫，誰愿意背負一身才華。

前言

上節我們介紹了《 Mybatis系列全解（四）：全網最全！Mybatis配置文件 XML 全貌詳解》，內容很詳細（也很枯燥），由于篇幅實在過于冗長，我預計大家想看完得花上兩段上班地鐵公交車的時間。。。

不過應該有讓大家了解到 Mybatis 的核心配置文件 config.xml 全貌，其中的元素即是我們本節準備登場介紹的 SQL 映射器，上節有介紹了三種引入 SQL 映射器的方式，本節我們就主要聊聊它的幾個頂級元素用法。

Mybatis 真正強大就在于它的語句映射，這是它的魔力所在，也是基石。由于它異常強大，映射器的 XML 文件就顯得相對簡單。如果拿它跟具有相同功能的 JDBC 代碼進行對比，你會立即發現省掉了將近 95% 的代碼（ 95% 是Mybatis 官網的說法，我也就引入一下），MyBatis 致力于減少使用成本，讓用戶能更專注于 SQL 代碼。

Mybatis系列全解腦圖分享，持續更新中

mapper 映射器頂級元素全貌

與其它 ORM 框架如 Hibernate 不同，Mybatis 的框架思想希望開發者能夠直接操作數據庫編寫 SQL，而不是隱藏起來，讓開發者獨自面對 Java 對象，為此 Mybatis 設計了 SQL 映射器，任你五招十二式。

映射器有九大頂級元素，基本技能介紹

select : 用于查詢，支持傳參，返回指定結果集；
insert : 用于新增，支持傳參，返回指定結果集；
update : 用于更新，支持傳參，返回指定結果集；
delete : 用于刪除，支持傳參，返回指定結果集；
sql : 被其它語句引用的可復用語句塊；
cache : 當前命名空間緩存配置；
cache-ref : 引用其它命名空間的緩存配置；
parameterMap : 參數映射，已棄用，是它不夠好；
resultMap : 結果集映射，它就很好；

其中，增刪改查操作拼接 SQL 時使用到的動態SQL（ if、where、foreach啥的），以及封裝結果集時使用到的復雜映射（1對1 ，1對多，多對多啥的），這兩部分我們后面單立文章再詳細介紹，本文中我們簡單點過。

九大頂級元素，功能歸類：

其中頂一元素 parameterMap 已棄用。

無論你有多么復雜的 SQL 操作，最根本的思路都逃不出以上 4 部分。

namespace 命名空間

一個完整的 Mapper 映射文件，需要有約束頭 xml 與 !DOCTYPE ，其次才是 mapper 根元素，最后再是頂級元素，而其中，namespace 屬性作為 mapper 的唯一標識，試回憶：

上學時，6年級一班23號，能代表唯一的你。
編寫 Java 類時，包名 + 類名，能代表唯一的類。
而如今，我們在 Mybatis 中寫的每一段 SQL 語句，同樣有唯一的代表方式，那就是「命名空間標識 + 語句id 」，無論是為了區分業務也好，還是為了拆分服務也好，反正 Mybatis 讓每一個 mapper.xml 配備一個唯一命名空間標識。

每一段 SQL 語句都是唯一定義的，我們在 Mybatis 中用「命名空間標識 + 語句塊 ID 」作為唯一的標識，組合之后在 Mybatis 二級緩存中可以作為本地 map 集合緩存的唯一Key ，也可以用于 Dao 接口的映射綁定，還能作為唯一代理標識。總之，我們希望避免命名沖突和重復定義，所以，擁有這么一個唯一標識，它就至少有一億個利好。

select 查詢

select 查詢語句，幾乎是我們最高頻的使用元素，所以 Mybatis 在這塊沒少下功夫，目的就是通過提供盡可能多的便利，讓我們的查詢操作變得簡單。一個查詢用戶 User 的查詢語句可以這么編寫：

<select id="selectUser" parameterType="int" resultType="hashmap">select * from t_user where id = #{id} </select>

id屬性：在當前 mapper.xml 命名空間下，它的 id 值是唯一的（不過如果在不同的 mapper.xml 命名空間下，則允許有相同的的 id 值）
parameterType 屬性：代表傳入的參數類型，這里是 int （或 Integer）類型
resultType屬性：代表返回結果類型，這里指定返回一個 hashMap 類型的對象，mybatis 會把查詢出來的數據表記錄對應的 ' 字段列名 - 字段值 '，自動映射為 map 集合的 key - value 。

當然如果你不希望通過 hashmap 來接收查詢結果，允許你自由指定返回類型。Mybatis 是支持自動綁定 JavaBean 的，我們只要讓查詢返回的字段名和 JavaBean 的屬性名保持一致（或者采用駝峰式命名），便可以自動映射結果集，例如你創建一個 Java 類 User.java ，包含兩個屬性 id 和 name , 那么結果集可以指定為 com.vo.User ，就完成了。 <select id="selectUser" parameterType="int" resultType="com.vo.User">select * from t_user where id = #{id} </select>

注意參數符號：

#{id}

#{} 告訴 MyBatis 創建一個預編譯語句（PreparedStatement）參數，在 JDBC 中，這樣的一個參數在 SQL 中會由一個 “ ? ” 來標識，并被傳遞到一個新的預編譯語句中，就像這樣：

// 近似的 JDBC 代碼，非 MyBatis 代碼... String selectUser = " select * from t_user where id = ? "; PreparedStatement ps = conn.prepareStatement(selectUser); ps.setInt(1,id);

#{} 作為占位符，${} 作為替換符，兩者沒有孰輕孰重，只不過應用場景不同，適當取舍即可。

我們希望完成類似 JDBC 中的 PrepareStatement 預編譯處理，可以使用 #{} ，它會在替換占位符時首尾添加上單引號 '' ，能有效防止 SQL 注入風險。

例如使用 ${} 操作刪除（就很有問題！）

// 1、使用 ${} 有注入風險 delete from t_user where id = ${id}// 2、正常傳值，id 傳入 1 delete from t_user where id = 1 // 結果刪除了id=1 的記錄// 3、注入風險，id 傳入 1 or 1=1 delete from t_user where id = 1 or 1=1 // 全表刪除了

再看看 #{} 是如何規避 SQL 注入的：

// 1、使用 #{} 有效防止注入風險 delete from t_user where id = #{id}// 2、正常傳值，id 傳入 1 delete from t_user where id = '1' // 結果刪除了id=1 的記錄// 3、注入風險，id 傳入 1 or 1=1 delete from t_user where id = '1 or 1=1' // SQL 語句報錯，表數據安全

雖然在防止 SQL 注入方面，${} 確實無能為力，不過我們 ${} 在其它方面可不容小覷，例如它允許你靈活地進行動態表和動態列名的替換操作，例如：

// 1、靈活查詢指定表數據 select * from ${tableName} // 傳入 tableName參數 = t_user , 結果 select * from t_user // 2、靈活查詢不同列條件數據 select * from t_user where ${colunmName} = ${value}// 傳入 colunmName參數 = name , value參數 = '潘潘', 結果 select * from t_user where name = '潘潘'// 傳入 colunmName參數 = id , value參數 = 1, 結果 select * from t_user where id = 1以上的 ${} 替換列名與表名的方式非常靈活，不過確實存在 SQL 注入風險，所以在考慮使用 #{} 或 ${} 前，需要評估風險，避免風險，允許的情況下，我建議使用 #{} 。

當然，select 元素允許你配置很多屬性來配置每條語句的行為細節。

<select id="selectUser" parameterType="int"parameterMap="deprecated"resultType="hashmap"resultMap="personResultMap"flushCache="false"useCache="true"timeout="10"fetchSize="256"statementType="PREPARED"resultSetType="FORWARD_ONLY"databaseId="mysql"resultOrdered="false"resultSets="rs1,rs2,rs3">select * from t_user </select>

下面詳細介紹一下，略微冗長，一口氣干完吧：

id 必填項，在命名空間下的唯一標識，可被 Mybatis 引用，如果存在相同的 “ 命名空間 + 語句id ” 組合，Mybatis 將拋出異常；
parameterType 可選項，傳入語句的參數的類全限定名或別名，可以是基本類型、map 或 JavaBean 等復雜的參數類型傳遞給 SQL；
parameterMap 用于引用外部 parameterMap 的屬性塊，目前已被廢棄。以后請使用行內參數映射和 parameterType 屬性。
resultType 可選項，定義類的全路徑，在允許自動匹配的情況下，結果集將通過 Javaben 的規范映射，或定義為 int 、double、float 等參數；也可以使用別名，但是要符合別名規范和定義。 resultType 和 resultMap 之間只能同時使用一個。（日常中，比如我們統計結果總條數的時候可以設置為 int ）；
resultMap 可選項，對外部 resultMap 的命名引用。結果映射是 MyBatis 最強大的特性，如果你對其理解透徹，許多復雜的映射問題都能迎刃而解，后面一對一、一對多、多對多我們會有一篇文章單獨講解。 resultType 和 resultMap 之間只能同時使用一個。
flushCache 可選項，清空緩存，將其設置為 true 后，只要語句被調用，都會導致本地緩存和二級緩存被清空，默認值：false。
useCache 可選項，使用緩存，將其設置為 true 后，將會導致本條語句的結果被二級緩存緩存起來，默認值：對 select 元素為 true。
timeout 可選項，這個設置是在拋出異常之前，驅動程序等待數據庫返回請求結果的秒數。默認值為未設置（unset）（依賴數據庫驅動）。
fetchSize 可選項，獲取記錄的總條數設定。這是一個給驅動的建議值，嘗試讓驅動程序每次批量返回的結果行數等于這個設置值。默認值為未設置（unset）（依賴驅動）。由于性能問題，建議在 sql 做分頁處理。
statementType 可選項，可選 STATEMENT，PREPARED 或 CALLABLE。這會讓 MyBatis 分別使用 Statement，PreparedStatement 或 CallableStatement，默認值：PREPARED。
resultSetType 可選項，FORWARD_ONLY，SCROLL_SENSITIVE, SCROLL_INSENSITIVE 或 DEFAULT（等價于 unset）中的一個，默認值為 unset （依賴數據庫驅動）。
- FORWARD_ONLY，只允許游標向前訪問；
- SCROLL_SENSITIVE，允許游標雙向滾動，但不會及時更新數據，也就是說如果數據庫中的數據被修改過，并不會在resultSet中及時更新出來；
- SCROLL_INSENSITIVE ，允許游標雙向滾動，如果數據庫中的數據被修改過，會及時更新到resultSet；

我們知道 JDBC 通過 ResultSet 來對查詢結果進行封裝，ResultSet 對象本身包含了一個由查詢語句返回的一個結果集合。例如你經常在 JDBC 見過的結果集讀取：// 允許滾動游標索引結果集 while( rs.next() ){rs.getString("name"); } // 當然也支持游標定位到最后一個位置 rs.last(); // 向后滾動 rs.previous();

databaseId 可選項，如果配置了數據庫廠商標識（databaseIdProvider），MyBatis 會加載所有不帶 databaseId 或匹配當前 databaseId 的語句；如果帶和不帶的語句都有，則不帶的會被忽略。
resultOrdered 可選項，這個設置僅針對嵌套結果 select 語句：如果為 true，將會假設包含了嵌套結果集或是分組，當返回一個主結果行時，就不會產生對前面結果集的引用。這就使得在獲取嵌套結果集的時候不至于內存不夠用。默認值：false。
resultSets 這個設置僅適用于多結果集的情況。它將列出語句執行后返回的結果集并賦予每個結果集一個名稱，多個名稱之間以逗號分隔。

insert / update / delete 增刪改

數據變更語句 insert，update 和 delete 的實現非常接近，而且相對于 select 元素而言要簡單許多。

<insertid="insertUser"parameterType="domain.vo.User"flushCache="true"statementType="PREPARED"keyProperty=""keyColumn=""useGeneratedKeys=""timeout="20"><updateid="updateUser"parameterType="domain.vo.User"flushCache="true"statementType="PREPARED"timeout="20"><deleteid="deleteUser"parameterType="domain.vo.User"flushCache="true"statementType="PREPARED"timeout="20">

其中大部分屬性和 select 元素相同，我們介紹 3 個不同的屬性：

useGeneratedKeys : （僅適用于 insert 和 update）這會令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法來取出由數據庫內部生成的主鍵（比如：像 MySQL 和 SQL Server 這樣的關系型數據庫管理系統的自動遞增字段），默認值：false。
keyProperty : （僅適用于 insert 和 update）指定能夠唯一識別對象的屬性，MyBatis 會使用 getGeneratedKeys 的返回值或 insert 語句的 selectKey 子元素設置它的值，默認值：未設置（unset）。如果生成列不止一個，可以用逗號分隔多個屬性名稱。
keyColumn : （僅適用于 insert 和 update）設置生成鍵值在表中的列名，在某些數據庫（像 PostgreSQL）中，當主鍵列不是表中的第一列的時候，是必須設置的。如果生成列不止一個，可以用逗號分隔多個屬性名稱。

我們先看看 insert，update 和 delete 語句的示例：

<insert id="insertUser">insert into t_user (id,name) values (#{id},#{name}) </insert><update id="updateUser">update t_user set name = #{name} where id = #{id} </update><delete id="deleteUser">delete from t_user where id = #{id} </delete>

如前所述，插入語句的配置規則更加豐富，在插入語句里面有一些額外的屬性和子元素用來處理主鍵的生成，并且提供了多種生成方式。

首先，如果你的數據庫支持自動生成主鍵的字段（比如 MySQL 和 SQL Server），那么你可以設置 useGeneratedKeys=”true”，然后再把 keyProperty 設置為目標屬性就 OK 了。例如，如果上面的 t_user 表已經在 id 列上使用了自動生成，那么語句可以修改為：

<insert id="insertUser" useGeneratedKeys="true"keyProperty="id">insert into t_user (name) values (#{name}) </insert>

如果你的數據庫還支持多行插入, 你也可以傳入一個 User 數組或集合，并返回自動生成的主鍵。

<insert id="insertUser" useGeneratedKeys="true"keyProperty="id">insert into t_user (name) values <foreach item="item" collection="list" separator=",">(#{item.name})</foreach> </insert>

對于不支持自動生成主鍵列的數據庫和可能不支持自動生成主鍵的 JDBC 驅動，MyBatis 有另外一種方法來生成主鍵。

這里有一個簡單（也很傻）的示例，它可以生成一個隨機 ID（不建議實際使用，這里只是為了展示 MyBatis 處理問題的靈活性和寬容度）：

<insert id="insertUser"><selectKey keyProperty="id" resultType="int" order="BEFORE">select CAST(RANDOM()*1000000 as INTEGER) a from SYSIBM.SYSDUMMY1</selectKey>insert into t_user (id, name)values (#{id}, #{name}) </insert>

在上面的示例中，首先會運行 selectKey 元素中的語句，并設置 User 的 id，然后才會調用插入語句。這樣就實現了數據庫自動生成主鍵類似的行為，同時保持了 Java 代碼的簡潔。

selectKey 元素描述如下：

<selectKeykeyProperty="id"resultType="int"order="BEFORE"statementType="PREPARED">

selectKey 中的 order 屬性有2個選擇：BEFORE 和 AFTER 。

BEFORE：表示先執行selectKey的語句，然后將查詢到的值設置到 JavaBean 對應屬性上，然后再執行 insert 語句。
AFTER：表示先執行 AFTER 語句，然后再執行 selectKey 語句，并將 selectKey 得到的值設置到 JavaBean 中的屬性。上面示例中如果改成 AFTER，那么插入的 id 就會是空值，但是返回的 JavaBean 屬性內會有值。

cache 緩存

緩存對于互聯網系統來說特別常見，其特點就是將數據保存在內存中。MyBatis 內置了一個強大的事務性查詢緩存機制，它可以非常方便地配置和定制。為了使它更加強大而且易于配置，我們對 MyBatis 3 中的緩存實現進行了許多改進。

默認情況下，只啟用了本地的會話緩存（即一級緩存，sqlSession級別），它僅僅對一個會話中的數據進行緩存。要啟用全局的二級緩存，首先在全局配置文件config.xml文件中加入如下代碼:

<settings> <setting name="cacheEnabled" value="true"/> </settings>

其次在UserMapper.xml文件中開啟緩存：

<cache></cache>

基本上就是這樣。這個簡單語句的效果如下:

映射語句文件中的所有 select 語句的結果將會被緩存。
映射語句文件中的所有 insert、update 和 delete 語句會刷新緩存。
緩存會使用最近最少使用算法（LRU, Least Recently Used）算法來清除不需要的緩存。
緩存不會定時進行刷新（也就是說，沒有刷新間隔）。
緩存會保存列表或對象（無論查詢方法返回哪種）的 1024 個引用。
緩存會被視為讀/寫緩存，這意味著獲取到的對象并不是共享的，可以安全地被調用者修改，而不干擾其他調用者或線程所做的潛在修改。

緩存只作用于 cache 標簽所在的映射文件中的語句。如果你混合使用 Java API 和 XML 映射文件，在共用接口中的語句將不會被默認緩存。你需要使用 @CacheNamespaceRef 注解指定緩存作用域。

這些屬性可以通過 cache 元素的屬性來修改。比如：

<cacheeviction="FIFO"flushInterval="60000"size="512"readOnly="true"/>

上面表示了一套更高級的緩存配置，首先創建了一個 FIFO 緩存，每隔 60 秒刷新，最多可以存儲結果對象或列表的 512 個引用，然后返回的對象被設置成只讀的，因此對它們進行修改可能會在不同線程中的調用者產生沖突。

緩存可用的清除策略有：

LRU – 最近最少使用：移除最長時間不被使用的對象。
FIFO – 先進先出：按對象進入緩存的順序來移除它們。
SOFT – 軟引用：基于垃圾回收器狀態和軟引用規則移除對象。
WEAK – 弱引用：更積極地基于垃圾收集器狀態和弱引用規則移除對象。

默認的清除策略是 LRU

flushInterval（刷新間隔）屬性可以被設置為任意的正整數，設置的值應該是一個以毫秒為單位的合理時間量。默認情況是不設置，也就是沒有刷新間隔，緩存僅僅會在調用語句時刷新。

size（引用數目）屬性可以被設置為任意正整數，要注意欲緩存對象的大小和運行環境中可用的內存資源。默認值是 1024。

readOnly（只讀）屬性可以被設置為 true 或 false。只讀的緩存會給所有調用者返回緩存對象的相同實例。因此這些對象不能被修改。這就提供了可觀的性能提升。而可讀寫的緩存會（通過序列化）返回緩存對象的拷貝。速度上會慢一些，但是更安全，因此默認值是 false。

二級緩存是事務性的。這意味著，當 SqlSession 完成并提交 ( commit ) 時，或是完成并回滾 ( close ) 時，二級緩存都會被刷新。不管是否配置了 flushCache=true 。

Mybatis 的緩存包括一級緩存（sqlSession 級別）和二級緩存（mapper 級別），所以 mapper 映射器中配置的是二級緩存，我們先大概知道有這個概念，因為后續我們會針對這兩種緩存進行詳細介紹，而且還會講解如何自定義緩存，因為 Mybatis 的緩存默認都是以 map 的數據結構存儲在本地，所以自定義緩存可以把存儲介質拓展到磁盤或數據庫redis等；而且一級緩存是默認開啟的，二級緩存需要我們手工開啟，這些后續都會詳細講解，提前預告。

緩存獲取順序：二級緩存 > 一級緩存 > 數據庫

cache-ref 引用緩存

回想一下 cache 的內容，對某一命名空間的語句，只會使用該命名空間的緩存進行緩存或刷新。但你可能會想要在多個命名空間中共享相同的緩存配置和實例。要實現這種需求，你可以使用 cache-ref 元素來引用另一個緩存。

<cache-ref namespace="com.vo.UserMapper"/>

sql 語句塊

這個元素可以用來定義可重用的 SQL 代碼片段，以便在其它語句中使用。參數可以靜態地（在加載的時候）確定下來，并且可以在不同的 include 元素中定義不同的參數值。比如：

<sql id="userColumns"> ${alias}.id,${alias}.name </sql>

這個 SQL 片段可以在其它語句中使用，例如：

<select id="selectUsers" resultType="map">select<include refid="userColumns"><property name="alias" value="t1"/></include>,<include refid="userColumns"><property name="alias" value="t2"/></include>from t_user t1 cross join t_user t2 </select>

也可以在 include 元素的 refid 屬性或多層內部語句中使用屬性值，例如：

<sql id="sql1">${prefix}_user </sql><sql id="sql2">from<include refid="${include_target}"/> </sql><select id="select" resultType="map">selectid, name<include refid="sql2"><property name="prefix" value="t"/><property name="include_target" value="sql1"/></include> </select>

parameterMap 參數映射

parameterMap 元素官方已經不建議使用，并且再后續版本會退出舞臺。首先對于我們 Java 來說，特別不希望在代碼中通過傳遞 map 來傳參，這樣對于后續維護或者參數查找都是極不負責任的，我們推薦使用 JavaBean 來傳值參數，這是 parameterMap 被拋棄的其中一個原因；另外也由于 parameterType 屬性的誕生就能很好的代替 parameterMap ，并且還能自定義 JavaBean 類型的傳參，所以 parameterMap 退出舞臺，實屬正常。

總結

我一直來都希望自己只輸出觀點，而不是輸出字典，但其中有些知識點又是極其冗雜，知識輸出真是個難搞的差事，如何既能把知識脈絡梳理的完整，又能講得淺顯易懂，言簡意賅，確實是后續文章分解輸出的研究方向。

本篇完，本系列下一篇我們講《 Mybatis系列全解（六）：Mybatis最硬核的API你知道幾個？》。

BIU ~ 文章持續更新，微信搜索「潘潘和他的朋友們」第一時間閱讀，隨時有驚喜。本文會在 GitHub https://github.com/JavaWord 收錄，熱騰騰的技術、框架、面經、解決方案，我們都會以最美的姿勢第一時間送達，歡迎 Star ~ 我們未來不止文章！想進讀者群的伙伴歡迎撩我個人號：panshenlian，備注「加群」我們群里歡聊吧 ~

總結

以上是生活随笔為你收集整理的mapper命名规范_Mybatis系列全解（五）：全网最全！详解Mybatis的Mapper映射文件的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。

上一篇：如何清洗海尔空调自动清洁功能？
下一篇： opencv mat 修改_OpenCV