通用Mapper的接口大全

Mapper3接口有兩種形式,一種是提供了一個方法的接口。還有一種是不提供方法,但是繼承了多個單方法的接口,一般是某類方法的集合。

例如SelectMapper<T>是一個單方法的接口,BaseSelectMapper<T>是一個繼承了4個基礎查詢方法的接口。

基礎接口

Select

接口:SelectMapper<T>
方法:List<T> select(T record);
說明:根據實體中的屬性值進行查詢,查詢條件使用等號
 

接口:SelectByPrimaryKeyMapper<T>
方法:T selectByPrimaryKey(Object key);
說明:根據主鍵字段進行查詢,方法參數必須包含完整的主鍵屬性,查詢條件使用等號
 

接口:SelectAllMapper<T>
方法:List<T> selectAll();
說明:查詢全部結果,select(null)方法能達到同樣的效果
 

接口:SelectOneMapper<T>
方法:T selectOne(T record);
說明:根據實體中的屬性進行查詢,只能有一個返回值,有多個結果是拋出異常,查詢條件使用等號
 

接口:SelectCountMapper<T>
方法:int selectCount(T record);
說明:根據實體中的屬性查詢總數,查詢條件使用等號
 

Insert

接口:InsertMapper<T>
方法:int insert(T record);
說明:保存一個實體,null的屬性也會保存,不會使用數據庫默認值
 

接口:InsertSelectiveMapper<T>
方法:int insertSelective(T record);
說明:保存一個實體,null的屬性不會保存,會使用數據庫默認值
 

Update

接口:UpdateByPrimaryKeyMapper<T>
方法:int updateByPrimaryKey(T record);
說明:根據主鍵更新實體全部字段,null值會被更新
 

接口:UpdateByPrimaryKeySelectiveMapper<T>
方法:int updateByPrimaryKeySelective(T record);
說明:根據主鍵更新屬性不爲null的值
 

Delete

接口:DeleteMapper<T>
方法:int delete(T record);
說明:根據實體屬性作爲條件進行刪除,查詢條件使用等號
 

接口:DeleteByPrimaryKeyMapper<T>
方法:int deleteByPrimaryKey(Object key);
說明:根據主鍵字段進行刪除,方法參數必須包含完整的主鍵屬性
 

base 組合接口

接口:BaseSelectMapper<T>
方法:包含上面Select的4個方法
 

接口:BaseInsertMapper<T>
方法:包含上面Insert的2個方法
 

接口:BaseUpdateMapper<T>
方法:包含上面Update的2個方法
 

接口:BaseDeleteMapper<T>
方法:包含上面Delete的2個方法
 

CRUD 組合接口

接口:BaseMapper<T>
方法:繼承了base組合接口中的4個組合接口,包含完整的CRUD方法
 

Example 方法

接口:SelectByExampleMapper<T>
方法:List<T> selectByExample(Object example);
說明:根據Example條件進行查詢
重點:這個查詢支持通過Example類指定查詢列,通過selectProperties方法指定查詢列
 

接口:SelectCountByExampleMapper<T>
方法:int selectCountByExample(Object example);
說明:根據Example條件進行查詢總數
 

接口:UpdateByExampleMapper<T>
方法:int updateByExample(@Param("record") T record, @Param("example") Object example);
說明:根據Example條件更新實體record包含的全部屬性,null值會被更新
 

接口:UpdateByExampleSelectiveMapper<T>
方法:int updateByExampleSelective(@Param("record") T record, @Param("example") Object example);
說明:根據Example條件更新實體record包含的不是null的屬性值
 

接口:DeleteByExampleMapper<T>
方法:int deleteByExample(Object example);
說明:根據Example條件刪除數據
 

Example 組合接口

接口:ExampleMapper<T>
方法:包含上面Example中的5個方法
 

Condition 方法

Condition方法和Example方法作用完全一樣,只是爲了避免Example帶來的歧義,提供的的Condition方法

接口:SelectByConditionMapper<T>
方法:List<T> selectByCondition(Object condition);
說明:根據Condition條件進行查詢
 

接口:SelectCountByConditionMapper<T>
方法:int selectCountByCondition(Object condition);
說明:根據Condition條件進行查詢總數
 

