Spring整合MybatisPlus學習筆記

簡介

MyBatis-Plus（簡稱 MP）是一個 MyBatis 的增強工具，在 MyBatis 的基礎上只做增強不做改變，為簡化開發、提高效率而生

特性

• 無侵入：只做增強不做改變，引入它不會對現有工程產生影響，如絲般順滑
• 損耗小：啟動即會自動注入基本 CURD，性能基本無損耗，直接面向對象操作
• 強大的 CRUD 操作：內置通用 Mapper、通用 Service，僅僅通過少量配置即可實現單表大部分 CRUD 操作，更有強大的條件構造器，滿足各類使用需求
• 支持 Lambda 形式調用：通過 Lambda 表達式，方便的編寫各類查詢條件，無需再擔心字段寫錯
• 支持多種數據庫：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer2005、SQLServer 等多種數據庫
• 支持主鍵自動生成：支持多達 4 種主鍵策略（內含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解決主鍵問題
• 支持 XML 熱加載：Mapper 對應的 XML 支持熱加載，對於簡單的 CRUD 操作，甚至可以無 XML 啟動
• 支持 ActiveRecord 模式：支持 ActiveRecord 形式調用，實體類只需繼承 Model 類即可進行強大的 CRUD 操作
• 支持自定義全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
• 支持關鍵詞自動轉義：支持數據庫關鍵詞（order、key......）自動轉義，還可自定義關鍵詞
• 內置代碼生成器：采用代碼或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 層代碼，支持模板引擎，更有超多自定義配置等您來使用
• 內置分頁插件：基於 MyBatis 物理分頁，開發者無需關心具體操作，配置好插件之后，寫分頁等同於普通 List 查詢
• 內置性能分析插件：可輸出 Sql 語句以及其執行時間，建議開發測試時啟用該功能，能快速揪出慢查詢
• 內置全局攔截插件：提供全表 delete 、 update 操作智能分析阻斷，也可自定義攔截規則，預防誤操作
• 內置 Sql 注入剝離器：支持 Sql 注入剝離，有效預防 Sql 注入攻擊

安裝：Maven+jdk8+spring4.0+MybatisPlus3.0.3

注意不同版本的差異很大，所以出現問題時候多考慮版本問題

---------------------------------------------------------------目錄-----------------------------------------------------------------------------------------

一、BaseMapper實現通用mapper

　　1.引入依賴

　　2.配置環境

　　3.測試mapper

　　4.附加BaseMapper源碼

二、代碼生成器---Generator

　　1.引入maven依賴

　　2.編寫代碼

　　3.執行測試

三、分頁插件

四、自定義全局策略配置

五、公共字段自動填充

 

　　1.創建填充類
　　2.配置填充handler
　　3.配置需要填充的字段

 

 

----------------------------------------------------------------------------------------------------通用mapper-----------------------------------------------------------------------------------------------------------------------

一、BaseMapper實現通用mapper

 

1.引入maven依賴

 

 <!-- mp依賴 mybatisPlus 會自動的維護Mybatis 以及MyBatis-spring相關的依賴 -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus</artifactId>
        <version>3.0.3</version>
    </dependency>

<!--junit -->
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.9</version>
</dependency>
<!-- log4j -->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>
<!-- c3p0 -->
<dependency>
    <groupId>com.mchange</groupId>
    <artifactId>c3p0</artifactId>
    <version>0.9.5.2</version>
</dependency>
<!-- mysql -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.37</version>
</dependency>
<!-- spring -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
    <version>4.2.3.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-orm</artifactId>
    <version>4.2.3.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>4.2.3.RELEASE</version>
</dependency>

 

2.配置dataSource，實現繼承BaseMapper，配置mapper文件包位置，然后就可使用內置的CRUD了

applicationContext.xml
在數據源等配置基礎上添加如下配置  
　　　<!-- 配置mybatis 掃描mapper接口的路徑 mapper為EmployeeMapper所在包的位置 -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="basePackage" value="mapper"></property>
    </bean>

 

 

 

3.通用Mapper測試

