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("mp@tom.com");
   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;