接口:UpdateByConditionMapper<T>
方法:int updateByCondition(@Param("record") T record, @Param("example") Object condition);
說明:根據Condition條件更新實體record包含的全部屬性,null值會被更新
 

接口:UpdateByConditionSelectiveMapper<T>
方法:int updateByConditionSelective(@Param("record") T record, @Param("example") Object condition);
說明:根據Condition條件更新實體record包含的不是null的屬性值
 

接口:DeleteByConditionMapper<T>
方法:int deleteByCondition(Object condition);
說明:根據Condition條件刪除數據
 

Condition 組合接口

接口:ConditionMapper<T>
方法:包含上面Condition中的5個方法
 

RowBounds

默認爲內存分頁,可以配合PageHelper實現物理分頁

接口:SelectRowBoundsMapper<T>
方法:List<T> selectByRowBounds(T record, RowBounds rowBounds);
說明:根據實體屬性和RowBounds進行分頁查詢
 

接口:SelectByExampleRowBoundsMapper<T>
方法:List<T> selectByExampleAndRowBounds(Object example, RowBounds rowBounds);
說明:根據example條件和RowBounds進行分頁查詢
 

接口:SelectByConditionRowBoundsMapper<T>
方法:List<T> selectByConditionAndRowBounds(Object condition, RowBounds rowBounds);
說明:根據example條件和RowBounds進行分頁查詢,該方法和selectByExampleAndRowBounds完全一樣,只是名字改成了Condition
 

RowBounds 組合接口

接口:RowBoundsMapper<T>
方法:包含上面RowBounds中的前兩個方法,不包含selectByConditionAndRowBounds
 

special 特殊接口

這些接口針對部分數據庫設計,不是所有數據庫都支持

接口:InsertListMapper<T>
方法:int insertList(List<T> recordList);
說明:批量插入,支持批量插入的數據庫可以使用,例如MySQL,H2等,另外該接口限制實體包含id屬性並且必須爲自增列
 

接口:InsertUseGeneratedKeysMapper<T>
方法:int insertUseGeneratedKeys(T record);
說明:插入數據,限制爲實體包含id屬性並且必須爲自增列,實體配置的主鍵策略無效
 

MySQL 專用

接口:MySqlMapper<T>
繼承方法:int insertList(List<T> recordList);
繼承方法:int insertUseGeneratedKeys(T record);
說明:該接口不包含方法,繼承了special中的InsertListMapper<T>InsertUseGeneratedKeysMapper<T>
 

SqlServer 專用

由於sqlserver中插入自增主鍵時,不能使用null插入,不能在insert語句中出現id

注意SqlServer的兩個特有插入方法都使用了

@Options(useGeneratedKeys = true, keyProperty = "id")

這就要求表的主鍵爲id,且爲自增,如果主鍵不叫id可以看高級教程中的解決方法。

另外這倆方法和base中的插入方法重名,不能同時存在!

如果某種數據庫和SqlServer這裏類似,也可以使用這些接口(需要先測試)。

接口:InsertMapper
方法:int insert(T record);
說明:插入數據庫,null值也會插入,不會使用列的默認值
 

接口:InsertSelectiveMapper
方法:int insertSelective(T record);
說明:插入數據庫,null的屬性不會保存,會使用數據庫默認值
 

接口:SqlServerMapper
說明:這是上面兩個接口的組合接口。
 

Ids 接口

通過操作ids字符串進行操作,ids 如 “1,2,3” 這種形式的字符串,這個方法要求實體類中有且只有一個帶有@Id註解的字段,否則會拋出異常。

接口:SelectByIdsMapper
方法:List<T> selectByIds(String ids)
說明:根據主鍵字符串進行查詢,類中只有存在一個帶有@Id註解的字段
 

接口:DeleteByIdsMapper
方法:int deleteByIds(String ids)
說明:根據主鍵字符串進行刪除,類中只有存在一個帶有@Id註解的字段
 

Ids 組合接口

接口:IdsMapper<T>
方法:包含上面Ids中的前兩個方法
 

Mapper<T> 接口

接口:Mapper<T>
該接口兼容Mapper2.x版本,繼承了BaseMapper<T>ExampleMapper<T>RowBoundsMapper<T>三個組合接口

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章