MyBatis-Plus | 最優雅最簡潔地完成數據庫操做
引言
兩點：java
一，使用MyBatis-Plus最新版（3.0.1）完成相關操做git
二，很久沒寫MyBatis操做數據庫的博文了，有沒有想我啊，哈哈，認真看，認真聽，認真學。github
測試效果：sql
下面聽我細細道來，MyBatis-Plus的優雅、簡潔與強大。數據庫
代碼生成器
代碼生成器，又被叫作逆向工程，MyBatis官方爲了推廣，本身也寫了一個，我以前也使用這個，功能也是很是強大，強大覺得支持自定義配置，那麼問題來了，我該怎麼配置才合理呢，因此，有人把全部的配置項都弄成中文的，還有人開發了生成插件，這些在我以往的博文中都看看到。MyBatis-Plus的代碼生成器到底怎麼樣，這我就不評判了，我就這樣說，用用看吧。apache
在MyBatis-Plus的官網文檔中，有將代碼生成器的問題，有配置詳解，也有項目示例代碼，複製來就可用。json
我此次是用MP 3.0.1，也就是最新版，官方尚未更新呢，因此，我去找了好久的源碼，纔將這個完成，勉強適合本身的了。這個在 CodeGenerator Module中，能夠下下下來，導入到IDE中，看一下，修改配置就能運行。有問題，也能夠與我討論。設計模式
功能列表：mybatis
-
[✔] 自動生成model類app
-
[✔] 自動生成dao接口
-
[✔] 自動生成xml文件
-
[✔] 自動生成service接口
-
[✔] 自動生成service實現類
-
[✔] model支持Builder模式
-
[✔] 支持swagger2
-
[✔] 支持生成數據庫字段常量
-
[✔] 支持生成Kotlin代碼
-
[] ......
項目初始化
第一步：pom.xml引入MyBatis-Plus依賴，注意，不須要再引入MyBatis的包，由於我這裏使用Spring Boot搭建的工程，全部由於方式見下：
<dependencies>
...
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.1</version>
</dependency>
...
</dependencies>
第二步：將生成的代碼，拷貝到相應的包下
第三步：在配置文件中進行相應的配置
具體配置可參考官網，這裏須要注意這樣幾個地方：
mybatis-plus:
# xml
mapper-locations: classpath:mapper/*Mapper.xml
# 實體掃描，多個package用逗號或者分號分隔
type-aliases-package: com.fengwenyi.mp3demo.model
configuration:
# 這個配置會將執行的sql打印出來，在開發或測試的時候能夠用
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
第四步：在啓動類上添加下面的註解
@EnableTransactionManagement
@MapperScan("com.fengwenyi.mp3demo.dao")
增刪改
Service
咱們一塊兒去看源碼 com.baomidou.mybatisplus.extension.service.IService<T>
增長：
/**
* <p>
* 插入一條記錄（選擇字段，策略插入）
* </p>
*
* @param entity 實體對象
*/
boolean save(T entity);
修改：
/**
* <p>
* 根據 ID 選擇修改
* </p>
*
* @param entity 實體對象
*/
boolean updateById(T entity);
/**
* <p>
* 根據 whereEntity 條件，更新記錄
* </p>
*
* @param entity 實體對象
* @param updateWrapper 實體對象封裝操做類
* {@link com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper}
*/
boolean update(T entity, Wrapper<T> updateWrapper);
刪除：
/**
* <p>
* 根據 ID 刪除
* </p>
*
* @param id 主鍵ID
*/
boolean removeById(Serializable id);
/**
* <p>
* 根據 entity 條件，刪除記錄
* </p>
*
* @param queryWrapper 實體包裝類
* {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
*/
boolean remove(Wrapper<T> queryWrapper);
Mapper
com.baomidou.mybatisplus.core.mapper.BaseMapper<T>
增長:
/**
* <p>
* 插入一條記錄
* </p>
*
* @param entity 實體對象
*/
int insert(T entity);
修改：
/**
* <p>
* 根據 whereEntity 條件，更新記錄
* </p>
*
* @param entity 實體對象 (set 條件值,不能爲 null)
* @param updateWrapper 實體對象封裝操做類（能夠爲 null,裏面的 entity 用於生成 where 語句）
*/
int update(@Param(Constants.ENTITY) T entity,
@Param(Constants.WRAPPER) Wrapper<T> updateWrapper);
/**
* <p>
* 根據 ID 修改
* </p>
*
* @param entity 實體對象
*/
int updateById(@Param(Constants.ENTITY) T entity);
刪除：
/**
* <p>
* 根據 entity 條件，刪除記錄
* </p>
*
* @param queryWrapper 實體對象封裝操做類（能夠爲 null）
*/
int delete(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
/**
* <p>
* 根據 ID 刪除
* </p>
*
* @param id 主鍵ID
*/
int deleteById(Serializable id);
以上至關因而經常使用API了，咱們去看看，他是怎麼實現的。毫無疑問，Mapper是底層，Service調用Mapper去執行sql，完成相關操做，因此，你徹底能夠直接調用Mapper完成相關操做，就跟使用MyBatis同樣。下面咱們去看看，他幫咱們寫的Service是什麼樣子，這裏只看一個修改操做吧。
接口：
/**
* <p>
* 根據 whereEntity 條件，更新記錄
* </p>
*
* @param entity 實體對象
* @param updateWrapper 實體對象封裝操做類
* {@link com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper}
*/
boolean update(T entity, Wrapper<T> updateWrapper);
實現：
@Override
public boolean update(T entity, Wrapper<T> updateWrapper) {
return ServiceImpl.retBool(baseMapper.update(entity, updateWrapper));
}
/**
* <p>
* 判斷數據庫操做是否成功
* </p>
* <p>
* 注意！！ 該方法爲 Integer 判斷，不可傳入 int 基本類型
* </p>
*
* @param result 數據庫操做返回影響條數
* @return boolean
*/
protected static boolean retBool(Integer result) {
return SqlHelper.retBool(result);
}
/**
* <p>
* 判斷數據庫操做是否成功
* </p>
*
* @param result 數據庫操做返回影響條數
* @return boolean
*/
public static boolean retBool(Integer result) {
return null != result && result >= 1;
}
哈哈，是否是咱們本身也會這樣寫啊！
查詢
接下來，咱們一塊兒討論下查詢吧。
MP 3.x，查詢接口發生了很大的變化，反正我是不喜歡的，你就弄一個什麼開頭啊，到時候，我一點就知道有哪些方法了，他這裏有 list*, get*，反正就是一個字——不必。
先看下接口說明：
/**
* <p>
* 查詢列表
* </p>
*
* @param queryWrapper 實體對象封裝操做類
* {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
*/
List<T> list(Wrapper<T> queryWrapper);
/**
* <p>
* 根據 ID 查詢
* </p>
*
* @param id 主鍵ID
*/
T getById(Serializable id);
/**
* <p>
* 根據 Wrapper，查詢一條記錄
* </p>
*
* @param queryWrapper 實體對象封裝操做類
* {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
*/
T getOne(Wrapper<T> queryWrapper);
嗯，差很少了吧，這樣須要注意這樣一個方法：
/**
* <p>
* 從list中取第一條數據返回對應List中泛型的單個結果
* </p>
*
* @param list
* @param <E>
* @return
*/
public static <E> E getObject(List<E> list) {
if (CollectionUtils.isNotEmpty(list)) {
int size = list.size();
if (size > 1) {
SqlHelper.logger.warn(
String.format("Warn: execute Method There are %s results.", size));
}
return list.get(0);
}
return null;
}
下面說下分頁的問題
根據官網的說法，須要藉助插件，這咱們是能夠理解。
在Spring Boot啓動類裏面添加：
/**
* 分頁插件
*/
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
這樣就可使用他提供的分頁接口了：
/**
* <p>
* 翻頁查詢
* </p>
*
* @param page 翻頁對象
* @param queryWrapper 實體對象封裝操做類
* {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
*/
IPage<T> page(IPage<T> page, Wrapper<T> queryWrapper);
咱們去看一下：
@Override
public IPage<T> page(IPage<T> page, Wrapper<T> queryWrapper) {
queryWrapper = (Wrapper<T>) SqlHelper.fillWrapper(page, queryWrapper);
return baseMapper.selectPage(page, queryWrapper);
}
/**
* <p>
* 填充Wrapper
* </p>
*
* @param page 分頁對象
* @param wrapper SQL包裝對象
*/
@SuppressWarnings("unchecked")
public static Wrapper<?> fillWrapper(IPage<?> page, Wrapper<?> wrapper) {
if (null == page) {
return wrapper;
}
if (ArrayUtils.isEmpty(page.ascs())
&& ArrayUtils.isEmpty(page.descs())
&& ObjectUtils.isEmpty(page.condition())) {
return wrapper;
}
QueryWrapper qw;
if (null == wrapper) {
qw = new QueryWrapper<>();
} else {
qw = (QueryWrapper) wrapper;
}
// 排序
if (ArrayUtils.isNotEmpty(page.ascs())) {
qw.orderByAsc(page.ascs());
}
if (ArrayUtils.isNotEmpty(page.descs())) {
qw.orderByDesc(page.descs());
}
// MAP 參數查詢
if (ObjectUtils.isNotEmpty(page.condition())) {
qw.allEq(page.condition());
}
return qw;
}
/**
* <p>
* 根據 entity 條件，查詢所有記錄（並翻頁）
* </p>
*
* @param page 分頁查詢條件（能夠爲 RowBounds.DEFAULT）
* @param queryWrapper 實體對象封裝操做類（能夠爲 null）
*/
IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
分頁的代碼大抵就是這樣，我以前也本身寫過，思路仍是至關來講比較簡單，關鍵是看你的查詢添加如何封裝，分頁類如何構造。
這裏有一點說明：
分頁從 1 開始 !!!
枚舉類
一、實現 接口
/**
* <p>
* 自定義枚舉接口
* </p>
*
* @author hubin
* @since 2017-10-11
*/
public interface IEnum<T extends Serializable> {
/**
* 枚舉數據庫存儲值
*/
T getValue();
}
二、實現注意
@Override
public Integer getValue() {
return this.value;
}
@JsonValue
public String getDesc() {
return desc;
}
這是Jackson的寫法，我沒用FastJson，因此用的夥伴，去官網看一下：FastJson看官網。
3:被忘了在配置文件中添加掃描：
mybatis-plus: # 掃描枚舉類 # 支持統配符 * 或者 ; 分割 type-enums-package: com.fengwenyi.mp3demo.enums
差很少了吧，好像
邏輯刪除
一、代碼生成器中配置：
new StrategyConfig().setLogicDeleteFieldName("is_delete") // 邏輯刪除屬性名稱
或者，你能夠手寫，參考：
@ApiModelProperty(value = "是否邏輯刪除（true：刪除；false：正常（默認））")
@TableLogic
private Boolean isDelete;
二、自定義數據庫的值：
mybatis-plus:
global-config:
db-config:
#邏輯刪除配置
logic-delete-value: 1
logic-not-delete-value: 0
MyBatis-Plus-Example
MyBatis-Plus的代碼都會上傳到github上
https://github.com/fengwenyi/MyBatis-Plus-Example
參考資料
- 1. MyBatis-Plus | 最優雅最簡潔地完成數據庫操做
- 2. 如何優雅地操做數據庫？ORM瞭解一下
- 3. nodejs如何簡潔優雅的訪問mysql數據庫
- 4. Node.js 如何簡潔優雅的訪問 MySQL 數據庫
- 5. 如何寫出最簡潔優雅的網絡封裝 Moya + RxSwift
- 6. 數據庫最基本操做
- 7. 最優化問題的簡潔介紹
- 8. PHP開發-最簡單的數據庫操做，使用ezSQL
- 9. 最新 MySQL數據庫安裝詳解（簡潔快速）
- 10. 【Android】實現登陸、註冊、數據庫操做（極簡潔）
- 更多相關文章...
- • NoSQL數據庫的優勢有哪些？ - NoSQL教程
- • BASE原理與最終一致性 - NoSQL教程
- • Flink 數據傳輸及反壓詳解
- • Tomcat學習筆記（史上最全tomcat學習筆記）
-
每一个你不满意的现在，都有一个你没有努力的曾经。