Mybatis-Plus简单入门

一、MyBatis-Plus 是什么？

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

Mybatis-Plus特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
• 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
• 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
• 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
• 支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作
• 支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
• 内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用
• 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
• 分页插件支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库
• 内置性能分析插件：可输出 SQL 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
• 内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作

二、快速上手

1.引入Maven依赖

代码如下（示例）：

	<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.5.RELEASE</version>
        <relativePath></relativePath>
    </parent>

    <dependencies>
        <!--1.数据库驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.47</version>
        </dependency>
        <!--2.lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <!--3.mybatis-plus  版本很重要3.0.5-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.0.5</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- 代码生成器模板引擎 -->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.0</version>
        </dependency>
    </dependencies>

2.生成数据库表

代码如下：

DROP TABLE IF EXISTS user;

CREATE TABLE user
(
	id BIGINT(20) NOT NULL COMMENT '主键ID',
	name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
	age INT(11) NULL DEFAULT NULL COMMENT '年龄',
	email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
	PRIMARY KEY (id)
);


DELETE FROM user;

INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');

3.配置

配置application.yml：

spring:
  datasource:
    driver-class-name: com.mysql.jdbc.Driver              # mysql驱动包
    url: jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=false
    username: root
    password: 123456

主启动类配置：

@SpringBootApplication
@MapperScan("com.xzw.mapper")
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class,args);
    }
}

4.代码

实体类User.java:

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

mapper接口：UserMapper

@Mapper
public interface UserMapper extends BaseMapper<User> {
}

和Mybatis不同的是继承了BaseMapper接口后不需要再编写方法了，可以直接事先简单的CRUD操作，大大减少了程序员的工作，同时支持各种条件查询Wrapper。

5.结果展示