//Beans
@TableName("tbl_employee")//設置對象名和表明對應 public class Employee { //value指定與數據庫列名一致，type指定主鍵策略為自增，即不用手動插入id
        @TableId(value = "id",type =IdType.AUTO) private Integer id ; @TableField("last_name")//設置駝峰命名和數據庫命令對應，也可以在配置文件中進行全局配置。
　　　　　　　　　　　　//有說法稱：my已經默認開啟了這一對應關系，但是我的沒有生效，所以又手動配置了 private String lastName; private String email ; private Integer gender; private Integer age ; //數據庫中不存在的列，但存在類中，注解后不會注入到sql
        @TableField(exist = false) private Double salary ;
　　　　　　setter(){}
　　　　　　getter(){}
｝

//Mapper
public interface EmployeeMapper extends BaseMapper<Employee> {

　　　　//不需要實現，這時候就可以調用baseMapper的增刪改了
}

//Controller
//加載配置文件
private ApplicationContext ioc =new ClassPathXmlApplicationContext("applicationContext.xml");

private EmployeeMapper employeeMapper=
      ioc.getBean("employeeMapper", EmployeeMapper.class)；

@Test
public void testCommonInsert() {
   
   //初始化Employee對象
   Employee employee  = new Employee();
   employee.setLastName("MP");
   employee.setEmail("[e-mail]");
   employee.setGender(1);
   employee.setAge(18);

   Integer result = employeeMapper.insert(employee);
   System.out.println("result: " + result );
   //獲取當前數據在數據庫中的主鍵值
   Integer key = employee.getId();
   System.out.println("key:" + key );
}

到此已經實現了通用CRUD的操作。

 

4.附一下BaseMapper的包含的方法

 

package com.baomidou.mybatisplus.core.mapper; import com.baomidou.mybatisplus.core.conditions.Wrapper; import com.baomidou.mybatisplus.core.metadata.IPage; import java.io.Serializable; import java.util.Collection; import java.util.List; import java.util.Map; import org.apache.ibatis.annotations.Param; public interface BaseMapper<T> { int insert(T var1); int deleteById(Serializable var1); int deleteByMap(@Param("cm") Map<String, Object> var1); int delete(@Param("ew") Wrapper<T> var1); int deleteBatchIds(@Param("coll") Collection<? extends Serializable> var1); int updateById(@Param("et") T var1); int update(@Param("et") T var1, @Param("ew") Wrapper<T> var2); T selectById(Serializable var1); List<T> selectBatchIds(@Param("coll") Collection<? extends Serializable> var1); List<T> selectByMap(@Param("cm") Map<String, Object> var1); T selectOne(@Param("ew") Wrapper<T> var1); Integer selectCount(@Param("ew") Wrapper<T> var1); List<T> selectList(@Param("ew") Wrapper<T> var1); List<Map<String, Object>> selectMaps(@Param("ew") Wrapper<T> var1); List<Object> selectObjs(@Param("ew") Wrapper<T> var1); IPage<T> selectPage(IPage<T> var1, @Param("ew") Wrapper<T> var2); IPage<Map<String, Object>> selectMapsPage(IPage<T> var1, @Param("ew") Wrapper<T> var2); }

-----------------------------------------------------------------------------------------------------代碼生成器 ------------------------------------------------------------------------------------------------------------------------------------------------------

1.引入Maven依賴

//在上面的基礎上引入下面的 
<!-- Apache velocity -->
    <dependency>
        <groupId>org.apache.velocity</groupId> //Velocity是一個基於Java的模板引擎
        <artifactId>velocity-engine-core</artifactId>
        <version>2.0</version>
    </dependency>
    <!-- sfl4j -->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.7</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-log4j12</artifactId>
        <version>1.7.7</version>
    </dependency>

