1.List item
區別一
如果Mybatis Plus是扳手,那Mybatis Generator就是生產扳手的工廠。
通俗來講——
MyBatis:一種操作數據庫的框架,提供一種Mapper類,支持讓你用java代碼進行增刪改查的數據庫操作,省去了每次都要手寫sql語句的麻煩。但是!有一個前提,你得先在xml中寫好sql語句,是不是很麻煩?於是有下面的↓
Mybatis Generator:自動為Mybatis生成簡單的增刪改查sql語句的工具,省去一大票時間,兩者配合使用,開發速度快到飛起。至於標題說的↓
Mybatis Plus:國人團隊苞米豆在Mybatis的基礎上開發的框架,在Mybatis基礎上擴展了許多功能,榮獲了2018最受歡迎國產開源軟件第5名,當然也有配套的↓
Mybatis Plus Generator:同樣為苞米豆開發,比Mybatis Generator更加強大,支持功能更多,自動生成Entity、Mapper、Service、Controller等
總結:
數據庫框架:Mybatis Plus > Mybatis
代碼生成器:Mybatis Plus Generator > Mybatis Generator
區別二
Mybatis-Plus是一個Mybatis的增強工具,它在Mybatis的基礎上做了增強,卻不做改變。我們在使用Mybatis-Plus之后既可以使用Mybatis-Plus的特有功能,又能夠正常使用Mybatis的原生功能。Mybatis-Plus(以下簡稱MP)是為簡化開發、提高開發效率而生,但它也提供了一些很有意思的插件,比如SQL性能監控、樂觀鎖、執行分析等。
Mybatis雖然已經給我們提供了很大的方便,但它還是有不足之處,實際上沒有什么東西是完美的,MP的存在就是為了稍稍彌補Mybatis的不足。在我們使用Mybatis時會發現,每當要寫一個業務邏輯的時候都要在DAO層寫一個方法,再對應一個SQL,即使是簡單的條件查詢、即使僅僅改變了一個條件都要在DAO層新增一個方法,針對這個問題,MP就提供了一個很好的解決方案,之后我會進行介紹。另外,MP的代碼生成器也是一個很有意思的東西,它可以讓我們避免許多重復性的工作,下面我將介紹如何在你的項目中集成MP。
一、 集成步驟↓:(首先,你要有個spring項目)
集成依賴,pom中加入依賴即可,不多說:
Java代碼 收藏代碼
說明:筆者使用的版本為:mybatis-plus.version=2.1-gamma,上邊的代碼中有兩個依賴,第一個是mybatis-plus核心依賴,第二個是使用代碼生成器時需要的模板引擎依賴,若果你不打算使用代碼生成器,此處可不引入。
注意:mybatis-plus的核心jar包中已集成了mybatis和mybatis-spring,所以為避免沖突,請勿再次引用這兩個jar包。
二、 在spring中配置MP:
注意:執行分析攔截器和性能分析推薦只在開發時調試程序使用,為保證程序性能和穩定性,建議在生產環境中注釋掉這兩個插件。
數據源:(此處使用druid)
到此,MP已經集成進我們的項目中了,下面將介紹它是如何簡化我們的開發的。
**
三、 簡單的CURD操作↓:
**
假設我們有一張user表,且已經建立好了一個與此表對應的實體類User,我們來介紹對user的簡單增刪改查操作。
建立DAO層接口。我們在使用普通的mybatis時會建立一個DAO層接口,並對應一個xml用來寫SQL。在這里我們同樣要建立一個DAO層接口,但是若無必要,我們甚至不需要建立xml,就可以進行資源的CURD操作了,我們只需要讓我們建立的DAO繼承MP提供的BaseMapper<?>即可:
public interface UserMapper extends BaseMapper { }
然后在我們需要做數據CURD時,像下邊這樣就好了:
Java代碼 收藏代碼
// 初始化 影響行數
int result = 0;
// 初始化 User 對象
User user = new User();
// 插入 User (插入成功會自動回寫主鍵到實體類)
user.setName(“Tom”);
result = userMapper.insert(user);
// 更新 User
user.setAge(18);
result = userMapper.updateById(user);//user要設置id哦,具體的在下邊我會詳細介紹
// 查詢 User
User exampleUser = userMapper.selectById(user.getId());
// 查詢姓名為‘張三’的所有用戶記錄
List userList = userMapper.selectList(
new EntityWrapper().eq(“name”, “張三”)
);
// 刪除 User
result = userMapper.deleteById(user.getId());
方便吧?如果只使用mybatis可是要寫4個SQL和4個方法喔,當然了,僅僅上邊這幾個方法還遠遠滿足不了我們的需求,請往下看:
**
多條件分頁查詢:
**
Java代碼 收藏代碼
// 分頁查詢 10 條姓名為‘張三’、性別為男,且年齡在18至50之間的用戶記錄
/**等價於SELECT *
*FROM sys_user
*WHERE (name=‘張三’ AND sex=0 AND age BETWEEN ‘18’ AND ‘50’)
*LIMIT 0,10
*/
下邊這個,多條件構造器。其實對於條件過於復雜的查詢,筆者還是建議使用原生mybatis的方式實現,易於維護且邏輯清晰,如果所有的數據操作都強行使用MP,就失去了MP簡化開發的意義了。所以在使用時請按實際情況取舍,在這里還是先介紹一下。
條件構造一(上邊方法的entityWrapper參數):
條件構造二(同上):
int buyCount = selectCount(Condition.create()
.setSqlSelect(“sum(quantity)”)
.isNull(“order_id”)
.eq(“user_id”, 1)
.eq(“type”, 1)
.in(“status”, new Integer[]{0, 1})
.eq(“product_id”, 1)
.between(“created_time”, startDate, currentDate)
.eq(“weal”, 1));
自定義條件使用entityWrapper:
List selectMyPage(RowBounds rowBounds, @Param(“ew”) Wrapper wrapper);
SELECT * FROM user ${ew.sqlSegment} *注意:此處不用擔心SQL注入,MP已對ew做了字符串轉義處理。 其實在使用MP做數據CURD時,還有另外一個方法,AR(ActiveRecord ),很簡單,讓我們的實體類繼承MP提供Model<?>就好了,這和我們常用的方法可能會有些不同,下邊簡單說一下吧:*
//實體類
@TableName(“sys_user”) // 注解指定表名
public class User extends Model {
… // fields
… // getter and setter
/** 指定主鍵 */
@Override
protected Serializable pkVal() { //一定要指定主鍵哦
return this.id;
}
}
下邊就是CURD操作了:
// 初始化 成功標識
boolean result = false;
// 初始化 User
User user = new User();
// 保存 User
user.setName(“Tom”);
result = user.insert();
// 更新 User
user.setAge(18);
result = user.updateById();
// 查詢 User
User exampleUser = t1.selectById();
// 查詢姓名為‘張三’的所有用戶記錄
List userList1 = user.selectList(
new EntityWrapper().eq(“name”, “張三”)
);
// 刪除 User
result = t2.deleteById();
// 分頁查詢 10 條姓名為‘張三’、性別為男,且年齡在18至50之間的用戶記錄
List userList = user.selectPage(
new Page(1, 10),
new EntityWrapper().eq(“name”, “張三”)
.eq(“sex”, 0)
.between(“age”, “18”, “50”)
).getRecords();
就是這樣了,可能你會說MP封裝的有些過分了,這樣做會分散數據邏輯到不同的層面中,難以管理,使代碼難以理解。其實確實是這樣,這就需要你在使用的時候注意一下了,在簡化開發的同時也要保證你的代碼層次清晰,做一個戰略上的設計或者做一個取舍與平衡。
**
其實上邊介紹的功能也不是MP的全部啦,下邊介紹一下MP最有意思的模塊——代碼生成器。
**
步驟↓:
如上邊所說,使用代碼生成器一定要引入velocity-engine-core(模板引擎)這個依賴。
准備工作:
選擇主鍵策略,就是在上邊最開始時候我介紹MP配置時其中的這項配置,如果你不記得了,請上翻!MP提供了如下幾個主鍵策略: 值 描述
IdType.AUTO 數據庫ID自增
IdType.INPUT 用戶輸入ID
IdType.ID_WORKER 全局唯一ID,內容為空自動填充(默認配置)
IdType.UUID 全局唯一ID,內容為空自動填充
MP默認使用的是ID_WORKER,這是MP在Sequence的基礎上進行部分優化,用於產生全局唯一ID。
表及字段命名策略選擇,同上,還是在那個配置中。下邊這段復制至MP官方文檔:
在MP中,我們建議數據庫表名采用下划線命名方式,而表字段名采用駝峰命名方式。
這么做的原因是為了避免在對應實體類時產生的性能損耗,這樣字段不用做映射就能直接和實體類對應。當然如果項目里不用考慮這點性能損耗,那么你采用下滑線也是沒問題的,只需要在生成代碼時配置dbColumnUnderline屬性就可以。
建表(命名規則依照剛才你所配置的,這會影響生成的代碼的類名、字段名是否正確)。
執行下邊的main方法,生成代碼:
說明:中間的內容請自行修改,注釋很清晰。
成功生成代碼,將生成的代碼拷貝到你的項目中就可以了,這個東西節省了我們大量的時間和精力!
下邊我將介紹MP提供的很有意思的插件: 分頁插件:插件的配置請看上邊開篇時的MP配置部分。
public interface UserMapper{//可以繼承或者不繼承BaseMapper
/**
*
* 查詢 : 根據state狀態查詢用戶列表,分頁顯示
*
*
* @param page
* 翻頁對象,可以作為 xml 參數直接使用,傳遞參數 Page 即自動分頁
* @param state
* 狀態
* @return
*/
List selectUserList(Pagination page, Integer state);
}
public Page selectUserPage(Page page, Integer state) {
page.setRecords(userMapper.selectUserList(page, state));
return page;
}
SELECT * FROM user WHERE state=#{state}
*樂觀鎖插件:當要更新一條記錄的時候,希望這條記錄沒有被別人更新過。 其實原理很簡單:
**
取出記錄時,獲取當前version
更新時,帶上這個version
執行更新時, set version = yourVersion+1 where version = yourVersion
如果version不對,就更新失敗
插件的配置請看上邊開篇時的MP配置部分,使用該插件的表必須擁有能夠作為version的字段,比如update_date:
Java代碼 收藏代碼
public class User {
}
說明:version僅支持int,Integer,long,Long,Date,Timestamp類型。
Java代碼 收藏代碼
int id = 100;
int version = 2;
User u = new User();
u.setId(id);
u.setVersion(version);
u.setXXX(xxx);
if(userService.updateById(u)){
System.out.println(“Update successfully”);
}else{
System.out.println(“Update failed due to modified by others”);
}
//等價於:update tbl_user set name=‘update’,version=3 where id=100 and version=2;
*執行分析插件,作用是分析處理 DELETE UPDATE 語句, 防止小白或者惡意 delete update 全表操作,不推薦生產環境使用。具體配置請看上邊開篇時的MP配置部分。
性能分析插件,用於輸出每條 SQL 語句及其執行時間,不推薦生產環境使用。具體配置請看上邊開篇時的MP配置部分。
xml熱加載插件,具體配置請看上邊開篇時的MP配置部分。
**
以下是注解說明,摘自官方文檔: 注解說明**
表名注解 @TableName
com.baomidou.mybatisplus.annotations.TableName
值 描述
value 表名( 默認空 )
resultMap xml 字段映射 resultMap ID
主鍵注解 @TableId
com.baomidou.mybatisplus.annotations.TableId
值 描述
value 字段值(駝峰命名方式,該值可無)
type 主鍵 ID 策略類型( 默認 INPUT ,全局開啟的是 ID_WORKER )
暫不支持組合主鍵
字段注解 @TableField
com.baomidou.mybatisplus.annotations.TableField
值 描述
value 字段值(駝峰命名方式,該值可無)
el 詳看注釋說明
exist 是否為數據庫表字段( 默認 true 存在,false 不存在 )
strategy 字段驗證 ( 默認 非 null 判斷,查看 com.baomidou.mybatisplus.enums.FieldStrategy )
fill 字段填充標記 ( FieldFill, 配合自動填充使用 )
字段填充策略 FieldFill
值 描述
DEFAULT 默認不處理
INSERT 插入填充字段
UPDATE 更新填充字段
INSERT_UPDATE 插入和更新填充字段
序列主鍵策略 注解 @KeySequence
com.baomidou.mybatisplus.annotations.KeySequence
值 描述
value 序列名
clazz id的類型
樂觀鎖標記注解 @Version
com.baomidou.mybatisplus.annotations.Version
排除非表字段、查看文檔常見問題部分!
總結:MP的宗旨是簡化開發,但是它在提供方便的同時卻容易造成代碼層次混亂,我們可能會把大量數據邏輯寫到service層甚至contoller層中,使代碼難以閱讀。凡事過猶不及,在使用MP時一定要做分析,不要將所有數據操作都交給MP去實現。畢竟MP只是mybatis的增強工具,它並沒有侵入mybatis的原生功能,在使用MP的增強功能的同時,原生mybatis的功能依然是可以正常使用的