编写测试类

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserTest {
    @Resource
    private UserMapper userMapper;

    @Test
    public void getList(){
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }

结果显示:

User(id=1, name=Jone, age=18, email=test1@baomidou.com)
User(id=2, name=Jack, age=20, email=test2@baomidou.com)
User(id=3, name=Tom, age=28, email=test3@baomidou.com)
User(id=4, name=Sandy, age=21, email=test4@baomidou.com)
User(id=5, name=Billie, age=24, email=test5@baomidou.com)

6.日志配置

为了显示更加详细的sql执行过程，以及时间效率，添加日志以及sql配置查看sql执行时间效率
日志添加
在application.yml添加配置,同时为了查看sql效率改为dev环境

#添加日志处理
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
spring:    
  profiles:
    active: dev

查看sql执行效率
添加配置类MybatisPlusConfig.java

@Configuration
@EnableTransactionManagement//事务管理默认已经开启了
public class MybatisPlusConfig {
    /**
     * 查看sql执行时间效率
     * @return
     */
    @Bean
    @Profile({"dev","test"})
    public PerformanceInterceptor performanceInterceptor(){
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        performanceInterceptor.setMaxTime(1000);//设置最大执行时间，超时会报错
        performanceInterceptor.setFormat(true);//sql格式化
        return performanceInterceptor;
    }
}

三、CRUD操作

mybatis已经将CRUD操作进行了封装，只用调用对应的方法即可，不需要再手写sql语句，简单的演示下，以及部分注意。

1.添加操作INSERT

添加操作：

@Test//测试插入
public void insertTest(){
    User user = new User();
    user.setName("xzw");
    user.setAge(18);
    user.setEmail("12345678@qq.com");
    //会帮我们自动生成id,返回值为影响的条数
    Integer result = userMapper.insert(user); 
}

ID自动添加

添加后会发现MP会自动生成主键的ID，这个是可以自己配置的
在User.java中的Id字段上通过注解@TableId的type属性来配置：

@TableId(type = IdType.ID_WORKER)//选择主键添加方式
    private Long id;

在枚举类中可以看见有六种方式，
默认是ID_WORKER使用的是雪花算法，AUTO是自动自增ID，NONE是没有，INPUT是手动输入，UUID是使用UUID生成id，ID_WORKEY_STR是字符串的雪花算法生成的id。这是Mybatis-Plus3.0版本的，之后3.3.0之后默认使用雪花+UUID。参考官方文档Mybatis-Plus自定义ID生成器。

2.更新操作UPDATE

更新操作：

@Test
public void updateTest(){
    User user = new User();
    user.setId(2L);
    //通过条件自动拼接动态Sql
    user.setName("root");
    user.setAge(12);
    user.setEmail("666666@qq.com");
    int i = userMapper.updateById(user);//updateById，但是参数是个user
    System.out.println(i);
}

自动填充

1、在表中增加字段：create_time,update_time表示该字段添加时间和最后修改时间。

2.同时在User.java中添加对应的属性

    //自动处理
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

通过@TableField注解设置自动填充功能，fill属性中FieldFill.INSERT表示添加操作的时候自动生成，FieldFill.INSERT_UPDATE表示添加和修改操作是自动成生成时间。

3.创建一个新类，实现MetaObjectHandler 接口，用来设置自动添加的内容配置

@Component
@Slf4j
public class MyMetaObjectHandler implements MetaObjectHandler {


    @Override
    public void insertFill(MetaObject metaObject) {
    //添加操作时
        log.info("=============insertFill start =================");
        this.setFieldValByName("createTime",new Date(),metaObject);
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
    //更新操作时候
        log.info("=============updateFill start =================");
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
}

更新时自动添加时间

乐观锁

乐观锁：顾名思义十分乐观,他总是认为不会出现问题,无论干什么都不上锁!如果出现了问题,再次更新值测试
悲观锁：顾名思义十分悲观,他总是认为出现问题,无论干什么都会上锁!再去操作!

1.数据库中添加version字段

2.User.java中添加version属性

    //乐观锁注解
    @Version
    private Integer version;

使用@Version注解表示这是一个乐观锁字段

3.添加乐观锁组件在MybatisPlusConfig.java中

 //注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor(){
        return new OptimisticLockerInterceptor();
    }

4.测试一下

@Test
public void testOptimisticLocker1(){
    //1、查询用户信息
    User user = userMapper.selectById(1L);
    //2、修改用户信息
    user.setAge(9);
    user.setEmail("9999999@qq.com");
    //3、执行更新操作
    userMapper.updateById(user);
}

MP会自动添加一个Version的判断

3.删除操作DELETE

通过ID可以直接删除：

    @Test
    public void testDeleteLogic(){
        userMapper.deleteById(6L);//删除id为6的数据
    }

逻辑删除

MP提供了逻辑删除功能，不将数据真正的删除，而是添加一个状态字段deleted，将删除的本质变为更新操作，更改deleted的状态（设0为未删除状态，1为已经删除状态），每次查询时会自动添加一个deletes属性的判断。
1.数据库添加deleted字段

2.User.java添加deleted属性

    //逻辑删除
    @TableLogic
    private Integer deleted;

通过@TableLogic注解表示为逻辑删除判断字段

3.添加逻辑删除组件MybatisPlusConfig.java中

 //逻辑删除组件
    @Bean
    public ISqlInjector sqlInjector(){
        return new LogicSqlInjector();
    }

4.application.yml中进行配置

    #配置逻辑删除  没删除的为0 删除的为1
mybatis-plus:
  global-config:
    db-config:
    #删除状态改为1，未删除状态改为0
      logic-delete-value: 1
      logic-not-delete-value: 0

5.测试
之前未添加逻辑删除时，为删除操作

添加逻辑删除后，查询时，会自动添加deleted的判断

而删除操作改为了Update操作

4.查询操作SELECT

查询所有

不带条件的查询：

	@Test
    public void getList(){
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }

查询结果：

通过wrapper的条件查询

可以在select查询中使用wrapper来添加查询条件实现各种条件查询，具体各类方法参考条件构造器。

进行了部分功能简单的测试，具体实现是使用QueryWrapper类的对象，进行条件配置，再传入的查询放个中进行查询。

@RunWith(SpringRunner.class)
@SpringBootTest
public class WrapperTest {
    @Resource
    private UserMapper userMapper;

    @Test
    public void selectTest1() {
        //参数是一个wrapper ，条件构造器，和刚才的map对比学习！
        //查询name不为空，email不为空，age大于18的用户
        QueryWrapper wrapper = new QueryWrapper();
        wrapper.isNotNull("name");
        wrapper.isNotNull("email");
        wrapper.ge("age", 18);
        List list = userMapper.selectList(wrapper);
        list.forEach(System.out::println);
    }

    @Test
    public void selectTest2() {
        //查询用户名叫Jack的
        QueryWrapper wrapper = new QueryWrapper();
        wrapper.eq("name", "Jack");
        User user = userMapper.selectOne(wrapper);
        System.out.println(user);
    }

    @Test
    public void selectTest3() {
        //20-30岁之间
        QueryWrapper wrapper = new QueryWrapper();
        wrapper.between("age", 20, 30);
        List list = userMapper.selectList(wrapper);
        System.out.println(list);
    }

    @Test
    public void selectTest5() {
        //模糊查询
        QueryWrapper wrapper = new QueryWrapper();
        wrapper.notLike("name","s");
        wrapper.likeRight("email","t");
        List<Map<String,Object>> maps = userMapper.selectMaps(wrapper);
        maps.forEach(System.out::println);
    }

    @Test
    public void selectTest6(){
        //子查询
        QueryWrapper wrapper = new QueryWrapper();
        wrapper.inSql("id","select id from user where id < 3");
        List<Object> objects = userMapper.selectObjs(wrapper);
        objects.forEach(System.out::println);
    }

    @Test
    public void selectTest7(){
        //按照id降序查询
        QueryWrapper wrapper = new QueryWrapper();
        wrapper.orderByDesc("id");
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }
}

拿方法selectTest1为例MP会自动的为我们自动拼接SQL语句：

分页查询

还有个比较重要的就是分页查询
1.首先在MybatisPlusConfig.java类中添加新的分页组件

@Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }

