MyBatis-Plus時Mybatis的Best Partner
MyBatis-Plus?(opens new window)（簡稱 MP）是一個?MyBatis?(opens new window)的增強工具，在 MyBatis 的基礎上只做增強不做改變，為簡化開發、提高效率而生。
特性
- 無侵入
- 損耗小
- 強大的 CRUD 操作
- 支持 Lambda 形式調用
- 支持主鍵自動生成
- 支持 ActiveRecord 模式
- 支持自定義全局通用操作
- 內置代碼生成器
- 內置分頁插件
- 分頁插件支持多種數據庫
- 內置性能分析插件
- 內置全局攔截插件
#支持數據庫
框架結構
引入?MyBatis-Plus?之后請不要再次引入?MyBatis?以及?mybatis-spring-boot-starter和MyBatis-Spring，以避免因版本差異導致的問題
注解
@TableName
描述：表名注解，標識實體類對應的表
使用位置：實體類
注意: 默認是以對象名為表名，可以配置全局配置名字增加前綴，
也可以用@TableName進行注釋表名，如下（同時配置，注解生效）
。@TableName("sys_user") public class User { private Long id; private String name; private Integer age; private String email; }
| 屬性 | 類型 | 必須指定 | 默認值 | 描述 |
| value | String | 否 | "" | 表名 |
| schema | String | 否 | "" | schema |
| keepGlobalPrefix | boolean | 否 | false | 是否保持使用全局的 tablePrefix 的值（當全局 tablePrefix 生效時） |
| resultMap | String | 否 | "" | xml 中 resultMap 的 id（用于滿足特定類型的實體類對象綁定） |
| autoResultMap | boolean | 否 | false | 是否自動構建 resultMap 并使用（如果設置 resultMap 則不會進行 resultMap 的自動構建與注入） |
| excludeProperty | String[] | 否 | {} | 需要排除的屬性名 @since 3.3.1 |
關于?autoResultMap?的說明：
MP 會自動構建一個?resultMap?并注入到 MyBatis 里（一般用不上），請注意以下內容：
因為 MP 底層是 MyBatis，所以 MP 只是幫您注入了常用 CRUD 到 MyBatis 里，注入之前是動態的（根據您的 Entity 字段以及注解變化而變化），但是注入之后是靜態的（等于 XML 配置中的內容）。
而對于?typeHandler?屬性，MyBatis 只支持寫在 2 個地方:
- 定義在 resultMap 里，作用于查詢結果的封裝
- 定義在?insert??update??#{property}??property?#{property,typehandler=xxx.xxx.xxx}?設置值
除了以上兩種直接指定?typeHandler?的形式，MyBatis 有一個全局掃描自定義?typeHandler?包的配置，原理是根據您的?property?類型去找其對應的?typeHandler?并使用。
@TableId
描述：主鍵注解
使用位置：實體類主鍵字段
@TableName("sys_user") public class User { @TableId private Long id; private String name; private Integer age; private String email; }
| 屬性 | 類型 | 必須指定 | 默認值 | 描述 |
| value | String | 否 | "" | 主鍵字段名 |
| type | Enum | 否 | IdType.NONE | 指定主鍵類型（在不寫type類型的時候默認為雪花算法） |
IdType
需要提前設置數據庫自增
如果需要自己寫主鍵，可以自己配置全局的主鍵生成策略
| 值 | 描述 |
| AUTO | 數據庫 ID 自增（需要設置數據庫的遞增） |
| NONE | 無狀態，該類型為未設置主鍵類型（注解里等于跟隨全局，全局里約等于 INPUT） |
| INPUT | insert 前自行 set 主鍵值 |
| ASSIGN_ID | 分配 ID(主鍵類型為 Number(Long 和 Integer)或 String)(since 3.3.0),使用接口 IdentifierGenerator的方法nextId(默認實現類為DefaultIdentifierGenerator雪花算法) |
| ASSIGN_UUID | 分配 UUID,主鍵類型為 String(since 3.3.0),使用接口 IdentifierGenerator的方法nextUUID (默認 default 方法) |
| ID_WORKER | 分布式全局唯一 ID 長整型類型(pleaseuseASSIGN_ID) |
| UUID | 32 位 UUID 字符串(please use ASSIGN_UUID ) |
| ID_WORKER_STR | 分布式全局唯一 ID 字符串類型(please use ASSIGN_ID ) |
@TableField
描述：字段注解（非主鍵）
@TableName("sys_user") public class User { @TableId private Long id; @TableField("nickname") private String name; private Integer age; private String email; }
| 屬性 | 類型 | 必須指定 | 默認值 | 描述 |
| value | String | 否 | "" | 數據庫字段名 |
| exist | boolean | 否 | true | 是否為數據庫表字段 |
| condition | String | 否 | "" | 字段 where 實體查詢比較條件，有值設置則按設置的值為準，沒有則為默認全局的 %s=#{%s} ， 參考 |
@Version
描述：樂觀鎖注解，標記@version在字段上
@EnumValue
描述：普通枚舉類注解(標注在枚舉字段上)
@TableLogic
描述：表字段邏輯處理注解(邏輯刪除)
| 屬性 | 類型 | 必須指定 | 默認值 | 描述 |
| value | String | 否 | "" | 邏輯未刪除值 |
| delval | String | 否 | "" | 邏輯刪除值 |
@OrderBy
描述：內置Sql默認指定排序，優先級低于wrapper條件查詢
| 屬性 | 類型 | 必須指定 | 默認值 | 描述 |
| asc | boolean | 否 | true | 是否倒序查詢 |
| sort | short | 否 | Short.MAX_VALUE | 數字越小越靠前 |
@Mapper
寫在Dao類上，將類注入Spring容器中
@MapperScan()
@MapperScan(value = {"com.aqiuo.dao"})
寫在啟動類上，將需要掃描的包寫在value中
CRUD接口
Service CRUD 接口
說明: 通用 Service CRUD 封裝IService (opens new window)
- get 查詢單行 remove 刪除
- list 查詢集合
- page 分頁
- Mapper 泛型 T 為任意實體對象 建議如果存在自定義通用 Service 方法的可能，
- 請創建自己的 IBaseService 基礎 Mybatis-Plus 的基類 對象 Wrapper 為 條件構造器
save
// 插入一條記錄（選擇字段，策略插入） boolean save(T entity); // 插入（批量） boolean saveBatch(Collection<T> entityList); // 插入（批量） boolean saveBatch(Collection<T> entityList, int batchSize);
參數說明
| 類型 | 參數名 | 描述 |
| T | entity | 實體對象 |
| Collection | entityList | 實體對象集合 |
| int | batchSize | 插入批次數量 |
SaveOrUpdate
// TableId 注解存在更新記錄，否插入一條記錄，
//如果有這個記錄，則修改記錄，如果沒有就插入記錄
//如果沒有id就是插入，有就是修改
boolean saveOrUpdate(T entity);
// 根據updateWrapper嘗試更新，否繼續執行saveOrUpdate(T)方法
boolean saveOrUpdate(T entity, Wrapper<T> updateWrapper);
// 批量修改插入
boolean saveOrUpdateBatch(Collection<T> entityList);
// 批量修改插入
boolean saveOrUpdateBatch(Collection<T> entityList, int batchSize);參數說明
| 類型 | 參數名 | 描述 |
| T | entity | 實體對象 |
| Wrapper | updateWrapper | 實體對象封裝操作類 UpdateWrapper |
| Collection | entityList | 實體對象集合 |
| int | batchSize | 插入批次數量 |
Remove
// 根據 queryWrapper 設置的條件，刪除記錄
boolean remove(Wrapper<T> queryWrapper);
// 根據 ID 刪除
boolean removeById(Serializable id);
// 根據 columnMap 條件，刪除記錄（map存的條件）
boolean removeByMap(Map<String, Object> columnMap);
// 刪除（根據ID 批量刪除）
boolean removeByIds(Collection<? extends Serializable> idList);參數說明
| 類型 | 參數名 | 描述 |
| Wrapper | queryWrapper | 實體包裝類 QueryWrapper |
| Serializable | id | 主鍵 ID |
| Map | columnMap | 表字段 map 對象 |
| Collection | idList | 主鍵 ID 列表 |
Update
（注意updateById才能根據id修改內容，其他的要用wrapper）
// 根據 UpdateWrapper 條件，更新記錄 需要設置sqlset
boolean update(Wrapper<T> updateWrapper);
// 根據 whereWrapper 條件，更新記錄
boolean update(T updateEntity, Wrapper<T> whereWrapper);
// 根據 ID 選擇修改
boolean updateById(T entity);
// 根據ID 批量更新
boolean updateBatchById(Collection<T> entityList);
// 根據ID 批量更新
boolean updateBatchById(Collection<T> entityList, int batchSize);參數說明
| 類型 | 參數名 | 描述 |
| Wrapper | updateWrapper | 實體對象封裝操作類 UpdateWrapper |
| T | entity | 實體對象 |
| Collection | entityList | 實體對象集合 |
| int | batchSize | 更新批次數量 |
Get
// 根據 ID 查詢
T getById(Serializable id);
// 根據 Wrapper，查詢一條記錄。結果集，如果是多個會拋出異常，隨機取一條加上限制條件 wrapper.last("LIMIT 1")
T getOne(Wrapper<T> queryWrapper);
// 根據 Wrapper，查詢一條記錄
T getOne(Wrapper<T> queryWrapper, boolean throwEx);
// 根據 Wrapper，查詢一條記錄
Map<String, Object> getMap(Wrapper<T> queryWrapper);
// 根據 Wrapper，查詢一條記錄
<V> V getObj(Wrapper<T> queryWrapper, Function<? super Object, V> mapper);參數說明
| 類型 | 參數名 | 描述 |
| Serializable | id | 主鍵 ID |
| Wrapper | queryWrapper | 實體對象封裝操作類 QueryWrapper |
| boolean | throwEx | 有多個 result 是否拋出異常 |
| T | entity | 實體對象 |
| Function | mapper | 轉換函數 |
List
// 查詢所有
List<T> list();
// 查詢列表
List<T> list(Wrapper<T> queryWrapper);
// 查詢（根據ID 批量查詢）
Collection<T> listByIds(Collection<? extends Serializable> idList);
// 查詢（根據 columnMap 條件）
Collection<T> listByMap(Map<String, Object> columnMap);
// 查詢所有列表
List<Map<String, Object>> listMaps();
// 查詢列表
List<Map<String, Object>> listMaps(Wrapper<T> queryWrapper);
// 查詢全部記錄
List<Object> listObjs();
// 查詢全部記錄
<V> List<V> listObjs(Function<? super Object, V> mapper);
// 根據 Wrapper 條件，查詢全部記錄
List<Object> listObjs(Wrapper<T> queryWrapper);
// 根據 Wrapper 條件，查詢全部記錄
<V> List<V> listObjs(Wrapper<T> queryWrapper, Function<? super Object, V> mapper);參數說明
| 類型 | 參數名 | 描述 |
| Wrapper | queryWrapper | 實體對象封裝操作類 QueryWrapper |
| Collection | idList | 主鍵 ID 列表 |
| Map | columnMap | 表字段 map 對象 |
| Function | mapper | 轉換函數 |
Page
// 無條件分頁查詢
IPage<T> page(IPage<T> page);
// 條件分頁查詢
IPage<T> page(IPage<T> page, Wrapper<T> queryWrapper);
// 無條件分頁查詢
IPage<Map<String, Object>> pageMaps(IPage<T> page);
// 條件分頁查詢
IPage<Map<String, Object>> pageMaps(IPage<T> page, Wrapper<T> queryWrapper);參數說明
| 類型 | 參數名 | 描述 |
| IPage | page | 翻頁對象 |
| Wrapper | queryWrapper | 實體對象封裝操作類 QueryWrapper |
Count
// 查詢總記錄數 int count(); // 根據 Wrapper 條件，查詢總記錄數 int count(Wrapper<T> queryWrapper);
參數說明
| 類型 | 參數名 | 描述 |
| Wrapper | queryWrapper | 實體對象封裝操作類 QueryWrapper |
Chain
query (返回值類型是lanmdateQuery)
(存在有一個靜態方法引用非靜態方法的問題)
// 鏈式查詢 普通
QueryChainWrapper<T> query();
// 鏈式查詢 lambda 式。注意：不支持 Kotlin
LambdaQueryChainWrapper<T> lambdaQuery();// 示例：
query().eq("column", value).one();
lambdaQuery().eq(Entity::getId, value).list();update(返回值是LamdaQueryWrapper)
// 鏈式更改 普通
UpdateChainWrapper<T> update();
// 鏈式更改 lambda 式。注意：不支持 Kotlin
LambdaUpdateChainWrapper<T> lambdaUpdate();// 示例：
update().eq("column", value).remove();
lambdaUpdate().eq(Entity::getId, value).update(entity);Mapper CRUD 接口
說明: 通用 CRUD 封裝BaseMapper接口，為Mybatis-Plus啟動時自動解析實體表關系映射轉換為Mybatis內部對象注入容器 泛型 T 為任意實體類對象 參數 Serializable為任意類型的主鍵，Mybatis-Plus不推薦使用復合主鍵約定每一張表都有自己唯一的id主鍵 對象Wrapper 條件構造器
Insert
// 插入一條記錄 int insert(T entity);
參數說明
| 類型 | 參數名 | 描述 |
| T | entity | 實體對象 |
Delete
// 根據 entity 條件，刪除記錄 int delete(@Param(Constants.WRAPPER) Wrapper<T> wrapper); // 刪除（根據ID 批量刪除） int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList); // 根據 ID 刪除 int deleteById(Serializable id); // 根據 columnMap 條件，刪除記錄 int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
參數說明
| 類型 | 參數名 | 描述 |
| Wrapper | wrapper | 實體對象封裝操作類（可以為 null） |
| Collection | idList | 主鍵 ID 列表(不能為 null 以及 empty) |
| Serializable | id | 主鍵 ID |
| Map | columnMap | 表字段 map 對象 |
Update
// 根據 whereWrapper 條件，更新記錄 int update(@Param(Constants.ENTITY) T updateEntity, @Param(Constants.WRAPPER) Wrapper<T> whereWrapper); // 根據 ID 修改 int updateById(@Param(Constants.ENTITY) T entity);
使用提示:
在調用updateById方法前，需要在T entity（對應的實體類）中的主鍵屬性上加上@TableId注解。
參數說明
| 類型 | 參數名 | 描述 |
| T | entity | 實體對象 (set 條件值,可為 null) |
| Wrapper | updateWrapper | 實體對象封裝操作類（可以為 null,里面的 entity 用于生成 where 語句） |
Select
// 根據 ID 查詢 T selectById(Serializable id); // 根據 entity 條件，查詢一條記錄 T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper); // 查詢（根據ID 批量查詢） List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList); // 根據 entity 條件，查詢全部記錄 List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper); // 查詢（根據 columnMap 條件） List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap); // 根據 Wrapper 條件，查詢全部記錄 List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper); // 根據 Wrapper 條件，查詢全部記錄。注意： 只返回第一個字段的值 List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper); // 根據 entity 條件，查詢全部記錄（并翻頁） IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper); // 根據 Wrapper 條件，查詢全部記錄（并翻頁） IPage<Map<String, Object>> selectMapsPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper); // 根據 Wrapper 條件，查詢總記錄數 Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
參數說明
| 類型 | 參數名 | 描述 |
| Serializable | id | 主鍵 ID |
| Wrapper | queryWrapper | 實體對象封裝操作類（可以為 null） |
| Collection | idList | 主鍵 ID 列表(不能為 null 以及 empty) |
| Map | columnMap | 表字段 map 對象 |
| IPage | page | 分頁查詢條件（可以為 RowBounds.DEFAULT） |
條件構造器
說明：
- 以下出現的第一個入參 boolean condition 表示該條件是否加入最后生成的sql語句中，例如：
- query.like(StringUtils.isNotBlank(name),Entity::getName,name).eq(age!=null && age>=0,Entity::getAge,age)
- 以下代碼塊內的多個方法均從上往下補全個別 boolean 類別的入參，默認為 true
- 以下方法在入參中出現的 R 為泛型，在普通wrapper中 是String, 在 LambdaWrapper 中是函數
- 例如： Entity::getId,Entity 為實體類，getId 為字段 id 的getter Method)
- 以下方法入參中的 R column 均為數據庫字段，當 R 具體類型為 String 時則為數據庫字段名（字段名是數據庫關鍵字的自己用轉義符包裹!）
- 以下舉例均為使用普通wrapper ,入參為Map 和List 的均以json形式表現！
- 如果入參的Map或者List為空，則不會加入最后生成的SQL中！！！
警告
- wrapper 很重
- 傳輸 wrapper 可以類比為你的 controller 用 map 接收值(開發一時爽,維護火葬場)
- 正確的 RPC 調用姿勢是寫一個 DTO 進行傳輸,被調用方再根據 DTO 執行相應的操作
- 我們拒絕接受任何關于 RPC 傳輸 Wrapper 報錯相關的 issue 甚至 pr
AbstractWrapper
說明:
QueryWrapper(LambdaQueryWrapper) 和 UpdateWrapper(LambdaUpdateWrapper) 的父類
用于生成 sql 的 where 條件, entity 屬性也用于生成 sql 的 where 條件
注意: entity 生成的 where 條件與 使用各個 api 生成的 where 條件沒有任何關聯行為
allEq
allEq(Map<R, V> params) allEq(Map<R, V> params, boolean null2IsNull) allEq(boolean condition, Map<R, V> params, boolean null2IsNull)
全部eq(或個別isNull）
個別參數說明：
- params : key 為數字庫字段名 value為 字段值
- null2IsNull: 為true,則 在 map 的value為null時調用isNull方法，為false，則忽略value的值為null的
例一：allEq({id:1,name:"老王",age:null}) --->id = 1 and name = '老王' and age is null
例二：allEq({id:1,name:"老王",age:null}, false)-->id = 1 and name = '老王'
eq
eq(R column, Object val) eq(boolean condition, R column, Object val)
等于 =
例:?eq("name", "老王") - --> name = '老王'
ne
ne(R column, Object val) ne(boolean condition, R column, Object val)
不等于 <>
例： ne("name", "老王") ---> name <> '老王'
gt
gt(R column, Object val) gt(boolean condition, R column, Object val)
- 大于 >
- 例：gt("age",18) - - -> age>18
ge
ge(R column, Object val) ge(boolean condition, R column, Object val)
- 大于等于 >=
- 例:?ge("age", 18) --> age >= 18
lt
lt(R column, Object val) lt(boolean condition, R column, Object val)
- 小于
- 例:?lt("age", 18)--->age < 18
#le
le(R column, Object val) le(boolean condition, R column, Object val)
- 小于等于
- 例:?le("age", 18)--->age
#between
between(R column, Object val1, Object val2) between(boolean condition, R column, Object val1, Object val2)
- BETWEEN 值1 AND 值2
- 例:?between("age", 18, 30)--->age between 18 and 30
#notBetween
notBetween(R column, Object val1, Object val2) notBetween(boolean condition, R column, Object val1, Object val2)
- NOT BETWEEN 值1 AND 值2
- 例:?notBetween("age", 18, 30)--->age not between 18 and 30
#like
like(R column, Object val) like(boolean condition, R column, Object val)
- LIKE '%值%'
- 例:?like("name", "王")--->name like '%王%'
#notLike
notLike(R column, Object val) notLike(boolean condition, R column, Object val)
- NOT LIKE '%值%'
- 例:?notLike("name", "王")--->name not like '%王%'
#likeLeft
likeLeft(R column, Object val) likeLeft(boolean condition, R column, Object val)
- LIKE '%值'
- 例:?likeLeft("name", "王")--->name like '%王'
likeRight
likeRight(R column, Object val) likeRight(boolean condition, R column, Object val)
- LIKE '值%'
- 例:?likeRight("name", "王")--->name like '王%'
notLikeLeft
notLikeLeft(R column, Object val) notLikeLeft(boolean condition, R column, Object val)
- NOT LIKE '%值'
- 例:?notLikeLeft("name", "王")--->name not like '%王'
notLikeRight
notLikeRight(R column, Object val) notLikeRight(boolean condition, R column, Object val)
- NOT LIKE '值%'
- 例:?notLikeRight("name", "王")--->name not like '王%'
#isNull
isNull(R column) isNull(boolean condition, R column)
- 字段 IS NULL
- 例:?isNull("name")--->name is null
isNotNull
isNotNull(R column) isNotNull(boolean condition, R column)
- 字段 IS NOT NULL
- 例:?isNotNull("name")--->name is not null
in
in(R column, Collection<?> value) in(boolean condition, R column, Collection<?> value)
- 字段 IN (value.get(0), value.get(1), ...)
- 例:?in("age",{1,2,3})--->age in (1,2,3)
in(R column, Object... values) in(boolean condition, R column, Object... values)
- 字段 IN (v0, v1, ...)
- 例:?in("age", 1, 2, 3)--->age in (1,2,3)
notIn
notIn(R column, Collection<?> value) notIn(boolean condition, R column, Collection<?> value)
- 字段 NOT IN (value.get(0), value.get(1), ...)
- 例:?notIn("age",{1,2,3})-->age not in (1,2,3)
notIn(R column, Object... values) notIn(boolean condition, R column, Object... values)
- 字段 NOT IN (v0, v1, ...)
- 例:?notIn("age", 1, 2, 3)--->age not in (1,2,3)
inSql
inSql(R column, String inValue) inSql(boolean condition, R column, String inValue)
- 字段 IN ( sql語句 )
- 例:?inSql("age", "1,2,3,4,5,6")--->age in (1,2,3,4,5,6)
- 例:?inSql("id", "select id from table where id < 3")--->id in (select id from table where id < 3)
notInSql
notInSql(R column, String inValue) notInSql(boolean condition, R column, String inValue)
- 字段 NOT IN ( sql語句 )
- 例:?notInSql("age", "1,2,3,4,5,6")--->age not in (1,2,3,4,5,6)
- 例:?notInSql("id", "select id from table where id < 3")--->id not in (select id from table where id < 3)
groupBy
groupBy(R... columns) groupBy(boolean condition, R... columns)
- 分組：GROUP BY 字段, ...
- 例:?groupBy("id", "name")--->group by id,name
orderByAsc
orderByAsc(R... columns) orderByAsc(boolean condition, R... columns)
- 排序：ORDER BY 字段, ... ASC
- 例:?orderByAsc("id", "name")--->order by id ASC,name ASC
orderByDesc
orderByDesc(R... columns) orderByDesc(boolean condition, R... columns)
- 排序：ORDER BY 字段, ... DESC
- 例:?orderByDesc("id", "name")--->order by id DESC,name DESC
orderBy
orderBy(boolean condition, boolean isAsc, R... columns)
- 排序：ORDER BY 字段, ...
- 例:?orderBy(true, true, "id", "name")--->order by id ASC,name ASC
having
having(String sqlHaving, Object... params) having(boolean condition, String sqlHaving, Object... params)
- HAVING ( sql語句 )
- 例:?having("sum(age) > 10")--->having sum(age) > 10
- 例:?having("sum(age) > {0}", 11)--->having sum(age) > 11
func
func(Consumer<Children> consumer) func(boolean condition, Consumer<Children> consumer)
- func 方法(主要方便在出現if...else下調用不同方法能不斷鏈)
- 例:?func(i -> if(true) {i.eq("id", 1)} else {i.ne("id", 1)})
or
or() or(boolean condition)
- 拼接 OR
注意事項:
主動調用or表示緊接著下一個方法不是用and連接!(不調用or則默認為使用and連接)
- 例:?eq("id",1).or().eq("name","老王") --->id = 1 or name = '老王'
or(Consumer<Param> consumer) or(boolean condition, Consumer<Param> consumer)
- OR 嵌套
- 例:?or(i -> i.eq("name", "李白").ne("status", "活著"))--->or (name = '李白' and status <> '活著')
and
and(Consumer<Param> consumer) and(boolean condition, Consumer<Param> consumer)
- AND 嵌套
- 例:?and(i -> i.eq("name", "李白").ne("status", "活著"))--->and (name = '李白' and status <> '活著')
nested
nested(Consumer<Param> consumer) nested(boolean condition, Consumer<Param> consumer)
- 正常嵌套 不帶 AND 或者 OR
- 例:?nested(i -> i.eq("name", "李白").ne("status", "活著")) --->(name = '李白' and status <> '活著')
apply
apply(String applySql, Object... params) apply(boolean condition, String applySql, Object... params)
- 拼接 sql
- 注意事項:
該方法可用于數據庫函數?動態入參的params對應前面applySql內部的{index}部分.這樣是不會有sql注入風險的,反之會有!
- 例:?apply("id = 1") id = 1
- 例:?apply("date_format(dateColumn,'%Y-%m-%d') = '2008-08-08'")--->date_format(dateColumn,'%Y-%m-%d') = '2008-08-08'")
- 例:?apply("date_format(dateColumn,'%Y-%m-%d') = {0}", "2008-08-08")--->date_format(dateColumn,'%Y-%m-%d') = '2008-08-08'")
last
last(String lastSql) last(boolean condition, String lastSql)
- 無視優化規則直接拼接到 sql 的最后
注意事項:
只能調用一次,多次調用以最后一次為準 有sql注入的風險,請謹慎使用
- 例:?last("limit 1")
exists
exists(String existsSql) exists(boolean condition, String existsSql)
- 拼接 EXISTS ( sql語句 )
- 例:?exists("select id from table where age = 1")--->exists (select id from table where age = 1)
notExists
notExists(String notExistsSql) notExists(boolean condition, String notExistsSql)
- 拼接 NOT EXISTS ( sql語句 )
- 例:?notExists("select id from table where age = 1")--->not exists (select id from table where age = 1)
QueryWrapper
說明:
繼承自 AbstractWrapper ,自身的內部屬性 entity 也用于生成 where 條件
及 LambdaQueryWrapper, 可以通過 new QueryWrapper().lambda() 方法獲取
select
select(String... sqlSelect) select(Predicate<TableFieldInfo> predicate) select(Class<T> entityClass, Predicate<TableFieldInfo> predicate)
- 設置查詢字段
說明:
以上方法分為兩類.
第二類方法為:過濾查詢字段(主鍵除外),入參不包含 class 的調用前需要wrapper內的entity屬性有值! 這兩類方法重復調用以最后一次為準
- 例:?select("id", "name", "age")
- 例:?select(i -> i.getProperty().startsWith("test"))
UpdateWrapper
說明:
繼承自?AbstractWrapper?,自身的內部屬性?entity?也用于生成 where 條件
及?LambdaUpdateWrapper, 可以通過?new UpdateWrapper().lambda()?方法獲取!
set
set(String column, Object val) set(boolean condition, String column, Object val)
- SQL SET 字段
- 例:?set("name", "老李頭")
- 例:?set("name", "")空字符串
- 例:?set("name", null) null
setSql
setSql(String sql)
- 設置 SET 部分 SQL
- 例:?setSql("name = '老李頭'")
lambda
(這個lambda可以用方法引用，其他不行，支持鏈式編程)
- 獲取?LambdaWrapper
在QueryWrapper是LambdaQueryWrapper
在UpdateWrapper是LambdaUpdateWrapper
樂觀OptimisticLockerInnerInterceptor
當要更新一條記錄的時候，希望這條記錄沒有被別人更新
樂觀鎖實現方式：
取出記錄時，獲取當前 version更新時，帶上這個 version執行更新時， set version = newVersion where version = oldVersion如果 version 不對，就更新失敗
spring boot 注解方式:
@Bean public MybatisPlusInterceptor mybatisPlusInterceptor() { MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor(); interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor()); return interceptor; }
2.在實體類的字段上加上@Version注解
@Version private Integer version;
示例
// Spring Boot 方式 @Configuration @MapperScan("按需修改") public class MybatisPlusConfig { /** * 舊版 */ @Bean public OptimisticLockerInterceptor optimisticLockerInterceptor() { return new OptimisticLockerInterceptor(); } /** * 新版 */ @Bean public MybatisPlusInterceptor mybatisPlusInterceptor() { MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor(); mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor()); return mybatisPlusInterceptor; } }
代碼生成器
引入依賴
<dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>最新版本</version> </dependency>
快速生成
FastAutoGenerator.create("url", "username", "password") .globalConfig(builder -> { builder.author("baomidou") // 設置作者 .enableSwagger() // 開啟 swagger 模式 .fileOverride() // 覆蓋已生成文件 .outputDir("D://"); // 指定輸出目錄 }) .dataSourceConfig(builder -> builder.typeConvertHandler((globalConfig, typeRegistry, metaInfo) -> { int typeCode = metaInfo.getJdbcType().TYPE_CODE; if (typeCode == Types.SMALLINT) { // 自定義類型轉換 return DbColumnType.INTEGER; } return typeRegistry.getColumnType(metaInfo); })) .packageConfig(builder -> { builder.parent("com.baomidou.mybatisplus.samples.generator") // 設置父包名 .moduleName("system") // 設置父包模塊名 .pathInfo(Collections.singletonMap(OutputFile.xml, "D://")); // 設置mapperXml生成路徑 }) .strategyConfig(builder -> { builder.addInclude("t_simple") // 設置需要生成的表名 .addTablePrefix("t_", "c_"); // 設置過濾表前綴 }) .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默認的是Velocity引擎模板 .execute();