2.編寫生成器

 public void testGenerator() { GlobalConfig config = new GlobalConfig(); //1.全局配置
        config.setAuthor("wx") .setOutputDir("F:\\Workspaces\\IDEA\\mybatisplus\\src\\main\\java") .setFileOverride(true) .setIdType(IdType.AUTO) //主鍵策略
                .setServiceName("%sService") //默認生成IEmployeeService格式的service %s去掉I
                .setBaseResultMap(true)    //是否生成基本結果集映射
                .setBaseColumnList(true);  //是否生成數據庫列 做通用查詢列 //2.數據源等配置
        DataSourceConfig dsConfig = new DataSourceConfig(); dsConfig.setDbType(DbType.MYSQL) .setDriverName("com.mysql.jdbc.Driver") .setUrl("jdbc:mysql://localhost:3306/mybatisplus") .setUsername("root") .setPassword("root"); //3.策略配置
        StrategyConfig strategyConfig = new StrategyConfig(); strategyConfig.setCapitalMode(true) //開啟全局大寫命名
                .setNaming(NamingStrategy.underline_to_camel)  //數據庫映射到實體類的命名策略
                .setTablePrefix("tbl_") .setInclude("tbl_employee");//生成的表 //4.包名策略
        PackageConfig packageConfig = new PackageConfig(); packageConfig.setParent("com.cmos.mybatisplus") .setMapper("mapper") .setEntity("domain") .setService("service") .setController("controller") .setXml("mapper"); //5.整合配置
        AutoGenerator autoGenerator = new AutoGenerator(); autoGenerator.setGlobalConfig(config) .setDataSource(dsConfig) .setPackageInfo(packageConfig) .setStrategy(strategyConfig); //6.執行
 autoGenerator.execute(); }

3.測試效果

------------------------------------------------------------------------------------------------------------------------分頁--------------------------------------------------------------------------------------------------------------

 三.分頁攔截器插件（物理分頁）

 <property name="plugins">
            <!--分頁插件注冊-->
           <list>
               <bean class="com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor"></bean>
           </list>
        </property>
//測試分頁
public void testPaginationInterceptor(){ IPage<Employee> pages =employeeMapper.selectPage(new Page<>(1,5),null);//即可實現分頁
System.out.println(pages.getRecords()); } IPage對象的方法： List<T> getRecords();//獲取當前頁數據long getTotal(); //獲取總頁數long getSize(); //獲取每頁尺寸long getCurrent(); //獲取當前頁碼 

另外兩種攔截器插件，與分頁插件的配置位置相同，引入即可1.執行分析器插件 SqlExplainInterceptor

2.性能分析器插件 PerformanceInterceptor
四、自定義全局策略配置中的一些，由於不同版本的差別比較大，這里只簡單說一下名字好了、
1.自定義全局操作 sqlInjector 在加載時單點的sql注入BaseMapper中
2.邏輯刪除 LogicDelete 實質上是把帶有@TableLogic注解的字段的sql替換成update操作
五、公共字段自動填充
1.創建填充類 由於版本不同其他版本是extentsMetaObjectHandler

/** * MetaObject：元對象 是mybatis 提供的一個用於更加方便的訪問對象屬性的數據 * 還會用於包裝對象 * 本質上metaObject獲取對象的屬性值或者給對象設置屬性值，最終是要通過Reflector * 獲取到屬性的對應方法的invoker，最終invoke * * */
public class MyMetaObjectHandler implements MetaObjectHandler { @Override public void insertFill(MetaObject metaObject) { //獲取要填充字段的值
        Object fieldValue = getFieldValByName("email",metaObject); if(fieldValue==null){ setFieldValByName("email","123@insert",metaObject); } } @Override public void updateFill(MetaObject metaObject) { //獲取要填充字段的值
        Object fieldValue = getFieldValByName("email",metaObject); if(fieldValue==null){ setFieldValByName("email","123@update",metaObject); } } }

2.配置填充handlerBean

 <!--公共字段自動填充-->
   <bean id="metaObjectHandler" class="Injector.MyMetaObjectHandler"></bean>

3.配置需要填充的字段
使用@TableField(fill=FieldFill.INSERT)注解標注需要自動填充的屬性

FieldFill枚舉類中的參數
DEFAULT,
INSERT,
UPDATE,
INSERT_UPDATE;