2.开始测试

@Test
     public void testPage(){
        //当前页数 每页数量
        Page<User> page = new Page<>(1,5);
        userMapper.selectPage(page,null);
        page.getRecords().forEach(System.out::println);
    }

创建一个Page类对象，传入两个参数，第一个参数是当前的页数，第二个参数是每一页的数量，再调用selectPage方法进行查询。
查询结构：

可以发现本质上还是使用的SQL语句的limit关键字进行的分页查询。

四、代码生成器

简单来说就是通过配置让MB自动为我们生成包类等，从entity到mapper层controller层都自动生成。
具体代码如下，只需要在策略配置中修改表名，以及数据库链接，可以根据自己的需要进行配置：

public class Code {
    public static void main(String[] args) {
        //构建一个代码生成器对象
        AutoGenerator mpg = new AutoGenerator();
        //配置策略

        //1.全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        //获取当前项目路径
        String projectPath = System.getProperty("user.dir");
        globalConfig.setOutputDir(projectPath + "/src/main/java");
        //设置作者
        globalConfig.setAuthor("author");
        //是否打开资源管理器
        globalConfig.setOpen(false);
        //是否覆盖原来生成的
        globalConfig.setFileOverride(false);
        //服务名
        globalConfig.setServiceName("%sService");
        //主键策略
        globalConfig.setIdType(IdType.ID_WORKER);
        //日期类型
        globalConfig.setDateType(DateType.ONLY_DATE);
        //Swagger文档
        globalConfig.setSwagger2(true);
        mpg.setGlobalConfig(globalConfig);

        //2.设置数据源
        DataSourceConfig ds = new DataSourceConfig();
        ds.setUsername("root");
        ds.setPassword("123456");
        ds.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=false");
        ds.setDriverName("com.mysql.jdbc.Driver");
        ds.setDbType(DbType.MYSQL);
        mpg.setDataSource(ds);

        //3.包的配置
        PackageConfig pk = new PackageConfig();
        //模块名
        pk.setModuleName("blog");
        pk.setParent("com.user");
        pk.setEntity("entity");
        pk.setMapper("mapper");
        pk.setService("service");
        pk.setController("controller");
        mpg.setPackageInfo(pk);

        //4.策略配置
        StrategyConfig strategy = new StrategyConfig();
        //*************表名**************
        strategy.setInclude("user");
        //命名规则下换线转驼峰
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true);
        //逻辑删除字段
        strategy.setLogicDeleteFieldName("deleted");
        //乐观锁
        strategy.setVersionFieldName("version");
        //设置自动填充
        TableFill createTime = new TableFill("create_time", FieldFill.INSERT);
        TableFill updateTime = new TableFill("update_time", FieldFill.INSERT_UPDATE);
        List<TableFill> tableFills = new ArrayList<>();
        tableFills.add(createTime);
        tableFills.add(updateTime);
        strategy.setTableFillList(tableFills);
        //rest驼峰命名
        strategy.setRestControllerStyle(true);
        //下划线命名localhost:8088/hello_id_1
        strategy.setControllerMappingHyphenStyle(true);
        mpg.setStrategy(strategy);

        //执行
        mpg.execute();
    }
}

生成的entity类自动写好注释等

使用代码生成器之后可能遇见问题所需要的依赖：

<!--模板引擎 依赖:mybatis-plus代码生成的时候报异常-->
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.0</version>
</dependency>
<!--配置ApiModel在实体类中不生效-->
<dependency>
    <groupId>com.spring4all</groupId>
    <artifactId>spring-boot-starter-swagger</artifactId>
    <version>1.5.1.RELEASE</version>
</dependency>
<!--freemarker-->
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.30</version>
</dependency>
<!--beetl-->
<dependency>
    <groupId>com.ibeetl</groupId>
    <artifactId>beetl</artifactId>
    <version>3.3.2.RELEASE</version>
</dependency>

五、总结

MP的功能和拓展还有很多，以上只是学习的一部分，可以在官网了解其他的能多拓展功能等，Mybatis-Plus官网